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
,
421 enum format_type type
;
422 int flags
; /* flags to number() */
423 int field_width
; /* width of output field */
425 int precision
; /* # of digits/chars */
429 static char *number(char *buf
, char *end
, unsigned long long num
,
430 struct printf_spec spec
)
432 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
433 static const char digits
[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
438 int need_pfx
= ((spec
.flags
& SPECIAL
) && spec
.base
!= 10);
441 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
442 * produces same digits or (maybe lowercased) letters */
443 locase
= (spec
.flags
& SMALL
);
444 if (spec
.flags
& LEFT
)
445 spec
.flags
&= ~ZEROPAD
;
447 if (spec
.flags
& SIGN
) {
448 if ((signed long long) num
< 0) {
450 num
= - (signed long long) num
;
452 } else if (spec
.flags
& PLUS
) {
455 } else if (spec
.flags
& SPACE
) {
466 /* generate full string in tmp[], in reverse order */
470 /* Generic code, for any base:
472 tmp[i++] = (digits[do_div(num,base)] | locase);
475 else if (spec
.base
!= 10) { /* 8 or 16 */
476 int mask
= spec
.base
- 1;
478 if (spec
.base
== 16) shift
= 4;
480 tmp
[i
++] = (digits
[((unsigned char)num
) & mask
] | locase
);
483 } else { /* base 10 */
484 i
= put_dec(tmp
, num
) - tmp
;
487 /* printing 100 using %2d gives "100", not "00" */
488 if (i
> spec
.precision
)
490 /* leading space padding */
491 spec
.field_width
-= spec
.precision
;
492 if (!(spec
.flags
& (ZEROPAD
+LEFT
))) {
493 while(--spec
.field_width
>= 0) {
505 /* "0x" / "0" prefix */
510 if (spec
.base
== 16) {
512 *buf
= ('X' | locase
);
516 /* zero or space padding */
517 if (!(spec
.flags
& LEFT
)) {
518 char c
= (spec
.flags
& ZEROPAD
) ? '0' : ' ';
519 while (--spec
.field_width
>= 0) {
525 /* hmm even more zero padding? */
526 while (i
<= --spec
.precision
) {
531 /* actual digits of result */
537 /* trailing space padding */
538 while (--spec
.field_width
>= 0) {
546 static char *string(char *buf
, char *end
, char *s
, struct printf_spec spec
)
550 if ((unsigned long)s
< PAGE_SIZE
)
553 len
= strnlen(s
, spec
.precision
);
555 if (!(spec
.flags
& LEFT
)) {
556 while (len
< spec
.field_width
--) {
562 for (i
= 0; i
< len
; ++i
) {
567 while (len
< spec
.field_width
--) {
575 static char *symbol_string(char *buf
, char *end
, void *ptr
,
576 struct printf_spec spec
)
578 unsigned long value
= (unsigned long) ptr
;
579 #ifdef CONFIG_KALLSYMS
580 char sym
[KSYM_SYMBOL_LEN
];
581 sprint_symbol(sym
, value
);
582 return string(buf
, end
, sym
, spec
);
584 spec
.field_width
= 2*sizeof(void *);
585 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
587 return number(buf
, end
, value
, spec
);
591 static char *resource_string(char *buf
, char *end
, struct resource
*res
,
592 struct printf_spec spec
)
594 #ifndef IO_RSRC_PRINTK_SIZE
595 #define IO_RSRC_PRINTK_SIZE 4
598 #ifndef MEM_RSRC_PRINTK_SIZE
599 #define MEM_RSRC_PRINTK_SIZE 8
601 struct printf_spec num_spec
= {
604 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
606 /* room for the actual numbers, the two "0x", -, [, ] and the final zero */
607 char sym
[4*sizeof(resource_size_t
) + 8];
608 char *p
= sym
, *pend
= sym
+ sizeof(sym
);
611 if (res
->flags
& IORESOURCE_IO
)
612 size
= IO_RSRC_PRINTK_SIZE
;
613 else if (res
->flags
& IORESOURCE_MEM
)
614 size
= MEM_RSRC_PRINTK_SIZE
;
617 num_spec
.field_width
= size
;
618 p
= number(p
, pend
, res
->start
, num_spec
);
620 p
= number(p
, pend
, res
->end
, num_spec
);
624 return string(buf
, end
, sym
, spec
);
627 static char *mac_address_string(char *buf
, char *end
, u8
*addr
,
628 struct printf_spec spec
)
630 char mac_addr
[6 * 3]; /* (6 * 2 hex digits), 5 colons and trailing zero */
634 for (i
= 0; i
< 6; i
++) {
635 p
= pack_hex_byte(p
, addr
[i
]);
636 if (!(spec
.flags
& SPECIAL
) && i
!= 5)
640 spec
.flags
&= ~SPECIAL
;
642 return string(buf
, end
, mac_addr
, spec
);
645 static char *ip6_addr_string(char *buf
, char *end
, u8
*addr
,
646 struct printf_spec spec
)
648 char ip6_addr
[8 * 5]; /* (8 * 4 hex digits), 7 colons and trailing zero */
652 for (i
= 0; i
< 8; i
++) {
653 p
= pack_hex_byte(p
, addr
[2 * i
]);
654 p
= pack_hex_byte(p
, addr
[2 * i
+ 1]);
655 if (!(spec
.flags
& SPECIAL
) && i
!= 7)
659 spec
.flags
&= ~SPECIAL
;
661 return string(buf
, end
, ip6_addr
, spec
);
664 static char *ip4_addr_string(char *buf
, char *end
, u8
*addr
,
665 struct printf_spec spec
)
667 char ip4_addr
[4 * 4]; /* (4 * 3 decimal digits), 3 dots and trailing zero */
668 char temp
[3]; /* hold each IP quad in reverse order */
672 for (i
= 0; i
< 4; i
++) {
673 digits
= put_dec_trunc(temp
, addr
[i
]) - temp
;
674 /* reverse the digits in the quad */
681 spec
.flags
&= ~SPECIAL
;
683 return string(buf
, end
, ip4_addr
, spec
);
687 * Show a '%p' thing. A kernel extension is that the '%p' is followed
688 * by an extra set of alphanumeric characters that are extended format
691 * Right now we handle:
693 * - 'F' For symbolic function descriptor pointers
694 * - 'S' For symbolic direct pointers
695 * - 'R' For a struct resource pointer, it prints the range of
696 * addresses (not the name nor the flags)
697 * - 'M' For a 6-byte MAC address, it prints the address in the
698 * usual colon-separated hex notation
699 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
700 * decimal for v4 and colon separated network-order 16 bit hex for v6)
701 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
704 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
705 * function pointers are really function descriptors, which contain a
706 * pointer to the real address.
708 static char *pointer(const char *fmt
, char *buf
, char *end
, void *ptr
,
709 struct printf_spec spec
)
712 return string(buf
, end
, "(null)", spec
);
716 ptr
= dereference_function_descriptor(ptr
);
719 return symbol_string(buf
, end
, ptr
, spec
);
721 return resource_string(buf
, end
, ptr
, spec
);
723 spec
.flags
|= SPECIAL
;
726 return mac_address_string(buf
, end
, ptr
, spec
);
728 spec
.flags
|= SPECIAL
;
732 return ip6_addr_string(buf
, end
, ptr
, spec
);
734 return ip4_addr_string(buf
, end
, ptr
, spec
);
735 spec
.flags
&= ~SPECIAL
;
739 if (spec
.field_width
== -1) {
740 spec
.field_width
= 2*sizeof(void *);
741 spec
.flags
|= ZEROPAD
;
745 return number(buf
, end
, (unsigned long) ptr
, spec
);
749 * Helper function to decode printf style format.
750 * Each call decode a token from the format and return the
751 * number of characters read (or likely the delta where it wants
752 * to go on the next call).
753 * The decoded token is returned through the parameters
755 * 'h', 'l', or 'L' for integer fields
756 * 'z' support added 23/7/1999 S.H.
757 * 'z' changed to 'Z' --davidm 1/25/99
758 * 't' added for ptrdiff_t
760 * @fmt: the format string
761 * @type of the token returned
762 * @flags: various flags such as +, -, # tokens..
763 * @field_width: overwritten width
764 * @base: base of the number (octal, hex, ...)
765 * @precision: precision of a number
766 * @qualifier: qualifier of a number (long, size_t, ...)
768 static int format_decode(const char *fmt
, struct printf_spec
*spec
)
770 const char *start
= fmt
;
773 /* we finished early by reading the field width */
774 if (spec
->type
== FORMAT_TYPE_WITDH
) {
775 if (spec
->field_width
< 0) {
776 spec
->field_width
= -spec
->field_width
;
779 spec
->type
= FORMAT_TYPE_NONE
;
783 /* we finished early by reading the precision */
784 if (spec
->type
== FORMAT_TYPE_PRECISION
) {
785 if (spec
->precision
< 0)
788 spec
->type
= FORMAT_TYPE_NONE
;
793 spec
->type
= FORMAT_TYPE_NONE
;
795 for (; *fmt
; ++fmt
) {
800 /* Return the current non-format string */
801 if (fmt
!= start
|| !*fmt
)
807 while (1) { /* this also skips first '%' */
813 case '-': spec
->flags
|= LEFT
; break;
814 case '+': spec
->flags
|= PLUS
; break;
815 case ' ': spec
->flags
|= SPACE
; break;
816 case '#': spec
->flags
|= SPECIAL
; break;
817 case '0': spec
->flags
|= ZEROPAD
; break;
818 default: found
= false;
825 /* get field width */
826 spec
->field_width
= -1;
829 spec
->field_width
= skip_atoi(&fmt
);
830 else if (*fmt
== '*') {
831 /* it's the next argument */
832 spec
->type
= FORMAT_TYPE_WITDH
;
833 return ++fmt
- start
;
837 /* get the precision */
838 spec
->precision
= -1;
842 spec
->precision
= skip_atoi(&fmt
);
843 if (spec
->precision
< 0)
845 } else if (*fmt
== '*') {
846 /* it's the next argument */
847 spec
->type
= FORMAT_TYPE_WITDH
;
848 return ++fmt
- start
;
853 /* get the conversion qualifier */
854 spec
->qualifier
= -1;
855 if (*fmt
== 'h' || *fmt
== 'l' || *fmt
== 'L' ||
856 *fmt
== 'Z' || *fmt
== 'z' || *fmt
== 't') {
857 spec
->qualifier
= *fmt
;
859 if (spec
->qualifier
== 'l' && *fmt
== 'l') {
860 spec
->qualifier
= 'L';
869 spec
->type
= FORMAT_TYPE_CHAR
;
870 return ++fmt
- start
;
873 spec
->type
= FORMAT_TYPE_STR
;
874 return ++fmt
- start
;
877 spec
->type
= FORMAT_TYPE_PTR
;
882 spec
->type
= FORMAT_TYPE_NRCHARS
;
883 return ++fmt
- start
;
886 spec
->type
= FORMAT_TYPE_PERCENT_CHAR
;
887 return ++fmt
- start
;
889 /* integer number formats - set up the flags and "break" */
895 spec
->flags
|= SMALL
;
908 spec
->type
= FORMAT_TYPE_INVALID
;
912 if (spec
->qualifier
== 'L')
913 spec
->type
= FORMAT_TYPE_LONG_LONG
;
914 else if (spec
->qualifier
== 'l') {
916 spec
->type
= FORMAT_TYPE_LONG
;
918 spec
->type
= FORMAT_TYPE_ULONG
;
919 } else if (spec
->qualifier
== 'Z' || spec
->qualifier
== 'z') {
920 spec
->type
= FORMAT_TYPE_SIZE_T
;
921 } else if (spec
->qualifier
== 't') {
922 spec
->type
= FORMAT_TYPE_PTRDIFF
;
923 } else if (spec
->qualifier
== 'h') {
925 spec
->type
= FORMAT_TYPE_SHORT
;
927 spec
->type
= FORMAT_TYPE_USHORT
;
930 spec
->type
= FORMAT_TYPE_INT
;
932 spec
->type
= FORMAT_TYPE_UINT
;
935 return ++fmt
- start
;
939 * vsnprintf - Format a string and place it in a buffer
940 * @buf: The buffer to place the result into
941 * @size: The size of the buffer, including the trailing null space
942 * @fmt: The format string to use
943 * @args: Arguments for the format string
945 * This function follows C99 vsnprintf, but has some extensions:
946 * %pS output the name of a text symbol
947 * %pF output the name of a function pointer
948 * %pR output the address range in a struct resource
950 * The return value is the number of characters which would
951 * be generated for the given input, excluding the trailing
952 * '\0', as per ISO C99. If you want to have the exact
953 * number of characters written into @buf as return value
954 * (not including the trailing '\0'), use vscnprintf(). If the
955 * return is greater than or equal to @size, the resulting
956 * string is truncated.
958 * Call this function if you are already dealing with a va_list.
959 * You probably want snprintf() instead.
961 int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
963 unsigned long long num
;
966 struct printf_spec spec
= {0};
968 /* Reject out-of-range values early. Large positive sizes are
969 used for unknown buffer sizes. */
970 if (unlikely((int) size
< 0)) {
971 /* There can be only one.. */
972 static char warn
= 1;
981 /* Make sure end is always >= buf */
988 const char *old_fmt
= fmt
;
990 read
= format_decode(fmt
, &spec
);
995 case FORMAT_TYPE_NONE
: {
998 if (copy
> end
- str
)
1000 memcpy(str
, old_fmt
, copy
);
1006 case FORMAT_TYPE_WITDH
:
1007 spec
.field_width
= va_arg(args
, int);
1010 case FORMAT_TYPE_PRECISION
:
1011 spec
.precision
= va_arg(args
, int);
1014 case FORMAT_TYPE_CHAR
:
1015 if (!(spec
.flags
& LEFT
)) {
1016 while (--spec
.field_width
> 0) {
1023 c
= (unsigned char) va_arg(args
, int);
1027 while (--spec
.field_width
> 0) {
1034 case FORMAT_TYPE_STR
:
1035 str
= string(str
, end
, va_arg(args
, char *), spec
);
1038 case FORMAT_TYPE_PTR
:
1039 str
= pointer(fmt
+1, str
, end
, va_arg(args
, void *),
1041 while (isalnum(*fmt
))
1045 case FORMAT_TYPE_PERCENT_CHAR
:
1051 case FORMAT_TYPE_INVALID
:
1064 case FORMAT_TYPE_NRCHARS
: {
1065 int qualifier
= spec
.qualifier
;
1067 if (qualifier
== 'l') {
1068 long *ip
= va_arg(args
, long *);
1070 } else if (qualifier
== 'Z' ||
1072 size_t *ip
= va_arg(args
, size_t *);
1075 int *ip
= va_arg(args
, int *);
1082 switch (spec
.type
) {
1083 case FORMAT_TYPE_LONG_LONG
:
1084 num
= va_arg(args
, long long);
1086 case FORMAT_TYPE_ULONG
:
1087 num
= va_arg(args
, unsigned long);
1089 case FORMAT_TYPE_LONG
:
1090 num
= va_arg(args
, long);
1092 case FORMAT_TYPE_SIZE_T
:
1093 num
= va_arg(args
, size_t);
1095 case FORMAT_TYPE_PTRDIFF
:
1096 num
= va_arg(args
, ptrdiff_t);
1098 case FORMAT_TYPE_USHORT
:
1099 num
= (unsigned short) va_arg(args
, int);
1101 case FORMAT_TYPE_SHORT
:
1102 num
= (short) va_arg(args
, int);
1104 case FORMAT_TYPE_UINT
:
1105 num
= va_arg(args
, unsigned int);
1108 num
= va_arg(args
, unsigned int);
1111 str
= number(str
, end
, num
, spec
);
1122 /* the trailing null byte doesn't count towards the total */
1126 EXPORT_SYMBOL(vsnprintf
);
1129 * vscnprintf - Format a string and place it in a buffer
1130 * @buf: The buffer to place the result into
1131 * @size: The size of the buffer, including the trailing null space
1132 * @fmt: The format string to use
1133 * @args: Arguments for the format string
1135 * The return value is the number of characters which have been written into
1136 * the @buf not including the trailing '\0'. If @size is <= 0 the function
1139 * Call this function if you are already dealing with a va_list.
1140 * You probably want scnprintf() instead.
1142 * See the vsnprintf() documentation for format string extensions over C99.
1144 int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
1148 i
=vsnprintf(buf
,size
,fmt
,args
);
1149 return (i
>= size
) ? (size
- 1) : i
;
1151 EXPORT_SYMBOL(vscnprintf
);
1154 * snprintf - Format a string and place it in a buffer
1155 * @buf: The buffer to place the result into
1156 * @size: The size of the buffer, including the trailing null space
1157 * @fmt: The format string to use
1158 * @...: Arguments for the format string
1160 * The return value is the number of characters which would be
1161 * generated for the given input, excluding the trailing null,
1162 * as per ISO C99. If the return is greater than or equal to
1163 * @size, the resulting string is truncated.
1165 * See the vsnprintf() documentation for format string extensions over C99.
1167 int snprintf(char * buf
, size_t size
, const char *fmt
, ...)
1172 va_start(args
, fmt
);
1173 i
=vsnprintf(buf
,size
,fmt
,args
);
1177 EXPORT_SYMBOL(snprintf
);
1180 * scnprintf - Format a string and place it in a buffer
1181 * @buf: The buffer to place the result into
1182 * @size: The size of the buffer, including the trailing null space
1183 * @fmt: The format string to use
1184 * @...: Arguments for the format string
1186 * The return value is the number of characters written into @buf not including
1187 * the trailing '\0'. If @size is <= 0 the function returns 0.
1190 int scnprintf(char * buf
, size_t size
, const char *fmt
, ...)
1195 va_start(args
, fmt
);
1196 i
= vsnprintf(buf
, size
, fmt
, args
);
1198 return (i
>= size
) ? (size
- 1) : i
;
1200 EXPORT_SYMBOL(scnprintf
);
1203 * vsprintf - Format a string and place it in a buffer
1204 * @buf: The buffer to place the result into
1205 * @fmt: The format string to use
1206 * @args: Arguments for the format string
1208 * The function returns the number of characters written
1209 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1212 * Call this function if you are already dealing with a va_list.
1213 * You probably want sprintf() instead.
1215 * See the vsnprintf() documentation for format string extensions over C99.
1217 int vsprintf(char *buf
, const char *fmt
, va_list args
)
1219 return vsnprintf(buf
, INT_MAX
, fmt
, args
);
1221 EXPORT_SYMBOL(vsprintf
);
1224 * sprintf - Format a string and place it in a buffer
1225 * @buf: The buffer to place the result into
1226 * @fmt: The format string to use
1227 * @...: Arguments for the format string
1229 * The function returns the number of characters written
1230 * into @buf. Use snprintf() or scnprintf() in order to avoid
1233 * See the vsnprintf() documentation for format string extensions over C99.
1235 int sprintf(char * buf
, const char *fmt
, ...)
1240 va_start(args
, fmt
);
1241 i
=vsnprintf(buf
, INT_MAX
, fmt
, args
);
1245 EXPORT_SYMBOL(sprintf
);
1247 #ifdef CONFIG_BINARY_PRINTF
1250 * vbin_printf() - VA arguments to binary data
1251 * bstr_printf() - Binary data to text string
1255 * vbin_printf - Parse a format string and place args' binary value in a buffer
1256 * @bin_buf: The buffer to place args' binary value
1257 * @size: The size of the buffer(by words(32bits), not characters)
1258 * @fmt: The format string to use
1259 * @args: Arguments for the format string
1261 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1264 * The return value is the number of words(32bits) which would be generated for
1268 * If the return value is greater than @size, the resulting bin_buf is NOT
1269 * valid for bstr_printf().
1271 int vbin_printf(u32
*bin_buf
, size_t size
, const char *fmt
, va_list args
)
1273 struct printf_spec spec
= {0};
1277 str
= (char *)bin_buf
;
1278 end
= (char *)(bin_buf
+ size
);
1280 #define save_arg(type) \
1282 if (sizeof(type) == 8) { \
1283 unsigned long long value; \
1284 str = PTR_ALIGN(str, sizeof(u32)); \
1285 value = va_arg(args, unsigned long long); \
1286 if (str + sizeof(type) <= end) { \
1287 *(u32 *)str = *(u32 *)&value; \
1288 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1291 unsigned long value; \
1292 str = PTR_ALIGN(str, sizeof(type)); \
1293 value = va_arg(args, int); \
1294 if (str + sizeof(type) <= end) \
1295 *(typeof(type) *)str = (type)value; \
1297 str += sizeof(type); \
1302 read
= format_decode(fmt
, &spec
);
1306 switch (spec
.type
) {
1307 case FORMAT_TYPE_NONE
:
1310 case FORMAT_TYPE_WITDH
:
1311 case FORMAT_TYPE_PRECISION
:
1315 case FORMAT_TYPE_CHAR
:
1319 case FORMAT_TYPE_STR
: {
1320 const char *save_str
= va_arg(args
, char *);
1322 if ((unsigned long)save_str
> (unsigned long)-PAGE_SIZE
1323 || (unsigned long)save_str
< PAGE_SIZE
)
1324 save_str
= "<NULL>";
1325 len
= strlen(save_str
);
1326 if (str
+ len
+ 1 < end
)
1327 memcpy(str
, save_str
, len
+ 1);
1332 case FORMAT_TYPE_PTR
:
1334 /* skip all alphanumeric pointer suffixes */
1335 while (isalnum(*fmt
))
1339 case FORMAT_TYPE_PERCENT_CHAR
:
1342 case FORMAT_TYPE_INVALID
:
1347 case FORMAT_TYPE_NRCHARS
: {
1348 /* skip %n 's argument */
1349 int qualifier
= spec
.qualifier
;
1351 if (qualifier
== 'l')
1352 skip_arg
= va_arg(args
, long *);
1353 else if (qualifier
== 'Z' || qualifier
== 'z')
1354 skip_arg
= va_arg(args
, size_t *);
1356 skip_arg
= va_arg(args
, int *);
1361 switch (spec
.type
) {
1363 case FORMAT_TYPE_LONG_LONG
:
1364 save_arg(long long);
1366 case FORMAT_TYPE_ULONG
:
1367 case FORMAT_TYPE_LONG
:
1368 save_arg(unsigned long);
1370 case FORMAT_TYPE_SIZE_T
:
1373 case FORMAT_TYPE_PTRDIFF
:
1374 save_arg(ptrdiff_t);
1376 case FORMAT_TYPE_USHORT
:
1377 case FORMAT_TYPE_SHORT
:
1385 return (u32
*)(PTR_ALIGN(str
, sizeof(u32
))) - bin_buf
;
1389 EXPORT_SYMBOL_GPL(vbin_printf
);
1392 * bstr_printf - Format a string from binary arguments and place it in a buffer
1393 * @buf: The buffer to place the result into
1394 * @size: The size of the buffer, including the trailing null space
1395 * @fmt: The format string to use
1396 * @bin_buf: Binary arguments for the format string
1398 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1399 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1400 * a binary buffer that generated by vbin_printf.
1402 * The format follows C99 vsnprintf, but has some extensions:
1403 * %pS output the name of a text symbol
1404 * %pF output the name of a function pointer
1405 * %pR output the address range in a struct resource
1408 * The return value is the number of characters which would
1409 * be generated for the given input, excluding the trailing
1410 * '\0', as per ISO C99. If you want to have the exact
1411 * number of characters written into @buf as return value
1412 * (not including the trailing '\0'), use vscnprintf(). If the
1413 * return is greater than or equal to @size, the resulting
1414 * string is truncated.
1416 int bstr_printf(char *buf
, size_t size
, const char *fmt
, const u32
*bin_buf
)
1418 unsigned long long num
;
1420 const char *args
= (const char *)bin_buf
;
1422 struct printf_spec spec
= {0};
1424 if (unlikely((int) size
< 0)) {
1425 /* There can be only one.. */
1426 static char warn
= 1;
1435 #define get_arg(type) \
1437 typeof(type) value; \
1438 if (sizeof(type) == 8) { \
1439 args = PTR_ALIGN(args, sizeof(u32)); \
1440 *(u32 *)&value = *(u32 *)args; \
1441 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1443 args = PTR_ALIGN(args, sizeof(type)); \
1444 value = *(typeof(type) *)args; \
1446 args += sizeof(type); \
1450 /* Make sure end is always >= buf */
1458 const char *old_fmt
= fmt
;
1460 read
= format_decode(fmt
, &spec
);
1464 switch (spec
.type
) {
1465 case FORMAT_TYPE_NONE
: {
1468 if (copy
> end
- str
)
1470 memcpy(str
, old_fmt
, copy
);
1476 case FORMAT_TYPE_WITDH
:
1477 spec
.field_width
= get_arg(int);
1480 case FORMAT_TYPE_PRECISION
:
1481 spec
.precision
= get_arg(int);
1484 case FORMAT_TYPE_CHAR
:
1485 if (!(spec
.flags
& LEFT
)) {
1486 while (--spec
.field_width
> 0) {
1492 c
= (unsigned char) get_arg(char);
1496 while (--spec
.field_width
> 0) {
1503 case FORMAT_TYPE_STR
: {
1504 const char *str_arg
= args
;
1505 size_t len
= strlen(str_arg
);
1507 str
= string(str
, end
, (char *)str_arg
, spec
);
1511 case FORMAT_TYPE_PTR
:
1512 str
= pointer(fmt
+1, str
, end
, get_arg(void *), spec
);
1513 while (isalnum(*fmt
))
1517 case FORMAT_TYPE_PERCENT_CHAR
:
1523 case FORMAT_TYPE_INVALID
:
1536 case FORMAT_TYPE_NRCHARS
:
1541 switch (spec
.type
) {
1543 case FORMAT_TYPE_LONG_LONG
:
1544 num
= get_arg(long long);
1546 case FORMAT_TYPE_ULONG
:
1547 num
= get_arg(unsigned long);
1549 case FORMAT_TYPE_LONG
:
1550 num
= get_arg(unsigned long);
1552 case FORMAT_TYPE_SIZE_T
:
1553 num
= get_arg(size_t);
1555 case FORMAT_TYPE_PTRDIFF
:
1556 num
= get_arg(ptrdiff_t);
1558 case FORMAT_TYPE_USHORT
:
1559 num
= get_arg(unsigned short);
1561 case FORMAT_TYPE_SHORT
:
1562 num
= get_arg(short);
1564 case FORMAT_TYPE_UINT
:
1565 num
= get_arg(unsigned int);
1571 str
= number(str
, end
, num
, spec
);
1584 /* the trailing null byte doesn't count towards the total */
1587 EXPORT_SYMBOL_GPL(bstr_printf
);
1590 * bprintf - Parse a format string and place args' binary value in a buffer
1591 * @bin_buf: The buffer to place args' binary value
1592 * @size: The size of the buffer(by words(32bits), not characters)
1593 * @fmt: The format string to use
1594 * @...: Arguments for the format string
1596 * The function returns the number of words(u32) written
1599 int bprintf(u32
*bin_buf
, size_t size
, const char *fmt
, ...)
1604 va_start(args
, fmt
);
1605 ret
= vbin_printf(bin_buf
, size
, fmt
, args
);
1609 EXPORT_SYMBOL_GPL(bprintf
);
1611 #endif /* CONFIG_BINARY_PRINTF */
1614 * vsscanf - Unformat a buffer into a list of arguments
1615 * @buf: input buffer
1616 * @fmt: format of buffer
1619 int vsscanf(const char * buf
, const char * fmt
, va_list args
)
1621 const char *str
= buf
;
1630 while(*fmt
&& *str
) {
1631 /* skip any white space in format */
1632 /* white space in format matchs any amount of
1633 * white space, including none, in the input.
1635 if (isspace(*fmt
)) {
1636 while (isspace(*fmt
))
1638 while (isspace(*str
))
1642 /* anything that is not a conversion must match exactly */
1643 if (*fmt
!= '%' && *fmt
) {
1644 if (*fmt
++ != *str
++)
1653 /* skip this conversion.
1654 * advance both strings to next white space
1657 while (!isspace(*fmt
) && *fmt
)
1659 while (!isspace(*str
) && *str
)
1664 /* get field width */
1667 field_width
= skip_atoi(&fmt
);
1669 /* get conversion qualifier */
1671 if (*fmt
== 'h' || *fmt
== 'l' || *fmt
== 'L' ||
1672 *fmt
== 'Z' || *fmt
== 'z') {
1674 if (unlikely(qualifier
== *fmt
)) {
1675 if (qualifier
== 'h') {
1678 } else if (qualifier
== 'l') {
1693 char *s
= (char *) va_arg(args
,char*);
1694 if (field_width
== -1)
1698 } while (--field_width
> 0 && *str
);
1704 char *s
= (char *) va_arg(args
, char *);
1705 if(field_width
== -1)
1706 field_width
= INT_MAX
;
1707 /* first, skip leading white space in buffer */
1708 while (isspace(*str
))
1711 /* now copy until next white space */
1712 while (*str
&& !isspace(*str
) && field_width
--) {
1720 /* return number of characters read so far */
1722 int *i
= (int *)va_arg(args
,int*);
1740 /* looking for '%' in str */
1745 /* invalid format; stop here */
1749 /* have some sort of integer conversion.
1750 * first, skip white space in buffer.
1752 while (isspace(*str
))
1756 if (is_sign
&& digit
== '-')
1760 || (base
== 16 && !isxdigit(digit
))
1761 || (base
== 10 && !isdigit(digit
))
1762 || (base
== 8 && (!isdigit(digit
) || digit
> '7'))
1763 || (base
== 0 && !isdigit(digit
)))
1767 case 'H': /* that's 'hh' in format */
1769 signed char *s
= (signed char *) va_arg(args
,signed char *);
1770 *s
= (signed char) simple_strtol(str
,&next
,base
);
1772 unsigned char *s
= (unsigned char *) va_arg(args
, unsigned char *);
1773 *s
= (unsigned char) simple_strtoul(str
, &next
, base
);
1778 short *s
= (short *) va_arg(args
,short *);
1779 *s
= (short) simple_strtol(str
,&next
,base
);
1781 unsigned short *s
= (unsigned short *) va_arg(args
, unsigned short *);
1782 *s
= (unsigned short) simple_strtoul(str
, &next
, base
);
1787 long *l
= (long *) va_arg(args
,long *);
1788 *l
= simple_strtol(str
,&next
,base
);
1790 unsigned long *l
= (unsigned long*) va_arg(args
,unsigned long*);
1791 *l
= simple_strtoul(str
,&next
,base
);
1796 long long *l
= (long long*) va_arg(args
,long long *);
1797 *l
= simple_strtoll(str
,&next
,base
);
1799 unsigned long long *l
= (unsigned long long*) va_arg(args
,unsigned long long*);
1800 *l
= simple_strtoull(str
,&next
,base
);
1806 size_t *s
= (size_t*) va_arg(args
,size_t*);
1807 *s
= (size_t) simple_strtoul(str
,&next
,base
);
1812 int *i
= (int *) va_arg(args
, int*);
1813 *i
= (int) simple_strtol(str
,&next
,base
);
1815 unsigned int *i
= (unsigned int*) va_arg(args
, unsigned int*);
1816 *i
= (unsigned int) simple_strtoul(str
,&next
,base
);
1828 * Now we've come all the way through so either the input string or the
1829 * format ended. In the former case, there can be a %n at the current
1830 * position in the format that needs to be filled.
1832 if (*fmt
== '%' && *(fmt
+ 1) == 'n') {
1833 int *p
= (int *)va_arg(args
, int *);
1839 EXPORT_SYMBOL(vsscanf
);
1842 * sscanf - Unformat a buffer into a list of arguments
1843 * @buf: input buffer
1844 * @fmt: formatting of buffer
1845 * @...: resulting arguments
1847 int sscanf(const char * buf
, const char * fmt
, ...)
1853 i
= vsscanf(buf
,fmt
,args
);
1857 EXPORT_SYMBOL(sscanf
);
This page took 0.139429 seconds and 5 git commands to generate.