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")];
685 for (i = 0; i < 6; i++) {
686 p = pack_hex_byte(p, addr[i]);
687 if (fmt[0] == 'M' && i != 5)
692 return string(buf, end, mac_addr, spec);
695 static char *ip4_string(char *p, const u8 *addr, bool leading_zeros)
699 for (i = 0; i < 4; i++) {
700 char temp[3]; /* hold each IP quad in reverse order */
701 int digits = put_dec_trunc(temp, addr[i]) - temp;
708 /* reverse the digits in the quad */
719 static char *ip6_compressed_string(char *p, const char *addr)
722 unsigned char zerolength[8];
727 bool needcolon = false;
731 memcpy(&in6, addr, sizeof(struct in6_addr));
733 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
735 memset(zerolength, 0, sizeof(zerolength));
742 /* find position of longest 0 run */
743 for (i = 0; i < range; i++) {
744 for (j = i; j < range; j++) {
745 if (in6.s6_addr16[j] != 0)
750 for (i = 0; i < range; i++) {
751 if (zerolength[i] > longest) {
752 longest = zerolength[i];
758 for (i = 0; i < range; i++) {
760 if (needcolon || i == 0)
771 /* hex u16 without leading 0s */
772 word = ntohs(in6.s6_addr16[i]);
777 p = pack_hex_byte(p, hi);
779 *p++ = hex_asc_lo(hi);
780 p = pack_hex_byte(p, lo);
783 p = pack_hex_byte(p, lo);
785 *p++ = hex_asc_lo(lo);
792 p = ip4_string(p, &in6.s6_addr[12], false);
799 static char *ip6_string(char *p, const char *addr, const char *fmt)
803 for (i = 0; i < 8; i++) {
804 p = pack_hex_byte(p, *addr++);
805 p = pack_hex_byte(p, *addr++);
806 if (fmt[0] == 'I' && i != 7)
814 static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
815 struct printf_spec spec, const char *fmt)
817 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
819 if (fmt[0] == 'I' && fmt[2] == 'c')
820 ip6_compressed_string(ip6_addr, addr);
822 ip6_string(ip6_addr, addr, fmt);
824 return string(buf, end, ip6_addr, spec);
827 static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
828 struct printf_spec spec, const char *fmt)
830 char ip4_addr[sizeof("255.255.255.255")];
832 ip4_string(ip4_addr, addr, fmt[0] == 'i');
834 return string(buf, end, ip4_addr, spec);
838 * Show a '%p' thing. A kernel extension is that the '%p' is followed
839 * by an extra set of alphanumeric characters that are extended format
842 * Right now we handle:
844 * - 'F' For symbolic function descriptor pointers with offset
845 * - 'f' For simple symbolic function names without offset
846 * - 'S' For symbolic direct pointers with offset
847 * - 's' For symbolic direct pointers without offset
848 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
849 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
850 * - 'M' For a 6-byte MAC address, it prints the address in the
851 * usual colon-separated hex notation
852 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
853 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
854 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
855 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
856 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
857 * IPv6 omits the colons (01020304...0f)
858 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
859 * - 'I6c' for IPv6 addresses printed as specified by
860 * http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
861 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
862 * function pointers are really function descriptors, which contain a
863 * pointer to the real address.
865 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
866 struct printf_spec spec)
869 return string(buf, end, "(null)", spec);
874 ptr = dereference_function_descriptor(ptr);
878 return symbol_string(buf, end, ptr, spec, *fmt);
881 return resource_string(buf, end, ptr, spec, fmt);
882 case 'M': /* Colon separated: 00:01:02:03:04:05 */
883 case 'm': /* Contiguous: 000102030405 */
884 return mac_address_string(buf, end, ptr, spec, fmt);
885 case 'I': /* Formatted IP supported
887 * 6: 0001:0203:...:0708
888 * 6c: 1::708 or 1::1.2.3.4
890 case 'i': /* Contiguous:
896 return ip6_addr_string(buf, end, ptr, spec, fmt);
898 return ip4_addr_string(buf, end, ptr, spec, fmt);
903 if (spec.field_width == -1) {
904 spec.field_width = 2*sizeof(void *);
905 spec.flags |= ZEROPAD;
909 return number(buf, end, (unsigned long) ptr, spec);
913 * Helper function to decode printf style format.
914 * Each call decode a token from the format and return the
915 * number of characters read (or likely the delta where it wants
916 * to go on the next call).
917 * The decoded token is returned through the parameters
919 * 'h', 'l', or 'L' for integer fields
920 * 'z' support added 23/7/1999 S.H.
921 * 'z' changed to 'Z' --davidm 1/25/99
922 * 't' added for ptrdiff_t
924 * @fmt: the format string
925 * @type of the token returned
926 * @flags: various flags such as +, -, # tokens..
927 * @field_width: overwritten width
928 * @base: base of the number (octal, hex, ...)
929 * @precision: precision of a number
930 * @qualifier: qualifier of a number (long, size_t, ...)
932 static int format_decode(const char *fmt, struct printf_spec *spec)
934 const char *start = fmt;
936 /* we finished early by reading the field width */
937 if (spec->type == FORMAT_TYPE_WIDTH) {
938 if (spec->field_width < 0) {
939 spec->field_width = -spec->field_width;
942 spec->type = FORMAT_TYPE_NONE;
946 /* we finished early by reading the precision */
947 if (spec->type == FORMAT_TYPE_PRECISION) {
948 if (spec->precision < 0)
951 spec->type = FORMAT_TYPE_NONE;
956 spec->type = FORMAT_TYPE_NONE;
958 for (; *fmt ; ++fmt) {
963 /* Return the current non-format string */
964 if (fmt != start || !*fmt)
970 while (1) { /* this also skips first '%' */
976 case '-': spec->flags |= LEFT; break;
977 case '+': spec->flags |= PLUS; break;
978 case ' ': spec->flags |= SPACE; break;
979 case '#': spec->flags |= SPECIAL; break;
980 case '0': spec->flags |= ZEROPAD; break;
981 default: found = false;
988 /* get field width */
989 spec->field_width = -1;
992 spec->field_width = skip_atoi(&fmt);
993 else if (*fmt == '*') {
994 /* it's the next argument */
995 spec->type = FORMAT_TYPE_WIDTH;
996 return ++fmt - start;
1000 /* get the precision */
1001 spec->precision = -1;
1004 if (isdigit(*fmt)) {
1005 spec->precision = skip_atoi(&fmt);
1006 if (spec->precision < 0)
1007 spec->precision = 0;
1008 } else if (*fmt == '*') {
1009 /* it's the next argument */
1010 spec->type = FORMAT_TYPE_PRECISION;
1011 return ++fmt - start;
1016 /* get the conversion qualifier */
1017 spec->qualifier = -1;
1018 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1019 TOLOWER(*fmt) == 'z' || *fmt == 't') {
1020 spec->qualifier = *fmt++;
1021 if (unlikely(spec->qualifier == *fmt)) {
1022 if (spec->qualifier == 'l') {
1023 spec->qualifier = 'L';
1025 } else if (spec->qualifier == 'h') {
1026 spec->qualifier = 'H';
1036 spec->type = FORMAT_TYPE_CHAR;
1037 return ++fmt - start;
1040 spec->type = FORMAT_TYPE_STR;
1041 return ++fmt - start;
1044 spec->type = FORMAT_TYPE_PTR;
1049 spec->type = FORMAT_TYPE_NRCHARS;
1050 return ++fmt - start;
1053 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1054 return ++fmt - start;
1056 /* integer number formats - set up the flags and "break" */
1062 spec->flags |= SMALL;
1070 spec->flags |= SIGN;
1075 spec->type = FORMAT_TYPE_INVALID;
1079 if (spec->qualifier == 'L')
1080 spec->type = FORMAT_TYPE_LONG_LONG;
1081 else if (spec->qualifier == 'l') {
1082 if (spec->flags & SIGN)
1083 spec->type = FORMAT_TYPE_LONG;
1085 spec->type = FORMAT_TYPE_ULONG;
1086 } else if (TOLOWER(spec->qualifier) == 'z') {
1087 spec->type = FORMAT_TYPE_SIZE_T;
1088 } else if (spec->qualifier == 't') {
1089 spec->type = FORMAT_TYPE_PTRDIFF;
1090 } else if (spec->qualifier == 'H') {
1091 if (spec->flags & SIGN)
1092 spec->type = FORMAT_TYPE_BYTE;
1094 spec->type = FORMAT_TYPE_UBYTE;
1095 } else if (spec->qualifier == 'h') {
1096 if (spec->flags & SIGN)
1097 spec->type = FORMAT_TYPE_SHORT;
1099 spec->type = FORMAT_TYPE_USHORT;
1101 if (spec->flags & SIGN)
1102 spec->type = FORMAT_TYPE_INT;
1104 spec->type = FORMAT_TYPE_UINT;
1107 return ++fmt - start;
1111 * vsnprintf - Format a string and place it in a buffer
1112 * @buf: The buffer to place the result into
1113 * @size: The size of the buffer, including the trailing null space
1114 * @fmt: The format string to use
1115 * @args: Arguments for the format string
1117 * This function follows C99 vsnprintf, but has some extensions:
1118 * %pS output the name of a text symbol with offset
1119 * %ps output the name of a text symbol without offset
1120 * %pF output the name of a function pointer with its offset
1121 * %pf output the name of a function pointer without its offset
1122 * %pR output the address range in a struct resource
1125 * The return value is the number of characters which would
1126 * be generated for the given input, excluding the trailing
1127 * '\0', as per ISO C99. If you want to have the exact
1128 * number of characters written into @buf as return value
1129 * (not including the trailing '\0'), use vscnprintf(). If the
1130 * return is greater than or equal to @size, the resulting
1131 * string is truncated.
1133 * Call this function if you are already dealing with a va_list.
1134 * You probably want snprintf() instead.
1136 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1138 unsigned long long num;
1140 struct printf_spec spec = {0};
1142 /* Reject out-of-range values early. Large positive sizes are
1143 used for unknown buffer sizes. */
1144 if (WARN_ON_ONCE((int) size < 0))
1150 /* Make sure end is always >= buf */
1157 const char *old_fmt = fmt;
1158 int read = format_decode(fmt, &spec);
1162 switch (spec.type) {
1163 case FORMAT_TYPE_NONE: {
1166 if (copy > end - str)
1168 memcpy(str, old_fmt, copy);
1174 case FORMAT_TYPE_WIDTH:
1175 spec.field_width = va_arg(args, int);
1178 case FORMAT_TYPE_PRECISION:
1179 spec.precision = va_arg(args, int);
1182 case FORMAT_TYPE_CHAR: {
1185 if (!(spec.flags & LEFT)) {
1186 while (--spec.field_width > 0) {
1193 c = (unsigned char) va_arg(args, int);
1197 while (--spec.field_width > 0) {
1205 case FORMAT_TYPE_STR:
1206 str = string(str, end, va_arg(args, char *), spec);
1209 case FORMAT_TYPE_PTR:
1210 str = pointer(fmt+1, str, end, va_arg(args, void *),
1212 while (isalnum(*fmt))
1216 case FORMAT_TYPE_PERCENT_CHAR:
1222 case FORMAT_TYPE_INVALID:
1228 case FORMAT_TYPE_NRCHARS: {
1229 int qualifier = spec.qualifier;
1231 if (qualifier == 'l') {
1232 long *ip = va_arg(args, long *);
1234 } else if (TOLOWER(qualifier) == 'z') {
1235 size_t *ip = va_arg(args, size_t *);
1238 int *ip = va_arg(args, int *);
1245 switch (spec.type) {
1246 case FORMAT_TYPE_LONG_LONG:
1247 num = va_arg(args, long long);
1249 case FORMAT_TYPE_ULONG:
1250 num = va_arg(args, unsigned long);
1252 case FORMAT_TYPE_LONG:
1253 num = va_arg(args, long);
1255 case FORMAT_TYPE_SIZE_T:
1256 num = va_arg(args, size_t);
1258 case FORMAT_TYPE_PTRDIFF:
1259 num = va_arg(args, ptrdiff_t);
1261 case FORMAT_TYPE_UBYTE:
1262 num = (unsigned char) va_arg(args, int);
1264 case FORMAT_TYPE_BYTE:
1265 num = (signed char) va_arg(args, int);
1267 case FORMAT_TYPE_USHORT:
1268 num = (unsigned short) va_arg(args, int);
1270 case FORMAT_TYPE_SHORT:
1271 num = (short) va_arg(args, int);
1273 case FORMAT_TYPE_INT:
1274 num = (int) va_arg(args, int);
1277 num = va_arg(args, unsigned int);
1280 str = number(str, end, num, spec);
1291 /* the trailing null byte doesn't count towards the total */
1295 EXPORT_SYMBOL(vsnprintf);
1298 * vscnprintf - Format a string and place it in a buffer
1299 * @buf: The buffer to place the result into
1300 * @size: The size of the buffer, including the trailing null space
1301 * @fmt: The format string to use
1302 * @args: Arguments for the format string
1304 * The return value is the number of characters which have been written into
1305 * the @buf not including the trailing '\0'. If @size is <= 0 the function
1308 * Call this function if you are already dealing with a va_list.
1309 * You probably want scnprintf() instead.
1311 * See the vsnprintf() documentation for format string extensions over C99.
1313 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1317 i = vsnprintf(buf, size, fmt, args);
1319 return (i >= size) ? (size - 1) : i;
1321 EXPORT_SYMBOL(vscnprintf);
1324 * snprintf - Format a string and place it in a buffer
1325 * @buf: The buffer to place the result into
1326 * @size: The size of the buffer, including the trailing null space
1327 * @fmt: The format string to use
1328 * @...: Arguments for the format string
1330 * The return value is the number of characters which would be
1331 * generated for the given input, excluding the trailing null,
1332 * as per ISO C99. If the return is greater than or equal to
1333 * @size, the resulting string is truncated.
1335 * See the vsnprintf() documentation for format string extensions over C99.
1337 int snprintf(char *buf, size_t size, const char *fmt, ...)
1342 va_start(args, fmt);
1343 i = vsnprintf(buf, size, fmt, args);
1348 EXPORT_SYMBOL(snprintf);
1351 * scnprintf - Format a string and place it in a buffer
1352 * @buf: The buffer to place the result into
1353 * @size: The size of the buffer, including the trailing null space
1354 * @fmt: The format string to use
1355 * @...: Arguments for the format string
1357 * The return value is the number of characters written into @buf not including
1358 * the trailing '\0'. If @size is <= 0 the function returns 0.
1361 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1366 va_start(args, fmt);
1367 i = vsnprintf(buf, size, fmt, args);
1370 return (i >= size) ? (size - 1) : i;
1372 EXPORT_SYMBOL(scnprintf);
1375 * vsprintf - Format a string and place it in a buffer
1376 * @buf: The buffer to place the result into
1377 * @fmt: The format string to use
1378 * @args: Arguments for the format string
1380 * The function returns the number of characters written
1381 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1384 * Call this function if you are already dealing with a va_list.
1385 * You probably want sprintf() instead.
1387 * See the vsnprintf() documentation for format string extensions over C99.
1389 int vsprintf(char *buf, const char *fmt, va_list args)
1391 return vsnprintf(buf, INT_MAX, fmt, args);
1393 EXPORT_SYMBOL(vsprintf);
1396 * sprintf - Format a string and place it in a buffer
1397 * @buf: The buffer to place the result into
1398 * @fmt: The format string to use
1399 * @...: Arguments for the format string
1401 * The function returns the number of characters written
1402 * into @buf. Use snprintf() or scnprintf() in order to avoid
1405 * See the vsnprintf() documentation for format string extensions over C99.
1407 int sprintf(char *buf, const char *fmt, ...)
1412 va_start(args, fmt);
1413 i = vsnprintf(buf, INT_MAX, fmt, args);
1418 EXPORT_SYMBOL(sprintf);
1420 #ifdef CONFIG_BINARY_PRINTF
1423 * vbin_printf() - VA arguments to binary data
1424 * bstr_printf() - Binary data to text string
1428 * vbin_printf - Parse a format string and place args' binary value in a buffer
1429 * @bin_buf: The buffer to place args' binary value
1430 * @size: The size of the buffer(by words(32bits), not characters)
1431 * @fmt: The format string to use
1432 * @args: Arguments for the format string
1434 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1437 * The return value is the number of words(32bits) which would be generated for
1441 * If the return value is greater than @size, the resulting bin_buf is NOT
1442 * valid for bstr_printf().
1444 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1446 struct printf_spec spec = {0};
1449 str = (char *)bin_buf;
1450 end = (char *)(bin_buf + size);
1452 #define save_arg(type) \
1454 if (sizeof(type) == 8) { \
1455 unsigned long long value; \
1456 str = PTR_ALIGN(str, sizeof(u32)); \
1457 value = va_arg(args, unsigned long long); \
1458 if (str + sizeof(type) <= end) { \
1459 *(u32 *)str = *(u32 *)&value; \
1460 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1463 unsigned long value; \
1464 str = PTR_ALIGN(str, sizeof(type)); \
1465 value = va_arg(args, int); \
1466 if (str + sizeof(type) <= end) \
1467 *(typeof(type) *)str = (type)value; \
1469 str += sizeof(type); \
1473 int read = format_decode(fmt, &spec);
1477 switch (spec.type) {
1478 case FORMAT_TYPE_NONE:
1479 case FORMAT_TYPE_INVALID:
1480 case FORMAT_TYPE_PERCENT_CHAR:
1483 case FORMAT_TYPE_WIDTH:
1484 case FORMAT_TYPE_PRECISION:
1488 case FORMAT_TYPE_CHAR:
1492 case FORMAT_TYPE_STR: {
1493 const char *save_str = va_arg(args, char *);
1496 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1497 || (unsigned long)save_str < PAGE_SIZE)
1498 save_str = "(null)";
1499 len = strlen(save_str) + 1;
1500 if (str + len < end)
1501 memcpy(str, save_str, len);
1506 case FORMAT_TYPE_PTR:
1508 /* skip all alphanumeric pointer suffixes */
1509 while (isalnum(*fmt))
1513 case FORMAT_TYPE_NRCHARS: {
1514 /* skip %n 's argument */
1515 int qualifier = spec.qualifier;
1517 if (qualifier == 'l')
1518 skip_arg = va_arg(args, long *);
1519 else if (TOLOWER(qualifier) == 'z')
1520 skip_arg = va_arg(args, size_t *);
1522 skip_arg = va_arg(args, int *);
1527 switch (spec.type) {
1529 case FORMAT_TYPE_LONG_LONG:
1530 save_arg(long long);
1532 case FORMAT_TYPE_ULONG:
1533 case FORMAT_TYPE_LONG:
1534 save_arg(unsigned long);
1536 case FORMAT_TYPE_SIZE_T:
1539 case FORMAT_TYPE_PTRDIFF:
1540 save_arg(ptrdiff_t);
1542 case FORMAT_TYPE_UBYTE:
1543 case FORMAT_TYPE_BYTE:
1546 case FORMAT_TYPE_USHORT:
1547 case FORMAT_TYPE_SHORT:
1556 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1559 EXPORT_SYMBOL_GPL(vbin_printf);
1562 * bstr_printf - Format a string from binary arguments and place it in a buffer
1563 * @buf: The buffer to place the result into
1564 * @size: The size of the buffer, including the trailing null space
1565 * @fmt: The format string to use
1566 * @bin_buf: Binary arguments for the format string
1568 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1569 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1570 * a binary buffer that generated by vbin_printf.
1572 * The format follows C99 vsnprintf, but has some extensions:
1573 * see vsnprintf comment for details.
1575 * The return value is the number of characters which would
1576 * be generated for the given input, excluding the trailing
1577 * '\0', as per ISO C99. If you want to have the exact
1578 * number of characters written into @buf as return value
1579 * (not including the trailing '\0'), use vscnprintf(). If the
1580 * return is greater than or equal to @size, the resulting
1581 * string is truncated.
1583 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1585 struct printf_spec spec = {0};
1587 const char *args = (const char *)bin_buf;
1589 if (WARN_ON_ONCE((int) size < 0))
1595 #define get_arg(type) \
1597 typeof(type) value; \
1598 if (sizeof(type) == 8) { \
1599 args = PTR_ALIGN(args, sizeof(u32)); \
1600 *(u32 *)&value = *(u32 *)args; \
1601 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1603 args = PTR_ALIGN(args, sizeof(type)); \
1604 value = *(typeof(type) *)args; \
1606 args += sizeof(type); \
1610 /* Make sure end is always >= buf */
1617 const char *old_fmt = fmt;
1618 int read = format_decode(fmt, &spec);
1622 switch (spec.type) {
1623 case FORMAT_TYPE_NONE: {
1626 if (copy > end - str)
1628 memcpy(str, old_fmt, copy);
1634 case FORMAT_TYPE_WIDTH:
1635 spec.field_width = get_arg(int);
1638 case FORMAT_TYPE_PRECISION:
1639 spec.precision = get_arg(int);
1642 case FORMAT_TYPE_CHAR: {
1645 if (!(spec.flags & LEFT)) {
1646 while (--spec.field_width > 0) {
1652 c = (unsigned char) get_arg(char);
1656 while (--spec.field_width > 0) {
1664 case FORMAT_TYPE_STR: {
1665 const char *str_arg = args;
1666 args += strlen(str_arg) + 1;
1667 str = string(str, end, (char *)str_arg, spec);
1671 case FORMAT_TYPE_PTR:
1672 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1673 while (isalnum(*fmt))
1677 case FORMAT_TYPE_PERCENT_CHAR:
1678 case FORMAT_TYPE_INVALID:
1684 case FORMAT_TYPE_NRCHARS:
1689 unsigned long long num;
1691 switch (spec.type) {
1693 case FORMAT_TYPE_LONG_LONG:
1694 num = get_arg(long long);
1696 case FORMAT_TYPE_ULONG:
1697 case FORMAT_TYPE_LONG:
1698 num = get_arg(unsigned long);
1700 case FORMAT_TYPE_SIZE_T:
1701 num = get_arg(size_t);
1703 case FORMAT_TYPE_PTRDIFF:
1704 num = get_arg(ptrdiff_t);
1706 case FORMAT_TYPE_UBYTE:
1707 num = get_arg(unsigned char);
1709 case FORMAT_TYPE_BYTE:
1710 num = get_arg(signed char);
1712 case FORMAT_TYPE_USHORT:
1713 num = get_arg(unsigned short);
1715 case FORMAT_TYPE_SHORT:
1716 num = get_arg(short);
1718 case FORMAT_TYPE_UINT:
1719 num = get_arg(unsigned int);
1725 str = number(str, end, num, spec);
1727 } /* switch(spec.type) */
1739 /* the trailing null byte doesn't count towards the total */
1742 EXPORT_SYMBOL_GPL(bstr_printf);
1745 * bprintf - Parse a format string and place args' binary value in a buffer
1746 * @bin_buf: The buffer to place args' binary value
1747 * @size: The size of the buffer(by words(32bits), not characters)
1748 * @fmt: The format string to use
1749 * @...: Arguments for the format string
1751 * The function returns the number of words(u32) written
1754 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1759 va_start(args, fmt);
1760 ret = vbin_printf(bin_buf, size, fmt, args);
1765 EXPORT_SYMBOL_GPL(bprintf);
1767 #endif /* CONFIG_BINARY_PRINTF */
1769 static noinline char *skip_space(const char *str)
1771 while (isspace(*str))
1777 * vsscanf - Unformat a buffer into a list of arguments
1778 * @buf: input buffer
1779 * @fmt: format of buffer
1782 int vsscanf(const char *buf, const char *fmt, va_list args)
1784 const char *str = buf;
1788 int qualifier, base, field_width;
1791 while (*fmt && *str) {
1792 /* skip any white space in format */
1793 /* white space in format matchs any amount of
1794 * white space, including none, in the input.
1796 if (isspace(*fmt)) {
1797 fmt = skip_space(fmt);
1798 str = skip_space(str);
1801 /* anything that is not a conversion must match exactly */
1802 if (*fmt != '%' && *fmt) {
1803 if (*fmt++ != *str++)
1812 /* skip this conversion.
1813 * advance both strings to next white space
1816 while (!isspace(*fmt) && *fmt != '%' && *fmt)
1818 while (!isspace(*str) && *str)
1823 /* get field width */
1826 field_width = skip_atoi(&fmt);
1828 /* get conversion qualifier */
1830 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1831 TOLOWER(*fmt) == 'z') {
1833 if (unlikely(qualifier == *fmt)) {
1834 if (qualifier == 'h') {
1837 } else if (qualifier == 'l') {
1853 char *s = (char *)va_arg(args, char*);
1854 if (field_width == -1)
1858 } while (--field_width > 0 && *str);
1864 char *s = (char *)va_arg(args, char *);
1865 if (field_width == -1)
1866 field_width = INT_MAX;
1867 /* first, skip leading white space in buffer */
1868 str = skip_space(str);
1870 /* now copy until next white space */
1871 while (*str && !isspace(*str) && field_width--)
1878 /* return number of characters read so far */
1880 int *i = (int *)va_arg(args, int*);
1898 /* looking for '%' in str */
1903 /* invalid format; stop here */
1907 /* have some sort of integer conversion.
1908 * first, skip white space in buffer.
1910 str = skip_space(str);
1913 if (is_sign && digit == '-')
1917 || (base == 16 && !isxdigit(digit))
1918 || (base == 10 && !isdigit(digit))
1919 || (base == 8 && (!isdigit(digit) || digit > '7'))
1920 || (base == 0 && !isdigit(digit)))
1923 switch (qualifier) {
1924 case 'H': /* that's 'hh' in format */
1926 signed char *s = (signed char *)va_arg(args, signed char *);
1927 *s = (signed char)simple_strtol(str, &next, base);
1929 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
1930 *s = (unsigned char)simple_strtoul(str, &next, base);
1935 short *s = (short *)va_arg(args, short *);
1936 *s = (short)simple_strtol(str, &next, base);
1938 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
1939 *s = (unsigned short)simple_strtoul(str, &next, base);
1944 long *l = (long *)va_arg(args, long *);
1945 *l = simple_strtol(str, &next, base);
1947 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
1948 *l = simple_strtoul(str, &next, base);
1953 long long *l = (long long *)va_arg(args, long long *);
1954 *l = simple_strtoll(str, &next, base);
1956 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
1957 *l = simple_strtoull(str, &next, base);
1963 size_t *s = (size_t *)va_arg(args, size_t *);
1964 *s = (size_t)simple_strtoul(str, &next, base);
1969 int *i = (int *)va_arg(args, int *);
1970 *i = (int)simple_strtol(str, &next, base);
1972 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
1973 *i = (unsigned int)simple_strtoul(str, &next, base);
1985 * Now we've come all the way through so either the input string or the
1986 * format ended. In the former case, there can be a %n at the current
1987 * position in the format that needs to be filled.
1989 if (*fmt == '%' && *(fmt + 1) == 'n') {
1990 int *p = (int *)va_arg(args, int *);
1996 EXPORT_SYMBOL(vsscanf);
1999 * sscanf - Unformat a buffer into a list of arguments
2000 * @buf: input buffer
2001 * @fmt: formatting of buffer
2002 * @...: resulting arguments
2004 int sscanf(const char *buf, const char *fmt, ...)
2009 va_start(args, fmt);
2010 i = vsscanf(buf, fmt, args);
2015 EXPORT_SYMBOL(sscanf);