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/module.h> /* for KSYM_SYMBOL_LEN */
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/ctype.h>
24 #include <linux/kernel.h>
25 #include <linux/kallsyms.h>
26 #include <linux/math64.h>
27 #include <linux/uaccess.h>
28 #include <linux/ioport.h>
29 #include <linux/dcache.h>
30 #include <linux/cred.h>
31 #include <net/addrconf.h>
33 #include <asm/page.h> /* for PAGE_SIZE */
34 #include <asm/sections.h> /* for dereference_function_descriptor() */
36 #include <linux/string_helpers.h>
40 * simple_strtoull - convert a string to an unsigned long long
41 * @cp: The start of the string
42 * @endp: A pointer to the end of the parsed string will be placed here
43 * @base: The number base to use
45 * This function is obsolete. Please use kstrtoull instead.
47 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
49 unsigned long long result;
52 cp = _parse_integer_fixup_radix(cp, &base);
53 rv = _parse_integer(cp, base, &result);
55 cp += (rv & ~KSTRTOX_OVERFLOW);
62 EXPORT_SYMBOL(simple_strtoull);
65 * simple_strtoul - convert a string to an unsigned long
66 * @cp: The start of the string
67 * @endp: A pointer to the end of the parsed string will be placed here
68 * @base: The number base to use
70 * This function is obsolete. Please use kstrtoul instead.
72 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
74 return simple_strtoull(cp, endp, base);
76 EXPORT_SYMBOL(simple_strtoul);
79 * simple_strtol - convert a string to a signed long
80 * @cp: The start of the string
81 * @endp: A pointer to the end of the parsed string will be placed here
82 * @base: The number base to use
84 * This function is obsolete. Please use kstrtol instead.
86 long simple_strtol(const char *cp, char **endp, unsigned int base)
89 return -simple_strtoul(cp + 1, endp, base);
91 return simple_strtoul(cp, endp, base);
93 EXPORT_SYMBOL(simple_strtol);
96 * simple_strtoll - convert a string to a signed long long
97 * @cp: The start of the string
98 * @endp: A pointer to the end of the parsed string will be placed here
99 * @base: The number base to use
101 * This function is obsolete. Please use kstrtoll instead.
103 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
106 return -simple_strtoull(cp + 1, endp, base);
108 return simple_strtoull(cp, endp, base);
110 EXPORT_SYMBOL(simple_strtoll);
112 static noinline_for_stack
113 int skip_atoi(const char **s)
118 i = i*10 + *((*s)++) - '0';
119 } while (isdigit(**s));
124 /* Decimal conversion is by far the most typical, and is used
125 * for /proc and /sys data. This directly impacts e.g. top performance
126 * with many processes running. We optimize it for speed
127 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
128 * (with permission from the author, Douglas W. Jones).
131 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
132 /* Formats correctly any integer in [0, 999999999] */
133 static noinline_for_stack
134 char *put_dec_full9(char *buf, unsigned q)
139 * Possible ways to approx. divide by 10
140 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
141 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
142 * (x * 0x6667) >> 18 x < 43699
143 * (x * 0x3334) >> 17 x < 16389
144 * (x * 0x199a) >> 16 x < 16389
145 * (x * 0x0ccd) >> 15 x < 16389
146 * (x * 0x0667) >> 14 x < 2739
147 * (x * 0x0334) >> 13 x < 1029
148 * (x * 0x019a) >> 12 x < 1029
149 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
150 * (x * 0x0067) >> 10 x < 179
151 * (x * 0x0034) >> 9 x < 69 same
152 * (x * 0x001a) >> 8 x < 69 same
153 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
154 * (x * 0x0007) >> 6 x < 19
155 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
157 r = (q * (uint64_t)0x1999999a) >> 32;
158 *buf++ = (q - 10 * r) + '0'; /* 1 */
159 q = (r * (uint64_t)0x1999999a) >> 32;
160 *buf++ = (r - 10 * q) + '0'; /* 2 */
161 r = (q * (uint64_t)0x1999999a) >> 32;
162 *buf++ = (q - 10 * r) + '0'; /* 3 */
163 q = (r * (uint64_t)0x1999999a) >> 32;
164 *buf++ = (r - 10 * q) + '0'; /* 4 */
165 r = (q * (uint64_t)0x1999999a) >> 32;
166 *buf++ = (q - 10 * r) + '0'; /* 5 */
167 /* Now value is under 10000, can avoid 64-bit multiply */
168 q = (r * 0x199a) >> 16;
169 *buf++ = (r - 10 * q) + '0'; /* 6 */
170 r = (q * 0xcd) >> 11;
171 *buf++ = (q - 10 * r) + '0'; /* 7 */
172 q = (r * 0xcd) >> 11;
173 *buf++ = (r - 10 * q) + '0'; /* 8 */
174 *buf++ = q + '0'; /* 9 */
179 /* Similar to above but do not pad with zeros.
180 * Code can be easily arranged to print 9 digits too, but our callers
181 * always call put_dec_full9() instead when the number has 9 decimal digits.
183 static noinline_for_stack
184 char *put_dec_trunc8(char *buf, unsigned r)
188 /* Copy of previous function's body with added early returns */
191 r = (r * (uint64_t)0x1999999a) >> 32;
195 q = (r * 0x199a) >> 16; /* r <= 9999 */
196 *buf++ = (r - 10 * q) + '0';
199 r = (q * 0xcd) >> 11; /* q <= 999 */
200 *buf++ = (q - 10 * r) + '0';
203 q = (r * 0xcd) >> 11; /* r <= 99 */
204 *buf++ = (r - 10 * q) + '0';
207 *buf++ = q + '0'; /* q <= 9 */
211 /* There are two algorithms to print larger numbers.
212 * One is generic: divide by 1000000000 and repeatedly print
213 * groups of (up to) 9 digits. It's conceptually simple,
214 * but requires a (unsigned long long) / 1000000000 division.
216 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
217 * manipulates them cleverly and generates groups of 4 decimal digits.
218 * It so happens that it does NOT require long long division.
220 * If long is > 32 bits, division of 64-bit values is relatively easy,
221 * and we will use the first algorithm.
222 * If long long is > 64 bits (strange architecture with VERY large long long),
223 * second algorithm can't be used, and we again use the first one.
225 * Else (if long is 32 bits and long long is 64 bits) we use second one.
228 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
230 /* First algorithm: generic */
233 char *put_dec(char *buf, unsigned long long n)
235 if (n >= 100*1000*1000) {
236 while (n >= 1000*1000*1000)
237 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
238 if (n >= 100*1000*1000)
239 return put_dec_full9(buf, n);
241 return put_dec_trunc8(buf, n);
246 /* Second algorithm: valid only for 64-bit long longs */
248 /* See comment in put_dec_full9 for choice of constants */
249 static noinline_for_stack
250 void put_dec_full4(char *buf, unsigned q)
253 r = (q * 0xccd) >> 15;
254 buf[0] = (q - 10 * r) + '0';
255 q = (r * 0xcd) >> 11;
256 buf[1] = (r - 10 * q) + '0';
257 r = (q * 0xcd) >> 11;
258 buf[2] = (q - 10 * r) + '0';
263 * Call put_dec_full4 on x % 10000, return x / 10000.
264 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
265 * holds for all x < 1,128,869,999. The largest value this
266 * helper will ever be asked to convert is 1,125,520,955.
267 * (d1 in the put_dec code, assuming n is all-ones).
270 unsigned put_dec_helper4(char *buf, unsigned x)
272 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
274 put_dec_full4(buf, x - q * 10000);
278 /* Based on code by Douglas W. Jones found at
279 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
280 * (with permission from the author).
281 * Performs no 64-bit division and hence should be fast on 32-bit machines.
284 char *put_dec(char *buf, unsigned long long n)
286 uint32_t d3, d2, d1, q, h;
288 if (n < 100*1000*1000)
289 return put_dec_trunc8(buf, n);
291 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
294 d3 = (h >> 16); /* implicit "& 0xffff" */
296 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
297 q = put_dec_helper4(buf, q);
299 q += 7671 * d3 + 9496 * d2 + 6 * d1;
300 q = put_dec_helper4(buf+4, q);
302 q += 4749 * d3 + 42 * d2;
303 q = put_dec_helper4(buf+8, q);
308 buf = put_dec_trunc8(buf, q);
309 else while (buf[-1] == '0')
318 * Convert passed number to decimal string.
319 * Returns the length of string. On buffer overflow, returns 0.
321 * If speed is not important, use snprintf(). It's easy to read the code.
323 int num_to_str(char *buf, int size, unsigned long long num)
325 char tmp[sizeof(num) * 3];
328 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
333 len = put_dec(tmp, num) - tmp;
338 for (idx = 0; idx < len; ++idx)
339 buf[idx] = tmp[len - idx - 1];
343 #define SIGN 1 /* unsigned/signed, must be 1 */
344 #define ZEROPAD 2 /* pad with zero */
345 #define PLUS 4 /* show plus */
346 #define SPACE 8 /* space if plus */
347 #define LEFT 16 /* left justified */
348 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
349 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
352 FORMAT_TYPE_NONE, /* Just a string part */
354 FORMAT_TYPE_PRECISION,
358 FORMAT_TYPE_PERCENT_CHAR,
360 FORMAT_TYPE_LONG_LONG,
374 u8 type; /* format_type enum */
375 u8 flags; /* flags to number() */
376 u8 base; /* number base, 8, 10 or 16 only */
377 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
378 s16 field_width; /* width of output field */
379 s16 precision; /* # of digits/chars */
382 static noinline_for_stack
383 char *number(char *buf, char *end, unsigned long long num,
384 struct printf_spec spec)
386 char tmp[3 * sizeof(num)];
389 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
391 bool is_zero = num == 0LL;
393 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
394 * produces same digits or (maybe lowercased) letters */
395 locase = (spec.flags & SMALL);
396 if (spec.flags & LEFT)
397 spec.flags &= ~ZEROPAD;
399 if (spec.flags & SIGN) {
400 if ((signed long long)num < 0) {
402 num = -(signed long long)num;
404 } else if (spec.flags & PLUS) {
407 } else if (spec.flags & SPACE) {
414 spec.field_width -= 2;
419 /* generate full string in tmp[], in reverse order */
422 tmp[i++] = hex_asc_upper[num] | locase;
423 else if (spec.base != 10) { /* 8 or 16 */
424 int mask = spec.base - 1;
430 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
433 } else { /* base 10 */
434 i = put_dec(tmp, num) - tmp;
437 /* printing 100 using %2d gives "100", not "00" */
438 if (i > spec.precision)
440 /* leading space padding */
441 spec.field_width -= spec.precision;
442 if (!(spec.flags & (ZEROPAD | LEFT))) {
443 while (--spec.field_width >= 0) {
455 /* "0x" / "0" prefix */
457 if (spec.base == 16 || !is_zero) {
462 if (spec.base == 16) {
464 *buf = ('X' | locase);
468 /* zero or space padding */
469 if (!(spec.flags & LEFT)) {
470 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
471 while (--spec.field_width >= 0) {
477 /* hmm even more zero padding? */
478 while (i <= --spec.precision) {
483 /* actual digits of result */
489 /* trailing space padding */
490 while (--spec.field_width >= 0) {
499 static noinline_for_stack
500 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
504 if ((unsigned long)s < PAGE_SIZE)
507 len = strnlen(s, spec.precision);
509 if (!(spec.flags & LEFT)) {
510 while (len < spec.field_width--) {
516 for (i = 0; i < len; ++i) {
521 while (len < spec.field_width--) {
530 static void widen(char *buf, char *end, unsigned len, unsigned spaces)
533 if (buf >= end) /* nowhere to put anything */
536 if (size <= spaces) {
537 memset(buf, ' ', size);
541 if (len > size - spaces)
543 memmove(buf + spaces, buf, len);
545 memset(buf, ' ', spaces);
548 static noinline_for_stack
549 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
552 const char *array[4], *s;
553 const struct dentry *p;
558 case '2': case '3': case '4':
559 depth = fmt[1] - '0';
566 for (i = 0; i < depth; i++, d = p) {
567 p = ACCESS_ONCE(d->d_parent);
568 array[i] = ACCESS_ONCE(d->d_name.name);
577 for (n = 0; n != spec.precision; n++, buf++) {
589 if (n < spec.field_width) {
590 /* we want to pad the sucker */
591 unsigned spaces = spec.field_width - n;
592 if (!(spec.flags & LEFT)) {
593 widen(buf - n, end, n, spaces);
605 static noinline_for_stack
606 char *symbol_string(char *buf, char *end, void *ptr,
607 struct printf_spec spec, const char *fmt)
610 #ifdef CONFIG_KALLSYMS
611 char sym[KSYM_SYMBOL_LEN];
615 ptr = __builtin_extract_return_addr(ptr);
616 value = (unsigned long)ptr;
618 #ifdef CONFIG_KALLSYMS
620 sprint_backtrace(sym, value);
621 else if (*fmt != 'f' && *fmt != 's')
622 sprint_symbol(sym, value);
624 sprint_symbol_no_offset(sym, value);
626 return string(buf, end, sym, spec);
628 spec.field_width = 2 * sizeof(void *);
629 spec.flags |= SPECIAL | SMALL | ZEROPAD;
632 return number(buf, end, value, spec);
636 static noinline_for_stack
637 char *resource_string(char *buf, char *end, struct resource *res,
638 struct printf_spec spec, const char *fmt)
640 #ifndef IO_RSRC_PRINTK_SIZE
641 #define IO_RSRC_PRINTK_SIZE 6
644 #ifndef MEM_RSRC_PRINTK_SIZE
645 #define MEM_RSRC_PRINTK_SIZE 10
647 static const struct printf_spec io_spec = {
649 .field_width = IO_RSRC_PRINTK_SIZE,
651 .flags = SPECIAL | SMALL | ZEROPAD,
653 static const struct printf_spec mem_spec = {
655 .field_width = MEM_RSRC_PRINTK_SIZE,
657 .flags = SPECIAL | SMALL | ZEROPAD,
659 static const struct printf_spec bus_spec = {
663 .flags = SMALL | ZEROPAD,
665 static const struct printf_spec dec_spec = {
670 static const struct printf_spec str_spec = {
675 static const struct printf_spec flag_spec = {
678 .flags = SPECIAL | SMALL,
681 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
682 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
683 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
684 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
685 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
686 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
687 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
688 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
690 char *p = sym, *pend = sym + sizeof(sym);
691 int decode = (fmt[0] == 'R') ? 1 : 0;
692 const struct printf_spec *specp;
695 if (res->flags & IORESOURCE_IO) {
696 p = string(p, pend, "io ", str_spec);
698 } else if (res->flags & IORESOURCE_MEM) {
699 p = string(p, pend, "mem ", str_spec);
701 } else if (res->flags & IORESOURCE_IRQ) {
702 p = string(p, pend, "irq ", str_spec);
704 } else if (res->flags & IORESOURCE_DMA) {
705 p = string(p, pend, "dma ", str_spec);
707 } else if (res->flags & IORESOURCE_BUS) {
708 p = string(p, pend, "bus ", str_spec);
711 p = string(p, pend, "??? ", str_spec);
715 if (decode && res->flags & IORESOURCE_UNSET) {
716 p = string(p, pend, "size ", str_spec);
717 p = number(p, pend, resource_size(res), *specp);
719 p = number(p, pend, res->start, *specp);
720 if (res->start != res->end) {
722 p = number(p, pend, res->end, *specp);
726 if (res->flags & IORESOURCE_MEM_64)
727 p = string(p, pend, " 64bit", str_spec);
728 if (res->flags & IORESOURCE_PREFETCH)
729 p = string(p, pend, " pref", str_spec);
730 if (res->flags & IORESOURCE_WINDOW)
731 p = string(p, pend, " window", str_spec);
732 if (res->flags & IORESOURCE_DISABLED)
733 p = string(p, pend, " disabled", str_spec);
735 p = string(p, pend, " flags ", str_spec);
736 p = number(p, pend, res->flags, flag_spec);
741 return string(buf, end, sym, spec);
744 static noinline_for_stack
745 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
748 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
749 negative value, fallback to the default */
752 if (spec.field_width == 0)
753 /* nothing to print */
756 if (ZERO_OR_NULL_PTR(addr))
758 return string(buf, end, NULL, spec);
775 if (spec.field_width > 0)
776 len = min_t(int, spec.field_width, 64);
778 for (i = 0; i < len && buf < end - 1; i++) {
779 buf = hex_byte_pack(buf, addr[i]);
781 if (buf < end && separator && i != len - 1)
788 static noinline_for_stack
789 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
790 struct printf_spec spec, const char *fmt)
792 const int CHUNKSZ = 32;
793 int nr_bits = max_t(int, spec.field_width, 0);
797 /* reused to print numbers */
798 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
800 chunksz = nr_bits & (CHUNKSZ - 1);
804 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
805 for (; i >= 0; i -= CHUNKSZ) {
809 chunkmask = ((1ULL << chunksz) - 1);
810 word = i / BITS_PER_LONG;
811 bit = i % BITS_PER_LONG;
812 val = (bitmap[word] >> bit) & chunkmask;
821 spec.field_width = DIV_ROUND_UP(chunksz, 4);
822 buf = number(buf, end, val, spec);
829 static noinline_for_stack
830 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
831 struct printf_spec spec, const char *fmt)
833 int nr_bits = max_t(int, spec.field_width, 0);
834 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
838 /* reused to print numbers */
839 spec = (struct printf_spec){ .base = 10 };
841 rbot = cur = find_first_bit(bitmap, nr_bits);
842 while (cur < nr_bits) {
844 cur = find_next_bit(bitmap, nr_bits, cur + 1);
845 if (cur < nr_bits && cur <= rtop + 1)
855 buf = number(buf, end, rbot, spec);
861 buf = number(buf, end, rtop, spec);
869 static noinline_for_stack
870 char *mac_address_string(char *buf, char *end, u8 *addr,
871 struct printf_spec spec, const char *fmt)
873 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
877 bool reversed = false;
893 for (i = 0; i < 6; i++) {
895 p = hex_byte_pack(p, addr[5 - i]);
897 p = hex_byte_pack(p, addr[i]);
899 if (fmt[0] == 'M' && i != 5)
904 return string(buf, end, mac_addr, spec);
907 static noinline_for_stack
908 char *ip4_string(char *p, const u8 *addr, const char *fmt)
911 bool leading_zeros = (fmt[0] == 'i');
936 for (i = 0; i < 4; i++) {
937 char temp[3]; /* hold each IP quad in reverse order */
938 int digits = put_dec_trunc8(temp, addr[index]) - temp;
945 /* reverse the digits in the quad */
957 static noinline_for_stack
958 char *ip6_compressed_string(char *p, const char *addr)
961 unsigned char zerolength[8];
966 bool needcolon = false;
970 memcpy(&in6, addr, sizeof(struct in6_addr));
972 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
974 memset(zerolength, 0, sizeof(zerolength));
981 /* find position of longest 0 run */
982 for (i = 0; i < range; i++) {
983 for (j = i; j < range; j++) {
984 if (in6.s6_addr16[j] != 0)
989 for (i = 0; i < range; i++) {
990 if (zerolength[i] > longest) {
991 longest = zerolength[i];
995 if (longest == 1) /* don't compress a single 0 */
999 for (i = 0; i < range; i++) {
1000 if (i == colonpos) {
1001 if (needcolon || i == 0)
1012 /* hex u16 without leading 0s */
1013 word = ntohs(in6.s6_addr16[i]);
1018 p = hex_byte_pack(p, hi);
1020 *p++ = hex_asc_lo(hi);
1021 p = hex_byte_pack(p, lo);
1024 p = hex_byte_pack(p, lo);
1026 *p++ = hex_asc_lo(lo);
1033 p = ip4_string(p, &in6.s6_addr[12], "I4");
1040 static noinline_for_stack
1041 char *ip6_string(char *p, const char *addr, const char *fmt)
1045 for (i = 0; i < 8; i++) {
1046 p = hex_byte_pack(p, *addr++);
1047 p = hex_byte_pack(p, *addr++);
1048 if (fmt[0] == 'I' && i != 7)
1056 static noinline_for_stack
1057 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1058 struct printf_spec spec, const char *fmt)
1060 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1062 if (fmt[0] == 'I' && fmt[2] == 'c')
1063 ip6_compressed_string(ip6_addr, addr);
1065 ip6_string(ip6_addr, addr, fmt);
1067 return string(buf, end, ip6_addr, spec);
1070 static noinline_for_stack
1071 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1072 struct printf_spec spec, const char *fmt)
1074 char ip4_addr[sizeof("255.255.255.255")];
1076 ip4_string(ip4_addr, addr, fmt);
1078 return string(buf, end, ip4_addr, spec);
1081 static noinline_for_stack
1082 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1083 struct printf_spec spec, const char *fmt)
1085 bool have_p = false, have_s = false, have_f = false, have_c = false;
1086 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1087 sizeof(":12345") + sizeof("/123456789") +
1088 sizeof("%1234567890")];
1089 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1090 const u8 *addr = (const u8 *) &sa->sin6_addr;
1091 char fmt6[2] = { fmt[0], '6' };
1095 while (isalpha(*++fmt)) {
1112 if (have_p || have_s || have_f) {
1117 if (fmt6[0] == 'I' && have_c)
1118 p = ip6_compressed_string(ip6_addr + off, addr);
1120 p = ip6_string(ip6_addr + off, addr, fmt6);
1122 if (have_p || have_s || have_f)
1127 p = number(p, pend, ntohs(sa->sin6_port), spec);
1131 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1132 IPV6_FLOWINFO_MASK), spec);
1136 p = number(p, pend, sa->sin6_scope_id, spec);
1140 return string(buf, end, ip6_addr, spec);
1143 static noinline_for_stack
1144 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1145 struct printf_spec spec, const char *fmt)
1147 bool have_p = false;
1148 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1149 char *pend = ip4_addr + sizeof(ip4_addr);
1150 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1151 char fmt4[3] = { fmt[0], '4', 0 };
1154 while (isalpha(*++fmt)) {
1168 p = ip4_string(ip4_addr, addr, fmt4);
1171 p = number(p, pend, ntohs(sa->sin_port), spec);
1175 return string(buf, end, ip4_addr, spec);
1178 static noinline_for_stack
1179 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1184 unsigned int flags = 0;
1187 if (spec.field_width == 0)
1188 return buf; /* nothing to print */
1190 if (ZERO_OR_NULL_PTR(addr))
1191 return string(buf, end, NULL, spec); /* NULL pointer */
1195 switch (fmt[count++]) {
1197 flags |= ESCAPE_ANY;
1200 flags |= ESCAPE_SPECIAL;
1203 flags |= ESCAPE_HEX;
1206 flags |= ESCAPE_NULL;
1209 flags |= ESCAPE_OCTAL;
1215 flags |= ESCAPE_SPACE;
1224 flags = ESCAPE_ANY_NP;
1226 len = spec.field_width < 0 ? 1 : spec.field_width;
1228 /* Ignore the error. We print as many characters as we can */
1229 string_escape_mem(addr, len, &buf, end - buf, flags, NULL);
1234 static noinline_for_stack
1235 char *uuid_string(char *buf, char *end, const u8 *addr,
1236 struct printf_spec spec, const char *fmt)
1238 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1241 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1242 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1243 const u8 *index = be;
1248 uc = true; /* fall-through */
1257 for (i = 0; i < 16; i++) {
1258 p = hex_byte_pack(p, addr[index[i]]);
1278 return string(buf, end, uuid, spec);
1282 char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1283 struct printf_spec spec)
1285 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1286 if (spec.field_width == -1)
1287 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1290 return number(buf, end, *(const netdev_features_t *)addr, spec);
1293 static noinline_for_stack
1294 char *address_val(char *buf, char *end, const void *addr,
1295 struct printf_spec spec, const char *fmt)
1297 unsigned long long num;
1299 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1304 num = *(const dma_addr_t *)addr;
1305 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1309 num = *(const phys_addr_t *)addr;
1310 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1314 return number(buf, end, num, spec);
1317 int kptr_restrict __read_mostly;
1320 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1321 * by an extra set of alphanumeric characters that are extended format
1324 * Right now we handle:
1326 * - 'F' For symbolic function descriptor pointers with offset
1327 * - 'f' For simple symbolic function names without offset
1328 * - 'S' For symbolic direct pointers with offset
1329 * - 's' For symbolic direct pointers without offset
1330 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1331 * - 'B' For backtraced symbolic direct pointers with offset
1332 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1333 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1334 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1335 * width which must be explicitly specified either as part of the
1336 * format string '%32b[l]' or through '%*b[l]', [l] selects
1337 * range-list format instead of hex format
1338 * - 'M' For a 6-byte MAC address, it prints the address in the
1339 * usual colon-separated hex notation
1340 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1341 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1342 * with a dash-separated hex notation
1343 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1344 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1345 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1346 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1348 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1349 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1350 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1351 * IPv6 omits the colons (01020304...0f)
1352 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1354 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1355 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1356 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1357 * - 'I[6S]c' for IPv6 addresses printed as specified by
1358 * http://tools.ietf.org/html/rfc5952
1359 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1360 * of the following flags (see string_escape_mem() for the
1363 * c - ESCAPE_SPECIAL
1369 * By default ESCAPE_ANY_NP is used.
1370 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1371 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1372 * Options for %pU are:
1373 * b big endian lower case hex (default)
1374 * B big endian UPPER case hex
1375 * l little endian lower case hex
1376 * L little endian UPPER case hex
1377 * big endian output byte order is:
1378 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1379 * little endian output byte order is:
1380 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1381 * - 'V' For a struct va_format which contains a format string * and va_list *,
1382 * call vsnprintf(->format, *->va_list).
1383 * Implements a "recursive vsnprintf".
1384 * Do not use this feature without some mechanism to verify the
1385 * correctness of the format string and va_list arguments.
1386 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1387 * - 'NF' For a netdev_features_t
1388 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1389 * a certain separator (' ' by default):
1393 * The maximum supported length is 64 bytes of the input. Consider
1394 * to use print_hex_dump() for the larger input.
1395 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1396 * (default assumed to be phys_addr_t, passed by reference)
1397 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1398 * - 'D[234]' Same as 'd' but for a struct file
1400 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1401 * function pointers are really function descriptors, which contain a
1402 * pointer to the real address.
1404 static noinline_for_stack
1405 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1406 struct printf_spec spec)
1408 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1410 if (!ptr && *fmt != 'K') {
1412 * Print (null) with the same width as a pointer so it makes
1413 * tabular output look nice.
1415 if (spec.field_width == -1)
1416 spec.field_width = default_width;
1417 return string(buf, end, "(null)", spec);
1423 ptr = dereference_function_descriptor(ptr);
1428 return symbol_string(buf, end, ptr, spec, fmt);
1431 return resource_string(buf, end, ptr, spec, fmt);
1433 return hex_string(buf, end, ptr, spec, fmt);
1437 return bitmap_list_string(buf, end, ptr, spec, fmt);
1439 return bitmap_string(buf, end, ptr, spec, fmt);
1441 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1442 case 'm': /* Contiguous: 000102030405 */
1444 /* [mM]R (Reverse order; Bluetooth) */
1445 return mac_address_string(buf, end, ptr, spec, fmt);
1446 case 'I': /* Formatted IP supported
1448 * 6: 0001:0203:...:0708
1449 * 6c: 1::708 or 1::1.2.3.4
1451 case 'i': /* Contiguous:
1452 * 4: 001.002.003.004
1457 return ip6_addr_string(buf, end, ptr, spec, fmt);
1459 return ip4_addr_string(buf, end, ptr, spec, fmt);
1462 struct sockaddr raw;
1463 struct sockaddr_in v4;
1464 struct sockaddr_in6 v6;
1467 switch (sa->raw.sa_family) {
1469 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1471 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1473 return string(buf, end, "(invalid address)", spec);
1478 return escaped_string(buf, end, ptr, spec, fmt);
1480 return uuid_string(buf, end, ptr, spec, fmt);
1485 va_copy(va, *((struct va_format *)ptr)->va);
1486 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1487 ((struct va_format *)ptr)->fmt, va);
1493 * %pK cannot be used in IRQ context because its test
1494 * for CAP_SYSLOG would be meaningless.
1496 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1498 if (spec.field_width == -1)
1499 spec.field_width = default_width;
1500 return string(buf, end, "pK-error", spec);
1503 switch (kptr_restrict) {
1505 /* Always print %pK values */
1509 * Only print the real pointer value if the current
1510 * process has CAP_SYSLOG and is running with the
1511 * same credentials it started with. This is because
1512 * access to files is checked at open() time, but %pK
1513 * checks permission at read() time. We don't want to
1514 * leak pointer values if a binary opens a file using
1515 * %pK and then elevates privileges before reading it.
1517 const struct cred *cred = current_cred();
1519 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1520 !uid_eq(cred->euid, cred->uid) ||
1521 !gid_eq(cred->egid, cred->gid))
1527 /* Always print 0's for %pK */
1536 return netdev_feature_string(buf, end, ptr, spec);
1540 return address_val(buf, end, ptr, spec, fmt);
1542 return dentry_name(buf, end, ptr, spec, fmt);
1544 return dentry_name(buf, end,
1545 ((const struct file *)ptr)->f_path.dentry,
1548 spec.flags |= SMALL;
1549 if (spec.field_width == -1) {
1550 spec.field_width = default_width;
1551 spec.flags |= ZEROPAD;
1555 return number(buf, end, (unsigned long) ptr, spec);
1559 * Helper function to decode printf style format.
1560 * Each call decode a token from the format and return the
1561 * number of characters read (or likely the delta where it wants
1562 * to go on the next call).
1563 * The decoded token is returned through the parameters
1565 * 'h', 'l', or 'L' for integer fields
1566 * 'z' support added 23/7/1999 S.H.
1567 * 'z' changed to 'Z' --davidm 1/25/99
1568 * 't' added for ptrdiff_t
1570 * @fmt: the format string
1571 * @type of the token returned
1572 * @flags: various flags such as +, -, # tokens..
1573 * @field_width: overwritten width
1574 * @base: base of the number (octal, hex, ...)
1575 * @precision: precision of a number
1576 * @qualifier: qualifier of a number (long, size_t, ...)
1578 static noinline_for_stack
1579 int format_decode(const char *fmt, struct printf_spec *spec)
1581 const char *start = fmt;
1583 /* we finished early by reading the field width */
1584 if (spec->type == FORMAT_TYPE_WIDTH) {
1585 if (spec->field_width < 0) {
1586 spec->field_width = -spec->field_width;
1587 spec->flags |= LEFT;
1589 spec->type = FORMAT_TYPE_NONE;
1593 /* we finished early by reading the precision */
1594 if (spec->type == FORMAT_TYPE_PRECISION) {
1595 if (spec->precision < 0)
1596 spec->precision = 0;
1598 spec->type = FORMAT_TYPE_NONE;
1603 spec->type = FORMAT_TYPE_NONE;
1605 for (; *fmt ; ++fmt) {
1610 /* Return the current non-format string */
1611 if (fmt != start || !*fmt)
1617 while (1) { /* this also skips first '%' */
1623 case '-': spec->flags |= LEFT; break;
1624 case '+': spec->flags |= PLUS; break;
1625 case ' ': spec->flags |= SPACE; break;
1626 case '#': spec->flags |= SPECIAL; break;
1627 case '0': spec->flags |= ZEROPAD; break;
1628 default: found = false;
1635 /* get field width */
1636 spec->field_width = -1;
1639 spec->field_width = skip_atoi(&fmt);
1640 else if (*fmt == '*') {
1641 /* it's the next argument */
1642 spec->type = FORMAT_TYPE_WIDTH;
1643 return ++fmt - start;
1647 /* get the precision */
1648 spec->precision = -1;
1651 if (isdigit(*fmt)) {
1652 spec->precision = skip_atoi(&fmt);
1653 if (spec->precision < 0)
1654 spec->precision = 0;
1655 } else if (*fmt == '*') {
1656 /* it's the next argument */
1657 spec->type = FORMAT_TYPE_PRECISION;
1658 return ++fmt - start;
1663 /* get the conversion qualifier */
1664 spec->qualifier = -1;
1665 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1666 _tolower(*fmt) == 'z' || *fmt == 't') {
1667 spec->qualifier = *fmt++;
1668 if (unlikely(spec->qualifier == *fmt)) {
1669 if (spec->qualifier == 'l') {
1670 spec->qualifier = 'L';
1672 } else if (spec->qualifier == 'h') {
1673 spec->qualifier = 'H';
1683 spec->type = FORMAT_TYPE_CHAR;
1684 return ++fmt - start;
1687 spec->type = FORMAT_TYPE_STR;
1688 return ++fmt - start;
1691 spec->type = FORMAT_TYPE_PTR;
1692 return ++fmt - start;
1695 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1696 return ++fmt - start;
1698 /* integer number formats - set up the flags and "break" */
1704 spec->flags |= SMALL;
1712 spec->flags |= SIGN;
1718 * Since %n poses a greater security risk than utility, treat
1719 * it as an invalid format specifier. Warn about its use so
1720 * that new instances don't get added.
1722 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1726 spec->type = FORMAT_TYPE_INVALID;
1730 if (spec->qualifier == 'L')
1731 spec->type = FORMAT_TYPE_LONG_LONG;
1732 else if (spec->qualifier == 'l') {
1733 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1734 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1735 } else if (_tolower(spec->qualifier) == 'z') {
1736 spec->type = FORMAT_TYPE_SIZE_T;
1737 } else if (spec->qualifier == 't') {
1738 spec->type = FORMAT_TYPE_PTRDIFF;
1739 } else if (spec->qualifier == 'H') {
1740 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1741 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1742 } else if (spec->qualifier == 'h') {
1743 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1744 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1746 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1747 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1750 return ++fmt - start;
1754 * vsnprintf - Format a string and place it in a buffer
1755 * @buf: The buffer to place the result into
1756 * @size: The size of the buffer, including the trailing null space
1757 * @fmt: The format string to use
1758 * @args: Arguments for the format string
1760 * This function follows C99 vsnprintf, but has some extensions:
1761 * %pS output the name of a text symbol with offset
1762 * %ps output the name of a text symbol without offset
1763 * %pF output the name of a function pointer with its offset
1764 * %pf output the name of a function pointer without its offset
1765 * %pB output the name of a backtrace symbol with its offset
1766 * %pR output the address range in a struct resource with decoded flags
1767 * %pr output the address range in a struct resource with raw flags
1768 * %pb output the bitmap with field width as the number of bits
1769 * %pbl output the bitmap as range list with field width as the number of bits
1770 * %pM output a 6-byte MAC address with colons
1771 * %pMR output a 6-byte MAC address with colons in reversed order
1772 * %pMF output a 6-byte MAC address with dashes
1773 * %pm output a 6-byte MAC address without colons
1774 * %pmR output a 6-byte MAC address without colons in reversed order
1775 * %pI4 print an IPv4 address without leading zeros
1776 * %pi4 print an IPv4 address with leading zeros
1777 * %pI6 print an IPv6 address with colons
1778 * %pi6 print an IPv6 address without colons
1779 * %pI6c print an IPv6 address as specified by RFC 5952
1780 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1781 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1782 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1784 * %*pE[achnops] print an escaped buffer
1785 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1786 * bytes of the input)
1789 * ** Please update Documentation/printk-formats.txt when making changes **
1791 * The return value is the number of characters which would
1792 * be generated for the given input, excluding the trailing
1793 * '\0', as per ISO C99. If you want to have the exact
1794 * number of characters written into @buf as return value
1795 * (not including the trailing '\0'), use vscnprintf(). If the
1796 * return is greater than or equal to @size, the resulting
1797 * string is truncated.
1799 * If you're not already dealing with a va_list consider using snprintf().
1801 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1803 unsigned long long num;
1805 struct printf_spec spec = {0};
1807 /* Reject out-of-range values early. Large positive sizes are
1808 used for unknown buffer sizes. */
1809 if (WARN_ON_ONCE(size > INT_MAX))
1815 /* Make sure end is always >= buf */
1822 const char *old_fmt = fmt;
1823 int read = format_decode(fmt, &spec);
1827 switch (spec.type) {
1828 case FORMAT_TYPE_NONE: {
1831 if (copy > end - str)
1833 memcpy(str, old_fmt, copy);
1839 case FORMAT_TYPE_WIDTH:
1840 spec.field_width = va_arg(args, int);
1843 case FORMAT_TYPE_PRECISION:
1844 spec.precision = va_arg(args, int);
1847 case FORMAT_TYPE_CHAR: {
1850 if (!(spec.flags & LEFT)) {
1851 while (--spec.field_width > 0) {
1858 c = (unsigned char) va_arg(args, int);
1862 while (--spec.field_width > 0) {
1870 case FORMAT_TYPE_STR:
1871 str = string(str, end, va_arg(args, char *), spec);
1874 case FORMAT_TYPE_PTR:
1875 str = pointer(fmt, str, end, va_arg(args, void *),
1877 while (isalnum(*fmt))
1881 case FORMAT_TYPE_PERCENT_CHAR:
1887 case FORMAT_TYPE_INVALID:
1894 switch (spec.type) {
1895 case FORMAT_TYPE_LONG_LONG:
1896 num = va_arg(args, long long);
1898 case FORMAT_TYPE_ULONG:
1899 num = va_arg(args, unsigned long);
1901 case FORMAT_TYPE_LONG:
1902 num = va_arg(args, long);
1904 case FORMAT_TYPE_SIZE_T:
1905 if (spec.flags & SIGN)
1906 num = va_arg(args, ssize_t);
1908 num = va_arg(args, size_t);
1910 case FORMAT_TYPE_PTRDIFF:
1911 num = va_arg(args, ptrdiff_t);
1913 case FORMAT_TYPE_UBYTE:
1914 num = (unsigned char) va_arg(args, int);
1916 case FORMAT_TYPE_BYTE:
1917 num = (signed char) va_arg(args, int);
1919 case FORMAT_TYPE_USHORT:
1920 num = (unsigned short) va_arg(args, int);
1922 case FORMAT_TYPE_SHORT:
1923 num = (short) va_arg(args, int);
1925 case FORMAT_TYPE_INT:
1926 num = (int) va_arg(args, int);
1929 num = va_arg(args, unsigned int);
1932 str = number(str, end, num, spec);
1943 /* the trailing null byte doesn't count towards the total */
1947 EXPORT_SYMBOL(vsnprintf);
1950 * vscnprintf - Format a string and place it in a buffer
1951 * @buf: The buffer to place the result into
1952 * @size: The size of the buffer, including the trailing null space
1953 * @fmt: The format string to use
1954 * @args: Arguments for the format string
1956 * The return value is the number of characters which have been written into
1957 * the @buf not including the trailing '\0'. If @size is == 0 the function
1960 * If you're not already dealing with a va_list consider using scnprintf().
1962 * See the vsnprintf() documentation for format string extensions over C99.
1964 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1968 i = vsnprintf(buf, size, fmt, args);
1970 if (likely(i < size))
1976 EXPORT_SYMBOL(vscnprintf);
1979 * snprintf - Format a string and place it in a buffer
1980 * @buf: The buffer to place the result into
1981 * @size: The size of the buffer, including the trailing null space
1982 * @fmt: The format string to use
1983 * @...: Arguments for the format string
1985 * The return value is the number of characters which would be
1986 * generated for the given input, excluding the trailing null,
1987 * as per ISO C99. If the return is greater than or equal to
1988 * @size, the resulting string is truncated.
1990 * See the vsnprintf() documentation for format string extensions over C99.
1992 int snprintf(char *buf, size_t size, const char *fmt, ...)
1997 va_start(args, fmt);
1998 i = vsnprintf(buf, size, fmt, args);
2003 EXPORT_SYMBOL(snprintf);
2006 * scnprintf - Format a string and place it in a buffer
2007 * @buf: The buffer to place the result into
2008 * @size: The size of the buffer, including the trailing null space
2009 * @fmt: The format string to use
2010 * @...: Arguments for the format string
2012 * The return value is the number of characters written into @buf not including
2013 * the trailing '\0'. If @size is == 0 the function returns 0.
2016 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2021 va_start(args, fmt);
2022 i = vscnprintf(buf, size, fmt, args);
2027 EXPORT_SYMBOL(scnprintf);
2030 * vsprintf - Format a string and place it in a buffer
2031 * @buf: The buffer to place the result into
2032 * @fmt: The format string to use
2033 * @args: Arguments for the format string
2035 * The function returns the number of characters written
2036 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2039 * If you're not already dealing with a va_list consider using sprintf().
2041 * See the vsnprintf() documentation for format string extensions over C99.
2043 int vsprintf(char *buf, const char *fmt, va_list args)
2045 return vsnprintf(buf, INT_MAX, fmt, args);
2047 EXPORT_SYMBOL(vsprintf);
2050 * sprintf - Format a string and place it in a buffer
2051 * @buf: The buffer to place the result into
2052 * @fmt: The format string to use
2053 * @...: Arguments for the format string
2055 * The function returns the number of characters written
2056 * into @buf. Use snprintf() or scnprintf() in order to avoid
2059 * See the vsnprintf() documentation for format string extensions over C99.
2061 int sprintf(char *buf, const char *fmt, ...)
2066 va_start(args, fmt);
2067 i = vsnprintf(buf, INT_MAX, fmt, args);
2072 EXPORT_SYMBOL(sprintf);
2074 #ifdef CONFIG_BINARY_PRINTF
2077 * vbin_printf() - VA arguments to binary data
2078 * bstr_printf() - Binary data to text string
2082 * vbin_printf - Parse a format string and place args' binary value in a buffer
2083 * @bin_buf: The buffer to place args' binary value
2084 * @size: The size of the buffer(by words(32bits), not characters)
2085 * @fmt: The format string to use
2086 * @args: Arguments for the format string
2088 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2091 * The return value is the number of words(32bits) which would be generated for
2095 * If the return value is greater than @size, the resulting bin_buf is NOT
2096 * valid for bstr_printf().
2098 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2100 struct printf_spec spec = {0};
2103 str = (char *)bin_buf;
2104 end = (char *)(bin_buf + size);
2106 #define save_arg(type) \
2108 if (sizeof(type) == 8) { \
2109 unsigned long long value; \
2110 str = PTR_ALIGN(str, sizeof(u32)); \
2111 value = va_arg(args, unsigned long long); \
2112 if (str + sizeof(type) <= end) { \
2113 *(u32 *)str = *(u32 *)&value; \
2114 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2117 unsigned long value; \
2118 str = PTR_ALIGN(str, sizeof(type)); \
2119 value = va_arg(args, int); \
2120 if (str + sizeof(type) <= end) \
2121 *(typeof(type) *)str = (type)value; \
2123 str += sizeof(type); \
2127 int read = format_decode(fmt, &spec);
2131 switch (spec.type) {
2132 case FORMAT_TYPE_NONE:
2133 case FORMAT_TYPE_INVALID:
2134 case FORMAT_TYPE_PERCENT_CHAR:
2137 case FORMAT_TYPE_WIDTH:
2138 case FORMAT_TYPE_PRECISION:
2142 case FORMAT_TYPE_CHAR:
2146 case FORMAT_TYPE_STR: {
2147 const char *save_str = va_arg(args, char *);
2150 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2151 || (unsigned long)save_str < PAGE_SIZE)
2152 save_str = "(null)";
2153 len = strlen(save_str) + 1;
2154 if (str + len < end)
2155 memcpy(str, save_str, len);
2160 case FORMAT_TYPE_PTR:
2162 /* skip all alphanumeric pointer suffixes */
2163 while (isalnum(*fmt))
2168 switch (spec.type) {
2170 case FORMAT_TYPE_LONG_LONG:
2171 save_arg(long long);
2173 case FORMAT_TYPE_ULONG:
2174 case FORMAT_TYPE_LONG:
2175 save_arg(unsigned long);
2177 case FORMAT_TYPE_SIZE_T:
2180 case FORMAT_TYPE_PTRDIFF:
2181 save_arg(ptrdiff_t);
2183 case FORMAT_TYPE_UBYTE:
2184 case FORMAT_TYPE_BYTE:
2187 case FORMAT_TYPE_USHORT:
2188 case FORMAT_TYPE_SHORT:
2197 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2200 EXPORT_SYMBOL_GPL(vbin_printf);
2203 * bstr_printf - Format a string from binary arguments and place it in a buffer
2204 * @buf: The buffer to place the result into
2205 * @size: The size of the buffer, including the trailing null space
2206 * @fmt: The format string to use
2207 * @bin_buf: Binary arguments for the format string
2209 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2210 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2211 * a binary buffer that generated by vbin_printf.
2213 * The format follows C99 vsnprintf, but has some extensions:
2214 * see vsnprintf comment for details.
2216 * The return value is the number of characters which would
2217 * be generated for the given input, excluding the trailing
2218 * '\0', as per ISO C99. If you want to have the exact
2219 * number of characters written into @buf as return value
2220 * (not including the trailing '\0'), use vscnprintf(). If the
2221 * return is greater than or equal to @size, the resulting
2222 * string is truncated.
2224 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2226 struct printf_spec spec = {0};
2228 const char *args = (const char *)bin_buf;
2230 if (WARN_ON_ONCE((int) size < 0))
2236 #define get_arg(type) \
2238 typeof(type) value; \
2239 if (sizeof(type) == 8) { \
2240 args = PTR_ALIGN(args, sizeof(u32)); \
2241 *(u32 *)&value = *(u32 *)args; \
2242 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2244 args = PTR_ALIGN(args, sizeof(type)); \
2245 value = *(typeof(type) *)args; \
2247 args += sizeof(type); \
2251 /* Make sure end is always >= buf */
2258 const char *old_fmt = fmt;
2259 int read = format_decode(fmt, &spec);
2263 switch (spec.type) {
2264 case FORMAT_TYPE_NONE: {
2267 if (copy > end - str)
2269 memcpy(str, old_fmt, copy);
2275 case FORMAT_TYPE_WIDTH:
2276 spec.field_width = get_arg(int);
2279 case FORMAT_TYPE_PRECISION:
2280 spec.precision = get_arg(int);
2283 case FORMAT_TYPE_CHAR: {
2286 if (!(spec.flags & LEFT)) {
2287 while (--spec.field_width > 0) {
2293 c = (unsigned char) get_arg(char);
2297 while (--spec.field_width > 0) {
2305 case FORMAT_TYPE_STR: {
2306 const char *str_arg = args;
2307 args += strlen(str_arg) + 1;
2308 str = string(str, end, (char *)str_arg, spec);
2312 case FORMAT_TYPE_PTR:
2313 str = pointer(fmt, str, end, get_arg(void *), spec);
2314 while (isalnum(*fmt))
2318 case FORMAT_TYPE_PERCENT_CHAR:
2319 case FORMAT_TYPE_INVALID:
2326 unsigned long long num;
2328 switch (spec.type) {
2330 case FORMAT_TYPE_LONG_LONG:
2331 num = get_arg(long long);
2333 case FORMAT_TYPE_ULONG:
2334 case FORMAT_TYPE_LONG:
2335 num = get_arg(unsigned long);
2337 case FORMAT_TYPE_SIZE_T:
2338 num = get_arg(size_t);
2340 case FORMAT_TYPE_PTRDIFF:
2341 num = get_arg(ptrdiff_t);
2343 case FORMAT_TYPE_UBYTE:
2344 num = get_arg(unsigned char);
2346 case FORMAT_TYPE_BYTE:
2347 num = get_arg(signed char);
2349 case FORMAT_TYPE_USHORT:
2350 num = get_arg(unsigned short);
2352 case FORMAT_TYPE_SHORT:
2353 num = get_arg(short);
2355 case FORMAT_TYPE_UINT:
2356 num = get_arg(unsigned int);
2362 str = number(str, end, num, spec);
2364 } /* switch(spec.type) */
2376 /* the trailing null byte doesn't count towards the total */
2379 EXPORT_SYMBOL_GPL(bstr_printf);
2382 * bprintf - Parse a format string and place args' binary value in a buffer
2383 * @bin_buf: The buffer to place args' binary value
2384 * @size: The size of the buffer(by words(32bits), not characters)
2385 * @fmt: The format string to use
2386 * @...: Arguments for the format string
2388 * The function returns the number of words(u32) written
2391 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2396 va_start(args, fmt);
2397 ret = vbin_printf(bin_buf, size, fmt, args);
2402 EXPORT_SYMBOL_GPL(bprintf);
2404 #endif /* CONFIG_BINARY_PRINTF */
2407 * vsscanf - Unformat a buffer into a list of arguments
2408 * @buf: input buffer
2409 * @fmt: format of buffer
2412 int vsscanf(const char *buf, const char *fmt, va_list args)
2414 const char *str = buf;
2422 unsigned long long u;
2428 /* skip any white space in format */
2429 /* white space in format matchs any amount of
2430 * white space, including none, in the input.
2432 if (isspace(*fmt)) {
2433 fmt = skip_spaces(++fmt);
2434 str = skip_spaces(str);
2437 /* anything that is not a conversion must match exactly */
2438 if (*fmt != '%' && *fmt) {
2439 if (*fmt++ != *str++)
2448 /* skip this conversion.
2449 * advance both strings to next white space
2454 while (!isspace(*fmt) && *fmt != '%' && *fmt)
2456 while (!isspace(*str) && *str)
2461 /* get field width */
2463 if (isdigit(*fmt)) {
2464 field_width = skip_atoi(&fmt);
2465 if (field_width <= 0)
2469 /* get conversion qualifier */
2471 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2472 _tolower(*fmt) == 'z') {
2474 if (unlikely(qualifier == *fmt)) {
2475 if (qualifier == 'h') {
2478 } else if (qualifier == 'l') {
2489 /* return number of characters read so far */
2490 *va_arg(args, int *) = str - buf;
2504 char *s = (char *)va_arg(args, char*);
2505 if (field_width == -1)
2509 } while (--field_width > 0 && *str);
2515 char *s = (char *)va_arg(args, char *);
2516 if (field_width == -1)
2517 field_width = SHRT_MAX;
2518 /* first, skip leading white space in buffer */
2519 str = skip_spaces(str);
2521 /* now copy until next white space */
2522 while (*str && !isspace(*str) && field_width--)
2542 /* looking for '%' in str */
2547 /* invalid format; stop here */
2551 /* have some sort of integer conversion.
2552 * first, skip white space in buffer.
2554 str = skip_spaces(str);
2557 if (is_sign && digit == '-')
2561 || (base == 16 && !isxdigit(digit))
2562 || (base == 10 && !isdigit(digit))
2563 || (base == 8 && (!isdigit(digit) || digit > '7'))
2564 || (base == 0 && !isdigit(digit)))
2568 val.s = qualifier != 'L' ?
2569 simple_strtol(str, &next, base) :
2570 simple_strtoll(str, &next, base);
2572 val.u = qualifier != 'L' ?
2573 simple_strtoul(str, &next, base) :
2574 simple_strtoull(str, &next, base);
2576 if (field_width > 0 && next - str > field_width) {
2578 _parse_integer_fixup_radix(str, &base);
2579 while (next - str > field_width) {
2581 val.s = div_s64(val.s, base);
2583 val.u = div_u64(val.u, base);
2588 switch (qualifier) {
2589 case 'H': /* that's 'hh' in format */
2591 *va_arg(args, signed char *) = val.s;
2593 *va_arg(args, unsigned char *) = val.u;
2597 *va_arg(args, short *) = val.s;
2599 *va_arg(args, unsigned short *) = val.u;
2603 *va_arg(args, long *) = val.s;
2605 *va_arg(args, unsigned long *) = val.u;
2609 *va_arg(args, long long *) = val.s;
2611 *va_arg(args, unsigned long long *) = val.u;
2615 *va_arg(args, size_t *) = val.u;
2619 *va_arg(args, int *) = val.s;
2621 *va_arg(args, unsigned int *) = val.u;
2633 EXPORT_SYMBOL(vsscanf);
2636 * sscanf - Unformat a buffer into a list of arguments
2637 * @buf: input buffer
2638 * @fmt: formatting of buffer
2639 * @...: resulting arguments
2641 int sscanf(const char *buf, const char *fmt, ...)
2646 va_start(args, fmt);
2647 i = vsscanf(buf, fmt, args);
2652 EXPORT_SYMBOL(sscanf);