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> /* for KSYM_SYMBOL_LEN */
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/math64.h>
27 #include <linux/uaccess.h>
28 #include <linux/ioport.h>
29 #include <linux/cred.h>
30 #include <net/addrconf.h>
32 #include <asm/page.h> /* for PAGE_SIZE */
33 #include <asm/sections.h> /* for dereference_function_descriptor() */
38 * simple_strtoull - convert a string to an unsigned long long
39 * @cp: The start of the string
40 * @endp: A pointer to the end of the parsed string will be placed here
41 * @base: The number base to use
43 * This function is obsolete. Please use kstrtoull instead.
45 unsigned long long simple_strtoull(const char *cp
, char **endp
, unsigned int base
)
47 unsigned long long result
;
50 cp
= _parse_integer_fixup_radix(cp
, &base
);
51 rv
= _parse_integer(cp
, base
, &result
);
53 cp
+= (rv
& ~KSTRTOX_OVERFLOW
);
60 EXPORT_SYMBOL(simple_strtoull
);
63 * simple_strtoul - convert a string to an unsigned long
64 * @cp: The start of the string
65 * @endp: A pointer to the end of the parsed string will be placed here
66 * @base: The number base to use
68 * This function is obsolete. Please use kstrtoul instead.
70 unsigned long simple_strtoul(const char *cp
, char **endp
, unsigned int base
)
72 return simple_strtoull(cp
, endp
, base
);
74 EXPORT_SYMBOL(simple_strtoul
);
77 * simple_strtol - convert a string to a signed long
78 * @cp: The start of the string
79 * @endp: A pointer to the end of the parsed string will be placed here
80 * @base: The number base to use
82 * This function is obsolete. Please use kstrtol instead.
84 long simple_strtol(const char *cp
, char **endp
, unsigned int base
)
87 return -simple_strtoul(cp
+ 1, endp
, base
);
89 return simple_strtoul(cp
, endp
, base
);
91 EXPORT_SYMBOL(simple_strtol
);
94 * simple_strtoll - convert a string to a signed long long
95 * @cp: The start of the string
96 * @endp: A pointer to the end of the parsed string will be placed here
97 * @base: The number base to use
99 * This function is obsolete. Please use kstrtoll instead.
101 long long simple_strtoll(const char *cp
, char **endp
, unsigned int base
)
104 return -simple_strtoull(cp
+ 1, endp
, base
);
106 return simple_strtoull(cp
, endp
, base
);
108 EXPORT_SYMBOL(simple_strtoll
);
110 static noinline_for_stack
111 int skip_atoi(const char **s
)
116 i
= i
*10 + *((*s
)++) - '0';
121 /* Decimal conversion is by far the most typical, and is used
122 * for /proc and /sys data. This directly impacts e.g. top performance
123 * with many processes running. We optimize it for speed
124 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
125 * (with permission from the author, Douglas W. Jones).
128 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
129 /* Formats correctly any integer in [0, 999999999] */
130 static noinline_for_stack
131 char *put_dec_full9(char *buf
, unsigned q
)
136 * Possible ways to approx. divide by 10
137 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
138 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
139 * (x * 0x6667) >> 18 x < 43699
140 * (x * 0x3334) >> 17 x < 16389
141 * (x * 0x199a) >> 16 x < 16389
142 * (x * 0x0ccd) >> 15 x < 16389
143 * (x * 0x0667) >> 14 x < 2739
144 * (x * 0x0334) >> 13 x < 1029
145 * (x * 0x019a) >> 12 x < 1029
146 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
147 * (x * 0x0067) >> 10 x < 179
148 * (x * 0x0034) >> 9 x < 69 same
149 * (x * 0x001a) >> 8 x < 69 same
150 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
151 * (x * 0x0007) >> 6 x < 19
152 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
154 r
= (q
* (uint64_t)0x1999999a) >> 32;
155 *buf
++ = (q
- 10 * r
) + '0'; /* 1 */
156 q
= (r
* (uint64_t)0x1999999a) >> 32;
157 *buf
++ = (r
- 10 * q
) + '0'; /* 2 */
158 r
= (q
* (uint64_t)0x1999999a) >> 32;
159 *buf
++ = (q
- 10 * r
) + '0'; /* 3 */
160 q
= (r
* (uint64_t)0x1999999a) >> 32;
161 *buf
++ = (r
- 10 * q
) + '0'; /* 4 */
162 r
= (q
* (uint64_t)0x1999999a) >> 32;
163 *buf
++ = (q
- 10 * r
) + '0'; /* 5 */
164 /* Now value is under 10000, can avoid 64-bit multiply */
165 q
= (r
* 0x199a) >> 16;
166 *buf
++ = (r
- 10 * q
) + '0'; /* 6 */
167 r
= (q
* 0xcd) >> 11;
168 *buf
++ = (q
- 10 * r
) + '0'; /* 7 */
169 q
= (r
* 0xcd) >> 11;
170 *buf
++ = (r
- 10 * q
) + '0'; /* 8 */
171 *buf
++ = q
+ '0'; /* 9 */
176 /* Similar to above but do not pad with zeros.
177 * Code can be easily arranged to print 9 digits too, but our callers
178 * always call put_dec_full9() instead when the number has 9 decimal digits.
180 static noinline_for_stack
181 char *put_dec_trunc8(char *buf
, unsigned r
)
185 /* Copy of previous function's body with added early returns */
188 r
= (r
* (uint64_t)0x1999999a) >> 32;
192 q
= (r
* 0x199a) >> 16; /* r <= 9999 */
193 *buf
++ = (r
- 10 * q
) + '0';
196 r
= (q
* 0xcd) >> 11; /* q <= 999 */
197 *buf
++ = (q
- 10 * r
) + '0';
200 q
= (r
* 0xcd) >> 11; /* r <= 99 */
201 *buf
++ = (r
- 10 * q
) + '0';
204 *buf
++ = q
+ '0'; /* q <= 9 */
208 /* There are two algorithms to print larger numbers.
209 * One is generic: divide by 1000000000 and repeatedly print
210 * groups of (up to) 9 digits. It's conceptually simple,
211 * but requires a (unsigned long long) / 1000000000 division.
213 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
214 * manipulates them cleverly and generates groups of 4 decimal digits.
215 * It so happens that it does NOT require long long division.
217 * If long is > 32 bits, division of 64-bit values is relatively easy,
218 * and we will use the first algorithm.
219 * If long long is > 64 bits (strange architecture with VERY large long long),
220 * second algorithm can't be used, and we again use the first one.
222 * Else (if long is 32 bits and long long is 64 bits) we use second one.
225 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
227 /* First algorithm: generic */
230 char *put_dec(char *buf
, unsigned long long n
)
232 if (n
>= 100*1000*1000) {
233 while (n
>= 1000*1000*1000)
234 buf
= put_dec_full9(buf
, do_div(n
, 1000*1000*1000));
235 if (n
>= 100*1000*1000)
236 return put_dec_full9(buf
, n
);
238 return put_dec_trunc8(buf
, n
);
243 /* Second algorithm: valid only for 64-bit long longs */
245 /* See comment in put_dec_full9 for choice of constants */
246 static noinline_for_stack
247 void put_dec_full4(char *buf
, unsigned q
)
250 r
= (q
* 0xccd) >> 15;
251 buf
[0] = (q
- 10 * r
) + '0';
252 q
= (r
* 0xcd) >> 11;
253 buf
[1] = (r
- 10 * q
) + '0';
254 r
= (q
* 0xcd) >> 11;
255 buf
[2] = (q
- 10 * r
) + '0';
260 * Call put_dec_full4 on x % 10000, return x / 10000.
261 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
262 * holds for all x < 1,128,869,999. The largest value this
263 * helper will ever be asked to convert is 1,125,520,955.
264 * (d1 in the put_dec code, assuming n is all-ones).
267 unsigned put_dec_helper4(char *buf
, unsigned x
)
269 uint32_t q
= (x
* (uint64_t)0x346DC5D7) >> 43;
271 put_dec_full4(buf
, x
- q
* 10000);
275 /* Based on code by Douglas W. Jones found at
276 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
277 * (with permission from the author).
278 * Performs no 64-bit division and hence should be fast on 32-bit machines.
281 char *put_dec(char *buf
, unsigned long long n
)
283 uint32_t d3
, d2
, d1
, q
, h
;
285 if (n
< 100*1000*1000)
286 return put_dec_trunc8(buf
, n
);
288 d1
= ((uint32_t)n
>> 16); /* implicit "& 0xffff" */
291 d3
= (h
>> 16); /* implicit "& 0xffff" */
293 q
= 656 * d3
+ 7296 * d2
+ 5536 * d1
+ ((uint32_t)n
& 0xffff);
294 q
= put_dec_helper4(buf
, q
);
296 q
+= 7671 * d3
+ 9496 * d2
+ 6 * d1
;
297 q
= put_dec_helper4(buf
+4, q
);
299 q
+= 4749 * d3
+ 42 * d2
;
300 q
= put_dec_helper4(buf
+8, q
);
305 buf
= put_dec_trunc8(buf
, q
);
306 else while (buf
[-1] == '0')
315 * Convert passed number to decimal string.
316 * Returns the length of string. On buffer overflow, returns 0.
318 * If speed is not important, use snprintf(). It's easy to read the code.
320 int num_to_str(char *buf
, int size
, unsigned long long num
)
322 char tmp
[sizeof(num
) * 3];
325 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
330 len
= put_dec(tmp
, num
) - tmp
;
335 for (idx
= 0; idx
< len
; ++idx
)
336 buf
[idx
] = tmp
[len
- idx
- 1];
340 #define ZEROPAD 1 /* pad with zero */
341 #define SIGN 2 /* unsigned/signed long */
342 #define PLUS 4 /* show plus */
343 #define SPACE 8 /* space if plus */
344 #define LEFT 16 /* left justified */
345 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
346 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
349 FORMAT_TYPE_NONE
, /* Just a string part */
351 FORMAT_TYPE_PRECISION
,
355 FORMAT_TYPE_PERCENT_CHAR
,
357 FORMAT_TYPE_LONG_LONG
,
372 u8 type
; /* format_type enum */
373 u8 flags
; /* flags to number() */
374 u8 base
; /* number base, 8, 10 or 16 only */
375 u8 qualifier
; /* number qualifier, one of 'hHlLtzZ' */
376 s16 field_width
; /* width of output field */
377 s16 precision
; /* # of digits/chars */
380 int kptr_restrict __read_mostly
= 4;
383 * Always cleanse %p and %pK specifiers
385 static inline int kptr_restrict_always_cleanse_pointers(void)
387 return kptr_restrict
>= 3;
391 * Always cleanse physical addresses (%pa* specifiers)
393 static inline int kptr_restrict_cleanse_addresses(void)
395 return kptr_restrict
>= 4;
399 * Always cleanse resource addresses (%p[rR] specifiers)
401 static inline int kptr_restrict_cleanse_resources(void)
403 return kptr_restrict
>= 4;
406 static noinline_for_stack
407 char *number(char *buf
, char *end
, unsigned long long num
,
408 struct printf_spec spec
)
410 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
411 static const char digits
[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
416 int need_pfx
= ((spec
.flags
& SPECIAL
) && spec
.base
!= 10);
418 bool is_zero
= num
== 0LL;
420 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
421 * produces same digits or (maybe lowercased) letters */
422 locase
= (spec
.flags
& SMALL
);
423 if (spec
.flags
& LEFT
)
424 spec
.flags
&= ~ZEROPAD
;
426 if (spec
.flags
& SIGN
) {
427 if ((signed long long)num
< 0) {
429 num
= -(signed long long)num
;
431 } else if (spec
.flags
& PLUS
) {
434 } else if (spec
.flags
& SPACE
) {
441 spec
.field_width
-= 2;
446 /* generate full string in tmp[], in reverse order */
449 tmp
[i
++] = digits
[num
] | locase
;
450 /* Generic code, for any base:
452 tmp[i++] = (digits[do_div(num,base)] | locase);
455 else if (spec
.base
!= 10) { /* 8 or 16 */
456 int mask
= spec
.base
- 1;
462 tmp
[i
++] = (digits
[((unsigned char)num
) & mask
] | locase
);
465 } else { /* base 10 */
466 i
= put_dec(tmp
, num
) - tmp
;
469 /* printing 100 using %2d gives "100", not "00" */
470 if (i
> spec
.precision
)
472 /* leading space padding */
473 spec
.field_width
-= spec
.precision
;
474 if (!(spec
.flags
& (ZEROPAD
+LEFT
))) {
475 while (--spec
.field_width
>= 0) {
487 /* "0x" / "0" prefix */
489 if (spec
.base
== 16 || !is_zero
) {
494 if (spec
.base
== 16) {
496 *buf
= ('X' | locase
);
500 /* zero or space padding */
501 if (!(spec
.flags
& LEFT
)) {
502 char c
= (spec
.flags
& ZEROPAD
) ? '0' : ' ';
503 while (--spec
.field_width
>= 0) {
509 /* hmm even more zero padding? */
510 while (i
<= --spec
.precision
) {
515 /* actual digits of result */
521 /* trailing space padding */
522 while (--spec
.field_width
>= 0) {
531 static noinline_for_stack
532 char *string(char *buf
, char *end
, const char *s
, struct printf_spec spec
)
536 if ((unsigned long)s
< PAGE_SIZE
)
539 len
= strnlen(s
, spec
.precision
);
541 if (!(spec
.flags
& LEFT
)) {
542 while (len
< spec
.field_width
--) {
548 for (i
= 0; i
< len
; ++i
) {
553 while (len
< spec
.field_width
--) {
562 static noinline_for_stack
563 char *symbol_string(char *buf
, char *end
, void *ptr
,
564 struct printf_spec spec
, const char *fmt
)
567 #ifdef CONFIG_KALLSYMS
568 char sym
[KSYM_SYMBOL_LEN
];
572 ptr
= __builtin_extract_return_addr(ptr
);
573 value
= (unsigned long)ptr
;
575 #ifdef CONFIG_KALLSYMS
577 sprint_backtrace(sym
, value
);
578 else if (*fmt
!= 'f' && *fmt
!= 's')
579 sprint_symbol(sym
, value
);
581 sprint_symbol_no_offset(sym
, value
);
583 return string(buf
, end
, sym
, spec
);
585 spec
.field_width
= 2 * sizeof(void *);
586 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
589 return number(buf
, end
, value
, spec
);
593 static noinline_for_stack
594 char *resource_string(char *buf
, char *end
, struct resource
*res
,
595 struct printf_spec spec
, const char *fmt
)
597 #ifndef IO_RSRC_PRINTK_SIZE
598 #define IO_RSRC_PRINTK_SIZE 6
601 #ifndef MEM_RSRC_PRINTK_SIZE
602 #define MEM_RSRC_PRINTK_SIZE 10
604 static const struct printf_spec io_spec
= {
606 .field_width
= IO_RSRC_PRINTK_SIZE
,
608 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
610 static const struct printf_spec mem_spec
= {
612 .field_width
= MEM_RSRC_PRINTK_SIZE
,
614 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
616 static const struct printf_spec bus_spec
= {
620 .flags
= SMALL
| ZEROPAD
,
622 static const struct printf_spec dec_spec
= {
627 static const struct printf_spec str_spec
= {
632 static const struct printf_spec flag_spec
= {
635 .flags
= SPECIAL
| SMALL
,
638 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
639 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
640 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
641 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
642 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
643 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
644 char sym
[max(2*RSRC_BUF_SIZE
+ DECODED_BUF_SIZE
,
645 2*RSRC_BUF_SIZE
+ FLAG_BUF_SIZE
+ RAW_BUF_SIZE
)];
647 char *p
= sym
, *pend
= sym
+ sizeof(sym
);
648 int decode
= (fmt
[0] == 'R') ? 1 : 0;
649 int cleanse
= kptr_restrict_cleanse_resources();
650 const struct printf_spec
*specp
;
653 if (res
->flags
& IORESOURCE_IO
) {
654 p
= string(p
, pend
, "io ", str_spec
);
656 } else if (res
->flags
& IORESOURCE_MEM
) {
657 p
= string(p
, pend
, "mem ", str_spec
);
659 } else if (res
->flags
& IORESOURCE_IRQ
) {
660 p
= string(p
, pend
, "irq ", str_spec
);
662 } else if (res
->flags
& IORESOURCE_DMA
) {
663 p
= string(p
, pend
, "dma ", str_spec
);
665 } else if (res
->flags
& IORESOURCE_BUS
) {
666 p
= string(p
, pend
, "bus ", str_spec
);
669 p
= string(p
, pend
, "??? ", str_spec
);
673 p
= number(p
, pend
, cleanse
? 0UL : res
->start
, *specp
);
674 if (res
->start
!= res
->end
) {
677 cleanse
? res
->end
- res
->start
: res
->end
, *specp
);
680 if (res
->flags
& IORESOURCE_MEM_64
)
681 p
= string(p
, pend
, " 64bit", str_spec
);
682 if (res
->flags
& IORESOURCE_PREFETCH
)
683 p
= string(p
, pend
, " pref", str_spec
);
684 if (res
->flags
& IORESOURCE_WINDOW
)
685 p
= string(p
, pend
, " window", 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
);
699 static noinline_for_stack
700 char *hex_string(char *buf
, char *end
, u8
*addr
, struct printf_spec spec
,
703 int i
, len
= 1; /* if we pass '%ph[CDN]', field witdh remains
704 negative value, fallback to the default */
707 if (spec
.field_width
== 0)
708 /* nothing to print */
711 if (ZERO_OR_NULL_PTR(addr
))
713 return string(buf
, end
, NULL
, spec
);
730 if (spec
.field_width
> 0)
731 len
= min_t(int, spec
.field_width
, 64);
733 for (i
= 0; i
< len
&& buf
< end
- 1; i
++) {
734 buf
= hex_byte_pack(buf
, addr
[i
]);
736 if (buf
< end
&& separator
&& i
!= len
- 1)
743 static noinline_for_stack
744 char *mac_address_string(char *buf
, char *end
, u8
*addr
,
745 struct printf_spec spec
, const char *fmt
)
747 char mac_addr
[sizeof("xx:xx:xx:xx:xx:xx")];
751 bool reversed
= false;
767 for (i
= 0; i
< 6; i
++) {
769 p
= hex_byte_pack(p
, addr
[5 - i
]);
771 p
= hex_byte_pack(p
, addr
[i
]);
773 if (fmt
[0] == 'M' && i
!= 5)
778 return string(buf
, end
, mac_addr
, spec
);
781 static noinline_for_stack
782 char *ip4_string(char *p
, const u8
*addr
, const char *fmt
)
785 bool leading_zeros
= (fmt
[0] == 'i');
810 for (i
= 0; i
< 4; i
++) {
811 char temp
[3]; /* hold each IP quad in reverse order */
812 int digits
= put_dec_trunc8(temp
, addr
[index
]) - temp
;
819 /* reverse the digits in the quad */
831 static noinline_for_stack
832 char *ip6_compressed_string(char *p
, const char *addr
)
835 unsigned char zerolength
[8];
840 bool needcolon
= false;
844 memcpy(&in6
, addr
, sizeof(struct in6_addr
));
846 useIPv4
= ipv6_addr_v4mapped(&in6
) || ipv6_addr_is_isatap(&in6
);
848 memset(zerolength
, 0, sizeof(zerolength
));
855 /* find position of longest 0 run */
856 for (i
= 0; i
< range
; i
++) {
857 for (j
= i
; j
< range
; j
++) {
858 if (in6
.s6_addr16
[j
] != 0)
863 for (i
= 0; i
< range
; i
++) {
864 if (zerolength
[i
] > longest
) {
865 longest
= zerolength
[i
];
869 if (longest
== 1) /* don't compress a single 0 */
873 for (i
= 0; i
< range
; i
++) {
875 if (needcolon
|| i
== 0)
886 /* hex u16 without leading 0s */
887 word
= ntohs(in6
.s6_addr16
[i
]);
892 p
= hex_byte_pack(p
, hi
);
894 *p
++ = hex_asc_lo(hi
);
895 p
= hex_byte_pack(p
, lo
);
898 p
= hex_byte_pack(p
, lo
);
900 *p
++ = hex_asc_lo(lo
);
907 p
= ip4_string(p
, &in6
.s6_addr
[12], "I4");
914 static noinline_for_stack
915 char *ip6_string(char *p
, const char *addr
, const char *fmt
)
919 for (i
= 0; i
< 8; i
++) {
920 p
= hex_byte_pack(p
, *addr
++);
921 p
= hex_byte_pack(p
, *addr
++);
922 if (fmt
[0] == 'I' && i
!= 7)
930 static noinline_for_stack
931 char *ip6_addr_string(char *buf
, char *end
, const u8
*addr
,
932 struct printf_spec spec
, const char *fmt
)
934 char ip6_addr
[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
936 if (fmt
[0] == 'I' && fmt
[2] == 'c')
937 ip6_compressed_string(ip6_addr
, addr
);
939 ip6_string(ip6_addr
, addr
, fmt
);
941 return string(buf
, end
, ip6_addr
, spec
);
944 static noinline_for_stack
945 char *ip4_addr_string(char *buf
, char *end
, const u8
*addr
,
946 struct printf_spec spec
, const char *fmt
)
948 char ip4_addr
[sizeof("255.255.255.255")];
950 ip4_string(ip4_addr
, addr
, fmt
);
952 return string(buf
, end
, ip4_addr
, spec
);
955 static noinline_for_stack
956 char *uuid_string(char *buf
, char *end
, const u8
*addr
,
957 struct printf_spec spec
, const char *fmt
)
959 char uuid
[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
962 static const u8 be
[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
963 static const u8 le
[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
964 const u8
*index
= be
;
969 uc
= true; /* fall-through */
978 for (i
= 0; i
< 16; i
++) {
979 p
= hex_byte_pack(p
, addr
[index
[i
]]);
999 return string(buf
, end
, uuid
, spec
);
1003 char *netdev_feature_string(char *buf
, char *end
, const u8
*addr
,
1004 struct printf_spec spec
)
1006 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
1007 if (spec
.field_width
== -1)
1008 spec
.field_width
= 2 + 2 * sizeof(netdev_features_t
);
1011 return number(buf
, end
, *(const netdev_features_t
*)addr
, spec
);
1015 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1016 * by an extra set of alphanumeric characters that are extended format
1019 * Right now we handle:
1021 * - 'F' For symbolic function descriptor pointers with offset
1022 * - 'f' For simple symbolic function names without offset
1023 * - 'S' For symbolic direct pointers with offset
1024 * - 's' For symbolic direct pointers without offset
1025 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1026 * - 'B' For backtraced symbolic direct pointers with offset
1027 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1028 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1029 * - 'M' For a 6-byte MAC address, it prints the address in the
1030 * usual colon-separated hex notation
1031 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1032 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1033 * with a dash-separated hex notation
1034 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1035 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1036 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1037 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1038 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1039 * IPv6 omits the colons (01020304...0f)
1040 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1041 * - '[Ii]4[hnbl]' IPv4 addresses in host, network, big or little endian order
1042 * - 'I6c' for IPv6 addresses printed as specified by
1043 * http://tools.ietf.org/html/rfc5952
1044 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1045 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1046 * Options for %pU are:
1047 * b big endian lower case hex (default)
1048 * B big endian UPPER case hex
1049 * l little endian lower case hex
1050 * L little endian UPPER case hex
1051 * big endian output byte order is:
1052 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1053 * little endian output byte order is:
1054 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1055 * - 'V' For a struct va_format which contains a format string * and va_list *,
1056 * call vsnprintf(->format, *->va_list).
1057 * Implements a "recursive vsnprintf".
1058 * Do not use this feature without some mechanism to verify the
1059 * correctness of the format string and va_list arguments.
1060 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1061 * - 'P' For a kernel pointer that should be shown to all users
1062 * - 'NF' For a netdev_features_t
1063 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1064 * a certain separator (' ' by default):
1068 * The maximum supported length is 64 bytes of the input. Consider
1069 * to use print_hex_dump() for the larger input.
1070 * - 'a' For a phys_addr_t type and its derivative types (passed by reference)
1072 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1073 * function pointers are really function descriptors, which contain a
1074 * pointer to the real address.
1076 * Note: That for kptr_restrict set to 3, %p and %pK have the same
1079 * Note: That for kptr_restrict set to 4, %pa will null out the physical
1082 * Note: That for kptr_restrict set to 4, %p[rR] will null out the memory
1085 static noinline_for_stack
1086 char *pointer(const char *fmt
, char *buf
, char *end
, void *ptr
,
1087 struct printf_spec spec
)
1089 int default_width
= 2 * sizeof(void *) + (spec
.flags
& SPECIAL
? 2 : 0);
1091 if (!ptr
&& *fmt
!= 'K' && !kptr_restrict_always_cleanse_pointers()) {
1093 * Print (null) with the same width as a pointer so it makes
1094 * tabular output look nice.
1096 if (spec
.field_width
== -1)
1097 spec
.field_width
= default_width
;
1098 return string(buf
, end
, "(null)", spec
);
1104 ptr
= dereference_function_descriptor(ptr
);
1109 return symbol_string(buf
, end
, ptr
, spec
, fmt
);
1112 return resource_string(buf
, end
, ptr
, spec
, fmt
);
1114 return hex_string(buf
, end
, ptr
, spec
, fmt
);
1115 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1116 case 'm': /* Contiguous: 000102030405 */
1118 /* [mM]R (Reverse order; Bluetooth) */
1119 return mac_address_string(buf
, end
, ptr
, spec
, fmt
);
1120 case 'I': /* Formatted IP supported
1122 * 6: 0001:0203:...:0708
1123 * 6c: 1::708 or 1::1.2.3.4
1125 case 'i': /* Contiguous:
1126 * 4: 001.002.003.004
1131 return ip6_addr_string(buf
, end
, ptr
, spec
, fmt
);
1133 return ip4_addr_string(buf
, end
, ptr
, spec
, fmt
);
1137 return uuid_string(buf
, end
, ptr
, spec
, fmt
);
1142 va_copy(va
, *((struct va_format
*)ptr
)->va
);
1143 buf
+= vsnprintf(buf
, end
> buf
? end
- buf
: 0,
1144 ((struct va_format
*)ptr
)->fmt
, va
);
1151 return netdev_feature_string(buf
, end
, ptr
, spec
);
1156 unsigned long long addr
;
1157 if (fmt
[1] != 'P' && kptr_restrict_cleanse_addresses())
1160 addr
= *((phys_addr_t
*)ptr
);
1161 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
1162 spec
.field_width
= sizeof(phys_addr_t
) * 2 + 2;
1164 return number(buf
, end
, addr
, spec
);
1168 * an explicitly whitelisted kernel pointer should never be
1174 * plain %p, no extension, check if we should always cleanse and
1177 if (!kptr_restrict_always_cleanse_pointers()) {
1182 switch (kptr_restrict
) {
1184 /* Always print %p values */
1187 const struct cred
*cred
;
1190 * kptr_restrict==1 cannot be used in IRQ context
1191 * because its test for CAP_SYSLOG would be meaningless.
1193 if (in_irq() || in_serving_softirq() || in_nmi()) {
1194 if (spec
.field_width
== -1)
1195 spec
.field_width
= default_width
;
1196 return string(buf
, end
, "pK-error", spec
);
1200 * Only print the real pointer value if the current
1201 * process has CAP_SYSLOG and is running with the
1202 * same credentials it started with. This is because
1203 * access to files is checked at open() time, but %p
1204 * checks permission at read() time. We don't want to
1205 * leak pointer values if a binary opens a file using
1206 * %pK and then elevates privileges before reading it.
1208 cred
= current_cred();
1209 if (!has_capability_noaudit(current
, CAP_SYSLOG
) ||
1210 !uid_eq(cred
->euid
, cred
->uid
) ||
1211 !gid_eq(cred
->egid
, cred
->gid
))
1215 case 2: /* restrict only %pK */
1216 case 3: /* restrict all non-extensioned %p and %pK */
1217 case 4: /* restrict all non-extensioned %p, %pK, %pa*, %p[rR] */
1224 spec
.flags
|= SMALL
;
1225 if (spec
.field_width
== -1) {
1226 spec
.field_width
= default_width
;
1227 spec
.flags
|= ZEROPAD
;
1231 return number(buf
, end
, (unsigned long long) ptr
, spec
);
1235 * Helper function to decode printf style format.
1236 * Each call decode a token from the format and return the
1237 * number of characters read (or likely the delta where it wants
1238 * to go on the next call).
1239 * The decoded token is returned through the parameters
1241 * 'h', 'l', or 'L' for integer fields
1242 * 'z' support added 23/7/1999 S.H.
1243 * 'z' changed to 'Z' --davidm 1/25/99
1244 * 't' added for ptrdiff_t
1246 * @fmt: the format string
1247 * @type of the token returned
1248 * @flags: various flags such as +, -, # tokens..
1249 * @field_width: overwritten width
1250 * @base: base of the number (octal, hex, ...)
1251 * @precision: precision of a number
1252 * @qualifier: qualifier of a number (long, size_t, ...)
1254 static noinline_for_stack
1255 int format_decode(const char *fmt
, struct printf_spec
*spec
)
1257 const char *start
= fmt
;
1259 /* we finished early by reading the field width */
1260 if (spec
->type
== FORMAT_TYPE_WIDTH
) {
1261 if (spec
->field_width
< 0) {
1262 spec
->field_width
= -spec
->field_width
;
1263 spec
->flags
|= LEFT
;
1265 spec
->type
= FORMAT_TYPE_NONE
;
1269 /* we finished early by reading the precision */
1270 if (spec
->type
== FORMAT_TYPE_PRECISION
) {
1271 if (spec
->precision
< 0)
1272 spec
->precision
= 0;
1274 spec
->type
= FORMAT_TYPE_NONE
;
1279 spec
->type
= FORMAT_TYPE_NONE
;
1281 for (; *fmt
; ++fmt
) {
1286 /* Return the current non-format string */
1287 if (fmt
!= start
|| !*fmt
)
1293 while (1) { /* this also skips first '%' */
1299 case '-': spec
->flags
|= LEFT
; break;
1300 case '+': spec
->flags
|= PLUS
; break;
1301 case ' ': spec
->flags
|= SPACE
; break;
1302 case '#': spec
->flags
|= SPECIAL
; break;
1303 case '0': spec
->flags
|= ZEROPAD
; break;
1304 default: found
= false;
1311 /* get field width */
1312 spec
->field_width
= -1;
1315 spec
->field_width
= skip_atoi(&fmt
);
1316 else if (*fmt
== '*') {
1317 /* it's the next argument */
1318 spec
->type
= FORMAT_TYPE_WIDTH
;
1319 return ++fmt
- start
;
1323 /* get the precision */
1324 spec
->precision
= -1;
1327 if (isdigit(*fmt
)) {
1328 spec
->precision
= skip_atoi(&fmt
);
1329 if (spec
->precision
< 0)
1330 spec
->precision
= 0;
1331 } else if (*fmt
== '*') {
1332 /* it's the next argument */
1333 spec
->type
= FORMAT_TYPE_PRECISION
;
1334 return ++fmt
- start
;
1339 /* get the conversion qualifier */
1340 spec
->qualifier
= -1;
1341 if (*fmt
== 'h' || _tolower(*fmt
) == 'l' ||
1342 _tolower(*fmt
) == 'z' || *fmt
== 't') {
1343 spec
->qualifier
= *fmt
++;
1344 if (unlikely(spec
->qualifier
== *fmt
)) {
1345 if (spec
->qualifier
== 'l') {
1346 spec
->qualifier
= 'L';
1348 } else if (spec
->qualifier
== 'h') {
1349 spec
->qualifier
= 'H';
1359 spec
->type
= FORMAT_TYPE_CHAR
;
1360 return ++fmt
- start
;
1363 spec
->type
= FORMAT_TYPE_STR
;
1364 return ++fmt
- start
;
1367 spec
->type
= FORMAT_TYPE_PTR
;
1372 spec
->type
= FORMAT_TYPE_NRCHARS
;
1373 return ++fmt
- start
;
1376 spec
->type
= FORMAT_TYPE_PERCENT_CHAR
;
1377 return ++fmt
- start
;
1379 /* integer number formats - set up the flags and "break" */
1385 spec
->flags
|= SMALL
;
1393 spec
->flags
|= SIGN
;
1398 spec
->type
= FORMAT_TYPE_INVALID
;
1402 if (spec
->qualifier
== 'L')
1403 spec
->type
= FORMAT_TYPE_LONG_LONG
;
1404 else if (spec
->qualifier
== 'l') {
1405 if (spec
->flags
& SIGN
)
1406 spec
->type
= FORMAT_TYPE_LONG
;
1408 spec
->type
= FORMAT_TYPE_ULONG
;
1409 } else if (_tolower(spec
->qualifier
) == 'z') {
1410 spec
->type
= FORMAT_TYPE_SIZE_T
;
1411 } else if (spec
->qualifier
== 't') {
1412 spec
->type
= FORMAT_TYPE_PTRDIFF
;
1413 } else if (spec
->qualifier
== 'H') {
1414 if (spec
->flags
& SIGN
)
1415 spec
->type
= FORMAT_TYPE_BYTE
;
1417 spec
->type
= FORMAT_TYPE_UBYTE
;
1418 } else if (spec
->qualifier
== 'h') {
1419 if (spec
->flags
& SIGN
)
1420 spec
->type
= FORMAT_TYPE_SHORT
;
1422 spec
->type
= FORMAT_TYPE_USHORT
;
1424 if (spec
->flags
& SIGN
)
1425 spec
->type
= FORMAT_TYPE_INT
;
1427 spec
->type
= FORMAT_TYPE_UINT
;
1430 return ++fmt
- start
;
1434 * vsnprintf - Format a string and place it in a buffer
1435 * @buf: The buffer to place the result into
1436 * @size: The size of the buffer, including the trailing null space
1437 * @fmt: The format string to use
1438 * @args: Arguments for the format string
1440 * This function follows C99 vsnprintf, but has some extensions:
1441 * %pS output the name of a text symbol with offset
1442 * %ps output the name of a text symbol without offset
1443 * %pF output the name of a function pointer with its offset
1444 * %pf output the name of a function pointer without its offset
1445 * %pB output the name of a backtrace symbol with its offset
1446 * %pR output the address range in a struct resource with decoded flags
1447 * %pr output the address range in a struct resource with raw flags
1448 * %pM output a 6-byte MAC address with colons
1449 * %pMR output a 6-byte MAC address with colons in reversed order
1450 * %pMF output a 6-byte MAC address with dashes
1451 * %pm output a 6-byte MAC address without colons
1452 * %pmR output a 6-byte MAC address without colons in reversed order
1453 * %pI4 print an IPv4 address without leading zeros
1454 * %pi4 print an IPv4 address with leading zeros
1455 * %pI6 print an IPv6 address with colons
1456 * %pi6 print an IPv6 address without colons
1457 * %pI6c print an IPv6 address as specified by RFC 5952
1458 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1460 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1461 * bytes of the input)
1464 * ** Please update Documentation/printk-formats.txt when making changes **
1466 * The return value is the number of characters which would
1467 * be generated for the given input, excluding the trailing
1468 * '\0', as per ISO C99. If you want to have the exact
1469 * number of characters written into @buf as return value
1470 * (not including the trailing '\0'), use vscnprintf(). If the
1471 * return is greater than or equal to @size, the resulting
1472 * string is truncated.
1474 * If you're not already dealing with a va_list consider using snprintf().
1476 int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
1478 unsigned long long num
;
1480 struct printf_spec spec
= {0};
1482 /* Reject out-of-range values early. Large positive sizes are
1483 used for unknown buffer sizes. */
1484 if (WARN_ON_ONCE((int) size
< 0))
1490 /* Make sure end is always >= buf */
1497 const char *old_fmt
= fmt
;
1498 int read
= format_decode(fmt
, &spec
);
1502 switch (spec
.type
) {
1503 case FORMAT_TYPE_NONE
: {
1506 if (copy
> end
- str
)
1508 memcpy(str
, old_fmt
, copy
);
1514 case FORMAT_TYPE_WIDTH
:
1515 spec
.field_width
= va_arg(args
, int);
1518 case FORMAT_TYPE_PRECISION
:
1519 spec
.precision
= va_arg(args
, int);
1522 case FORMAT_TYPE_CHAR
: {
1525 if (!(spec
.flags
& LEFT
)) {
1526 while (--spec
.field_width
> 0) {
1533 c
= (unsigned char) va_arg(args
, int);
1537 while (--spec
.field_width
> 0) {
1545 case FORMAT_TYPE_STR
:
1546 str
= string(str
, end
, va_arg(args
, char *), spec
);
1549 case FORMAT_TYPE_PTR
:
1550 str
= pointer(fmt
+1, str
, end
, va_arg(args
, void *),
1552 while (isalnum(*fmt
))
1556 case FORMAT_TYPE_PERCENT_CHAR
:
1562 case FORMAT_TYPE_INVALID
:
1568 case FORMAT_TYPE_NRCHARS
: {
1569 u8 qualifier
= spec
.qualifier
;
1571 if (qualifier
== 'l') {
1572 long *ip
= va_arg(args
, long *);
1574 } else if (_tolower(qualifier
) == 'z') {
1575 size_t *ip
= va_arg(args
, size_t *);
1578 int *ip
= va_arg(args
, int *);
1585 switch (spec
.type
) {
1586 case FORMAT_TYPE_LONG_LONG
:
1587 num
= va_arg(args
, long long);
1589 case FORMAT_TYPE_ULONG
:
1590 num
= va_arg(args
, unsigned long);
1592 case FORMAT_TYPE_LONG
:
1593 num
= va_arg(args
, long);
1595 case FORMAT_TYPE_SIZE_T
:
1596 if (spec
.flags
& SIGN
)
1597 num
= va_arg(args
, ssize_t
);
1599 num
= va_arg(args
, size_t);
1601 case FORMAT_TYPE_PTRDIFF
:
1602 num
= va_arg(args
, ptrdiff_t);
1604 case FORMAT_TYPE_UBYTE
:
1605 num
= (unsigned char) va_arg(args
, int);
1607 case FORMAT_TYPE_BYTE
:
1608 num
= (signed char) va_arg(args
, int);
1610 case FORMAT_TYPE_USHORT
:
1611 num
= (unsigned short) va_arg(args
, int);
1613 case FORMAT_TYPE_SHORT
:
1614 num
= (short) va_arg(args
, int);
1616 case FORMAT_TYPE_INT
:
1617 num
= (int) va_arg(args
, int);
1620 num
= va_arg(args
, unsigned int);
1623 str
= number(str
, end
, num
, spec
);
1634 /* the trailing null byte doesn't count towards the total */
1638 EXPORT_SYMBOL(vsnprintf
);
1641 * vscnprintf - Format a string and place it in a buffer
1642 * @buf: The buffer to place the result into
1643 * @size: The size of the buffer, including the trailing null space
1644 * @fmt: The format string to use
1645 * @args: Arguments for the format string
1647 * The return value is the number of characters which have been written into
1648 * the @buf not including the trailing '\0'. If @size is == 0 the function
1651 * If you're not already dealing with a va_list consider using scnprintf().
1653 * See the vsnprintf() documentation for format string extensions over C99.
1655 int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
1659 i
= vsnprintf(buf
, size
, fmt
, args
);
1661 if (likely(i
< size
))
1667 EXPORT_SYMBOL(vscnprintf
);
1670 * snprintf - Format a string and place it in a buffer
1671 * @buf: The buffer to place the result into
1672 * @size: The size of the buffer, including the trailing null space
1673 * @fmt: The format string to use
1674 * @...: Arguments for the format string
1676 * The return value is the number of characters which would be
1677 * generated for the given input, excluding the trailing null,
1678 * as per ISO C99. If the return is greater than or equal to
1679 * @size, the resulting string is truncated.
1681 * See the vsnprintf() documentation for format string extensions over C99.
1683 int snprintf(char *buf
, size_t size
, const char *fmt
, ...)
1688 va_start(args
, fmt
);
1689 i
= vsnprintf(buf
, size
, fmt
, args
);
1694 EXPORT_SYMBOL(snprintf
);
1697 * scnprintf - Format a string and place it in a buffer
1698 * @buf: The buffer to place the result into
1699 * @size: The size of the buffer, including the trailing null space
1700 * @fmt: The format string to use
1701 * @...: Arguments for the format string
1703 * The return value is the number of characters written into @buf not including
1704 * the trailing '\0'. If @size is == 0 the function returns 0.
1707 int scnprintf(char *buf
, size_t size
, const char *fmt
, ...)
1712 va_start(args
, fmt
);
1713 i
= vscnprintf(buf
, size
, fmt
, args
);
1718 EXPORT_SYMBOL(scnprintf
);
1721 * vsprintf - Format a string and place it in a buffer
1722 * @buf: The buffer to place the result into
1723 * @fmt: The format string to use
1724 * @args: Arguments for the format string
1726 * The function returns the number of characters written
1727 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1730 * If you're not already dealing with a va_list consider using sprintf().
1732 * See the vsnprintf() documentation for format string extensions over C99.
1734 int vsprintf(char *buf
, const char *fmt
, va_list args
)
1736 return vsnprintf(buf
, INT_MAX
, fmt
, args
);
1738 EXPORT_SYMBOL(vsprintf
);
1741 * sprintf - Format a string and place it in a buffer
1742 * @buf: The buffer to place the result into
1743 * @fmt: The format string to use
1744 * @...: Arguments for the format string
1746 * The function returns the number of characters written
1747 * into @buf. Use snprintf() or scnprintf() in order to avoid
1750 * See the vsnprintf() documentation for format string extensions over C99.
1752 int sprintf(char *buf
, const char *fmt
, ...)
1757 va_start(args
, fmt
);
1758 i
= vsnprintf(buf
, INT_MAX
, fmt
, args
);
1763 EXPORT_SYMBOL(sprintf
);
1765 #ifdef CONFIG_BINARY_PRINTF
1768 * vbin_printf() - VA arguments to binary data
1769 * bstr_printf() - Binary data to text string
1773 * vbin_printf - Parse a format string and place args' binary value in a buffer
1774 * @bin_buf: The buffer to place args' binary value
1775 * @size: The size of the buffer(by words(32bits), not characters)
1776 * @fmt: The format string to use
1777 * @args: Arguments for the format string
1779 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1782 * The return value is the number of words(32bits) which would be generated for
1786 * If the return value is greater than @size, the resulting bin_buf is NOT
1787 * valid for bstr_printf().
1789 int vbin_printf(u32
*bin_buf
, size_t size
, const char *fmt
, va_list args
)
1791 struct printf_spec spec
= {0};
1794 str
= (char *)bin_buf
;
1795 end
= (char *)(bin_buf
+ size
);
1797 #define save_arg(type) \
1799 if (sizeof(type) == 8) { \
1800 unsigned long long value; \
1801 str = PTR_ALIGN(str, sizeof(u32)); \
1802 value = va_arg(args, unsigned long long); \
1803 if (str + sizeof(type) <= end) { \
1804 *(u32 *)str = *(u32 *)&value; \
1805 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1808 unsigned long value; \
1809 str = PTR_ALIGN(str, sizeof(type)); \
1810 value = va_arg(args, int); \
1811 if (str + sizeof(type) <= end) \
1812 *(typeof(type) *)str = (type)value; \
1814 str += sizeof(type); \
1818 int read
= format_decode(fmt
, &spec
);
1822 switch (spec
.type
) {
1823 case FORMAT_TYPE_NONE
:
1824 case FORMAT_TYPE_INVALID
:
1825 case FORMAT_TYPE_PERCENT_CHAR
:
1828 case FORMAT_TYPE_WIDTH
:
1829 case FORMAT_TYPE_PRECISION
:
1833 case FORMAT_TYPE_CHAR
:
1837 case FORMAT_TYPE_STR
: {
1838 const char *save_str
= va_arg(args
, char *);
1841 if ((unsigned long)save_str
> (unsigned long)-PAGE_SIZE
1842 || (unsigned long)save_str
< PAGE_SIZE
)
1843 save_str
= "(null)";
1844 len
= strlen(save_str
) + 1;
1845 if (str
+ len
< end
)
1846 memcpy(str
, save_str
, len
);
1851 case FORMAT_TYPE_PTR
:
1853 /* skip all alphanumeric pointer suffixes */
1854 while (isalnum(*fmt
))
1858 case FORMAT_TYPE_NRCHARS
: {
1859 /* skip %n 's argument */
1860 u8 qualifier
= spec
.qualifier
;
1862 if (qualifier
== 'l')
1863 skip_arg
= va_arg(args
, long *);
1864 else if (_tolower(qualifier
) == 'z')
1865 skip_arg
= va_arg(args
, size_t *);
1867 skip_arg
= va_arg(args
, int *);
1872 switch (spec
.type
) {
1874 case FORMAT_TYPE_LONG_LONG
:
1875 save_arg(long long);
1877 case FORMAT_TYPE_ULONG
:
1878 case FORMAT_TYPE_LONG
:
1879 save_arg(unsigned long);
1881 case FORMAT_TYPE_SIZE_T
:
1884 case FORMAT_TYPE_PTRDIFF
:
1885 save_arg(ptrdiff_t);
1887 case FORMAT_TYPE_UBYTE
:
1888 case FORMAT_TYPE_BYTE
:
1891 case FORMAT_TYPE_USHORT
:
1892 case FORMAT_TYPE_SHORT
:
1901 return (u32
*)(PTR_ALIGN(str
, sizeof(u32
))) - bin_buf
;
1904 EXPORT_SYMBOL_GPL(vbin_printf
);
1907 * bstr_printf - Format a string from binary arguments and place it in a buffer
1908 * @buf: The buffer to place the result into
1909 * @size: The size of the buffer, including the trailing null space
1910 * @fmt: The format string to use
1911 * @bin_buf: Binary arguments for the format string
1913 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1914 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1915 * a binary buffer that generated by vbin_printf.
1917 * The format follows C99 vsnprintf, but has some extensions:
1918 * see vsnprintf comment for details.
1920 * The return value is the number of characters which would
1921 * be generated for the given input, excluding the trailing
1922 * '\0', as per ISO C99. If you want to have the exact
1923 * number of characters written into @buf as return value
1924 * (not including the trailing '\0'), use vscnprintf(). If the
1925 * return is greater than or equal to @size, the resulting
1926 * string is truncated.
1928 int bstr_printf(char *buf
, size_t size
, const char *fmt
, const u32
*bin_buf
)
1930 struct printf_spec spec
= {0};
1932 const char *args
= (const char *)bin_buf
;
1934 if (WARN_ON_ONCE((int) size
< 0))
1940 #define get_arg(type) \
1942 typeof(type) value; \
1943 if (sizeof(type) == 8) { \
1944 args = PTR_ALIGN(args, sizeof(u32)); \
1945 *(u32 *)&value = *(u32 *)args; \
1946 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1948 args = PTR_ALIGN(args, sizeof(type)); \
1949 value = *(typeof(type) *)args; \
1951 args += sizeof(type); \
1955 /* Make sure end is always >= buf */
1962 const char *old_fmt
= fmt
;
1963 int read
= format_decode(fmt
, &spec
);
1967 switch (spec
.type
) {
1968 case FORMAT_TYPE_NONE
: {
1971 if (copy
> end
- str
)
1973 memcpy(str
, old_fmt
, copy
);
1979 case FORMAT_TYPE_WIDTH
:
1980 spec
.field_width
= get_arg(int);
1983 case FORMAT_TYPE_PRECISION
:
1984 spec
.precision
= get_arg(int);
1987 case FORMAT_TYPE_CHAR
: {
1990 if (!(spec
.flags
& LEFT
)) {
1991 while (--spec
.field_width
> 0) {
1997 c
= (unsigned char) get_arg(char);
2001 while (--spec
.field_width
> 0) {
2009 case FORMAT_TYPE_STR
: {
2010 const char *str_arg
= args
;
2011 args
+= strlen(str_arg
) + 1;
2012 str
= string(str
, end
, (char *)str_arg
, spec
);
2016 case FORMAT_TYPE_PTR
:
2017 str
= pointer(fmt
+1, str
, end
, get_arg(void *), spec
);
2018 while (isalnum(*fmt
))
2022 case FORMAT_TYPE_PERCENT_CHAR
:
2023 case FORMAT_TYPE_INVALID
:
2029 case FORMAT_TYPE_NRCHARS
:
2034 unsigned long long num
;
2036 switch (spec
.type
) {
2038 case FORMAT_TYPE_LONG_LONG
:
2039 num
= get_arg(long long);
2041 case FORMAT_TYPE_ULONG
:
2042 case FORMAT_TYPE_LONG
:
2043 num
= get_arg(unsigned long);
2045 case FORMAT_TYPE_SIZE_T
:
2046 num
= get_arg(size_t);
2048 case FORMAT_TYPE_PTRDIFF
:
2049 num
= get_arg(ptrdiff_t);
2051 case FORMAT_TYPE_UBYTE
:
2052 num
= get_arg(unsigned char);
2054 case FORMAT_TYPE_BYTE
:
2055 num
= get_arg(signed char);
2057 case FORMAT_TYPE_USHORT
:
2058 num
= get_arg(unsigned short);
2060 case FORMAT_TYPE_SHORT
:
2061 num
= get_arg(short);
2063 case FORMAT_TYPE_UINT
:
2064 num
= get_arg(unsigned int);
2070 str
= number(str
, end
, num
, spec
);
2072 } /* switch(spec.type) */
2084 /* the trailing null byte doesn't count towards the total */
2087 EXPORT_SYMBOL_GPL(bstr_printf
);
2090 * bprintf - Parse a format string and place args' binary value in a buffer
2091 * @bin_buf: The buffer to place args' binary value
2092 * @size: The size of the buffer(by words(32bits), not characters)
2093 * @fmt: The format string to use
2094 * @...: Arguments for the format string
2096 * The function returns the number of words(u32) written
2099 int bprintf(u32
*bin_buf
, size_t size
, const char *fmt
, ...)
2104 va_start(args
, fmt
);
2105 ret
= vbin_printf(bin_buf
, size
, fmt
, args
);
2110 EXPORT_SYMBOL_GPL(bprintf
);
2112 #endif /* CONFIG_BINARY_PRINTF */
2115 * vsscanf - Unformat a buffer into a list of arguments
2116 * @buf: input buffer
2117 * @fmt: format of buffer
2120 int vsscanf(const char *buf
, const char *fmt
, va_list args
)
2122 const char *str
= buf
;
2130 unsigned long long u
;
2136 /* skip any white space in format */
2137 /* white space in format matchs any amount of
2138 * white space, including none, in the input.
2140 if (isspace(*fmt
)) {
2141 fmt
= skip_spaces(++fmt
);
2142 str
= skip_spaces(str
);
2145 /* anything that is not a conversion must match exactly */
2146 if (*fmt
!= '%' && *fmt
) {
2147 if (*fmt
++ != *str
++)
2156 /* skip this conversion.
2157 * advance both strings to next white space
2162 while (!isspace(*fmt
) && *fmt
!= '%' && *fmt
)
2164 while (!isspace(*str
) && *str
)
2169 /* get field width */
2171 if (isdigit(*fmt
)) {
2172 field_width
= skip_atoi(&fmt
);
2173 if (field_width
<= 0)
2177 /* get conversion qualifier */
2179 if (*fmt
== 'h' || _tolower(*fmt
) == 'l' ||
2180 _tolower(*fmt
) == 'z') {
2182 if (unlikely(qualifier
== *fmt
)) {
2183 if (qualifier
== 'h') {
2186 } else if (qualifier
== 'l') {
2197 /* return number of characters read so far */
2198 *va_arg(args
, int *) = str
- buf
;
2212 char *s
= (char *)va_arg(args
, char*);
2213 if (field_width
== -1)
2217 } while (--field_width
> 0 && *str
);
2223 char *s
= (char *)va_arg(args
, char *);
2224 if (field_width
== -1)
2225 field_width
= SHRT_MAX
;
2226 /* first, skip leading white space in buffer */
2227 str
= skip_spaces(str
);
2229 /* now copy until next white space */
2230 while (*str
&& !isspace(*str
) && field_width
--)
2250 /* looking for '%' in str */
2255 /* invalid format; stop here */
2259 /* have some sort of integer conversion.
2260 * first, skip white space in buffer.
2262 str
= skip_spaces(str
);
2265 if (is_sign
&& digit
== '-')
2269 || (base
== 16 && !isxdigit(digit
))
2270 || (base
== 10 && !isdigit(digit
))
2271 || (base
== 8 && (!isdigit(digit
) || digit
> '7'))
2272 || (base
== 0 && !isdigit(digit
)))
2276 val
.s
= qualifier
!= 'L' ?
2277 simple_strtol(str
, &next
, base
) :
2278 simple_strtoll(str
, &next
, base
);
2280 val
.u
= qualifier
!= 'L' ?
2281 simple_strtoul(str
, &next
, base
) :
2282 simple_strtoull(str
, &next
, base
);
2284 if (field_width
> 0 && next
- str
> field_width
) {
2286 _parse_integer_fixup_radix(str
, &base
);
2287 while (next
- str
> field_width
) {
2289 val
.s
= div_s64(val
.s
, base
);
2291 val
.u
= div_u64(val
.u
, base
);
2296 switch (qualifier
) {
2297 case 'H': /* that's 'hh' in format */
2299 *va_arg(args
, signed char *) = val
.s
;
2301 *va_arg(args
, unsigned char *) = val
.u
;
2305 *va_arg(args
, short *) = val
.s
;
2307 *va_arg(args
, unsigned short *) = val
.u
;
2311 *va_arg(args
, long *) = val
.s
;
2313 *va_arg(args
, unsigned long *) = val
.u
;
2317 *va_arg(args
, long long *) = val
.s
;
2319 *va_arg(args
, unsigned long long *) = val
.u
;
2323 *va_arg(args
, size_t *) = val
.u
;
2327 *va_arg(args
, int *) = val
.s
;
2329 *va_arg(args
, unsigned int *) = val
.u
;
2341 EXPORT_SYMBOL(vsscanf
);
2344 * sscanf - Unformat a buffer into a list of arguments
2345 * @buf: input buffer
2346 * @fmt: formatting of buffer
2347 * @...: resulting arguments
2349 int sscanf(const char *buf
, const char *fmt
, ...)
2354 va_start(args
, fmt
);
2355 i
= vsscanf(buf
, fmt
, args
);
2360 EXPORT_SYMBOL(sscanf
);