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>
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/uaccess.h>
27 #include <linux/ioport.h>
28 #include <net/addrconf.h>
30 #include <asm/page.h> /* for PAGE_SIZE */
31 #include <asm/div64.h>
32 #include <asm/sections.h> /* for dereference_function_descriptor() */
34 /* Works only for digits and letters, but small and fast */
35 #define TOLOWER(x) ((x) | 0x20)
37 static unsigned int simple_guess_base(const char *cp)
40 if (TOLOWER(cp[1]) == 'x' && isxdigit(cp[2]))
50 * simple_strtoull - convert a string to an unsigned long long
51 * @cp: The start of the string
52 * @endp: A pointer to the end of the parsed string will be placed here
53 * @base: The number base to use
55 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
57 unsigned long long result = 0;
60 base = simple_guess_base(cp);
62 if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
65 while (isxdigit(*cp)) {
68 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
71 result = result * base + value;
79 EXPORT_SYMBOL(simple_strtoull);
82 * simple_strtoul - convert a string to an unsigned long
83 * @cp: The start of the string
84 * @endp: A pointer to the end of the parsed string will be placed here
85 * @base: The number base to use
87 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
89 return simple_strtoull(cp, endp, base);
91 EXPORT_SYMBOL(simple_strtoul);
94 * simple_strtol - convert a string to a signed long
95 * @cp: The start of the string
96 * @endp: A pointer to the end of the parsed string will be placed here
97 * @base: The number base to use
99 long simple_strtol(const char *cp, char **endp, unsigned int base)
102 return -simple_strtoul(cp + 1, endp, base);
104 return simple_strtoul(cp, endp, base);
106 EXPORT_SYMBOL(simple_strtol);
109 * simple_strtoll - convert a string to a signed long long
110 * @cp: The start of the string
111 * @endp: A pointer to the end of the parsed string will be placed here
112 * @base: The number base to use
114 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
117 return -simple_strtoull(cp + 1, endp, base);
119 return simple_strtoull(cp, endp, base);
123 * strict_strtoul - convert a string to an unsigned long strictly
124 * @cp: The string to be converted
125 * @base: The number base to use
126 * @res: The converted result value
128 * strict_strtoul converts a string to an unsigned long only if the
129 * string is really an unsigned long string, any string containing
130 * any invalid char at the tail will be rejected and -EINVAL is returned,
131 * only a newline char at the tail is acceptible because people generally
132 * change a module parameter in the following way:
134 * echo 1024 > /sys/module/e1000/parameters/copybreak
136 * echo will append a newline to the tail.
138 * It returns 0 if conversion is successful and *res is set to the converted
139 * value, otherwise it returns -EINVAL and *res is set to 0.
141 * simple_strtoul just ignores the successive invalid characters and
142 * return the converted value of prefix part of the string.
144 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
155 val = simple_strtoul(cp, &tail, base);
159 if ((*tail == '\0') ||
160 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
167 EXPORT_SYMBOL(strict_strtoul);
170 * strict_strtol - convert a string to a long strictly
171 * @cp: The string to be converted
172 * @base: The number base to use
173 * @res: The converted result value
175 * strict_strtol is similiar to strict_strtoul, but it allows the first
176 * character of a string is '-'.
178 * It returns 0 if conversion is successful and *res is set to the converted
179 * value, otherwise it returns -EINVAL and *res is set to 0.
181 int strict_strtol(const char *cp, unsigned int base, long *res)
185 ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
189 ret = strict_strtoul(cp, base, (unsigned long *)res);
194 EXPORT_SYMBOL(strict_strtol);
197 * strict_strtoull - convert a string to an unsigned long long strictly
198 * @cp: The string to be converted
199 * @base: The number base to use
200 * @res: The converted result value
202 * strict_strtoull converts a string to an unsigned long long only if the
203 * string is really an unsigned long long string, any string containing
204 * any invalid char at the tail will be rejected and -EINVAL is returned,
205 * only a newline char at the tail is acceptible because people generally
206 * change a module parameter in the following way:
208 * echo 1024 > /sys/module/e1000/parameters/copybreak
210 * echo will append a newline to the tail of the string.
212 * It returns 0 if conversion is successful and *res is set to the converted
213 * value, otherwise it returns -EINVAL and *res is set to 0.
215 * simple_strtoull just ignores the successive invalid characters and
216 * return the converted value of prefix part of the string.
218 int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
221 unsigned long long val;
229 val = simple_strtoull(cp, &tail, base);
232 if ((*tail == '\0') ||
233 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
240 EXPORT_SYMBOL(strict_strtoull);
243 * strict_strtoll - convert a string to a long long strictly
244 * @cp: The string to be converted
245 * @base: The number base to use
246 * @res: The converted result value
248 * strict_strtoll is similiar to strict_strtoull, but it allows the first
249 * character of a string is '-'.
251 * It returns 0 if conversion is successful and *res is set to the converted
252 * value, otherwise it returns -EINVAL and *res is set to 0.
254 int strict_strtoll(const char *cp, unsigned int base, long long *res)
258 ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
262 ret = strict_strtoull(cp, base, (unsigned long long *)res);
267 EXPORT_SYMBOL(strict_strtoll);
269 static int skip_atoi(const char **s)
274 i = i*10 + *((*s)++) - '0';
279 /* Decimal conversion is by far the most typical, and is used
280 * for /proc and /sys data. This directly impacts e.g. top performance
281 * with many processes running. We optimize it for speed
283 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
284 * (with permission from the author, Douglas W. Jones). */
286 /* Formats correctly any integer in [0,99999].
287 * Outputs from one to five digits depending on input.
288 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
289 static char *put_dec_trunc(char *buf, unsigned q)
291 unsigned d3, d2, d1, d0;
296 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
297 q = (d0 * 0xcd) >> 11;
299 *buf++ = d0 + '0'; /* least significant digit */
300 d1 = q + 9*d3 + 5*d2 + d1;
302 q = (d1 * 0xcd) >> 11;
304 *buf++ = d1 + '0'; /* next digit */
307 if ((d2 != 0) || (d3 != 0)) {
310 *buf++ = d2 + '0'; /* next digit */
314 q = (d3 * 0xcd) >> 11;
316 *buf++ = d3 + '0'; /* next digit */
318 *buf++ = q + '0'; /* most sign. digit */
325 /* Same with if's removed. Always emits five digits */
326 static char *put_dec_full(char *buf, unsigned q)
328 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
329 /* but anyway, gcc produces better code with full-sized ints */
330 unsigned d3, d2, d1, d0;
336 * Possible ways to approx. divide by 10
337 * gcc -O2 replaces multiply with shifts and adds
338 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
339 * (x * 0x67) >> 10: 1100111
340 * (x * 0x34) >> 9: 110100 - same
341 * (x * 0x1a) >> 8: 11010 - same
342 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
344 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
345 q = (d0 * 0xcd) >> 11;
348 d1 = q + 9*d3 + 5*d2 + d1;
349 q = (d1 * 0xcd) >> 11;
359 q = (d3 * 0xcd) >> 11; /* - shorter code */
360 /* q = (d3 * 0x67) >> 10; - would also work */
367 /* No inlining helps gcc to use registers better */
368 static noinline char *put_dec(char *buf, unsigned long long num)
373 return put_dec_trunc(buf, num);
374 rem = do_div(num, 100000);
375 buf = put_dec_full(buf, rem);
379 #define ZEROPAD 1 /* pad with zero */
380 #define SIGN 2 /* unsigned/signed long */
381 #define PLUS 4 /* show plus */
382 #define SPACE 8 /* space if plus */
383 #define LEFT 16 /* left justified */
384 #define SMALL 32 /* Must be 32 == 0x20 */
385 #define SPECIAL 64 /* 0x */
388 FORMAT_TYPE_NONE, /* Just a string part */
390 FORMAT_TYPE_PRECISION,
394 FORMAT_TYPE_PERCENT_CHAR,
396 FORMAT_TYPE_LONG_LONG,
411 enum format_type type;
412 int flags; /* flags to number() */
413 int field_width; /* width of output field */
415 int precision; /* # of digits/chars */
419 static char *number(char *buf, char *end, unsigned long long num,
420 struct printf_spec spec)
422 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
423 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
428 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
431 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
432 * produces same digits or (maybe lowercased) letters */
433 locase = (spec.flags & SMALL);
434 if (spec.flags & LEFT)
435 spec.flags &= ~ZEROPAD;
437 if (spec.flags & SIGN) {
438 if ((signed long long)num < 0) {
440 num = -(signed long long)num;
442 } else if (spec.flags & PLUS) {
445 } else if (spec.flags & SPACE) {
456 /* generate full string in tmp[], in reverse order */
460 /* Generic code, for any base:
462 tmp[i++] = (digits[do_div(num,base)] | locase);
465 else if (spec.base != 10) { /* 8 or 16 */
466 int mask = spec.base - 1;
472 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
475 } else { /* base 10 */
476 i = put_dec(tmp, num) - tmp;
479 /* printing 100 using %2d gives "100", not "00" */
480 if (i > spec.precision)
482 /* leading space padding */
483 spec.field_width -= spec.precision;
484 if (!(spec.flags & (ZEROPAD+LEFT))) {
485 while (--spec.field_width >= 0) {
497 /* "0x" / "0" prefix */
502 if (spec.base == 16) {
504 *buf = ('X' | locase);
508 /* zero or space padding */
509 if (!(spec.flags & LEFT)) {
510 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
511 while (--spec.field_width >= 0) {
517 /* hmm even more zero padding? */
518 while (i <= --spec.precision) {
523 /* actual digits of result */
529 /* trailing space padding */
530 while (--spec.field_width >= 0) {
539 static char *string(char *buf, char *end, const char *s, struct printf_spec spec)
543 if ((unsigned long)s < PAGE_SIZE)
546 len = strnlen(s, spec.precision);
548 if (!(spec.flags & LEFT)) {
549 while (len < spec.field_width--) {
555 for (i = 0; i < len; ++i) {
560 while (len < spec.field_width--) {
569 static char *symbol_string(char *buf, char *end, void *ptr,
570 struct printf_spec spec, char ext)
572 unsigned long value = (unsigned long) ptr;
573 #ifdef CONFIG_KALLSYMS
574 char sym[KSYM_SYMBOL_LEN];
575 if (ext != 'f' && ext != 's')
576 sprint_symbol(sym, value);
578 kallsyms_lookup(value, NULL, NULL, NULL, sym);
580 return string(buf, end, sym, spec);
582 spec.field_width = 2 * sizeof(void *);
583 spec.flags |= SPECIAL | SMALL | ZEROPAD;
586 return number(buf, end, value, spec);
590 static char *resource_string(char *buf, char *end, struct resource *res,
591 struct printf_spec spec, const char *fmt)
593 #ifndef IO_RSRC_PRINTK_SIZE
594 #define IO_RSRC_PRINTK_SIZE 6
597 #ifndef MEM_RSRC_PRINTK_SIZE
598 #define MEM_RSRC_PRINTK_SIZE 10
600 struct printf_spec hex_spec = {
603 .flags = SPECIAL | SMALL | ZEROPAD,
605 struct printf_spec dec_spec = {
610 struct printf_spec str_spec = {
615 struct printf_spec flag_spec = {
618 .flags = SPECIAL | SMALL,
621 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
622 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
623 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
624 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
625 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref disabled]")
626 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
627 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
628 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
630 char *p = sym, *pend = sym + sizeof(sym);
631 int size = -1, addr = 0;
632 int decode = (fmt[0] == 'R') ? 1 : 0;
634 if (res->flags & IORESOURCE_IO) {
635 size = IO_RSRC_PRINTK_SIZE;
637 } else if (res->flags & IORESOURCE_MEM) {
638 size = MEM_RSRC_PRINTK_SIZE;
643 if (res->flags & IORESOURCE_IO)
644 p = string(p, pend, "io ", str_spec);
645 else if (res->flags & IORESOURCE_MEM)
646 p = string(p, pend, "mem ", str_spec);
647 else if (res->flags & IORESOURCE_IRQ)
648 p = string(p, pend, "irq ", str_spec);
649 else if (res->flags & IORESOURCE_DMA)
650 p = string(p, pend, "dma ", str_spec);
652 p = string(p, pend, "??? ", str_spec);
655 hex_spec.field_width = size;
656 p = number(p, pend, res->start, addr ? hex_spec : dec_spec);
657 if (res->start != res->end) {
659 p = number(p, pend, res->end, addr ? hex_spec : dec_spec);
662 if (res->flags & IORESOURCE_MEM_64)
663 p = string(p, pend, " 64bit", str_spec);
664 if (res->flags & IORESOURCE_PREFETCH)
665 p = string(p, pend, " pref", str_spec);
666 if (res->flags & IORESOURCE_DISABLED)
667 p = string(p, pend, " disabled", str_spec);
669 p = string(p, pend, " flags ", str_spec);
670 p = number(p, pend, res->flags, flag_spec);
675 return string(buf, end, sym, spec);
678 static char *mac_address_string(char *buf, char *end, u8 *addr,
679 struct printf_spec spec, const char *fmt)
681 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
686 if (fmt[1] == 'F') { /* FDDI canonical format */
692 for (i = 0; i < 6; i++) {
693 p = pack_hex_byte(p, addr[i]);
694 if (fmt[0] == 'M' && i != 5)
699 return string(buf, end, mac_addr, spec);
702 static char *ip4_string(char *p, const u8 *addr, bool leading_zeros)
706 for (i = 0; i < 4; i++) {
707 char temp[3]; /* hold each IP quad in reverse order */
708 int digits = put_dec_trunc(temp, addr[i]) - temp;
715 /* reverse the digits in the quad */
726 static char *ip6_compressed_string(char *p, const char *addr)
729 unsigned char zerolength[8];
734 bool needcolon = false;
738 memcpy(&in6, addr, sizeof(struct in6_addr));
740 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
742 memset(zerolength, 0, sizeof(zerolength));
749 /* find position of longest 0 run */
750 for (i = 0; i < range; i++) {
751 for (j = i; j < range; j++) {
752 if (in6.s6_addr16[j] != 0)
757 for (i = 0; i < range; i++) {
758 if (zerolength[i] > longest) {
759 longest = zerolength[i];
765 for (i = 0; i < range; i++) {
767 if (needcolon || i == 0)
778 /* hex u16 without leading 0s */
779 word = ntohs(in6.s6_addr16[i]);
784 p = pack_hex_byte(p, hi);
786 *p++ = hex_asc_lo(hi);
787 p = pack_hex_byte(p, lo);
790 p = pack_hex_byte(p, lo);
792 *p++ = hex_asc_lo(lo);
799 p = ip4_string(p, &in6.s6_addr[12], false);
806 static char *ip6_string(char *p, const char *addr, const char *fmt)
810 for (i = 0; i < 8; i++) {
811 p = pack_hex_byte(p, *addr++);
812 p = pack_hex_byte(p, *addr++);
813 if (fmt[0] == 'I' && i != 7)
821 static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
822 struct printf_spec spec, const char *fmt)
824 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
826 if (fmt[0] == 'I' && fmt[2] == 'c')
827 ip6_compressed_string(ip6_addr, addr);
829 ip6_string(ip6_addr, addr, fmt);
831 return string(buf, end, ip6_addr, spec);
834 static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
835 struct printf_spec spec, const char *fmt)
837 char ip4_addr[sizeof("255.255.255.255")];
839 ip4_string(ip4_addr, addr, fmt[0] == 'i');
841 return string(buf, end, ip4_addr, spec);
844 static char *uuid_string(char *buf, char *end, const u8 *addr,
845 struct printf_spec spec, const char *fmt)
847 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
850 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
851 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
852 const u8 *index = be;
857 uc = true; /* fall-through */
866 for (i = 0; i < 16; i++) {
867 p = pack_hex_byte(p, addr[index[i]]);
887 return string(buf, end, uuid, spec);
891 * Show a '%p' thing. A kernel extension is that the '%p' is followed
892 * by an extra set of alphanumeric characters that are extended format
895 * Right now we handle:
897 * - 'F' For symbolic function descriptor pointers with offset
898 * - 'f' For simple symbolic function names without offset
899 * - 'S' For symbolic direct pointers with offset
900 * - 's' For symbolic direct pointers without offset
901 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
902 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
903 * - 'M' For a 6-byte MAC address, it prints the address in the
904 * usual colon-separated hex notation
905 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
906 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
907 * with a dash-separated hex notation
908 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
909 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
910 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
911 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
912 * IPv6 omits the colons (01020304...0f)
913 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
914 * - 'I6c' for IPv6 addresses printed as specified by
915 * http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
916 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
917 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
918 * Options for %pU are:
919 * b big endian lower case hex (default)
920 * B big endian UPPER case hex
921 * l little endian lower case hex
922 * L little endian UPPER case hex
923 * big endian output byte order is:
924 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
925 * little endian output byte order is:
926 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
928 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
929 * function pointers are really function descriptors, which contain a
930 * pointer to the real address.
932 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
933 struct printf_spec spec)
936 return string(buf, end, "(null)", spec);
941 ptr = dereference_function_descriptor(ptr);
945 return symbol_string(buf, end, ptr, spec, *fmt);
948 return resource_string(buf, end, ptr, spec, fmt);
949 case 'M': /* Colon separated: 00:01:02:03:04:05 */
950 case 'm': /* Contiguous: 000102030405 */
951 /* [mM]F (FDDI, bit reversed) */
952 return mac_address_string(buf, end, ptr, spec, fmt);
953 case 'I': /* Formatted IP supported
955 * 6: 0001:0203:...:0708
956 * 6c: 1::708 or 1::1.2.3.4
958 case 'i': /* Contiguous:
964 return ip6_addr_string(buf, end, ptr, spec, fmt);
966 return ip4_addr_string(buf, end, ptr, spec, fmt);
970 return uuid_string(buf, end, ptr, spec, fmt);
973 if (spec.field_width == -1) {
974 spec.field_width = 2*sizeof(void *);
975 spec.flags |= ZEROPAD;
979 return number(buf, end, (unsigned long) ptr, spec);
983 * Helper function to decode printf style format.
984 * Each call decode a token from the format and return the
985 * number of characters read (or likely the delta where it wants
986 * to go on the next call).
987 * The decoded token is returned through the parameters
989 * 'h', 'l', or 'L' for integer fields
990 * 'z' support added 23/7/1999 S.H.
991 * 'z' changed to 'Z' --davidm 1/25/99
992 * 't' added for ptrdiff_t
994 * @fmt: the format string
995 * @type of the token returned
996 * @flags: various flags such as +, -, # tokens..
997 * @field_width: overwritten width
998 * @base: base of the number (octal, hex, ...)
999 * @precision: precision of a number
1000 * @qualifier: qualifier of a number (long, size_t, ...)
1002 static int format_decode(const char *fmt, struct printf_spec *spec)
1004 const char *start = fmt;
1006 /* we finished early by reading the field width */
1007 if (spec->type == FORMAT_TYPE_WIDTH) {
1008 if (spec->field_width < 0) {
1009 spec->field_width = -spec->field_width;
1010 spec->flags |= LEFT;
1012 spec->type = FORMAT_TYPE_NONE;
1016 /* we finished early by reading the precision */
1017 if (spec->type == FORMAT_TYPE_PRECISION) {
1018 if (spec->precision < 0)
1019 spec->precision = 0;
1021 spec->type = FORMAT_TYPE_NONE;
1026 spec->type = FORMAT_TYPE_NONE;
1028 for (; *fmt ; ++fmt) {
1033 /* Return the current non-format string */
1034 if (fmt != start || !*fmt)
1040 while (1) { /* this also skips first '%' */
1046 case '-': spec->flags |= LEFT; break;
1047 case '+': spec->flags |= PLUS; break;
1048 case ' ': spec->flags |= SPACE; break;
1049 case '#': spec->flags |= SPECIAL; break;
1050 case '0': spec->flags |= ZEROPAD; break;
1051 default: found = false;
1058 /* get field width */
1059 spec->field_width = -1;
1062 spec->field_width = skip_atoi(&fmt);
1063 else if (*fmt == '*') {
1064 /* it's the next argument */
1065 spec->type = FORMAT_TYPE_WIDTH;
1066 return ++fmt - start;
1070 /* get the precision */
1071 spec->precision = -1;
1074 if (isdigit(*fmt)) {
1075 spec->precision = skip_atoi(&fmt);
1076 if (spec->precision < 0)
1077 spec->precision = 0;
1078 } else if (*fmt == '*') {
1079 /* it's the next argument */
1080 spec->type = FORMAT_TYPE_PRECISION;
1081 return ++fmt - start;
1086 /* get the conversion qualifier */
1087 spec->qualifier = -1;
1088 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1089 TOLOWER(*fmt) == 'z' || *fmt == 't') {
1090 spec->qualifier = *fmt++;
1091 if (unlikely(spec->qualifier == *fmt)) {
1092 if (spec->qualifier == 'l') {
1093 spec->qualifier = 'L';
1095 } else if (spec->qualifier == 'h') {
1096 spec->qualifier = 'H';
1106 spec->type = FORMAT_TYPE_CHAR;
1107 return ++fmt - start;
1110 spec->type = FORMAT_TYPE_STR;
1111 return ++fmt - start;
1114 spec->type = FORMAT_TYPE_PTR;
1119 spec->type = FORMAT_TYPE_NRCHARS;
1120 return ++fmt - start;
1123 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1124 return ++fmt - start;
1126 /* integer number formats - set up the flags and "break" */
1132 spec->flags |= SMALL;
1140 spec->flags |= SIGN;
1145 spec->type = FORMAT_TYPE_INVALID;
1149 if (spec->qualifier == 'L')
1150 spec->type = FORMAT_TYPE_LONG_LONG;
1151 else if (spec->qualifier == 'l') {
1152 if (spec->flags & SIGN)
1153 spec->type = FORMAT_TYPE_LONG;
1155 spec->type = FORMAT_TYPE_ULONG;
1156 } else if (TOLOWER(spec->qualifier) == 'z') {
1157 spec->type = FORMAT_TYPE_SIZE_T;
1158 } else if (spec->qualifier == 't') {
1159 spec->type = FORMAT_TYPE_PTRDIFF;
1160 } else if (spec->qualifier == 'H') {
1161 if (spec->flags & SIGN)
1162 spec->type = FORMAT_TYPE_BYTE;
1164 spec->type = FORMAT_TYPE_UBYTE;
1165 } else if (spec->qualifier == 'h') {
1166 if (spec->flags & SIGN)
1167 spec->type = FORMAT_TYPE_SHORT;
1169 spec->type = FORMAT_TYPE_USHORT;
1171 if (spec->flags & SIGN)
1172 spec->type = FORMAT_TYPE_INT;
1174 spec->type = FORMAT_TYPE_UINT;
1177 return ++fmt - start;
1181 * vsnprintf - Format a string and place it in a buffer
1182 * @buf: The buffer to place the result into
1183 * @size: The size of the buffer, including the trailing null space
1184 * @fmt: The format string to use
1185 * @args: Arguments for the format string
1187 * This function follows C99 vsnprintf, but has some extensions:
1188 * %pS output the name of a text symbol with offset
1189 * %ps output the name of a text symbol without offset
1190 * %pF output the name of a function pointer with its offset
1191 * %pf output the name of a function pointer without its offset
1192 * %pR output the address range in a struct resource with decoded flags
1193 * %pr output the address range in a struct resource with raw flags
1194 * %pM output a 6-byte MAC address with colons
1195 * %pm output a 6-byte MAC address without colons
1196 * %pI4 print an IPv4 address without leading zeros
1197 * %pi4 print an IPv4 address with leading zeros
1198 * %pI6 print an IPv6 address with colons
1199 * %pi6 print an IPv6 address without colons
1200 * %pI6c print an IPv6 address as specified by
1201 * http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
1202 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1206 * The return value is the number of characters which would
1207 * be generated for the given input, excluding the trailing
1208 * '\0', as per ISO C99. If you want to have the exact
1209 * number of characters written into @buf as return value
1210 * (not including the trailing '\0'), use vscnprintf(). If the
1211 * return is greater than or equal to @size, the resulting
1212 * string is truncated.
1214 * Call this function if you are already dealing with a va_list.
1215 * You probably want snprintf() instead.
1217 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1219 unsigned long long num;
1221 struct printf_spec spec = {0};
1223 /* Reject out-of-range values early. Large positive sizes are
1224 used for unknown buffer sizes. */
1225 if (WARN_ON_ONCE((int) size < 0))
1231 /* Make sure end is always >= buf */
1238 const char *old_fmt = fmt;
1239 int read = format_decode(fmt, &spec);
1243 switch (spec.type) {
1244 case FORMAT_TYPE_NONE: {
1247 if (copy > end - str)
1249 memcpy(str, old_fmt, copy);
1255 case FORMAT_TYPE_WIDTH:
1256 spec.field_width = va_arg(args, int);
1259 case FORMAT_TYPE_PRECISION:
1260 spec.precision = va_arg(args, int);
1263 case FORMAT_TYPE_CHAR: {
1266 if (!(spec.flags & LEFT)) {
1267 while (--spec.field_width > 0) {
1274 c = (unsigned char) va_arg(args, int);
1278 while (--spec.field_width > 0) {
1286 case FORMAT_TYPE_STR:
1287 str = string(str, end, va_arg(args, char *), spec);
1290 case FORMAT_TYPE_PTR:
1291 str = pointer(fmt+1, str, end, va_arg(args, void *),
1293 while (isalnum(*fmt))
1297 case FORMAT_TYPE_PERCENT_CHAR:
1303 case FORMAT_TYPE_INVALID:
1309 case FORMAT_TYPE_NRCHARS: {
1310 int qualifier = spec.qualifier;
1312 if (qualifier == 'l') {
1313 long *ip = va_arg(args, long *);
1315 } else if (TOLOWER(qualifier) == 'z') {
1316 size_t *ip = va_arg(args, size_t *);
1319 int *ip = va_arg(args, int *);
1326 switch (spec.type) {
1327 case FORMAT_TYPE_LONG_LONG:
1328 num = va_arg(args, long long);
1330 case FORMAT_TYPE_ULONG:
1331 num = va_arg(args, unsigned long);
1333 case FORMAT_TYPE_LONG:
1334 num = va_arg(args, long);
1336 case FORMAT_TYPE_SIZE_T:
1337 num = va_arg(args, size_t);
1339 case FORMAT_TYPE_PTRDIFF:
1340 num = va_arg(args, ptrdiff_t);
1342 case FORMAT_TYPE_UBYTE:
1343 num = (unsigned char) va_arg(args, int);
1345 case FORMAT_TYPE_BYTE:
1346 num = (signed char) va_arg(args, int);
1348 case FORMAT_TYPE_USHORT:
1349 num = (unsigned short) va_arg(args, int);
1351 case FORMAT_TYPE_SHORT:
1352 num = (short) va_arg(args, int);
1354 case FORMAT_TYPE_INT:
1355 num = (int) va_arg(args, int);
1358 num = va_arg(args, unsigned int);
1361 str = number(str, end, num, spec);
1372 /* the trailing null byte doesn't count towards the total */
1376 EXPORT_SYMBOL(vsnprintf);
1379 * vscnprintf - Format a string and place it in a buffer
1380 * @buf: The buffer to place the result into
1381 * @size: The size of the buffer, including the trailing null space
1382 * @fmt: The format string to use
1383 * @args: Arguments for the format string
1385 * The return value is the number of characters which have been written into
1386 * the @buf not including the trailing '\0'. If @size is <= 0 the function
1389 * Call this function if you are already dealing with a va_list.
1390 * You probably want scnprintf() instead.
1392 * See the vsnprintf() documentation for format string extensions over C99.
1394 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1398 i = vsnprintf(buf, size, fmt, args);
1400 return (i >= size) ? (size - 1) : i;
1402 EXPORT_SYMBOL(vscnprintf);
1405 * snprintf - Format a string and place it in a buffer
1406 * @buf: The buffer to place the result into
1407 * @size: The size of the buffer, including the trailing null space
1408 * @fmt: The format string to use
1409 * @...: Arguments for the format string
1411 * The return value is the number of characters which would be
1412 * generated for the given input, excluding the trailing null,
1413 * as per ISO C99. If the return is greater than or equal to
1414 * @size, the resulting string is truncated.
1416 * See the vsnprintf() documentation for format string extensions over C99.
1418 int snprintf(char *buf, size_t size, const char *fmt, ...)
1423 va_start(args, fmt);
1424 i = vsnprintf(buf, size, fmt, args);
1429 EXPORT_SYMBOL(snprintf);
1432 * scnprintf - Format a string and place it in a buffer
1433 * @buf: The buffer to place the result into
1434 * @size: The size of the buffer, including the trailing null space
1435 * @fmt: The format string to use
1436 * @...: Arguments for the format string
1438 * The return value is the number of characters written into @buf not including
1439 * the trailing '\0'. If @size is <= 0 the function returns 0.
1442 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1447 va_start(args, fmt);
1448 i = vsnprintf(buf, size, fmt, args);
1451 return (i >= size) ? (size - 1) : i;
1453 EXPORT_SYMBOL(scnprintf);
1456 * vsprintf - Format a string and place it in a buffer
1457 * @buf: The buffer to place the result into
1458 * @fmt: The format string to use
1459 * @args: Arguments for the format string
1461 * The function returns the number of characters written
1462 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1465 * Call this function if you are already dealing with a va_list.
1466 * You probably want sprintf() instead.
1468 * See the vsnprintf() documentation for format string extensions over C99.
1470 int vsprintf(char *buf, const char *fmt, va_list args)
1472 return vsnprintf(buf, INT_MAX, fmt, args);
1474 EXPORT_SYMBOL(vsprintf);
1477 * sprintf - Format a string and place it in a buffer
1478 * @buf: The buffer to place the result into
1479 * @fmt: The format string to use
1480 * @...: Arguments for the format string
1482 * The function returns the number of characters written
1483 * into @buf. Use snprintf() or scnprintf() in order to avoid
1486 * See the vsnprintf() documentation for format string extensions over C99.
1488 int sprintf(char *buf, const char *fmt, ...)
1493 va_start(args, fmt);
1494 i = vsnprintf(buf, INT_MAX, fmt, args);
1499 EXPORT_SYMBOL(sprintf);
1501 #ifdef CONFIG_BINARY_PRINTF
1504 * vbin_printf() - VA arguments to binary data
1505 * bstr_printf() - Binary data to text string
1509 * vbin_printf - Parse a format string and place args' binary value in a buffer
1510 * @bin_buf: The buffer to place args' binary value
1511 * @size: The size of the buffer(by words(32bits), not characters)
1512 * @fmt: The format string to use
1513 * @args: Arguments for the format string
1515 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1518 * The return value is the number of words(32bits) which would be generated for
1522 * If the return value is greater than @size, the resulting bin_buf is NOT
1523 * valid for bstr_printf().
1525 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1527 struct printf_spec spec = {0};
1530 str = (char *)bin_buf;
1531 end = (char *)(bin_buf + size);
1533 #define save_arg(type) \
1535 if (sizeof(type) == 8) { \
1536 unsigned long long value; \
1537 str = PTR_ALIGN(str, sizeof(u32)); \
1538 value = va_arg(args, unsigned long long); \
1539 if (str + sizeof(type) <= end) { \
1540 *(u32 *)str = *(u32 *)&value; \
1541 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1544 unsigned long value; \
1545 str = PTR_ALIGN(str, sizeof(type)); \
1546 value = va_arg(args, int); \
1547 if (str + sizeof(type) <= end) \
1548 *(typeof(type) *)str = (type)value; \
1550 str += sizeof(type); \
1554 int read = format_decode(fmt, &spec);
1558 switch (spec.type) {
1559 case FORMAT_TYPE_NONE:
1560 case FORMAT_TYPE_INVALID:
1561 case FORMAT_TYPE_PERCENT_CHAR:
1564 case FORMAT_TYPE_WIDTH:
1565 case FORMAT_TYPE_PRECISION:
1569 case FORMAT_TYPE_CHAR:
1573 case FORMAT_TYPE_STR: {
1574 const char *save_str = va_arg(args, char *);
1577 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1578 || (unsigned long)save_str < PAGE_SIZE)
1579 save_str = "(null)";
1580 len = strlen(save_str) + 1;
1581 if (str + len < end)
1582 memcpy(str, save_str, len);
1587 case FORMAT_TYPE_PTR:
1589 /* skip all alphanumeric pointer suffixes */
1590 while (isalnum(*fmt))
1594 case FORMAT_TYPE_NRCHARS: {
1595 /* skip %n 's argument */
1596 int qualifier = spec.qualifier;
1598 if (qualifier == 'l')
1599 skip_arg = va_arg(args, long *);
1600 else if (TOLOWER(qualifier) == 'z')
1601 skip_arg = va_arg(args, size_t *);
1603 skip_arg = va_arg(args, int *);
1608 switch (spec.type) {
1610 case FORMAT_TYPE_LONG_LONG:
1611 save_arg(long long);
1613 case FORMAT_TYPE_ULONG:
1614 case FORMAT_TYPE_LONG:
1615 save_arg(unsigned long);
1617 case FORMAT_TYPE_SIZE_T:
1620 case FORMAT_TYPE_PTRDIFF:
1621 save_arg(ptrdiff_t);
1623 case FORMAT_TYPE_UBYTE:
1624 case FORMAT_TYPE_BYTE:
1627 case FORMAT_TYPE_USHORT:
1628 case FORMAT_TYPE_SHORT:
1637 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1640 EXPORT_SYMBOL_GPL(vbin_printf);
1643 * bstr_printf - Format a string from binary arguments and place it in a buffer
1644 * @buf: The buffer to place the result into
1645 * @size: The size of the buffer, including the trailing null space
1646 * @fmt: The format string to use
1647 * @bin_buf: Binary arguments for the format string
1649 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1650 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1651 * a binary buffer that generated by vbin_printf.
1653 * The format follows C99 vsnprintf, but has some extensions:
1654 * see vsnprintf comment for details.
1656 * The return value is the number of characters which would
1657 * be generated for the given input, excluding the trailing
1658 * '\0', as per ISO C99. If you want to have the exact
1659 * number of characters written into @buf as return value
1660 * (not including the trailing '\0'), use vscnprintf(). If the
1661 * return is greater than or equal to @size, the resulting
1662 * string is truncated.
1664 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1666 struct printf_spec spec = {0};
1668 const char *args = (const char *)bin_buf;
1670 if (WARN_ON_ONCE((int) size < 0))
1676 #define get_arg(type) \
1678 typeof(type) value; \
1679 if (sizeof(type) == 8) { \
1680 args = PTR_ALIGN(args, sizeof(u32)); \
1681 *(u32 *)&value = *(u32 *)args; \
1682 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1684 args = PTR_ALIGN(args, sizeof(type)); \
1685 value = *(typeof(type) *)args; \
1687 args += sizeof(type); \
1691 /* Make sure end is always >= buf */
1698 const char *old_fmt = fmt;
1699 int read = format_decode(fmt, &spec);
1703 switch (spec.type) {
1704 case FORMAT_TYPE_NONE: {
1707 if (copy > end - str)
1709 memcpy(str, old_fmt, copy);
1715 case FORMAT_TYPE_WIDTH:
1716 spec.field_width = get_arg(int);
1719 case FORMAT_TYPE_PRECISION:
1720 spec.precision = get_arg(int);
1723 case FORMAT_TYPE_CHAR: {
1726 if (!(spec.flags & LEFT)) {
1727 while (--spec.field_width > 0) {
1733 c = (unsigned char) get_arg(char);
1737 while (--spec.field_width > 0) {
1745 case FORMAT_TYPE_STR: {
1746 const char *str_arg = args;
1747 args += strlen(str_arg) + 1;
1748 str = string(str, end, (char *)str_arg, spec);
1752 case FORMAT_TYPE_PTR:
1753 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1754 while (isalnum(*fmt))
1758 case FORMAT_TYPE_PERCENT_CHAR:
1759 case FORMAT_TYPE_INVALID:
1765 case FORMAT_TYPE_NRCHARS:
1770 unsigned long long num;
1772 switch (spec.type) {
1774 case FORMAT_TYPE_LONG_LONG:
1775 num = get_arg(long long);
1777 case FORMAT_TYPE_ULONG:
1778 case FORMAT_TYPE_LONG:
1779 num = get_arg(unsigned long);
1781 case FORMAT_TYPE_SIZE_T:
1782 num = get_arg(size_t);
1784 case FORMAT_TYPE_PTRDIFF:
1785 num = get_arg(ptrdiff_t);
1787 case FORMAT_TYPE_UBYTE:
1788 num = get_arg(unsigned char);
1790 case FORMAT_TYPE_BYTE:
1791 num = get_arg(signed char);
1793 case FORMAT_TYPE_USHORT:
1794 num = get_arg(unsigned short);
1796 case FORMAT_TYPE_SHORT:
1797 num = get_arg(short);
1799 case FORMAT_TYPE_UINT:
1800 num = get_arg(unsigned int);
1806 str = number(str, end, num, spec);
1808 } /* switch(spec.type) */
1820 /* the trailing null byte doesn't count towards the total */
1823 EXPORT_SYMBOL_GPL(bstr_printf);
1826 * bprintf - Parse a format string and place args' binary value in a buffer
1827 * @bin_buf: The buffer to place args' binary value
1828 * @size: The size of the buffer(by words(32bits), not characters)
1829 * @fmt: The format string to use
1830 * @...: Arguments for the format string
1832 * The function returns the number of words(u32) written
1835 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1840 va_start(args, fmt);
1841 ret = vbin_printf(bin_buf, size, fmt, args);
1846 EXPORT_SYMBOL_GPL(bprintf);
1848 #endif /* CONFIG_BINARY_PRINTF */
1851 * vsscanf - Unformat a buffer into a list of arguments
1852 * @buf: input buffer
1853 * @fmt: format of buffer
1856 int vsscanf(const char *buf, const char *fmt, va_list args)
1858 const char *str = buf;
1862 int qualifier, base, field_width;
1865 while (*fmt && *str) {
1866 /* skip any white space in format */
1867 /* white space in format matchs any amount of
1868 * white space, including none, in the input.
1870 if (isspace(*fmt)) {
1871 fmt = skip_spaces(++fmt);
1872 str = skip_spaces(str);
1875 /* anything that is not a conversion must match exactly */
1876 if (*fmt != '%' && *fmt) {
1877 if (*fmt++ != *str++)
1886 /* skip this conversion.
1887 * advance both strings to next white space
1890 while (!isspace(*fmt) && *fmt != '%' && *fmt)
1892 while (!isspace(*str) && *str)
1897 /* get field width */
1900 field_width = skip_atoi(&fmt);
1902 /* get conversion qualifier */
1904 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1905 TOLOWER(*fmt) == 'z') {
1907 if (unlikely(qualifier == *fmt)) {
1908 if (qualifier == 'h') {
1911 } else if (qualifier == 'l') {
1927 char *s = (char *)va_arg(args, char*);
1928 if (field_width == -1)
1932 } while (--field_width > 0 && *str);
1938 char *s = (char *)va_arg(args, char *);
1939 if (field_width == -1)
1940 field_width = INT_MAX;
1941 /* first, skip leading white space in buffer */
1942 str = skip_spaces(str);
1944 /* now copy until next white space */
1945 while (*str && !isspace(*str) && field_width--)
1952 /* return number of characters read so far */
1954 int *i = (int *)va_arg(args, int*);
1972 /* looking for '%' in str */
1977 /* invalid format; stop here */
1981 /* have some sort of integer conversion.
1982 * first, skip white space in buffer.
1984 str = skip_spaces(str);
1987 if (is_sign && digit == '-')
1991 || (base == 16 && !isxdigit(digit))
1992 || (base == 10 && !isdigit(digit))
1993 || (base == 8 && (!isdigit(digit) || digit > '7'))
1994 || (base == 0 && !isdigit(digit)))
1997 switch (qualifier) {
1998 case 'H': /* that's 'hh' in format */
2000 signed char *s = (signed char *)va_arg(args, signed char *);
2001 *s = (signed char)simple_strtol(str, &next, base);
2003 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
2004 *s = (unsigned char)simple_strtoul(str, &next, base);
2009 short *s = (short *)va_arg(args, short *);
2010 *s = (short)simple_strtol(str, &next, base);
2012 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
2013 *s = (unsigned short)simple_strtoul(str, &next, base);
2018 long *l = (long *)va_arg(args, long *);
2019 *l = simple_strtol(str, &next, base);
2021 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
2022 *l = simple_strtoul(str, &next, base);
2027 long long *l = (long long *)va_arg(args, long long *);
2028 *l = simple_strtoll(str, &next, base);
2030 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
2031 *l = simple_strtoull(str, &next, base);
2037 size_t *s = (size_t *)va_arg(args, size_t *);
2038 *s = (size_t)simple_strtoul(str, &next, base);
2043 int *i = (int *)va_arg(args, int *);
2044 *i = (int)simple_strtol(str, &next, base);
2046 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
2047 *i = (unsigned int)simple_strtoul(str, &next, base);
2059 * Now we've come all the way through so either the input string or the
2060 * format ended. In the former case, there can be a %n at the current
2061 * position in the format that needs to be filled.
2063 if (*fmt == '%' && *(fmt + 1) == 'n') {
2064 int *p = (int *)va_arg(args, int *);
2070 EXPORT_SYMBOL(vsscanf);
2073 * sscanf - Unformat a buffer into a list of arguments
2074 * @buf: input buffer
2075 * @fmt: formatting of buffer
2076 * @...: resulting arguments
2078 int sscanf(const char *buf, const char *fmt, ...)
2083 va_start(args, fmt);
2084 i = vsscanf(buf, fmt, args);
2089 EXPORT_SYMBOL(sscanf);