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_strtoul - convert a string to an unsigned 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 simple_strtoul(const char *cp, char **endp, unsigned int base)
57 unsigned 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_strtoul);
82 * simple_strtol - convert a string to a signed 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 long simple_strtol(const char *cp, char **endp, unsigned int base)
90 return -simple_strtoul(cp + 1, endp, base);
92 return simple_strtoul(cp, endp, base);
94 EXPORT_SYMBOL(simple_strtol);
97 * simple_strtoull - convert a string to an unsigned long long
98 * @cp: The start of the string
99 * @endp: A pointer to the end of the parsed string will be placed here
100 * @base: The number base to use
102 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
104 unsigned long long result = 0;
107 base = simple_guess_base(cp);
109 if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
112 while (isxdigit(*cp)) {
115 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
118 result = result * base + value;
126 EXPORT_SYMBOL(simple_strtoull);
129 * simple_strtoll - convert a string to a signed long long
130 * @cp: The start of the string
131 * @endp: A pointer to the end of the parsed string will be placed here
132 * @base: The number base to use
134 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
137 return -simple_strtoull(cp + 1, endp, base);
139 return simple_strtoull(cp, endp, base);
143 * strict_strtoul - convert a string to an unsigned long strictly
144 * @cp: The string to be converted
145 * @base: The number base to use
146 * @res: The converted result value
148 * strict_strtoul converts a string to an unsigned long only if the
149 * string is really an unsigned long string, any string containing
150 * any invalid char at the tail will be rejected and -EINVAL is returned,
151 * only a newline char at the tail is acceptible because people generally
152 * change a module parameter in the following way:
154 * echo 1024 > /sys/module/e1000/parameters/copybreak
156 * echo will append a newline to the tail.
158 * It returns 0 if conversion is successful and *res is set to the converted
159 * value, otherwise it returns -EINVAL and *res is set to 0.
161 * simple_strtoul just ignores the successive invalid characters and
162 * return the converted value of prefix part of the string.
164 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
175 val = simple_strtoul(cp, &tail, base);
179 if ((*tail == '\0') ||
180 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
187 EXPORT_SYMBOL(strict_strtoul);
190 * strict_strtol - convert a string to a long strictly
191 * @cp: The string to be converted
192 * @base: The number base to use
193 * @res: The converted result value
195 * strict_strtol is similiar to strict_strtoul, but it allows the first
196 * character of a string is '-'.
198 * It returns 0 if conversion is successful and *res is set to the converted
199 * value, otherwise it returns -EINVAL and *res is set to 0.
201 int strict_strtol(const char *cp, unsigned int base, long *res)
205 ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
209 ret = strict_strtoul(cp, base, (unsigned long *)res);
214 EXPORT_SYMBOL(strict_strtol);
217 * strict_strtoull - convert a string to an unsigned long long strictly
218 * @cp: The string to be converted
219 * @base: The number base to use
220 * @res: The converted result value
222 * strict_strtoull converts a string to an unsigned long long only if the
223 * string is really an unsigned long long string, any string containing
224 * any invalid char at the tail will be rejected and -EINVAL is returned,
225 * only a newline char at the tail is acceptible because people generally
226 * change a module parameter in the following way:
228 * echo 1024 > /sys/module/e1000/parameters/copybreak
230 * echo will append a newline to the tail of the string.
232 * It returns 0 if conversion is successful and *res is set to the converted
233 * value, otherwise it returns -EINVAL and *res is set to 0.
235 * simple_strtoull just ignores the successive invalid characters and
236 * return the converted value of prefix part of the string.
238 int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
241 unsigned long long val;
249 val = simple_strtoull(cp, &tail, base);
252 if ((*tail == '\0') ||
253 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
260 EXPORT_SYMBOL(strict_strtoull);
263 * strict_strtoll - convert a string to a long long strictly
264 * @cp: The string to be converted
265 * @base: The number base to use
266 * @res: The converted result value
268 * strict_strtoll is similiar to strict_strtoull, but it allows the first
269 * character of a string is '-'.
271 * It returns 0 if conversion is successful and *res is set to the converted
272 * value, otherwise it returns -EINVAL and *res is set to 0.
274 int strict_strtoll(const char *cp, unsigned int base, long long *res)
278 ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
282 ret = strict_strtoull(cp, base, (unsigned long long *)res);
287 EXPORT_SYMBOL(strict_strtoll);
289 static int skip_atoi(const char **s)
294 i = i*10 + *((*s)++) - '0';
299 /* Decimal conversion is by far the most typical, and is used
300 * for /proc and /sys data. This directly impacts e.g. top performance
301 * with many processes running. We optimize it for speed
303 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
304 * (with permission from the author, Douglas W. Jones). */
306 /* Formats correctly any integer in [0,99999].
307 * Outputs from one to five digits depending on input.
308 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
309 static char *put_dec_trunc(char *buf, unsigned q)
311 unsigned d3, d2, d1, d0;
316 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
317 q = (d0 * 0xcd) >> 11;
319 *buf++ = d0 + '0'; /* least significant digit */
320 d1 = q + 9*d3 + 5*d2 + d1;
322 q = (d1 * 0xcd) >> 11;
324 *buf++ = d1 + '0'; /* next digit */
327 if ((d2 != 0) || (d3 != 0)) {
330 *buf++ = d2 + '0'; /* next digit */
334 q = (d3 * 0xcd) >> 11;
336 *buf++ = d3 + '0'; /* next digit */
338 *buf++ = q + '0'; /* most sign. digit */
345 /* Same with if's removed. Always emits five digits */
346 static char *put_dec_full(char *buf, unsigned q)
348 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
349 /* but anyway, gcc produces better code with full-sized ints */
350 unsigned d3, d2, d1, d0;
356 * Possible ways to approx. divide by 10
357 * gcc -O2 replaces multiply with shifts and adds
358 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
359 * (x * 0x67) >> 10: 1100111
360 * (x * 0x34) >> 9: 110100 - same
361 * (x * 0x1a) >> 8: 11010 - same
362 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
364 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
365 q = (d0 * 0xcd) >> 11;
368 d1 = q + 9*d3 + 5*d2 + d1;
369 q = (d1 * 0xcd) >> 11;
379 q = (d3 * 0xcd) >> 11; /* - shorter code */
380 /* q = (d3 * 0x67) >> 10; - would also work */
387 /* No inlining helps gcc to use registers better */
388 static noinline char *put_dec(char *buf, unsigned long long num)
393 return put_dec_trunc(buf, num);
394 rem = do_div(num, 100000);
395 buf = put_dec_full(buf, rem);
399 #define ZEROPAD 1 /* pad with zero */
400 #define SIGN 2 /* unsigned/signed long */
401 #define PLUS 4 /* show plus */
402 #define SPACE 8 /* space if plus */
403 #define LEFT 16 /* left justified */
404 #define SMALL 32 /* Must be 32 == 0x20 */
405 #define SPECIAL 64 /* 0x */
408 FORMAT_TYPE_NONE, /* Just a string part */
410 FORMAT_TYPE_PRECISION,
414 FORMAT_TYPE_PERCENT_CHAR,
416 FORMAT_TYPE_LONG_LONG,
431 enum format_type type;
432 int flags; /* flags to number() */
433 int field_width; /* width of output field */
435 int precision; /* # of digits/chars */
439 static char *number(char *buf, char *end, unsigned long long num,
440 struct printf_spec spec)
442 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
443 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
448 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
451 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
452 * produces same digits or (maybe lowercased) letters */
453 locase = (spec.flags & SMALL);
454 if (spec.flags & LEFT)
455 spec.flags &= ~ZEROPAD;
457 if (spec.flags & SIGN) {
458 if ((signed long long)num < 0) {
460 num = -(signed long long)num;
462 } else if (spec.flags & PLUS) {
465 } else if (spec.flags & SPACE) {
476 /* generate full string in tmp[], in reverse order */
480 /* Generic code, for any base:
482 tmp[i++] = (digits[do_div(num,base)] | locase);
485 else if (spec.base != 10) { /* 8 or 16 */
486 int mask = spec.base - 1;
492 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
495 } else { /* base 10 */
496 i = put_dec(tmp, num) - tmp;
499 /* printing 100 using %2d gives "100", not "00" */
500 if (i > spec.precision)
502 /* leading space padding */
503 spec.field_width -= spec.precision;
504 if (!(spec.flags & (ZEROPAD+LEFT))) {
505 while (--spec.field_width >= 0) {
517 /* "0x" / "0" prefix */
522 if (spec.base == 16) {
524 *buf = ('X' | locase);
528 /* zero or space padding */
529 if (!(spec.flags & LEFT)) {
530 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
531 while (--spec.field_width >= 0) {
537 /* hmm even more zero padding? */
538 while (i <= --spec.precision) {
543 /* actual digits of result */
549 /* trailing space padding */
550 while (--spec.field_width >= 0) {
559 static char *string(char *buf, char *end, const char *s, struct printf_spec spec)
563 if ((unsigned long)s < PAGE_SIZE)
566 len = strnlen(s, spec.precision);
568 if (!(spec.flags & LEFT)) {
569 while (len < spec.field_width--) {
575 for (i = 0; i < len; ++i) {
580 while (len < spec.field_width--) {
589 static char *symbol_string(char *buf, char *end, void *ptr,
590 struct printf_spec spec, char ext)
592 unsigned long value = (unsigned long) ptr;
593 #ifdef CONFIG_KALLSYMS
594 char sym[KSYM_SYMBOL_LEN];
595 if (ext != 'f' && ext != 's')
596 sprint_symbol(sym, value);
598 kallsyms_lookup(value, NULL, NULL, NULL, sym);
600 return string(buf, end, sym, spec);
602 spec.field_width = 2 * sizeof(void *);
603 spec.flags |= SPECIAL | SMALL | ZEROPAD;
606 return number(buf, end, value, spec);
610 static char *resource_string(char *buf, char *end, struct resource *res,
611 struct printf_spec spec, const char *fmt)
613 #ifndef IO_RSRC_PRINTK_SIZE
614 #define IO_RSRC_PRINTK_SIZE 6
617 #ifndef MEM_RSRC_PRINTK_SIZE
618 #define MEM_RSRC_PRINTK_SIZE 10
620 struct printf_spec hex_spec = {
623 .flags = SPECIAL | SMALL | ZEROPAD,
625 struct printf_spec dec_spec = {
630 struct printf_spec str_spec = {
635 struct printf_spec flag_spec = {
638 .flags = SPECIAL | SMALL,
641 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
642 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
643 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
644 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
645 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref disabled]")
646 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
647 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
648 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
650 char *p = sym, *pend = sym + sizeof(sym);
651 int size = -1, addr = 0;
652 int decode = (fmt[0] == 'R') ? 1 : 0;
654 if (res->flags & IORESOURCE_IO) {
655 size = IO_RSRC_PRINTK_SIZE;
657 } else if (res->flags & IORESOURCE_MEM) {
658 size = MEM_RSRC_PRINTK_SIZE;
663 if (res->flags & IORESOURCE_IO)
664 p = string(p, pend, "io ", str_spec);
665 else if (res->flags & IORESOURCE_MEM)
666 p = string(p, pend, "mem ", str_spec);
667 else if (res->flags & IORESOURCE_IRQ)
668 p = string(p, pend, "irq ", str_spec);
669 else if (res->flags & IORESOURCE_DMA)
670 p = string(p, pend, "dma ", str_spec);
672 p = string(p, pend, "??? ", str_spec);
675 hex_spec.field_width = size;
676 p = number(p, pend, res->start, addr ? hex_spec : dec_spec);
677 if (res->start != res->end) {
679 p = number(p, pend, res->end, addr ? hex_spec : dec_spec);
682 if (res->flags & IORESOURCE_MEM_64)
683 p = string(p, pend, " 64bit", str_spec);
684 if (res->flags & IORESOURCE_PREFETCH)
685 p = string(p, pend, " pref", str_spec);
686 if (res->flags & IORESOURCE_DISABLED)
687 p = string(p, pend, " disabled", str_spec);
689 p = string(p, pend, " flags ", str_spec);
690 p = number(p, pend, res->flags, flag_spec);
695 return string(buf, end, sym, spec);
698 static char *mac_address_string(char *buf, char *end, u8 *addr,
699 struct printf_spec spec, const char *fmt)
701 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
705 for (i = 0; i < 6; i++) {
706 p = pack_hex_byte(p, addr[i]);
707 if (fmt[0] == 'M' && i != 5)
712 return string(buf, end, mac_addr, spec);
715 static char *ip4_string(char *p, const u8 *addr, bool leading_zeros)
719 for (i = 0; i < 4; i++) {
720 char temp[3]; /* hold each IP quad in reverse order */
721 int digits = put_dec_trunc(temp, addr[i]) - temp;
728 /* reverse the digits in the quad */
739 static char *ip6_compressed_string(char *p, const char *addr)
742 unsigned char zerolength[8];
747 bool needcolon = false;
751 memcpy(&in6, addr, sizeof(struct in6_addr));
753 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
755 memset(zerolength, 0, sizeof(zerolength));
762 /* find position of longest 0 run */
763 for (i = 0; i < range; i++) {
764 for (j = i; j < range; j++) {
765 if (in6.s6_addr16[j] != 0)
770 for (i = 0; i < range; i++) {
771 if (zerolength[i] > longest) {
772 longest = zerolength[i];
778 for (i = 0; i < range; i++) {
780 if (needcolon || i == 0)
791 /* hex u16 without leading 0s */
792 word = ntohs(in6.s6_addr16[i]);
797 p = pack_hex_byte(p, hi);
799 *p++ = hex_asc_lo(hi);
800 p = pack_hex_byte(p, lo);
803 p = pack_hex_byte(p, lo);
805 *p++ = hex_asc_lo(lo);
812 p = ip4_string(p, &in6.s6_addr[12], false);
819 static char *ip6_string(char *p, const char *addr, const char *fmt)
823 for (i = 0; i < 8; i++) {
824 p = pack_hex_byte(p, *addr++);
825 p = pack_hex_byte(p, *addr++);
826 if (fmt[0] == 'I' && i != 7)
834 static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
835 struct printf_spec spec, const char *fmt)
837 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
839 if (fmt[0] == 'I' && fmt[2] == 'c')
840 ip6_compressed_string(ip6_addr, addr);
842 ip6_string(ip6_addr, addr, fmt);
844 return string(buf, end, ip6_addr, spec);
847 static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
848 struct printf_spec spec, const char *fmt)
850 char ip4_addr[sizeof("255.255.255.255")];
852 ip4_string(ip4_addr, addr, fmt[0] == 'i');
854 return string(buf, end, ip4_addr, spec);
858 * Show a '%p' thing. A kernel extension is that the '%p' is followed
859 * by an extra set of alphanumeric characters that are extended format
862 * Right now we handle:
864 * - 'F' For symbolic function descriptor pointers with offset
865 * - 'f' For simple symbolic function names without offset
866 * - 'S' For symbolic direct pointers with offset
867 * - 's' For symbolic direct pointers without offset
868 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
869 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
870 * - 'M' For a 6-byte MAC address, it prints the address in the
871 * usual colon-separated hex notation
872 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
873 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
874 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
875 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
876 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
877 * IPv6 omits the colons (01020304...0f)
878 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
879 * - 'I6c' for IPv6 addresses printed as specified by
880 * http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
881 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
882 * function pointers are really function descriptors, which contain a
883 * pointer to the real address.
885 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
886 struct printf_spec spec)
889 return string(buf, end, "(null)", spec);
894 ptr = dereference_function_descriptor(ptr);
898 return symbol_string(buf, end, ptr, spec, *fmt);
901 return resource_string(buf, end, ptr, spec, fmt);
902 case 'M': /* Colon separated: 00:01:02:03:04:05 */
903 case 'm': /* Contiguous: 000102030405 */
904 return mac_address_string(buf, end, ptr, spec, fmt);
905 case 'I': /* Formatted IP supported
907 * 6: 0001:0203:...:0708
908 * 6c: 1::708 or 1::1.2.3.4
910 case 'i': /* Contiguous:
916 return ip6_addr_string(buf, end, ptr, spec, fmt);
918 return ip4_addr_string(buf, end, ptr, spec, fmt);
923 if (spec.field_width == -1) {
924 spec.field_width = 2*sizeof(void *);
925 spec.flags |= ZEROPAD;
929 return number(buf, end, (unsigned long) ptr, spec);
933 * Helper function to decode printf style format.
934 * Each call decode a token from the format and return the
935 * number of characters read (or likely the delta where it wants
936 * to go on the next call).
937 * The decoded token is returned through the parameters
939 * 'h', 'l', or 'L' for integer fields
940 * 'z' support added 23/7/1999 S.H.
941 * 'z' changed to 'Z' --davidm 1/25/99
942 * 't' added for ptrdiff_t
944 * @fmt: the format string
945 * @type of the token returned
946 * @flags: various flags such as +, -, # tokens..
947 * @field_width: overwritten width
948 * @base: base of the number (octal, hex, ...)
949 * @precision: precision of a number
950 * @qualifier: qualifier of a number (long, size_t, ...)
952 static int format_decode(const char *fmt, struct printf_spec *spec)
954 const char *start = fmt;
956 /* we finished early by reading the field width */
957 if (spec->type == FORMAT_TYPE_WIDTH) {
958 if (spec->field_width < 0) {
959 spec->field_width = -spec->field_width;
962 spec->type = FORMAT_TYPE_NONE;
966 /* we finished early by reading the precision */
967 if (spec->type == FORMAT_TYPE_PRECISION) {
968 if (spec->precision < 0)
971 spec->type = FORMAT_TYPE_NONE;
976 spec->type = FORMAT_TYPE_NONE;
978 for (; *fmt ; ++fmt) {
983 /* Return the current non-format string */
984 if (fmt != start || !*fmt)
990 while (1) { /* this also skips first '%' */
996 case '-': spec->flags |= LEFT; break;
997 case '+': spec->flags |= PLUS; break;
998 case ' ': spec->flags |= SPACE; break;
999 case '#': spec->flags |= SPECIAL; break;
1000 case '0': spec->flags |= ZEROPAD; break;
1001 default: found = false;
1008 /* get field width */
1009 spec->field_width = -1;
1012 spec->field_width = skip_atoi(&fmt);
1013 else if (*fmt == '*') {
1014 /* it's the next argument */
1015 spec->type = FORMAT_TYPE_WIDTH;
1016 return ++fmt - start;
1020 /* get the precision */
1021 spec->precision = -1;
1024 if (isdigit(*fmt)) {
1025 spec->precision = skip_atoi(&fmt);
1026 if (spec->precision < 0)
1027 spec->precision = 0;
1028 } else if (*fmt == '*') {
1029 /* it's the next argument */
1030 spec->type = FORMAT_TYPE_PRECISION;
1031 return ++fmt - start;
1036 /* get the conversion qualifier */
1037 spec->qualifier = -1;
1038 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1039 TOLOWER(*fmt) == 'z' || *fmt == 't') {
1040 spec->qualifier = *fmt++;
1041 if (unlikely(spec->qualifier == *fmt)) {
1042 if (spec->qualifier == 'l') {
1043 spec->qualifier = 'L';
1045 } else if (spec->qualifier == 'h') {
1046 spec->qualifier = 'H';
1056 spec->type = FORMAT_TYPE_CHAR;
1057 return ++fmt - start;
1060 spec->type = FORMAT_TYPE_STR;
1061 return ++fmt - start;
1064 spec->type = FORMAT_TYPE_PTR;
1069 spec->type = FORMAT_TYPE_NRCHARS;
1070 return ++fmt - start;
1073 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1074 return ++fmt - start;
1076 /* integer number formats - set up the flags and "break" */
1082 spec->flags |= SMALL;
1090 spec->flags |= SIGN;
1095 spec->type = FORMAT_TYPE_INVALID;
1099 if (spec->qualifier == 'L')
1100 spec->type = FORMAT_TYPE_LONG_LONG;
1101 else if (spec->qualifier == 'l') {
1102 if (spec->flags & SIGN)
1103 spec->type = FORMAT_TYPE_LONG;
1105 spec->type = FORMAT_TYPE_ULONG;
1106 } else if (TOLOWER(spec->qualifier) == 'z') {
1107 spec->type = FORMAT_TYPE_SIZE_T;
1108 } else if (spec->qualifier == 't') {
1109 spec->type = FORMAT_TYPE_PTRDIFF;
1110 } else if (spec->qualifier == 'H') {
1111 if (spec->flags & SIGN)
1112 spec->type = FORMAT_TYPE_BYTE;
1114 spec->type = FORMAT_TYPE_UBYTE;
1115 } else if (spec->qualifier == 'h') {
1116 if (spec->flags & SIGN)
1117 spec->type = FORMAT_TYPE_SHORT;
1119 spec->type = FORMAT_TYPE_USHORT;
1121 if (spec->flags & SIGN)
1122 spec->type = FORMAT_TYPE_INT;
1124 spec->type = FORMAT_TYPE_UINT;
1127 return ++fmt - start;
1131 * vsnprintf - Format a string and place it in a buffer
1132 * @buf: The buffer to place the result into
1133 * @size: The size of the buffer, including the trailing null space
1134 * @fmt: The format string to use
1135 * @args: Arguments for the format string
1137 * This function follows C99 vsnprintf, but has some extensions:
1138 * %pS output the name of a text symbol with offset
1139 * %ps output the name of a text symbol without offset
1140 * %pF output the name of a function pointer with its offset
1141 * %pf output the name of a function pointer without its offset
1142 * %pR output the address range in a struct resource
1145 * The return value is the number of characters which would
1146 * be generated for the given input, excluding the trailing
1147 * '\0', as per ISO C99. If you want to have the exact
1148 * number of characters written into @buf as return value
1149 * (not including the trailing '\0'), use vscnprintf(). If the
1150 * return is greater than or equal to @size, the resulting
1151 * string is truncated.
1153 * Call this function if you are already dealing with a va_list.
1154 * You probably want snprintf() instead.
1156 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1158 unsigned long long num;
1161 struct printf_spec spec = {0};
1163 /* Reject out-of-range values early. Large positive sizes are
1164 used for unknown buffer sizes. */
1165 if (WARN_ON_ONCE((int) size < 0))
1171 /* Make sure end is always >= buf */
1178 const char *old_fmt = fmt;
1180 read = format_decode(fmt, &spec);
1184 switch (spec.type) {
1185 case FORMAT_TYPE_NONE: {
1188 if (copy > end - str)
1190 memcpy(str, old_fmt, copy);
1196 case FORMAT_TYPE_WIDTH:
1197 spec.field_width = va_arg(args, int);
1200 case FORMAT_TYPE_PRECISION:
1201 spec.precision = va_arg(args, int);
1204 case FORMAT_TYPE_CHAR:
1205 if (!(spec.flags & LEFT)) {
1206 while (--spec.field_width > 0) {
1213 c = (unsigned char) va_arg(args, int);
1217 while (--spec.field_width > 0) {
1224 case FORMAT_TYPE_STR:
1225 str = string(str, end, va_arg(args, char *), spec);
1228 case FORMAT_TYPE_PTR:
1229 str = pointer(fmt+1, str, end, va_arg(args, void *),
1231 while (isalnum(*fmt))
1235 case FORMAT_TYPE_PERCENT_CHAR:
1241 case FORMAT_TYPE_INVALID:
1247 case FORMAT_TYPE_NRCHARS: {
1248 int qualifier = spec.qualifier;
1250 if (qualifier == 'l') {
1251 long *ip = va_arg(args, long *);
1253 } else if (TOLOWER(qualifier) == 'z') {
1254 size_t *ip = va_arg(args, size_t *);
1257 int *ip = va_arg(args, int *);
1264 switch (spec.type) {
1265 case FORMAT_TYPE_LONG_LONG:
1266 num = va_arg(args, long long);
1268 case FORMAT_TYPE_ULONG:
1269 num = va_arg(args, unsigned long);
1271 case FORMAT_TYPE_LONG:
1272 num = va_arg(args, long);
1274 case FORMAT_TYPE_SIZE_T:
1275 num = va_arg(args, size_t);
1277 case FORMAT_TYPE_PTRDIFF:
1278 num = va_arg(args, ptrdiff_t);
1280 case FORMAT_TYPE_UBYTE:
1281 num = (unsigned char) va_arg(args, int);
1283 case FORMAT_TYPE_BYTE:
1284 num = (signed char) va_arg(args, int);
1286 case FORMAT_TYPE_USHORT:
1287 num = (unsigned short) va_arg(args, int);
1289 case FORMAT_TYPE_SHORT:
1290 num = (short) va_arg(args, int);
1292 case FORMAT_TYPE_INT:
1293 num = (int) va_arg(args, int);
1296 num = va_arg(args, unsigned int);
1299 str = number(str, end, num, spec);
1310 /* the trailing null byte doesn't count towards the total */
1314 EXPORT_SYMBOL(vsnprintf);
1317 * vscnprintf - Format a string and place it in a buffer
1318 * @buf: The buffer to place the result into
1319 * @size: The size of the buffer, including the trailing null space
1320 * @fmt: The format string to use
1321 * @args: Arguments for the format string
1323 * The return value is the number of characters which have been written into
1324 * the @buf not including the trailing '\0'. If @size is <= 0 the function
1327 * Call this function if you are already dealing with a va_list.
1328 * You probably want scnprintf() instead.
1330 * See the vsnprintf() documentation for format string extensions over C99.
1332 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1336 i = vsnprintf(buf, size, fmt, args);
1338 return (i >= size) ? (size - 1) : i;
1340 EXPORT_SYMBOL(vscnprintf);
1343 * snprintf - Format a string and place it in a buffer
1344 * @buf: The buffer to place the result into
1345 * @size: The size of the buffer, including the trailing null space
1346 * @fmt: The format string to use
1347 * @...: Arguments for the format string
1349 * The return value is the number of characters which would be
1350 * generated for the given input, excluding the trailing null,
1351 * as per ISO C99. If the return is greater than or equal to
1352 * @size, the resulting string is truncated.
1354 * See the vsnprintf() documentation for format string extensions over C99.
1356 int snprintf(char *buf, size_t size, const char *fmt, ...)
1361 va_start(args, fmt);
1362 i = vsnprintf(buf, size, fmt, args);
1367 EXPORT_SYMBOL(snprintf);
1370 * scnprintf - Format a string and place it in a buffer
1371 * @buf: The buffer to place the result into
1372 * @size: The size of the buffer, including the trailing null space
1373 * @fmt: The format string to use
1374 * @...: Arguments for the format string
1376 * The return value is the number of characters written into @buf not including
1377 * the trailing '\0'. If @size is <= 0 the function returns 0.
1380 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1385 va_start(args, fmt);
1386 i = vsnprintf(buf, size, fmt, args);
1389 return (i >= size) ? (size - 1) : i;
1391 EXPORT_SYMBOL(scnprintf);
1394 * vsprintf - Format a string and place it in a buffer
1395 * @buf: The buffer to place the result into
1396 * @fmt: The format string to use
1397 * @args: Arguments for the format string
1399 * The function returns the number of characters written
1400 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1403 * Call this function if you are already dealing with a va_list.
1404 * You probably want sprintf() instead.
1406 * See the vsnprintf() documentation for format string extensions over C99.
1408 int vsprintf(char *buf, const char *fmt, va_list args)
1410 return vsnprintf(buf, INT_MAX, fmt, args);
1412 EXPORT_SYMBOL(vsprintf);
1415 * sprintf - Format a string and place it in a buffer
1416 * @buf: The buffer to place the result into
1417 * @fmt: The format string to use
1418 * @...: Arguments for the format string
1420 * The function returns the number of characters written
1421 * into @buf. Use snprintf() or scnprintf() in order to avoid
1424 * See the vsnprintf() documentation for format string extensions over C99.
1426 int sprintf(char *buf, const char *fmt, ...)
1431 va_start(args, fmt);
1432 i = vsnprintf(buf, INT_MAX, fmt, args);
1437 EXPORT_SYMBOL(sprintf);
1439 #ifdef CONFIG_BINARY_PRINTF
1442 * vbin_printf() - VA arguments to binary data
1443 * bstr_printf() - Binary data to text string
1447 * vbin_printf - Parse a format string and place args' binary value in a buffer
1448 * @bin_buf: The buffer to place args' binary value
1449 * @size: The size of the buffer(by words(32bits), not characters)
1450 * @fmt: The format string to use
1451 * @args: Arguments for the format string
1453 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1456 * The return value is the number of words(32bits) which would be generated for
1460 * If the return value is greater than @size, the resulting bin_buf is NOT
1461 * valid for bstr_printf().
1463 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1465 struct printf_spec spec = {0};
1469 str = (char *)bin_buf;
1470 end = (char *)(bin_buf + size);
1472 #define save_arg(type) \
1474 if (sizeof(type) == 8) { \
1475 unsigned long long value; \
1476 str = PTR_ALIGN(str, sizeof(u32)); \
1477 value = va_arg(args, unsigned long long); \
1478 if (str + sizeof(type) <= end) { \
1479 *(u32 *)str = *(u32 *)&value; \
1480 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1483 unsigned long value; \
1484 str = PTR_ALIGN(str, sizeof(type)); \
1485 value = va_arg(args, int); \
1486 if (str + sizeof(type) <= end) \
1487 *(typeof(type) *)str = (type)value; \
1489 str += sizeof(type); \
1493 read = format_decode(fmt, &spec);
1497 switch (spec.type) {
1498 case FORMAT_TYPE_NONE:
1501 case FORMAT_TYPE_WIDTH:
1502 case FORMAT_TYPE_PRECISION:
1506 case FORMAT_TYPE_CHAR:
1510 case FORMAT_TYPE_STR: {
1511 const char *save_str = va_arg(args, char *);
1514 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1515 || (unsigned long)save_str < PAGE_SIZE)
1516 save_str = "(null)";
1517 len = strlen(save_str) + 1;
1518 if (str + len < end)
1519 memcpy(str, save_str, len);
1524 case FORMAT_TYPE_PTR:
1526 /* skip all alphanumeric pointer suffixes */
1527 while (isalnum(*fmt))
1531 case FORMAT_TYPE_PERCENT_CHAR:
1534 case FORMAT_TYPE_INVALID:
1537 case FORMAT_TYPE_NRCHARS: {
1538 /* skip %n 's argument */
1539 int qualifier = spec.qualifier;
1541 if (qualifier == 'l')
1542 skip_arg = va_arg(args, long *);
1543 else if (TOLOWER(qualifier) == 'z')
1544 skip_arg = va_arg(args, size_t *);
1546 skip_arg = va_arg(args, int *);
1551 switch (spec.type) {
1553 case FORMAT_TYPE_LONG_LONG:
1554 save_arg(long long);
1556 case FORMAT_TYPE_ULONG:
1557 case FORMAT_TYPE_LONG:
1558 save_arg(unsigned long);
1560 case FORMAT_TYPE_SIZE_T:
1563 case FORMAT_TYPE_PTRDIFF:
1564 save_arg(ptrdiff_t);
1566 case FORMAT_TYPE_UBYTE:
1567 case FORMAT_TYPE_BYTE:
1570 case FORMAT_TYPE_USHORT:
1571 case FORMAT_TYPE_SHORT:
1580 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1583 EXPORT_SYMBOL_GPL(vbin_printf);
1586 * bstr_printf - Format a string from binary arguments and place it in a buffer
1587 * @buf: The buffer to place the result into
1588 * @size: The size of the buffer, including the trailing null space
1589 * @fmt: The format string to use
1590 * @bin_buf: Binary arguments for the format string
1592 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1593 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1594 * a binary buffer that generated by vbin_printf.
1596 * The format follows C99 vsnprintf, but has some extensions:
1597 * see vsnprintf comment for details.
1599 * The return value is the number of characters which would
1600 * be generated for the given input, excluding the trailing
1601 * '\0', as per ISO C99. If you want to have the exact
1602 * number of characters written into @buf as return value
1603 * (not including the trailing '\0'), use vscnprintf(). If the
1604 * return is greater than or equal to @size, the resulting
1605 * string is truncated.
1607 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1609 unsigned long long num;
1611 const char *args = (const char *)bin_buf;
1612 struct printf_spec spec = {0};
1614 if (WARN_ON_ONCE((int) size < 0))
1620 #define get_arg(type) \
1622 typeof(type) value; \
1623 if (sizeof(type) == 8) { \
1624 args = PTR_ALIGN(args, sizeof(u32)); \
1625 *(u32 *)&value = *(u32 *)args; \
1626 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1628 args = PTR_ALIGN(args, sizeof(type)); \
1629 value = *(typeof(type) *)args; \
1631 args += sizeof(type); \
1635 /* Make sure end is always >= buf */
1643 const char *old_fmt = fmt;
1645 read = format_decode(fmt, &spec);
1649 switch (spec.type) {
1650 case FORMAT_TYPE_NONE: {
1653 if (copy > end - str)
1655 memcpy(str, old_fmt, copy);
1661 case FORMAT_TYPE_WIDTH:
1662 spec.field_width = get_arg(int);
1665 case FORMAT_TYPE_PRECISION:
1666 spec.precision = get_arg(int);
1669 case FORMAT_TYPE_CHAR:
1670 if (!(spec.flags & LEFT)) {
1671 while (--spec.field_width > 0) {
1677 c = (unsigned char) get_arg(char);
1681 while (--spec.field_width > 0) {
1688 case FORMAT_TYPE_STR: {
1689 const char *str_arg = args;
1690 size_t len = strlen(str_arg);
1692 str = string(str, end, (char *)str_arg, spec);
1696 case FORMAT_TYPE_PTR:
1697 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1698 while (isalnum(*fmt))
1702 case FORMAT_TYPE_PERCENT_CHAR:
1708 case FORMAT_TYPE_INVALID:
1714 case FORMAT_TYPE_NRCHARS:
1719 switch (spec.type) {
1721 case FORMAT_TYPE_LONG_LONG:
1722 num = get_arg(long long);
1724 case FORMAT_TYPE_ULONG:
1725 num = get_arg(unsigned long);
1727 case FORMAT_TYPE_LONG:
1728 num = get_arg(unsigned long);
1730 case FORMAT_TYPE_SIZE_T:
1731 num = get_arg(size_t);
1733 case FORMAT_TYPE_PTRDIFF:
1734 num = get_arg(ptrdiff_t);
1736 case FORMAT_TYPE_UBYTE:
1737 num = get_arg(unsigned char);
1739 case FORMAT_TYPE_BYTE:
1740 num = get_arg(signed char);
1742 case FORMAT_TYPE_USHORT:
1743 num = get_arg(unsigned short);
1745 case FORMAT_TYPE_SHORT:
1746 num = get_arg(short);
1748 case FORMAT_TYPE_UINT:
1749 num = get_arg(unsigned int);
1755 str = number(str, end, num, spec);
1768 /* the trailing null byte doesn't count towards the total */
1771 EXPORT_SYMBOL_GPL(bstr_printf);
1774 * bprintf - Parse a format string and place args' binary value in a buffer
1775 * @bin_buf: The buffer to place args' binary value
1776 * @size: The size of the buffer(by words(32bits), not characters)
1777 * @fmt: The format string to use
1778 * @...: Arguments for the format string
1780 * The function returns the number of words(u32) written
1783 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1788 va_start(args, fmt);
1789 ret = vbin_printf(bin_buf, size, fmt, args);
1794 EXPORT_SYMBOL_GPL(bprintf);
1796 #endif /* CONFIG_BINARY_PRINTF */
1799 * vsscanf - Unformat a buffer into a list of arguments
1800 * @buf: input buffer
1801 * @fmt: format of buffer
1804 int vsscanf(const char *buf, const char *fmt, va_list args)
1806 const char *str = buf;
1810 int qualifier, base, field_width;
1813 while (*fmt && *str) {
1814 /* skip any white space in format */
1815 /* white space in format matchs any amount of
1816 * white space, including none, in the input.
1818 if (isspace(*fmt)) {
1819 while (isspace(*fmt))
1821 while (isspace(*str))
1825 /* anything that is not a conversion must match exactly */
1826 if (*fmt != '%' && *fmt) {
1827 if (*fmt++ != *str++)
1836 /* skip this conversion.
1837 * advance both strings to next white space
1840 while (!isspace(*fmt) && *fmt != '%' && *fmt)
1842 while (!isspace(*str) && *str)
1847 /* get field width */
1850 field_width = skip_atoi(&fmt);
1852 /* get conversion qualifier */
1854 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1855 TOLOWER(*fmt) == 'z') {
1857 if (unlikely(qualifier == *fmt)) {
1858 if (qualifier == 'h') {
1861 } else if (qualifier == 'l') {
1876 char *s = (char *)va_arg(args, char*);
1877 if (field_width == -1)
1881 } while (--field_width > 0 && *str);
1887 char *s = (char *)va_arg(args, char *);
1888 if (field_width == -1)
1889 field_width = INT_MAX;
1890 /* first, skip leading white space in buffer */
1891 while (isspace(*str))
1894 /* now copy until next white space */
1895 while (*str && !isspace(*str) && field_width--)
1902 /* return number of characters read so far */
1904 int *i = (int *)va_arg(args, int*);
1922 /* looking for '%' in str */
1927 /* invalid format; stop here */
1931 /* have some sort of integer conversion.
1932 * first, skip white space in buffer.
1934 while (isspace(*str))
1938 if (is_sign && digit == '-')
1942 || (base == 16 && !isxdigit(digit))
1943 || (base == 10 && !isdigit(digit))
1944 || (base == 8 && (!isdigit(digit) || digit > '7'))
1945 || (base == 0 && !isdigit(digit)))
1948 switch (qualifier) {
1949 case 'H': /* that's 'hh' in format */
1951 signed char *s = (signed char *)va_arg(args, signed char *);
1952 *s = (signed char)simple_strtol(str, &next, base);
1954 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
1955 *s = (unsigned char)simple_strtoul(str, &next, base);
1960 short *s = (short *)va_arg(args, short *);
1961 *s = (short)simple_strtol(str, &next, base);
1963 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
1964 *s = (unsigned short)simple_strtoul(str, &next, base);
1969 long *l = (long *)va_arg(args, long *);
1970 *l = simple_strtol(str, &next, base);
1972 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
1973 *l = simple_strtoul(str, &next, base);
1978 long long *l = (long long *)va_arg(args, long long *);
1979 *l = simple_strtoll(str, &next, base);
1981 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
1982 *l = simple_strtoull(str, &next, base);
1988 size_t *s = (size_t *)va_arg(args, size_t *);
1989 *s = (size_t)simple_strtoul(str, &next, base);
1994 int *i = (int *)va_arg(args, int *);
1995 *i = (int)simple_strtol(str, &next, base);
1997 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
1998 *i = (unsigned int)simple_strtoul(str, &next, base);
2010 * Now we've come all the way through so either the input string or the
2011 * format ended. In the former case, there can be a %n at the current
2012 * position in the format that needs to be filled.
2014 if (*fmt == '%' && *(fmt + 1) == 'n') {
2015 int *p = (int *)va_arg(args, int *);
2021 EXPORT_SYMBOL(vsscanf);
2024 * sscanf - Unformat a buffer into a list of arguments
2025 * @buf: input buffer
2026 * @fmt: formatting of buffer
2027 * @...: resulting arguments
2029 int sscanf(const char *buf, const char *fmt, ...)
2034 va_start(args, fmt);
2035 i = vsscanf(buf, fmt, args);
2040 EXPORT_SYMBOL(sscanf);