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>
29 #include <asm/page.h> /* for PAGE_SIZE */
30 #include <asm/div64.h>
31 #include <asm/sections.h> /* for dereference_function_descriptor() */
33 /* Works only for digits and letters, but small and fast */
34 #define TOLOWER(x) ((x) | 0x20)
36 static unsigned int simple_guess_base(const char *cp)
39 if (TOLOWER(cp[1]) == 'x' && isxdigit(cp[2]))
49 * simple_strtoul - convert a string to an unsigned long
50 * @cp: The start of the string
51 * @endp: A pointer to the end of the parsed string will be placed here
52 * @base: The number base to use
54 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
56 unsigned long result = 0;
59 base = simple_guess_base(cp);
61 if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
64 while (isxdigit(*cp)) {
67 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
70 result = result * base + value;
78 EXPORT_SYMBOL(simple_strtoul);
81 * simple_strtol - convert a string to a signed long
82 * @cp: The start of the string
83 * @endp: A pointer to the end of the parsed string will be placed here
84 * @base: The number base to use
86 long simple_strtol(const char *cp, char **endp, unsigned int base)
89 return -simple_strtoul(cp + 1, endp, base);
90 return simple_strtoul(cp, endp, base);
92 EXPORT_SYMBOL(simple_strtol);
95 * simple_strtoull - convert a string to an unsigned long long
96 * @cp: The start of the string
97 * @endp: A pointer to the end of the parsed string will be placed here
98 * @base: The number base to use
100 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
102 unsigned long long result = 0;
105 base = simple_guess_base(cp);
107 if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
110 while (isxdigit(*cp)) {
113 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
116 result = result * base + value;
124 EXPORT_SYMBOL(simple_strtoull);
127 * simple_strtoll - convert a string to a signed long long
128 * @cp: The start of the string
129 * @endp: A pointer to the end of the parsed string will be placed here
130 * @base: The number base to use
132 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
135 return -simple_strtoull(cp + 1, endp, base);
136 return simple_strtoull(cp, endp, base);
140 * strict_strtoul - convert a string to an unsigned long strictly
141 * @cp: The string to be converted
142 * @base: The number base to use
143 * @res: The converted result value
145 * strict_strtoul converts a string to an unsigned long only if the
146 * string is really an unsigned long string, any string containing
147 * any invalid char at the tail will be rejected and -EINVAL is returned,
148 * only a newline char at the tail is acceptible because people generally
149 * change a module parameter in the following way:
151 * echo 1024 > /sys/module/e1000/parameters/copybreak
153 * echo will append a newline to the tail.
155 * It returns 0 if conversion is successful and *res is set to the converted
156 * value, otherwise it returns -EINVAL and *res is set to 0.
158 * simple_strtoul just ignores the successive invalid characters and
159 * return the converted value of prefix part of the string.
161 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
172 val = simple_strtoul(cp, &tail, base);
175 if ((*tail == '\0') ||
176 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
183 EXPORT_SYMBOL(strict_strtoul);
186 * strict_strtol - convert a string to a long strictly
187 * @cp: The string to be converted
188 * @base: The number base to use
189 * @res: The converted result value
191 * strict_strtol is similiar to strict_strtoul, but it allows the first
192 * character of a string is '-'.
194 * It returns 0 if conversion is successful and *res is set to the converted
195 * value, otherwise it returns -EINVAL and *res is set to 0.
197 int strict_strtol(const char *cp, unsigned int base, long *res)
201 ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
205 ret = strict_strtoul(cp, base, (unsigned long *)res);
210 EXPORT_SYMBOL(strict_strtol);
213 * strict_strtoull - convert a string to an unsigned long long strictly
214 * @cp: The string to be converted
215 * @base: The number base to use
216 * @res: The converted result value
218 * strict_strtoull converts a string to an unsigned long long only if the
219 * string is really an unsigned long long string, any string containing
220 * any invalid char at the tail will be rejected and -EINVAL is returned,
221 * only a newline char at the tail is acceptible because people generally
222 * change a module parameter in the following way:
224 * echo 1024 > /sys/module/e1000/parameters/copybreak
226 * echo will append a newline to the tail of the string.
228 * It returns 0 if conversion is successful and *res is set to the converted
229 * value, otherwise it returns -EINVAL and *res is set to 0.
231 * simple_strtoull just ignores the successive invalid characters and
232 * return the converted value of prefix part of the string.
234 int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
237 unsigned long long val;
245 val = simple_strtoull(cp, &tail, base);
248 if ((*tail == '\0') ||
249 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
256 EXPORT_SYMBOL(strict_strtoull);
259 * strict_strtoll - convert a string to a long long strictly
260 * @cp: The string to be converted
261 * @base: The number base to use
262 * @res: The converted result value
264 * strict_strtoll is similiar to strict_strtoull, but it allows the first
265 * character of a string is '-'.
267 * It returns 0 if conversion is successful and *res is set to the converted
268 * value, otherwise it returns -EINVAL and *res is set to 0.
270 int strict_strtoll(const char *cp, unsigned int base, long long *res)
274 ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
278 ret = strict_strtoull(cp, base, (unsigned long long *)res);
283 EXPORT_SYMBOL(strict_strtoll);
285 static int skip_atoi(const char **s)
290 i = i*10 + *((*s)++) - '0';
294 /* Decimal conversion is by far the most typical, and is used
295 * for /proc and /sys data. This directly impacts e.g. top performance
296 * with many processes running. We optimize it for speed
298 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
299 * (with permission from the author, Douglas W. Jones). */
301 /* Formats correctly any integer in [0,99999].
302 * Outputs from one to five digits depending on input.
303 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
304 static char* put_dec_trunc(char *buf, unsigned q)
306 unsigned d3, d2, d1, d0;
311 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
312 q = (d0 * 0xcd) >> 11;
314 *buf++ = d0 + '0'; /* least significant digit */
315 d1 = q + 9*d3 + 5*d2 + d1;
317 q = (d1 * 0xcd) >> 11;
319 *buf++ = d1 + '0'; /* next digit */
322 if ((d2 != 0) || (d3 != 0)) {
325 *buf++ = d2 + '0'; /* next digit */
329 q = (d3 * 0xcd) >> 11;
331 *buf++ = d3 + '0'; /* next digit */
333 *buf++ = q + '0'; /* most sign. digit */
339 /* Same with if's removed. Always emits five digits */
340 static char* put_dec_full(char *buf, unsigned q)
342 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
343 /* but anyway, gcc produces better code with full-sized ints */
344 unsigned d3, d2, d1, d0;
349 /* Possible ways to approx. divide by 10 */
350 /* gcc -O2 replaces multiply with shifts and adds */
351 // (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
352 // (x * 0x67) >> 10: 1100111
353 // (x * 0x34) >> 9: 110100 - same
354 // (x * 0x1a) >> 8: 11010 - same
355 // (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
357 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
358 q = (d0 * 0xcd) >> 11;
361 d1 = q + 9*d3 + 5*d2 + d1;
362 q = (d1 * 0xcd) >> 11;
372 q = (d3 * 0xcd) >> 11; /* - shorter code */
373 /* q = (d3 * 0x67) >> 10; - would also work */
379 /* No inlining helps gcc to use registers better */
380 static noinline char* put_dec(char *buf, unsigned long long num)
385 return put_dec_trunc(buf, num);
386 rem = do_div(num, 100000);
387 buf = put_dec_full(buf, rem);
391 #define ZEROPAD 1 /* pad with zero */
392 #define SIGN 2 /* unsigned/signed long */
393 #define PLUS 4 /* show plus */
394 #define SPACE 8 /* space if plus */
395 #define LEFT 16 /* left justified */
396 #define SMALL 32 /* Must be 32 == 0x20 */
397 #define SPECIAL 64 /* 0x */
400 FORMAT_TYPE_NONE, /* Just a string part */
402 FORMAT_TYPE_PRECISION,
406 FORMAT_TYPE_PERCENT_CHAR,
408 FORMAT_TYPE_LONG_LONG,
423 enum format_type type;
424 int flags; /* flags to number() */
425 int field_width; /* width of output field */
427 int precision; /* # of digits/chars */
431 static char *number(char *buf, char *end, unsigned long long num,
432 struct printf_spec spec)
434 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
435 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
440 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
443 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
444 * produces same digits or (maybe lowercased) letters */
445 locase = (spec.flags & SMALL);
446 if (spec.flags & LEFT)
447 spec.flags &= ~ZEROPAD;
449 if (spec.flags & SIGN) {
450 if ((signed long long) num < 0) {
452 num = - (signed long long) num;
454 } else if (spec.flags & PLUS) {
457 } else if (spec.flags & SPACE) {
468 /* generate full string in tmp[], in reverse order */
472 /* Generic code, for any base:
474 tmp[i++] = (digits[do_div(num,base)] | locase);
477 else if (spec.base != 10) { /* 8 or 16 */
478 int mask = spec.base - 1;
480 if (spec.base == 16) shift = 4;
482 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
485 } else { /* base 10 */
486 i = put_dec(tmp, num) - tmp;
489 /* printing 100 using %2d gives "100", not "00" */
490 if (i > spec.precision)
492 /* leading space padding */
493 spec.field_width -= spec.precision;
494 if (!(spec.flags & (ZEROPAD+LEFT))) {
495 while(--spec.field_width >= 0) {
507 /* "0x" / "0" prefix */
512 if (spec.base == 16) {
514 *buf = ('X' | locase);
518 /* zero or space padding */
519 if (!(spec.flags & LEFT)) {
520 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
521 while (--spec.field_width >= 0) {
527 /* hmm even more zero padding? */
528 while (i <= --spec.precision) {
533 /* actual digits of result */
539 /* trailing space padding */
540 while (--spec.field_width >= 0) {
548 static char *string(char *buf, char *end, char *s, struct printf_spec spec)
552 if ((unsigned long)s < PAGE_SIZE)
555 len = strnlen(s, spec.precision);
557 if (!(spec.flags & LEFT)) {
558 while (len < spec.field_width--) {
564 for (i = 0; i < len; ++i) {
569 while (len < spec.field_width--) {
577 static char *symbol_string(char *buf, char *end, void *ptr,
578 struct printf_spec spec)
580 unsigned long value = (unsigned long) ptr;
581 #ifdef CONFIG_KALLSYMS
582 char sym[KSYM_SYMBOL_LEN];
583 sprint_symbol(sym, value);
584 return string(buf, end, sym, spec);
586 spec.field_width = 2*sizeof(void *);
587 spec.flags |= SPECIAL | SMALL | ZEROPAD;
589 return number(buf, end, value, spec);
593 static char *resource_string(char *buf, char *end, struct resource *res,
594 struct printf_spec spec)
596 #ifndef IO_RSRC_PRINTK_SIZE
597 #define IO_RSRC_PRINTK_SIZE 4
600 #ifndef MEM_RSRC_PRINTK_SIZE
601 #define MEM_RSRC_PRINTK_SIZE 8
603 struct printf_spec num_spec = {
606 .flags = SPECIAL | SMALL | ZEROPAD,
608 /* room for the actual numbers, the two "0x", -, [, ] and the final zero */
609 char sym[4*sizeof(resource_size_t) + 8];
610 char *p = sym, *pend = sym + sizeof(sym);
613 if (res->flags & IORESOURCE_IO)
614 size = IO_RSRC_PRINTK_SIZE;
615 else if (res->flags & IORESOURCE_MEM)
616 size = MEM_RSRC_PRINTK_SIZE;
619 num_spec.field_width = size;
620 p = number(p, pend, res->start, num_spec);
622 p = number(p, pend, res->end, num_spec);
626 return string(buf, end, sym, spec);
629 static char *mac_address_string(char *buf, char *end, u8 *addr,
630 struct printf_spec spec)
632 char mac_addr[6 * 3]; /* (6 * 2 hex digits), 5 colons and trailing zero */
636 for (i = 0; i < 6; i++) {
637 p = pack_hex_byte(p, addr[i]);
638 if (!(spec.flags & SPECIAL) && i != 5)
642 spec.flags &= ~SPECIAL;
644 return string(buf, end, mac_addr, spec);
647 static char *ip6_addr_string(char *buf, char *end, u8 *addr,
648 struct printf_spec spec)
650 char ip6_addr[8 * 5]; /* (8 * 4 hex digits), 7 colons and trailing zero */
654 for (i = 0; i < 8; i++) {
655 p = pack_hex_byte(p, addr[2 * i]);
656 p = pack_hex_byte(p, addr[2 * i + 1]);
657 if (!(spec.flags & SPECIAL) && i != 7)
661 spec.flags &= ~SPECIAL;
663 return string(buf, end, ip6_addr, spec);
666 static char *ip4_addr_string(char *buf, char *end, u8 *addr,
667 struct printf_spec spec)
669 char ip4_addr[4 * 4]; /* (4 * 3 decimal digits), 3 dots and trailing zero */
670 char temp[3]; /* hold each IP quad in reverse order */
674 for (i = 0; i < 4; i++) {
675 digits = put_dec_trunc(temp, addr[i]) - temp;
676 /* reverse the digits in the quad */
683 spec.flags &= ~SPECIAL;
685 return string(buf, end, ip4_addr, spec);
689 * Show a '%p' thing. A kernel extension is that the '%p' is followed
690 * by an extra set of alphanumeric characters that are extended format
693 * Right now we handle:
695 * - 'F' For symbolic function descriptor pointers
696 * - 'S' For symbolic direct pointers
697 * - 'R' For a struct resource pointer, it prints the range of
698 * addresses (not the name nor the flags)
699 * - 'M' For a 6-byte MAC address, it prints the address in the
700 * usual colon-separated hex notation
701 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
702 * decimal for v4 and colon separated network-order 16 bit hex for v6)
703 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
706 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
707 * function pointers are really function descriptors, which contain a
708 * pointer to the real address.
710 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
711 struct printf_spec spec)
714 return string(buf, end, "(null)", spec);
718 ptr = dereference_function_descriptor(ptr);
721 return symbol_string(buf, end, ptr, spec);
723 return resource_string(buf, end, ptr, spec);
725 spec.flags |= SPECIAL;
728 return mac_address_string(buf, end, ptr, spec);
730 spec.flags |= SPECIAL;
734 return ip6_addr_string(buf, end, ptr, spec);
736 return ip4_addr_string(buf, end, ptr, spec);
737 spec.flags &= ~SPECIAL;
741 if (spec.field_width == -1) {
742 spec.field_width = 2*sizeof(void *);
743 spec.flags |= ZEROPAD;
747 return number(buf, end, (unsigned long) ptr, spec);
751 * Helper function to decode printf style format.
752 * Each call decode a token from the format and return the
753 * number of characters read (or likely the delta where it wants
754 * to go on the next call).
755 * The decoded token is returned through the parameters
757 * 'h', 'l', or 'L' for integer fields
758 * 'z' support added 23/7/1999 S.H.
759 * 'z' changed to 'Z' --davidm 1/25/99
760 * 't' added for ptrdiff_t
762 * @fmt: the format string
763 * @type of the token returned
764 * @flags: various flags such as +, -, # tokens..
765 * @field_width: overwritten width
766 * @base: base of the number (octal, hex, ...)
767 * @precision: precision of a number
768 * @qualifier: qualifier of a number (long, size_t, ...)
770 static int format_decode(const char *fmt, struct printf_spec *spec)
772 const char *start = fmt;
774 /* we finished early by reading the field width */
775 if (spec->type == FORMAT_TYPE_WIDTH) {
776 if (spec->field_width < 0) {
777 spec->field_width = -spec->field_width;
780 spec->type = FORMAT_TYPE_NONE;
784 /* we finished early by reading the precision */
785 if (spec->type == FORMAT_TYPE_PRECISION) {
786 if (spec->precision < 0)
789 spec->type = FORMAT_TYPE_NONE;
794 spec->type = FORMAT_TYPE_NONE;
796 for (; *fmt ; ++fmt) {
801 /* Return the current non-format string */
802 if (fmt != start || !*fmt)
808 while (1) { /* this also skips first '%' */
814 case '-': spec->flags |= LEFT; break;
815 case '+': spec->flags |= PLUS; break;
816 case ' ': spec->flags |= SPACE; break;
817 case '#': spec->flags |= SPECIAL; break;
818 case '0': spec->flags |= ZEROPAD; break;
819 default: found = false;
826 /* get field width */
827 spec->field_width = -1;
830 spec->field_width = skip_atoi(&fmt);
831 else if (*fmt == '*') {
832 /* it's the next argument */
833 spec->type = FORMAT_TYPE_WIDTH;
834 return ++fmt - start;
838 /* get the precision */
839 spec->precision = -1;
843 spec->precision = skip_atoi(&fmt);
844 if (spec->precision < 0)
846 } else if (*fmt == '*') {
847 /* it's the next argument */
848 spec->type = FORMAT_TYPE_PRECISION;
849 return ++fmt - start;
854 /* get the conversion qualifier */
855 spec->qualifier = -1;
856 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
857 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
858 spec->qualifier = *fmt++;
859 if (unlikely(spec->qualifier == *fmt)) {
860 if (spec->qualifier == 'l') {
861 spec->qualifier = 'L';
863 } else if (spec->qualifier == 'h') {
864 spec->qualifier = 'H';
874 spec->type = FORMAT_TYPE_CHAR;
875 return ++fmt - start;
878 spec->type = FORMAT_TYPE_STR;
879 return ++fmt - start;
882 spec->type = FORMAT_TYPE_PTR;
887 spec->type = FORMAT_TYPE_NRCHARS;
888 return ++fmt - start;
891 spec->type = FORMAT_TYPE_PERCENT_CHAR;
892 return ++fmt - start;
894 /* integer number formats - set up the flags and "break" */
900 spec->flags |= SMALL;
913 spec->type = FORMAT_TYPE_INVALID;
917 if (spec->qualifier == 'L')
918 spec->type = FORMAT_TYPE_LONG_LONG;
919 else if (spec->qualifier == 'l') {
920 if (spec->flags & SIGN)
921 spec->type = FORMAT_TYPE_LONG;
923 spec->type = FORMAT_TYPE_ULONG;
924 } else if (spec->qualifier == 'Z' || spec->qualifier == 'z') {
925 spec->type = FORMAT_TYPE_SIZE_T;
926 } else if (spec->qualifier == 't') {
927 spec->type = FORMAT_TYPE_PTRDIFF;
928 } else if (spec->qualifier == 'H') {
929 if (spec->flags & SIGN)
930 spec->type = FORMAT_TYPE_BYTE;
932 spec->type = FORMAT_TYPE_UBYTE;
933 } else if (spec->qualifier == 'h') {
934 if (spec->flags & SIGN)
935 spec->type = FORMAT_TYPE_SHORT;
937 spec->type = FORMAT_TYPE_USHORT;
939 if (spec->flags & SIGN)
940 spec->type = FORMAT_TYPE_INT;
942 spec->type = FORMAT_TYPE_UINT;
945 return ++fmt - start;
949 * vsnprintf - Format a string and place it in a buffer
950 * @buf: The buffer to place the result into
951 * @size: The size of the buffer, including the trailing null space
952 * @fmt: The format string to use
953 * @args: Arguments for the format string
955 * This function follows C99 vsnprintf, but has some extensions:
956 * %pS output the name of a text symbol
957 * %pF output the name of a function pointer
958 * %pR output the address range in a struct resource
960 * The return value is the number of characters which would
961 * be generated for the given input, excluding the trailing
962 * '\0', as per ISO C99. If you want to have the exact
963 * number of characters written into @buf as return value
964 * (not including the trailing '\0'), use vscnprintf(). If the
965 * return is greater than or equal to @size, the resulting
966 * string is truncated.
968 * Call this function if you are already dealing with a va_list.
969 * You probably want snprintf() instead.
971 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
973 unsigned long long num;
976 struct printf_spec spec = {0};
978 /* Reject out-of-range values early. Large positive sizes are
979 used for unknown buffer sizes. */
980 if (unlikely((int) size < 0)) {
981 /* There can be only one.. */
982 static char warn = 1;
991 /* Make sure end is always >= buf */
998 const char *old_fmt = fmt;
1000 read = format_decode(fmt, &spec);
1004 switch (spec.type) {
1005 case FORMAT_TYPE_NONE: {
1008 if (copy > end - str)
1010 memcpy(str, old_fmt, copy);
1016 case FORMAT_TYPE_WIDTH:
1017 spec.field_width = va_arg(args, int);
1020 case FORMAT_TYPE_PRECISION:
1021 spec.precision = va_arg(args, int);
1024 case FORMAT_TYPE_CHAR:
1025 if (!(spec.flags & LEFT)) {
1026 while (--spec.field_width > 0) {
1033 c = (unsigned char) va_arg(args, int);
1037 while (--spec.field_width > 0) {
1044 case FORMAT_TYPE_STR:
1045 str = string(str, end, va_arg(args, char *), spec);
1048 case FORMAT_TYPE_PTR:
1049 str = pointer(fmt+1, str, end, va_arg(args, void *),
1051 while (isalnum(*fmt))
1055 case FORMAT_TYPE_PERCENT_CHAR:
1061 case FORMAT_TYPE_INVALID:
1067 case FORMAT_TYPE_NRCHARS: {
1068 int qualifier = spec.qualifier;
1070 if (qualifier == 'l') {
1071 long *ip = va_arg(args, long *);
1073 } else if (qualifier == 'Z' ||
1075 size_t *ip = va_arg(args, size_t *);
1078 int *ip = va_arg(args, int *);
1085 switch (spec.type) {
1086 case FORMAT_TYPE_LONG_LONG:
1087 num = va_arg(args, long long);
1089 case FORMAT_TYPE_ULONG:
1090 num = va_arg(args, unsigned long);
1092 case FORMAT_TYPE_LONG:
1093 num = va_arg(args, long);
1095 case FORMAT_TYPE_SIZE_T:
1096 num = va_arg(args, size_t);
1098 case FORMAT_TYPE_PTRDIFF:
1099 num = va_arg(args, ptrdiff_t);
1101 case FORMAT_TYPE_UBYTE:
1102 num = (unsigned char) va_arg(args, int);
1104 case FORMAT_TYPE_BYTE:
1105 num = (signed char) va_arg(args, int);
1107 case FORMAT_TYPE_USHORT:
1108 num = (unsigned short) va_arg(args, int);
1110 case FORMAT_TYPE_SHORT:
1111 num = (short) va_arg(args, int);
1113 case FORMAT_TYPE_INT:
1114 num = (int) va_arg(args, int);
1117 num = va_arg(args, unsigned int);
1120 str = number(str, end, num, spec);
1131 /* the trailing null byte doesn't count towards the total */
1135 EXPORT_SYMBOL(vsnprintf);
1138 * vscnprintf - Format a string and place it in a buffer
1139 * @buf: The buffer to place the result into
1140 * @size: The size of the buffer, including the trailing null space
1141 * @fmt: The format string to use
1142 * @args: Arguments for the format string
1144 * The return value is the number of characters which have been written into
1145 * the @buf not including the trailing '\0'. If @size is <= 0 the function
1148 * Call this function if you are already dealing with a va_list.
1149 * You probably want scnprintf() instead.
1151 * See the vsnprintf() documentation for format string extensions over C99.
1153 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1157 i=vsnprintf(buf,size,fmt,args);
1158 return (i >= size) ? (size - 1) : i;
1160 EXPORT_SYMBOL(vscnprintf);
1163 * snprintf - Format a string and place it in a buffer
1164 * @buf: The buffer to place the result into
1165 * @size: The size of the buffer, including the trailing null space
1166 * @fmt: The format string to use
1167 * @...: Arguments for the format string
1169 * The return value is the number of characters which would be
1170 * generated for the given input, excluding the trailing null,
1171 * as per ISO C99. If the return is greater than or equal to
1172 * @size, the resulting string is truncated.
1174 * See the vsnprintf() documentation for format string extensions over C99.
1176 int snprintf(char * buf, size_t size, const char *fmt, ...)
1181 va_start(args, fmt);
1182 i=vsnprintf(buf,size,fmt,args);
1186 EXPORT_SYMBOL(snprintf);
1189 * scnprintf - Format a string and place it in a buffer
1190 * @buf: The buffer to place the result into
1191 * @size: The size of the buffer, including the trailing null space
1192 * @fmt: The format string to use
1193 * @...: Arguments for the format string
1195 * The return value is the number of characters written into @buf not including
1196 * the trailing '\0'. If @size is <= 0 the function returns 0.
1199 int scnprintf(char * buf, size_t size, const char *fmt, ...)
1204 va_start(args, fmt);
1205 i = vsnprintf(buf, size, fmt, args);
1207 return (i >= size) ? (size - 1) : i;
1209 EXPORT_SYMBOL(scnprintf);
1212 * vsprintf - Format a string and place it in a buffer
1213 * @buf: The buffer to place the result into
1214 * @fmt: The format string to use
1215 * @args: Arguments for the format string
1217 * The function returns the number of characters written
1218 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1221 * Call this function if you are already dealing with a va_list.
1222 * You probably want sprintf() instead.
1224 * See the vsnprintf() documentation for format string extensions over C99.
1226 int vsprintf(char *buf, const char *fmt, va_list args)
1228 return vsnprintf(buf, INT_MAX, fmt, args);
1230 EXPORT_SYMBOL(vsprintf);
1233 * sprintf - Format a string and place it in a buffer
1234 * @buf: The buffer to place the result into
1235 * @fmt: The format string to use
1236 * @...: Arguments for the format string
1238 * The function returns the number of characters written
1239 * into @buf. Use snprintf() or scnprintf() in order to avoid
1242 * See the vsnprintf() documentation for format string extensions over C99.
1244 int sprintf(char * buf, const char *fmt, ...)
1249 va_start(args, fmt);
1250 i=vsnprintf(buf, INT_MAX, fmt, args);
1254 EXPORT_SYMBOL(sprintf);
1256 #ifdef CONFIG_BINARY_PRINTF
1259 * vbin_printf() - VA arguments to binary data
1260 * bstr_printf() - Binary data to text string
1264 * vbin_printf - Parse a format string and place args' binary value in a buffer
1265 * @bin_buf: The buffer to place args' binary value
1266 * @size: The size of the buffer(by words(32bits), not characters)
1267 * @fmt: The format string to use
1268 * @args: Arguments for the format string
1270 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1273 * The return value is the number of words(32bits) which would be generated for
1277 * If the return value is greater than @size, the resulting bin_buf is NOT
1278 * valid for bstr_printf().
1280 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1282 struct printf_spec spec = {0};
1286 str = (char *)bin_buf;
1287 end = (char *)(bin_buf + size);
1289 #define save_arg(type) \
1291 if (sizeof(type) == 8) { \
1292 unsigned long long value; \
1293 str = PTR_ALIGN(str, sizeof(u32)); \
1294 value = va_arg(args, unsigned long long); \
1295 if (str + sizeof(type) <= end) { \
1296 *(u32 *)str = *(u32 *)&value; \
1297 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1300 unsigned long value; \
1301 str = PTR_ALIGN(str, sizeof(type)); \
1302 value = va_arg(args, int); \
1303 if (str + sizeof(type) <= end) \
1304 *(typeof(type) *)str = (type)value; \
1306 str += sizeof(type); \
1311 read = format_decode(fmt, &spec);
1315 switch (spec.type) {
1316 case FORMAT_TYPE_NONE:
1319 case FORMAT_TYPE_WIDTH:
1320 case FORMAT_TYPE_PRECISION:
1324 case FORMAT_TYPE_CHAR:
1328 case FORMAT_TYPE_STR: {
1329 const char *save_str = va_arg(args, char *);
1331 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1332 || (unsigned long)save_str < PAGE_SIZE)
1333 save_str = "<NULL>";
1334 len = strlen(save_str);
1335 if (str + len + 1 < end)
1336 memcpy(str, save_str, len + 1);
1341 case FORMAT_TYPE_PTR:
1343 /* skip all alphanumeric pointer suffixes */
1344 while (isalnum(*fmt))
1348 case FORMAT_TYPE_PERCENT_CHAR:
1351 case FORMAT_TYPE_INVALID:
1354 case FORMAT_TYPE_NRCHARS: {
1355 /* skip %n 's argument */
1356 int qualifier = spec.qualifier;
1358 if (qualifier == 'l')
1359 skip_arg = va_arg(args, long *);
1360 else if (qualifier == 'Z' || qualifier == 'z')
1361 skip_arg = va_arg(args, size_t *);
1363 skip_arg = va_arg(args, int *);
1368 switch (spec.type) {
1370 case FORMAT_TYPE_LONG_LONG:
1371 save_arg(long long);
1373 case FORMAT_TYPE_ULONG:
1374 case FORMAT_TYPE_LONG:
1375 save_arg(unsigned long);
1377 case FORMAT_TYPE_SIZE_T:
1380 case FORMAT_TYPE_PTRDIFF:
1381 save_arg(ptrdiff_t);
1383 case FORMAT_TYPE_UBYTE:
1384 case FORMAT_TYPE_BYTE:
1387 case FORMAT_TYPE_USHORT:
1388 case FORMAT_TYPE_SHORT:
1396 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1400 EXPORT_SYMBOL_GPL(vbin_printf);
1403 * bstr_printf - Format a string from binary arguments and place it in a buffer
1404 * @buf: The buffer to place the result into
1405 * @size: The size of the buffer, including the trailing null space
1406 * @fmt: The format string to use
1407 * @bin_buf: Binary arguments for the format string
1409 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1410 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1411 * a binary buffer that generated by vbin_printf.
1413 * The format follows C99 vsnprintf, but has some extensions:
1414 * %pS output the name of a text symbol
1415 * %pF output the name of a function pointer
1416 * %pR output the address range in a struct resource
1419 * The return value is the number of characters which would
1420 * be generated for the given input, excluding the trailing
1421 * '\0', as per ISO C99. If you want to have the exact
1422 * number of characters written into @buf as return value
1423 * (not including the trailing '\0'), use vscnprintf(). If the
1424 * return is greater than or equal to @size, the resulting
1425 * string is truncated.
1427 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1429 unsigned long long num;
1431 const char *args = (const char *)bin_buf;
1433 struct printf_spec spec = {0};
1435 if (unlikely((int) size < 0)) {
1436 /* There can be only one.. */
1437 static char warn = 1;
1446 #define get_arg(type) \
1448 typeof(type) value; \
1449 if (sizeof(type) == 8) { \
1450 args = PTR_ALIGN(args, sizeof(u32)); \
1451 *(u32 *)&value = *(u32 *)args; \
1452 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1454 args = PTR_ALIGN(args, sizeof(type)); \
1455 value = *(typeof(type) *)args; \
1457 args += sizeof(type); \
1461 /* Make sure end is always >= buf */
1469 const char *old_fmt = fmt;
1471 read = format_decode(fmt, &spec);
1475 switch (spec.type) {
1476 case FORMAT_TYPE_NONE: {
1479 if (copy > end - str)
1481 memcpy(str, old_fmt, copy);
1487 case FORMAT_TYPE_WIDTH:
1488 spec.field_width = get_arg(int);
1491 case FORMAT_TYPE_PRECISION:
1492 spec.precision = get_arg(int);
1495 case FORMAT_TYPE_CHAR:
1496 if (!(spec.flags & LEFT)) {
1497 while (--spec.field_width > 0) {
1503 c = (unsigned char) get_arg(char);
1507 while (--spec.field_width > 0) {
1514 case FORMAT_TYPE_STR: {
1515 const char *str_arg = args;
1516 size_t len = strlen(str_arg);
1518 str = string(str, end, (char *)str_arg, spec);
1522 case FORMAT_TYPE_PTR:
1523 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1524 while (isalnum(*fmt))
1528 case FORMAT_TYPE_PERCENT_CHAR:
1534 case FORMAT_TYPE_INVALID:
1540 case FORMAT_TYPE_NRCHARS:
1545 switch (spec.type) {
1547 case FORMAT_TYPE_LONG_LONG:
1548 num = get_arg(long long);
1550 case FORMAT_TYPE_ULONG:
1551 num = get_arg(unsigned long);
1553 case FORMAT_TYPE_LONG:
1554 num = get_arg(unsigned long);
1556 case FORMAT_TYPE_SIZE_T:
1557 num = get_arg(size_t);
1559 case FORMAT_TYPE_PTRDIFF:
1560 num = get_arg(ptrdiff_t);
1562 case FORMAT_TYPE_UBYTE:
1563 num = get_arg(unsigned char);
1565 case FORMAT_TYPE_BYTE:
1566 num = get_arg(signed char);
1568 case FORMAT_TYPE_USHORT:
1569 num = get_arg(unsigned short);
1571 case FORMAT_TYPE_SHORT:
1572 num = get_arg(short);
1574 case FORMAT_TYPE_UINT:
1575 num = get_arg(unsigned int);
1581 str = number(str, end, num, spec);
1594 /* the trailing null byte doesn't count towards the total */
1597 EXPORT_SYMBOL_GPL(bstr_printf);
1600 * bprintf - Parse a format string and place args' binary value in a buffer
1601 * @bin_buf: The buffer to place args' binary value
1602 * @size: The size of the buffer(by words(32bits), not characters)
1603 * @fmt: The format string to use
1604 * @...: Arguments for the format string
1606 * The function returns the number of words(u32) written
1609 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1614 va_start(args, fmt);
1615 ret = vbin_printf(bin_buf, size, fmt, args);
1619 EXPORT_SYMBOL_GPL(bprintf);
1621 #endif /* CONFIG_BINARY_PRINTF */
1624 * vsscanf - Unformat a buffer into a list of arguments
1625 * @buf: input buffer
1626 * @fmt: format of buffer
1629 int vsscanf(const char * buf, const char * fmt, va_list args)
1631 const char *str = buf;
1640 while(*fmt && *str) {
1641 /* skip any white space in format */
1642 /* white space in format matchs any amount of
1643 * white space, including none, in the input.
1645 if (isspace(*fmt)) {
1646 while (isspace(*fmt))
1648 while (isspace(*str))
1652 /* anything that is not a conversion must match exactly */
1653 if (*fmt != '%' && *fmt) {
1654 if (*fmt++ != *str++)
1663 /* skip this conversion.
1664 * advance both strings to next white space
1667 while (!isspace(*fmt) && *fmt)
1669 while (!isspace(*str) && *str)
1674 /* get field width */
1677 field_width = skip_atoi(&fmt);
1679 /* get conversion qualifier */
1681 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
1682 *fmt == 'Z' || *fmt == 'z') {
1684 if (unlikely(qualifier == *fmt)) {
1685 if (qualifier == 'h') {
1688 } else if (qualifier == 'l') {
1703 char *s = (char *) va_arg(args,char*);
1704 if (field_width == -1)
1708 } while (--field_width > 0 && *str);
1714 char *s = (char *) va_arg(args, char *);
1715 if(field_width == -1)
1716 field_width = INT_MAX;
1717 /* first, skip leading white space in buffer */
1718 while (isspace(*str))
1721 /* now copy until next white space */
1722 while (*str && !isspace(*str) && field_width--) {
1730 /* return number of characters read so far */
1732 int *i = (int *)va_arg(args,int*);
1750 /* looking for '%' in str */
1755 /* invalid format; stop here */
1759 /* have some sort of integer conversion.
1760 * first, skip white space in buffer.
1762 while (isspace(*str))
1766 if (is_sign && digit == '-')
1770 || (base == 16 && !isxdigit(digit))
1771 || (base == 10 && !isdigit(digit))
1772 || (base == 8 && (!isdigit(digit) || digit > '7'))
1773 || (base == 0 && !isdigit(digit)))
1777 case 'H': /* that's 'hh' in format */
1779 signed char *s = (signed char *) va_arg(args,signed char *);
1780 *s = (signed char) simple_strtol(str,&next,base);
1782 unsigned char *s = (unsigned char *) va_arg(args, unsigned char *);
1783 *s = (unsigned char) simple_strtoul(str, &next, base);
1788 short *s = (short *) va_arg(args,short *);
1789 *s = (short) simple_strtol(str,&next,base);
1791 unsigned short *s = (unsigned short *) va_arg(args, unsigned short *);
1792 *s = (unsigned short) simple_strtoul(str, &next, base);
1797 long *l = (long *) va_arg(args,long *);
1798 *l = simple_strtol(str,&next,base);
1800 unsigned long *l = (unsigned long*) va_arg(args,unsigned long*);
1801 *l = simple_strtoul(str,&next,base);
1806 long long *l = (long long*) va_arg(args,long long *);
1807 *l = simple_strtoll(str,&next,base);
1809 unsigned long long *l = (unsigned long long*) va_arg(args,unsigned long long*);
1810 *l = simple_strtoull(str,&next,base);
1816 size_t *s = (size_t*) va_arg(args,size_t*);
1817 *s = (size_t) simple_strtoul(str,&next,base);
1822 int *i = (int *) va_arg(args, int*);
1823 *i = (int) simple_strtol(str,&next,base);
1825 unsigned int *i = (unsigned int*) va_arg(args, unsigned int*);
1826 *i = (unsigned int) simple_strtoul(str,&next,base);
1838 * Now we've come all the way through so either the input string or the
1839 * format ended. In the former case, there can be a %n at the current
1840 * position in the format that needs to be filled.
1842 if (*fmt == '%' && *(fmt + 1) == 'n') {
1843 int *p = (int *)va_arg(args, int *);
1849 EXPORT_SYMBOL(vsscanf);
1852 * sscanf - Unformat a buffer into a list of arguments
1853 * @buf: input buffer
1854 * @fmt: formatting of buffer
1855 * @...: resulting arguments
1857 int sscanf(const char * buf, const char * fmt, ...)
1863 i = vsscanf(buf,fmt,args);
1867 EXPORT_SYMBOL(sscanf);