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/clk.h>
21 #include <linux/clk-provider.h>
22 #include <linux/module.h> /* for KSYM_SYMBOL_LEN */
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/ctype.h>
26 #include <linux/kernel.h>
27 #include <linux/kallsyms.h>
28 #include <linux/math64.h>
29 #include <linux/uaccess.h>
30 #include <linux/ioport.h>
31 #include <linux/dcache.h>
32 #include <linux/cred.h>
33 #include <net/addrconf.h>
35 #include <asm/page.h> /* for PAGE_SIZE */
36 #include <asm/sections.h> /* for dereference_function_descriptor() */
37 #include <asm/byteorder.h> /* cpu_to_le16 */
39 #include <linux/string_helpers.h>
43 * simple_strtoull - convert a string to an unsigned long long
44 * @cp: The start of the string
45 * @endp: A pointer to the end of the parsed string will be placed here
46 * @base: The number base to use
48 * This function is obsolete. Please use kstrtoull instead.
50 unsigned long long simple_strtoull(const char *cp
, char **endp
, unsigned int base
)
52 unsigned long long result
;
55 cp
= _parse_integer_fixup_radix(cp
, &base
);
56 rv
= _parse_integer(cp
, base
, &result
);
58 cp
+= (rv
& ~KSTRTOX_OVERFLOW
);
65 EXPORT_SYMBOL(simple_strtoull
);
68 * simple_strtoul - convert a string to an unsigned long
69 * @cp: The start of the string
70 * @endp: A pointer to the end of the parsed string will be placed here
71 * @base: The number base to use
73 * This function is obsolete. Please use kstrtoul instead.
75 unsigned long simple_strtoul(const char *cp
, char **endp
, unsigned int base
)
77 return simple_strtoull(cp
, endp
, base
);
79 EXPORT_SYMBOL(simple_strtoul
);
82 * simple_strtol - convert a string to a signed long
83 * @cp: The start of the string
84 * @endp: A pointer to the end of the parsed string will be placed here
85 * @base: The number base to use
87 * This function is obsolete. Please use kstrtol instead.
89 long simple_strtol(const char *cp
, char **endp
, unsigned int base
)
92 return -simple_strtoul(cp
+ 1, endp
, base
);
94 return simple_strtoul(cp
, endp
, base
);
96 EXPORT_SYMBOL(simple_strtol
);
99 * simple_strtoll - convert a string to a signed long long
100 * @cp: The start of the string
101 * @endp: A pointer to the end of the parsed string will be placed here
102 * @base: The number base to use
104 * This function is obsolete. Please use kstrtoll instead.
106 long long simple_strtoll(const char *cp
, char **endp
, unsigned int base
)
109 return -simple_strtoull(cp
+ 1, endp
, base
);
111 return simple_strtoull(cp
, endp
, base
);
113 EXPORT_SYMBOL(simple_strtoll
);
115 static noinline_for_stack
116 int skip_atoi(const char **s
)
121 i
= i
*10 + *((*s
)++) - '0';
122 } while (isdigit(**s
));
128 * Decimal conversion is by far the most typical, and is used for
129 * /proc and /sys data. This directly impacts e.g. top performance
130 * with many processes running. We optimize it for speed by emitting
131 * two characters at a time, using a 200 byte lookup table. This
132 * roughly halves the number of multiplications compared to computing
133 * the digits one at a time. Implementation strongly inspired by the
134 * previous version, which in turn used ideas described at
135 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
136 * from the author, Douglas W. Jones).
138 * It turns out there is precisely one 26 bit fixed-point
139 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
140 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
141 * range happens to be somewhat larger (x <= 1073741898), but that's
142 * irrelevant for our purpose.
144 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
145 * need a 32x32->64 bit multiply, so we simply use the same constant.
147 * For dividing a number in the range [100, 10^4-1] by 100, there are
148 * several options. The simplest is (x * 0x147b) >> 19, which is valid
149 * for all x <= 43698.
152 static const u16 decpair
[100] = {
153 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
154 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
155 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
156 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
157 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
158 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
159 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
160 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
161 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
162 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
163 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
168 * This will print a single '0' even if r == 0, since we would
169 * immediately jump to out_r where two 0s would be written but only
170 * one of them accounted for in buf. This is needed by ip4_string
171 * below. All other callers pass a non-zero value of r.
173 static noinline_for_stack
174 char *put_dec_trunc8(char *buf
, unsigned r
)
182 /* 100 <= r < 10^8 */
183 q
= (r
* (u64
)0x28f5c29) >> 32;
184 *((u16
*)buf
) = decpair
[r
- 100*q
];
191 /* 100 <= q < 10^6 */
192 r
= (q
* (u64
)0x28f5c29) >> 32;
193 *((u16
*)buf
) = decpair
[q
- 100*r
];
200 /* 100 <= r < 10^4 */
201 q
= (r
* 0x147b) >> 19;
202 *((u16
*)buf
) = decpair
[r
- 100*q
];
209 *((u16
*)buf
) = decpair
[r
];
210 buf
+= r
< 10 ? 1 : 2;
214 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
215 static noinline_for_stack
216 char *put_dec_full8(char *buf
, unsigned r
)
221 q
= (r
* (u64
)0x28f5c29) >> 32;
222 *((u16
*)buf
) = decpair
[r
- 100*q
];
226 r
= (q
* (u64
)0x28f5c29) >> 32;
227 *((u16
*)buf
) = decpair
[q
- 100*r
];
231 q
= (r
* 0x147b) >> 19;
232 *((u16
*)buf
) = decpair
[r
- 100*q
];
236 *((u16
*)buf
) = decpair
[q
];
241 static noinline_for_stack
242 char *put_dec(char *buf
, unsigned long long n
)
244 if (n
>= 100*1000*1000)
245 buf
= put_dec_full8(buf
, do_div(n
, 100*1000*1000));
246 /* 1 <= n <= 1.6e11 */
247 if (n
>= 100*1000*1000)
248 buf
= put_dec_full8(buf
, do_div(n
, 100*1000*1000));
250 return put_dec_trunc8(buf
, n
);
253 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
256 put_dec_full4(char *buf
, unsigned r
)
261 q
= (r
* 0x147b) >> 19;
262 *((u16
*)buf
) = decpair
[r
- 100*q
];
265 *((u16
*)buf
) = decpair
[q
];
269 * Call put_dec_full4 on x % 10000, return x / 10000.
270 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
271 * holds for all x < 1,128,869,999. The largest value this
272 * helper will ever be asked to convert is 1,125,520,955.
273 * (second call in the put_dec code, assuming n is all-ones).
275 static noinline_for_stack
276 unsigned put_dec_helper4(char *buf
, unsigned x
)
278 uint32_t q
= (x
* (uint64_t)0x346DC5D7) >> 43;
280 put_dec_full4(buf
, x
- q
* 10000);
284 /* Based on code by Douglas W. Jones found at
285 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
286 * (with permission from the author).
287 * Performs no 64-bit division and hence should be fast on 32-bit machines.
290 char *put_dec(char *buf
, unsigned long long n
)
292 uint32_t d3
, d2
, d1
, q
, h
;
294 if (n
< 100*1000*1000)
295 return put_dec_trunc8(buf
, n
);
297 d1
= ((uint32_t)n
>> 16); /* implicit "& 0xffff" */
300 d3
= (h
>> 16); /* implicit "& 0xffff" */
302 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
303 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
304 q
= 656 * d3
+ 7296 * d2
+ 5536 * d1
+ ((uint32_t)n
& 0xffff);
305 q
= put_dec_helper4(buf
, q
);
307 q
+= 7671 * d3
+ 9496 * d2
+ 6 * d1
;
308 q
= put_dec_helper4(buf
+4, q
);
310 q
+= 4749 * d3
+ 42 * d2
;
311 q
= put_dec_helper4(buf
+8, q
);
316 buf
= put_dec_trunc8(buf
, q
);
317 else while (buf
[-1] == '0')
326 * Convert passed number to decimal string.
327 * Returns the length of string. On buffer overflow, returns 0.
329 * If speed is not important, use snprintf(). It's easy to read the code.
331 int num_to_str(char *buf
, int size
, unsigned long long num
)
333 /* put_dec requires 2-byte alignment of the buffer. */
334 char tmp
[sizeof(num
) * 3] __aligned(2);
337 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
342 len
= put_dec(tmp
, num
) - tmp
;
347 for (idx
= 0; idx
< len
; ++idx
)
348 buf
[idx
] = tmp
[len
- idx
- 1];
352 #define SIGN 1 /* unsigned/signed, must be 1 */
353 #define LEFT 2 /* left justified */
354 #define PLUS 4 /* show plus */
355 #define SPACE 8 /* space if plus */
356 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
357 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
358 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
361 FORMAT_TYPE_NONE
, /* Just a string part */
363 FORMAT_TYPE_PRECISION
,
367 FORMAT_TYPE_PERCENT_CHAR
,
369 FORMAT_TYPE_LONG_LONG
,
383 u8 type
; /* format_type enum */
384 u8 flags
; /* flags to number() */
385 u8 base
; /* number base, 8, 10 or 16 only */
386 u8 qualifier
; /* number qualifier, one of 'hHlLtzZ' */
387 s16 field_width
; /* width of output field */
388 s16 precision
; /* # of digits/chars */
391 static noinline_for_stack
392 char *number(char *buf
, char *end
, unsigned long long num
,
393 struct printf_spec spec
)
395 /* put_dec requires 2-byte alignment of the buffer. */
396 char tmp
[3 * sizeof(num
)] __aligned(2);
399 int need_pfx
= ((spec
.flags
& SPECIAL
) && spec
.base
!= 10);
401 bool is_zero
= num
== 0LL;
403 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
404 * produces same digits or (maybe lowercased) letters */
405 locase
= (spec
.flags
& SMALL
);
406 if (spec
.flags
& LEFT
)
407 spec
.flags
&= ~ZEROPAD
;
409 if (spec
.flags
& SIGN
) {
410 if ((signed long long)num
< 0) {
412 num
= -(signed long long)num
;
414 } else if (spec
.flags
& PLUS
) {
417 } else if (spec
.flags
& SPACE
) {
424 spec
.field_width
-= 2;
429 /* generate full string in tmp[], in reverse order */
432 tmp
[i
++] = hex_asc_upper
[num
] | locase
;
433 else if (spec
.base
!= 10) { /* 8 or 16 */
434 int mask
= spec
.base
- 1;
440 tmp
[i
++] = (hex_asc_upper
[((unsigned char)num
) & mask
] | locase
);
443 } else { /* base 10 */
444 i
= put_dec(tmp
, num
) - tmp
;
447 /* printing 100 using %2d gives "100", not "00" */
448 if (i
> spec
.precision
)
450 /* leading space padding */
451 spec
.field_width
-= spec
.precision
;
452 if (!(spec
.flags
& (ZEROPAD
| LEFT
))) {
453 while (--spec
.field_width
>= 0) {
465 /* "0x" / "0" prefix */
467 if (spec
.base
== 16 || !is_zero
) {
472 if (spec
.base
== 16) {
474 *buf
= ('X' | locase
);
478 /* zero or space padding */
479 if (!(spec
.flags
& LEFT
)) {
480 char c
= ' ' + (spec
.flags
& ZEROPAD
);
481 BUILD_BUG_ON(' ' + ZEROPAD
!= '0');
482 while (--spec
.field_width
>= 0) {
488 /* hmm even more zero padding? */
489 while (i
<= --spec
.precision
) {
494 /* actual digits of result */
500 /* trailing space padding */
501 while (--spec
.field_width
>= 0) {
510 static noinline_for_stack
511 char *string(char *buf
, char *end
, const char *s
, struct printf_spec spec
)
515 if ((unsigned long)s
< PAGE_SIZE
)
518 len
= strnlen(s
, spec
.precision
);
520 if (!(spec
.flags
& LEFT
)) {
521 while (len
< spec
.field_width
--) {
527 for (i
= 0; i
< len
; ++i
) {
532 while (len
< spec
.field_width
--) {
541 static void widen(char *buf
, char *end
, unsigned len
, unsigned spaces
)
544 if (buf
>= end
) /* nowhere to put anything */
547 if (size
<= spaces
) {
548 memset(buf
, ' ', size
);
552 if (len
> size
- spaces
)
554 memmove(buf
+ spaces
, buf
, len
);
556 memset(buf
, ' ', spaces
);
559 static noinline_for_stack
560 char *dentry_name(char *buf
, char *end
, const struct dentry
*d
, struct printf_spec spec
,
563 const char *array
[4], *s
;
564 const struct dentry
*p
;
569 case '2': case '3': case '4':
570 depth
= fmt
[1] - '0';
577 for (i
= 0; i
< depth
; i
++, d
= p
) {
578 p
= ACCESS_ONCE(d
->d_parent
);
579 array
[i
] = ACCESS_ONCE(d
->d_name
.name
);
588 for (n
= 0; n
!= spec
.precision
; n
++, buf
++) {
600 if (n
< spec
.field_width
) {
601 /* we want to pad the sucker */
602 unsigned spaces
= spec
.field_width
- n
;
603 if (!(spec
.flags
& LEFT
)) {
604 widen(buf
- n
, end
, n
, spaces
);
616 static noinline_for_stack
617 char *symbol_string(char *buf
, char *end
, void *ptr
,
618 struct printf_spec spec
, const char *fmt
)
621 #ifdef CONFIG_KALLSYMS
622 char sym
[KSYM_SYMBOL_LEN
];
626 ptr
= __builtin_extract_return_addr(ptr
);
627 value
= (unsigned long)ptr
;
629 #ifdef CONFIG_KALLSYMS
631 sprint_backtrace(sym
, value
);
632 else if (*fmt
!= 'f' && *fmt
!= 's')
633 sprint_symbol(sym
, value
);
635 sprint_symbol_no_offset(sym
, value
);
637 return string(buf
, end
, sym
, spec
);
639 spec
.field_width
= 2 * sizeof(void *);
640 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
643 return number(buf
, end
, value
, spec
);
647 static noinline_for_stack
648 char *resource_string(char *buf
, char *end
, struct resource
*res
,
649 struct printf_spec spec
, const char *fmt
)
651 #ifndef IO_RSRC_PRINTK_SIZE
652 #define IO_RSRC_PRINTK_SIZE 6
655 #ifndef MEM_RSRC_PRINTK_SIZE
656 #define MEM_RSRC_PRINTK_SIZE 10
658 static const struct printf_spec io_spec
= {
660 .field_width
= IO_RSRC_PRINTK_SIZE
,
662 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
664 static const struct printf_spec mem_spec
= {
666 .field_width
= MEM_RSRC_PRINTK_SIZE
,
668 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
670 static const struct printf_spec bus_spec
= {
674 .flags
= SMALL
| ZEROPAD
,
676 static const struct printf_spec dec_spec
= {
681 static const struct printf_spec str_spec
= {
686 static const struct printf_spec flag_spec
= {
689 .flags
= SPECIAL
| SMALL
,
692 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
693 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
694 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
695 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
696 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
697 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
698 char sym
[max(2*RSRC_BUF_SIZE
+ DECODED_BUF_SIZE
,
699 2*RSRC_BUF_SIZE
+ FLAG_BUF_SIZE
+ RAW_BUF_SIZE
)];
701 char *p
= sym
, *pend
= sym
+ sizeof(sym
);
702 int decode
= (fmt
[0] == 'R') ? 1 : 0;
703 const struct printf_spec
*specp
;
706 if (res
->flags
& IORESOURCE_IO
) {
707 p
= string(p
, pend
, "io ", str_spec
);
709 } else if (res
->flags
& IORESOURCE_MEM
) {
710 p
= string(p
, pend
, "mem ", str_spec
);
712 } else if (res
->flags
& IORESOURCE_IRQ
) {
713 p
= string(p
, pend
, "irq ", str_spec
);
715 } else if (res
->flags
& IORESOURCE_DMA
) {
716 p
= string(p
, pend
, "dma ", str_spec
);
718 } else if (res
->flags
& IORESOURCE_BUS
) {
719 p
= string(p
, pend
, "bus ", str_spec
);
722 p
= string(p
, pend
, "??? ", str_spec
);
726 if (decode
&& res
->flags
& IORESOURCE_UNSET
) {
727 p
= string(p
, pend
, "size ", str_spec
);
728 p
= number(p
, pend
, resource_size(res
), *specp
);
730 p
= number(p
, pend
, res
->start
, *specp
);
731 if (res
->start
!= res
->end
) {
733 p
= number(p
, pend
, res
->end
, *specp
);
737 if (res
->flags
& IORESOURCE_MEM_64
)
738 p
= string(p
, pend
, " 64bit", str_spec
);
739 if (res
->flags
& IORESOURCE_PREFETCH
)
740 p
= string(p
, pend
, " pref", str_spec
);
741 if (res
->flags
& IORESOURCE_WINDOW
)
742 p
= string(p
, pend
, " window", str_spec
);
743 if (res
->flags
& IORESOURCE_DISABLED
)
744 p
= string(p
, pend
, " disabled", str_spec
);
746 p
= string(p
, pend
, " flags ", str_spec
);
747 p
= number(p
, pend
, res
->flags
, flag_spec
);
752 return string(buf
, end
, sym
, spec
);
755 static noinline_for_stack
756 char *hex_string(char *buf
, char *end
, u8
*addr
, struct printf_spec spec
,
759 int i
, len
= 1; /* if we pass '%ph[CDN]', field width remains
760 negative value, fallback to the default */
763 if (spec
.field_width
== 0)
764 /* nothing to print */
767 if (ZERO_OR_NULL_PTR(addr
))
769 return string(buf
, end
, NULL
, spec
);
786 if (spec
.field_width
> 0)
787 len
= min_t(int, spec
.field_width
, 64);
789 for (i
= 0; i
< len
; ++i
) {
791 *buf
= hex_asc_hi(addr
[i
]);
794 *buf
= hex_asc_lo(addr
[i
]);
797 if (separator
&& i
!= len
- 1) {
807 static noinline_for_stack
808 char *bitmap_string(char *buf
, char *end
, unsigned long *bitmap
,
809 struct printf_spec spec
, const char *fmt
)
811 const int CHUNKSZ
= 32;
812 int nr_bits
= max_t(int, spec
.field_width
, 0);
816 /* reused to print numbers */
817 spec
= (struct printf_spec
){ .flags
= SMALL
| ZEROPAD
, .base
= 16 };
819 chunksz
= nr_bits
& (CHUNKSZ
- 1);
823 i
= ALIGN(nr_bits
, CHUNKSZ
) - CHUNKSZ
;
824 for (; i
>= 0; i
-= CHUNKSZ
) {
828 chunkmask
= ((1ULL << chunksz
) - 1);
829 word
= i
/ BITS_PER_LONG
;
830 bit
= i
% BITS_PER_LONG
;
831 val
= (bitmap
[word
] >> bit
) & chunkmask
;
840 spec
.field_width
= DIV_ROUND_UP(chunksz
, 4);
841 buf
= number(buf
, end
, val
, spec
);
848 static noinline_for_stack
849 char *bitmap_list_string(char *buf
, char *end
, unsigned long *bitmap
,
850 struct printf_spec spec
, const char *fmt
)
852 int nr_bits
= max_t(int, spec
.field_width
, 0);
853 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
857 /* reused to print numbers */
858 spec
= (struct printf_spec
){ .base
= 10 };
860 rbot
= cur
= find_first_bit(bitmap
, nr_bits
);
861 while (cur
< nr_bits
) {
863 cur
= find_next_bit(bitmap
, nr_bits
, cur
+ 1);
864 if (cur
< nr_bits
&& cur
<= rtop
+ 1)
874 buf
= number(buf
, end
, rbot
, spec
);
880 buf
= number(buf
, end
, rtop
, spec
);
888 static noinline_for_stack
889 char *mac_address_string(char *buf
, char *end
, u8
*addr
,
890 struct printf_spec spec
, const char *fmt
)
892 char mac_addr
[sizeof("xx:xx:xx:xx:xx:xx")];
896 bool reversed
= false;
912 for (i
= 0; i
< 6; i
++) {
914 p
= hex_byte_pack(p
, addr
[5 - i
]);
916 p
= hex_byte_pack(p
, addr
[i
]);
918 if (fmt
[0] == 'M' && i
!= 5)
923 return string(buf
, end
, mac_addr
, spec
);
926 static noinline_for_stack
927 char *ip4_string(char *p
, const u8
*addr
, const char *fmt
)
930 bool leading_zeros
= (fmt
[0] == 'i');
955 for (i
= 0; i
< 4; i
++) {
956 char temp
[4] __aligned(2); /* hold each IP quad in reverse order */
957 int digits
= put_dec_trunc8(temp
, addr
[index
]) - temp
;
964 /* reverse the digits in the quad */
976 static noinline_for_stack
977 char *ip6_compressed_string(char *p
, const char *addr
)
980 unsigned char zerolength
[8];
985 bool needcolon
= false;
989 memcpy(&in6
, addr
, sizeof(struct in6_addr
));
991 useIPv4
= ipv6_addr_v4mapped(&in6
) || ipv6_addr_is_isatap(&in6
);
993 memset(zerolength
, 0, sizeof(zerolength
));
1000 /* find position of longest 0 run */
1001 for (i
= 0; i
< range
; i
++) {
1002 for (j
= i
; j
< range
; j
++) {
1003 if (in6
.s6_addr16
[j
] != 0)
1008 for (i
= 0; i
< range
; i
++) {
1009 if (zerolength
[i
] > longest
) {
1010 longest
= zerolength
[i
];
1014 if (longest
== 1) /* don't compress a single 0 */
1018 for (i
= 0; i
< range
; i
++) {
1019 if (i
== colonpos
) {
1020 if (needcolon
|| i
== 0)
1031 /* hex u16 without leading 0s */
1032 word
= ntohs(in6
.s6_addr16
[i
]);
1037 p
= hex_byte_pack(p
, hi
);
1039 *p
++ = hex_asc_lo(hi
);
1040 p
= hex_byte_pack(p
, lo
);
1043 p
= hex_byte_pack(p
, lo
);
1045 *p
++ = hex_asc_lo(lo
);
1052 p
= ip4_string(p
, &in6
.s6_addr
[12], "I4");
1059 static noinline_for_stack
1060 char *ip6_string(char *p
, const char *addr
, const char *fmt
)
1064 for (i
= 0; i
< 8; i
++) {
1065 p
= hex_byte_pack(p
, *addr
++);
1066 p
= hex_byte_pack(p
, *addr
++);
1067 if (fmt
[0] == 'I' && i
!= 7)
1075 static noinline_for_stack
1076 char *ip6_addr_string(char *buf
, char *end
, const u8
*addr
,
1077 struct printf_spec spec
, const char *fmt
)
1079 char ip6_addr
[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1081 if (fmt
[0] == 'I' && fmt
[2] == 'c')
1082 ip6_compressed_string(ip6_addr
, addr
);
1084 ip6_string(ip6_addr
, addr
, fmt
);
1086 return string(buf
, end
, ip6_addr
, spec
);
1089 static noinline_for_stack
1090 char *ip4_addr_string(char *buf
, char *end
, const u8
*addr
,
1091 struct printf_spec spec
, const char *fmt
)
1093 char ip4_addr
[sizeof("255.255.255.255")];
1095 ip4_string(ip4_addr
, addr
, fmt
);
1097 return string(buf
, end
, ip4_addr
, spec
);
1100 static noinline_for_stack
1101 char *ip6_addr_string_sa(char *buf
, char *end
, const struct sockaddr_in6
*sa
,
1102 struct printf_spec spec
, const char *fmt
)
1104 bool have_p
= false, have_s
= false, have_f
= false, have_c
= false;
1105 char ip6_addr
[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1106 sizeof(":12345") + sizeof("/123456789") +
1107 sizeof("%1234567890")];
1108 char *p
= ip6_addr
, *pend
= ip6_addr
+ sizeof(ip6_addr
);
1109 const u8
*addr
= (const u8
*) &sa
->sin6_addr
;
1110 char fmt6
[2] = { fmt
[0], '6' };
1114 while (isalpha(*++fmt
)) {
1131 if (have_p
|| have_s
|| have_f
) {
1136 if (fmt6
[0] == 'I' && have_c
)
1137 p
= ip6_compressed_string(ip6_addr
+ off
, addr
);
1139 p
= ip6_string(ip6_addr
+ off
, addr
, fmt6
);
1141 if (have_p
|| have_s
|| have_f
)
1146 p
= number(p
, pend
, ntohs(sa
->sin6_port
), spec
);
1150 p
= number(p
, pend
, ntohl(sa
->sin6_flowinfo
&
1151 IPV6_FLOWINFO_MASK
), spec
);
1155 p
= number(p
, pend
, sa
->sin6_scope_id
, spec
);
1159 return string(buf
, end
, ip6_addr
, spec
);
1162 static noinline_for_stack
1163 char *ip4_addr_string_sa(char *buf
, char *end
, const struct sockaddr_in
*sa
,
1164 struct printf_spec spec
, const char *fmt
)
1166 bool have_p
= false;
1167 char *p
, ip4_addr
[sizeof("255.255.255.255") + sizeof(":12345")];
1168 char *pend
= ip4_addr
+ sizeof(ip4_addr
);
1169 const u8
*addr
= (const u8
*) &sa
->sin_addr
.s_addr
;
1170 char fmt4
[3] = { fmt
[0], '4', 0 };
1173 while (isalpha(*++fmt
)) {
1187 p
= ip4_string(ip4_addr
, addr
, fmt4
);
1190 p
= number(p
, pend
, ntohs(sa
->sin_port
), spec
);
1194 return string(buf
, end
, ip4_addr
, spec
);
1197 static noinline_for_stack
1198 char *escaped_string(char *buf
, char *end
, u8
*addr
, struct printf_spec spec
,
1203 unsigned int flags
= 0;
1206 if (spec
.field_width
== 0)
1207 return buf
; /* nothing to print */
1209 if (ZERO_OR_NULL_PTR(addr
))
1210 return string(buf
, end
, NULL
, spec
); /* NULL pointer */
1214 switch (fmt
[count
++]) {
1216 flags
|= ESCAPE_ANY
;
1219 flags
|= ESCAPE_SPECIAL
;
1222 flags
|= ESCAPE_HEX
;
1225 flags
|= ESCAPE_NULL
;
1228 flags
|= ESCAPE_OCTAL
;
1234 flags
|= ESCAPE_SPACE
;
1243 flags
= ESCAPE_ANY_NP
;
1245 len
= spec
.field_width
< 0 ? 1 : spec
.field_width
;
1248 * string_escape_mem() writes as many characters as it can to
1249 * the given buffer, and returns the total size of the output
1250 * had the buffer been big enough.
1252 buf
+= string_escape_mem(addr
, len
, buf
, buf
< end
? end
- buf
: 0, flags
, NULL
);
1257 static noinline_for_stack
1258 char *uuid_string(char *buf
, char *end
, const u8
*addr
,
1259 struct printf_spec spec
, const char *fmt
)
1261 char uuid
[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1264 static const u8 be
[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1265 static const u8 le
[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1266 const u8
*index
= be
;
1271 uc
= true; /* fall-through */
1280 for (i
= 0; i
< 16; i
++) {
1281 p
= hex_byte_pack(p
, addr
[index
[i
]]);
1301 return string(buf
, end
, uuid
, spec
);
1305 char *netdev_feature_string(char *buf
, char *end
, const u8
*addr
,
1306 struct printf_spec spec
)
1308 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
1309 if (spec
.field_width
== -1)
1310 spec
.field_width
= 2 + 2 * sizeof(netdev_features_t
);
1313 return number(buf
, end
, *(const netdev_features_t
*)addr
, spec
);
1316 static noinline_for_stack
1317 char *address_val(char *buf
, char *end
, const void *addr
,
1318 struct printf_spec spec
, const char *fmt
)
1320 unsigned long long num
;
1322 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
1327 num
= *(const dma_addr_t
*)addr
;
1328 spec
.field_width
= sizeof(dma_addr_t
) * 2 + 2;
1332 num
= *(const phys_addr_t
*)addr
;
1333 spec
.field_width
= sizeof(phys_addr_t
) * 2 + 2;
1337 return number(buf
, end
, num
, spec
);
1340 static noinline_for_stack
1341 char *clock(char *buf
, char *end
, struct clk
*clk
, struct printf_spec spec
,
1344 if (!IS_ENABLED(CONFIG_HAVE_CLK
) || !clk
)
1345 return string(buf
, end
, NULL
, spec
);
1349 return number(buf
, end
, clk_get_rate(clk
), spec
);
1353 #ifdef CONFIG_COMMON_CLK
1354 return string(buf
, end
, __clk_get_name(clk
), spec
);
1357 spec
.field_width
= sizeof(unsigned long) * 2 + 2;
1358 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
1359 return number(buf
, end
, (unsigned long)clk
, spec
);
1364 int kptr_restrict __read_mostly
;
1367 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1368 * by an extra set of alphanumeric characters that are extended format
1371 * Right now we handle:
1373 * - 'F' For symbolic function descriptor pointers with offset
1374 * - 'f' For simple symbolic function names without offset
1375 * - 'S' For symbolic direct pointers with offset
1376 * - 's' For symbolic direct pointers without offset
1377 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1378 * - 'B' For backtraced symbolic direct pointers with offset
1379 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1380 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1381 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1382 * width which must be explicitly specified either as part of the
1383 * format string '%32b[l]' or through '%*b[l]', [l] selects
1384 * range-list format instead of hex format
1385 * - 'M' For a 6-byte MAC address, it prints the address in the
1386 * usual colon-separated hex notation
1387 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1388 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1389 * with a dash-separated hex notation
1390 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1391 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1392 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1393 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1395 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1396 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1397 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1398 * IPv6 omits the colons (01020304...0f)
1399 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1401 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1402 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1403 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1404 * - 'I[6S]c' for IPv6 addresses printed as specified by
1405 * http://tools.ietf.org/html/rfc5952
1406 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1407 * of the following flags (see string_escape_mem() for the
1410 * c - ESCAPE_SPECIAL
1416 * By default ESCAPE_ANY_NP is used.
1417 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1418 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1419 * Options for %pU are:
1420 * b big endian lower case hex (default)
1421 * B big endian UPPER case hex
1422 * l little endian lower case hex
1423 * L little endian UPPER case hex
1424 * big endian output byte order is:
1425 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1426 * little endian output byte order is:
1427 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1428 * - 'V' For a struct va_format which contains a format string * and va_list *,
1429 * call vsnprintf(->format, *->va_list).
1430 * Implements a "recursive vsnprintf".
1431 * Do not use this feature without some mechanism to verify the
1432 * correctness of the format string and va_list arguments.
1433 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1434 * - 'NF' For a netdev_features_t
1435 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1436 * a certain separator (' ' by default):
1440 * The maximum supported length is 64 bytes of the input. Consider
1441 * to use print_hex_dump() for the larger input.
1442 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1443 * (default assumed to be phys_addr_t, passed by reference)
1444 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1445 * - 'D[234]' Same as 'd' but for a struct file
1446 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1447 * (legacy clock framework) of the clock
1448 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1449 * (legacy clock framework) of the clock
1450 * - 'Cr' For a clock, it prints the current rate of the clock
1452 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1453 * function pointers are really function descriptors, which contain a
1454 * pointer to the real address.
1456 static noinline_for_stack
1457 char *pointer(const char *fmt
, char *buf
, char *end
, void *ptr
,
1458 struct printf_spec spec
)
1460 int default_width
= 2 * sizeof(void *) + (spec
.flags
& SPECIAL
? 2 : 0);
1462 if (!ptr
&& *fmt
!= 'K') {
1464 * Print (null) with the same width as a pointer so it makes
1465 * tabular output look nice.
1467 if (spec
.field_width
== -1)
1468 spec
.field_width
= default_width
;
1469 return string(buf
, end
, "(null)", spec
);
1475 ptr
= dereference_function_descriptor(ptr
);
1480 return symbol_string(buf
, end
, ptr
, spec
, fmt
);
1483 return resource_string(buf
, end
, ptr
, spec
, fmt
);
1485 return hex_string(buf
, end
, ptr
, spec
, fmt
);
1489 return bitmap_list_string(buf
, end
, ptr
, spec
, fmt
);
1491 return bitmap_string(buf
, end
, ptr
, spec
, fmt
);
1493 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1494 case 'm': /* Contiguous: 000102030405 */
1496 /* [mM]R (Reverse order; Bluetooth) */
1497 return mac_address_string(buf
, end
, ptr
, spec
, fmt
);
1498 case 'I': /* Formatted IP supported
1500 * 6: 0001:0203:...:0708
1501 * 6c: 1::708 or 1::1.2.3.4
1503 case 'i': /* Contiguous:
1504 * 4: 001.002.003.004
1509 return ip6_addr_string(buf
, end
, ptr
, spec
, fmt
);
1511 return ip4_addr_string(buf
, end
, ptr
, spec
, fmt
);
1514 struct sockaddr raw
;
1515 struct sockaddr_in v4
;
1516 struct sockaddr_in6 v6
;
1519 switch (sa
->raw
.sa_family
) {
1521 return ip4_addr_string_sa(buf
, end
, &sa
->v4
, spec
, fmt
);
1523 return ip6_addr_string_sa(buf
, end
, &sa
->v6
, spec
, fmt
);
1525 return string(buf
, end
, "(invalid address)", spec
);
1530 return escaped_string(buf
, end
, ptr
, spec
, fmt
);
1532 return uuid_string(buf
, end
, ptr
, spec
, fmt
);
1537 va_copy(va
, *((struct va_format
*)ptr
)->va
);
1538 buf
+= vsnprintf(buf
, end
> buf
? end
- buf
: 0,
1539 ((struct va_format
*)ptr
)->fmt
, va
);
1545 * %pK cannot be used in IRQ context because its test
1546 * for CAP_SYSLOG would be meaningless.
1548 if (kptr_restrict
&& (in_irq() || in_serving_softirq() ||
1550 if (spec
.field_width
== -1)
1551 spec
.field_width
= default_width
;
1552 return string(buf
, end
, "pK-error", spec
);
1555 switch (kptr_restrict
) {
1557 /* Always print %pK values */
1561 * Only print the real pointer value if the current
1562 * process has CAP_SYSLOG and is running with the
1563 * same credentials it started with. This is because
1564 * access to files is checked at open() time, but %pK
1565 * checks permission at read() time. We don't want to
1566 * leak pointer values if a binary opens a file using
1567 * %pK and then elevates privileges before reading it.
1569 const struct cred
*cred
= current_cred();
1571 if (!has_capability_noaudit(current
, CAP_SYSLOG
) ||
1572 !uid_eq(cred
->euid
, cred
->uid
) ||
1573 !gid_eq(cred
->egid
, cred
->gid
))
1579 /* Always print 0's for %pK */
1588 return netdev_feature_string(buf
, end
, ptr
, spec
);
1592 return address_val(buf
, end
, ptr
, spec
, fmt
);
1594 return dentry_name(buf
, end
, ptr
, spec
, fmt
);
1596 return clock(buf
, end
, ptr
, spec
, fmt
);
1598 return dentry_name(buf
, end
,
1599 ((const struct file
*)ptr
)->f_path
.dentry
,
1602 spec
.flags
|= SMALL
;
1603 if (spec
.field_width
== -1) {
1604 spec
.field_width
= default_width
;
1605 spec
.flags
|= ZEROPAD
;
1609 return number(buf
, end
, (unsigned long) ptr
, spec
);
1613 * Helper function to decode printf style format.
1614 * Each call decode a token from the format and return the
1615 * number of characters read (or likely the delta where it wants
1616 * to go on the next call).
1617 * The decoded token is returned through the parameters
1619 * 'h', 'l', or 'L' for integer fields
1620 * 'z' support added 23/7/1999 S.H.
1621 * 'z' changed to 'Z' --davidm 1/25/99
1622 * 't' added for ptrdiff_t
1624 * @fmt: the format string
1625 * @type of the token returned
1626 * @flags: various flags such as +, -, # tokens..
1627 * @field_width: overwritten width
1628 * @base: base of the number (octal, hex, ...)
1629 * @precision: precision of a number
1630 * @qualifier: qualifier of a number (long, size_t, ...)
1632 static noinline_for_stack
1633 int format_decode(const char *fmt
, struct printf_spec
*spec
)
1635 const char *start
= fmt
;
1637 /* we finished early by reading the field width */
1638 if (spec
->type
== FORMAT_TYPE_WIDTH
) {
1639 if (spec
->field_width
< 0) {
1640 spec
->field_width
= -spec
->field_width
;
1641 spec
->flags
|= LEFT
;
1643 spec
->type
= FORMAT_TYPE_NONE
;
1647 /* we finished early by reading the precision */
1648 if (spec
->type
== FORMAT_TYPE_PRECISION
) {
1649 if (spec
->precision
< 0)
1650 spec
->precision
= 0;
1652 spec
->type
= FORMAT_TYPE_NONE
;
1657 spec
->type
= FORMAT_TYPE_NONE
;
1659 for (; *fmt
; ++fmt
) {
1664 /* Return the current non-format string */
1665 if (fmt
!= start
|| !*fmt
)
1671 while (1) { /* this also skips first '%' */
1677 case '-': spec
->flags
|= LEFT
; break;
1678 case '+': spec
->flags
|= PLUS
; break;
1679 case ' ': spec
->flags
|= SPACE
; break;
1680 case '#': spec
->flags
|= SPECIAL
; break;
1681 case '0': spec
->flags
|= ZEROPAD
; break;
1682 default: found
= false;
1689 /* get field width */
1690 spec
->field_width
= -1;
1693 spec
->field_width
= skip_atoi(&fmt
);
1694 else if (*fmt
== '*') {
1695 /* it's the next argument */
1696 spec
->type
= FORMAT_TYPE_WIDTH
;
1697 return ++fmt
- start
;
1701 /* get the precision */
1702 spec
->precision
= -1;
1705 if (isdigit(*fmt
)) {
1706 spec
->precision
= skip_atoi(&fmt
);
1707 if (spec
->precision
< 0)
1708 spec
->precision
= 0;
1709 } else if (*fmt
== '*') {
1710 /* it's the next argument */
1711 spec
->type
= FORMAT_TYPE_PRECISION
;
1712 return ++fmt
- start
;
1717 /* get the conversion qualifier */
1718 spec
->qualifier
= -1;
1719 if (*fmt
== 'h' || _tolower(*fmt
) == 'l' ||
1720 _tolower(*fmt
) == 'z' || *fmt
== 't') {
1721 spec
->qualifier
= *fmt
++;
1722 if (unlikely(spec
->qualifier
== *fmt
)) {
1723 if (spec
->qualifier
== 'l') {
1724 spec
->qualifier
= 'L';
1726 } else if (spec
->qualifier
== 'h') {
1727 spec
->qualifier
= 'H';
1737 spec
->type
= FORMAT_TYPE_CHAR
;
1738 return ++fmt
- start
;
1741 spec
->type
= FORMAT_TYPE_STR
;
1742 return ++fmt
- start
;
1745 spec
->type
= FORMAT_TYPE_PTR
;
1746 return ++fmt
- start
;
1749 spec
->type
= FORMAT_TYPE_PERCENT_CHAR
;
1750 return ++fmt
- start
;
1752 /* integer number formats - set up the flags and "break" */
1758 spec
->flags
|= SMALL
;
1766 spec
->flags
|= SIGN
;
1772 * Since %n poses a greater security risk than utility, treat
1773 * it as an invalid format specifier. Warn about its use so
1774 * that new instances don't get added.
1776 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt
);
1780 spec
->type
= FORMAT_TYPE_INVALID
;
1784 if (spec
->qualifier
== 'L')
1785 spec
->type
= FORMAT_TYPE_LONG_LONG
;
1786 else if (spec
->qualifier
== 'l') {
1787 BUILD_BUG_ON(FORMAT_TYPE_ULONG
+ SIGN
!= FORMAT_TYPE_LONG
);
1788 spec
->type
= FORMAT_TYPE_ULONG
+ (spec
->flags
& SIGN
);
1789 } else if (_tolower(spec
->qualifier
) == 'z') {
1790 spec
->type
= FORMAT_TYPE_SIZE_T
;
1791 } else if (spec
->qualifier
== 't') {
1792 spec
->type
= FORMAT_TYPE_PTRDIFF
;
1793 } else if (spec
->qualifier
== 'H') {
1794 BUILD_BUG_ON(FORMAT_TYPE_UBYTE
+ SIGN
!= FORMAT_TYPE_BYTE
);
1795 spec
->type
= FORMAT_TYPE_UBYTE
+ (spec
->flags
& SIGN
);
1796 } else if (spec
->qualifier
== 'h') {
1797 BUILD_BUG_ON(FORMAT_TYPE_USHORT
+ SIGN
!= FORMAT_TYPE_SHORT
);
1798 spec
->type
= FORMAT_TYPE_USHORT
+ (spec
->flags
& SIGN
);
1800 BUILD_BUG_ON(FORMAT_TYPE_UINT
+ SIGN
!= FORMAT_TYPE_INT
);
1801 spec
->type
= FORMAT_TYPE_UINT
+ (spec
->flags
& SIGN
);
1804 return ++fmt
- start
;
1808 * vsnprintf - Format a string and place it in a buffer
1809 * @buf: The buffer to place the result into
1810 * @size: The size of the buffer, including the trailing null space
1811 * @fmt: The format string to use
1812 * @args: Arguments for the format string
1814 * This function follows C99 vsnprintf, but has some extensions:
1815 * %pS output the name of a text symbol with offset
1816 * %ps output the name of a text symbol without offset
1817 * %pF output the name of a function pointer with its offset
1818 * %pf output the name of a function pointer without its offset
1819 * %pB output the name of a backtrace symbol with its offset
1820 * %pR output the address range in a struct resource with decoded flags
1821 * %pr output the address range in a struct resource with raw flags
1822 * %pb output the bitmap with field width as the number of bits
1823 * %pbl output the bitmap as range list with field width as the number of bits
1824 * %pM output a 6-byte MAC address with colons
1825 * %pMR output a 6-byte MAC address with colons in reversed order
1826 * %pMF output a 6-byte MAC address with dashes
1827 * %pm output a 6-byte MAC address without colons
1828 * %pmR output a 6-byte MAC address without colons in reversed order
1829 * %pI4 print an IPv4 address without leading zeros
1830 * %pi4 print an IPv4 address with leading zeros
1831 * %pI6 print an IPv6 address with colons
1832 * %pi6 print an IPv6 address without colons
1833 * %pI6c print an IPv6 address as specified by RFC 5952
1834 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1835 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1836 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1838 * %*pE[achnops] print an escaped buffer
1839 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1840 * bytes of the input)
1841 * %pC output the name (Common Clock Framework) or address (legacy clock
1842 * framework) of a clock
1843 * %pCn output the name (Common Clock Framework) or address (legacy clock
1844 * framework) of a clock
1845 * %pCr output the current rate of a clock
1848 * ** Please update Documentation/printk-formats.txt when making changes **
1850 * The return value is the number of characters which would
1851 * be generated for the given input, excluding the trailing
1852 * '\0', as per ISO C99. If you want to have the exact
1853 * number of characters written into @buf as return value
1854 * (not including the trailing '\0'), use vscnprintf(). If the
1855 * return is greater than or equal to @size, the resulting
1856 * string is truncated.
1858 * If you're not already dealing with a va_list consider using snprintf().
1860 int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
1862 unsigned long long num
;
1864 struct printf_spec spec
= {0};
1866 /* Reject out-of-range values early. Large positive sizes are
1867 used for unknown buffer sizes. */
1868 if (WARN_ON_ONCE(size
> INT_MAX
))
1874 /* Make sure end is always >= buf */
1881 const char *old_fmt
= fmt
;
1882 int read
= format_decode(fmt
, &spec
);
1886 switch (spec
.type
) {
1887 case FORMAT_TYPE_NONE
: {
1890 if (copy
> end
- str
)
1892 memcpy(str
, old_fmt
, copy
);
1898 case FORMAT_TYPE_WIDTH
:
1899 spec
.field_width
= va_arg(args
, int);
1902 case FORMAT_TYPE_PRECISION
:
1903 spec
.precision
= va_arg(args
, int);
1906 case FORMAT_TYPE_CHAR
: {
1909 if (!(spec
.flags
& LEFT
)) {
1910 while (--spec
.field_width
> 0) {
1917 c
= (unsigned char) va_arg(args
, int);
1921 while (--spec
.field_width
> 0) {
1929 case FORMAT_TYPE_STR
:
1930 str
= string(str
, end
, va_arg(args
, char *), spec
);
1933 case FORMAT_TYPE_PTR
:
1934 str
= pointer(fmt
, str
, end
, va_arg(args
, void *),
1936 while (isalnum(*fmt
))
1940 case FORMAT_TYPE_PERCENT_CHAR
:
1946 case FORMAT_TYPE_INVALID
:
1953 switch (spec
.type
) {
1954 case FORMAT_TYPE_LONG_LONG
:
1955 num
= va_arg(args
, long long);
1957 case FORMAT_TYPE_ULONG
:
1958 num
= va_arg(args
, unsigned long);
1960 case FORMAT_TYPE_LONG
:
1961 num
= va_arg(args
, long);
1963 case FORMAT_TYPE_SIZE_T
:
1964 if (spec
.flags
& SIGN
)
1965 num
= va_arg(args
, ssize_t
);
1967 num
= va_arg(args
, size_t);
1969 case FORMAT_TYPE_PTRDIFF
:
1970 num
= va_arg(args
, ptrdiff_t);
1972 case FORMAT_TYPE_UBYTE
:
1973 num
= (unsigned char) va_arg(args
, int);
1975 case FORMAT_TYPE_BYTE
:
1976 num
= (signed char) va_arg(args
, int);
1978 case FORMAT_TYPE_USHORT
:
1979 num
= (unsigned short) va_arg(args
, int);
1981 case FORMAT_TYPE_SHORT
:
1982 num
= (short) va_arg(args
, int);
1984 case FORMAT_TYPE_INT
:
1985 num
= (int) va_arg(args
, int);
1988 num
= va_arg(args
, unsigned int);
1991 str
= number(str
, end
, num
, spec
);
2002 /* the trailing null byte doesn't count towards the total */
2006 EXPORT_SYMBOL(vsnprintf
);
2009 * vscnprintf - Format a string and place it in a buffer
2010 * @buf: The buffer to place the result into
2011 * @size: The size of the buffer, including the trailing null space
2012 * @fmt: The format string to use
2013 * @args: Arguments for the format string
2015 * The return value is the number of characters which have been written into
2016 * the @buf not including the trailing '\0'. If @size is == 0 the function
2019 * If you're not already dealing with a va_list consider using scnprintf().
2021 * See the vsnprintf() documentation for format string extensions over C99.
2023 int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
2027 i
= vsnprintf(buf
, size
, fmt
, args
);
2029 if (likely(i
< size
))
2035 EXPORT_SYMBOL(vscnprintf
);
2038 * snprintf - Format a string and place it in a buffer
2039 * @buf: The buffer to place the result into
2040 * @size: The size of the buffer, including the trailing null space
2041 * @fmt: The format string to use
2042 * @...: Arguments for the format string
2044 * The return value is the number of characters which would be
2045 * generated for the given input, excluding the trailing null,
2046 * as per ISO C99. If the return is greater than or equal to
2047 * @size, the resulting string is truncated.
2049 * See the vsnprintf() documentation for format string extensions over C99.
2051 int snprintf(char *buf
, size_t size
, const char *fmt
, ...)
2056 va_start(args
, fmt
);
2057 i
= vsnprintf(buf
, size
, fmt
, args
);
2062 EXPORT_SYMBOL(snprintf
);
2065 * scnprintf - Format a string and place it in a buffer
2066 * @buf: The buffer to place the result into
2067 * @size: The size of the buffer, including the trailing null space
2068 * @fmt: The format string to use
2069 * @...: Arguments for the format string
2071 * The return value is the number of characters written into @buf not including
2072 * the trailing '\0'. If @size is == 0 the function returns 0.
2075 int scnprintf(char *buf
, size_t size
, const char *fmt
, ...)
2080 va_start(args
, fmt
);
2081 i
= vscnprintf(buf
, size
, fmt
, args
);
2086 EXPORT_SYMBOL(scnprintf
);
2089 * vsprintf - Format a string and place it in a buffer
2090 * @buf: The buffer to place the result into
2091 * @fmt: The format string to use
2092 * @args: Arguments for the format string
2094 * The function returns the number of characters written
2095 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2098 * If you're not already dealing with a va_list consider using sprintf().
2100 * See the vsnprintf() documentation for format string extensions over C99.
2102 int vsprintf(char *buf
, const char *fmt
, va_list args
)
2104 return vsnprintf(buf
, INT_MAX
, fmt
, args
);
2106 EXPORT_SYMBOL(vsprintf
);
2109 * sprintf - Format a string and place it in a buffer
2110 * @buf: The buffer to place the result into
2111 * @fmt: The format string to use
2112 * @...: Arguments for the format string
2114 * The function returns the number of characters written
2115 * into @buf. Use snprintf() or scnprintf() in order to avoid
2118 * See the vsnprintf() documentation for format string extensions over C99.
2120 int sprintf(char *buf
, const char *fmt
, ...)
2125 va_start(args
, fmt
);
2126 i
= vsnprintf(buf
, INT_MAX
, fmt
, args
);
2131 EXPORT_SYMBOL(sprintf
);
2133 #ifdef CONFIG_BINARY_PRINTF
2136 * vbin_printf() - VA arguments to binary data
2137 * bstr_printf() - Binary data to text string
2141 * vbin_printf - Parse a format string and place args' binary value in a buffer
2142 * @bin_buf: The buffer to place args' binary value
2143 * @size: The size of the buffer(by words(32bits), not characters)
2144 * @fmt: The format string to use
2145 * @args: Arguments for the format string
2147 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2150 * The return value is the number of words(32bits) which would be generated for
2154 * If the return value is greater than @size, the resulting bin_buf is NOT
2155 * valid for bstr_printf().
2157 int vbin_printf(u32
*bin_buf
, size_t size
, const char *fmt
, va_list args
)
2159 struct printf_spec spec
= {0};
2162 str
= (char *)bin_buf
;
2163 end
= (char *)(bin_buf
+ size
);
2165 #define save_arg(type) \
2167 if (sizeof(type) == 8) { \
2168 unsigned long long value; \
2169 str = PTR_ALIGN(str, sizeof(u32)); \
2170 value = va_arg(args, unsigned long long); \
2171 if (str + sizeof(type) <= end) { \
2172 *(u32 *)str = *(u32 *)&value; \
2173 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2176 unsigned long value; \
2177 str = PTR_ALIGN(str, sizeof(type)); \
2178 value = va_arg(args, int); \
2179 if (str + sizeof(type) <= end) \
2180 *(typeof(type) *)str = (type)value; \
2182 str += sizeof(type); \
2186 int read
= format_decode(fmt
, &spec
);
2190 switch (spec
.type
) {
2191 case FORMAT_TYPE_NONE
:
2192 case FORMAT_TYPE_INVALID
:
2193 case FORMAT_TYPE_PERCENT_CHAR
:
2196 case FORMAT_TYPE_WIDTH
:
2197 case FORMAT_TYPE_PRECISION
:
2201 case FORMAT_TYPE_CHAR
:
2205 case FORMAT_TYPE_STR
: {
2206 const char *save_str
= va_arg(args
, char *);
2209 if ((unsigned long)save_str
> (unsigned long)-PAGE_SIZE
2210 || (unsigned long)save_str
< PAGE_SIZE
)
2211 save_str
= "(null)";
2212 len
= strlen(save_str
) + 1;
2213 if (str
+ len
< end
)
2214 memcpy(str
, save_str
, len
);
2219 case FORMAT_TYPE_PTR
:
2221 /* skip all alphanumeric pointer suffixes */
2222 while (isalnum(*fmt
))
2227 switch (spec
.type
) {
2229 case FORMAT_TYPE_LONG_LONG
:
2230 save_arg(long long);
2232 case FORMAT_TYPE_ULONG
:
2233 case FORMAT_TYPE_LONG
:
2234 save_arg(unsigned long);
2236 case FORMAT_TYPE_SIZE_T
:
2239 case FORMAT_TYPE_PTRDIFF
:
2240 save_arg(ptrdiff_t);
2242 case FORMAT_TYPE_UBYTE
:
2243 case FORMAT_TYPE_BYTE
:
2246 case FORMAT_TYPE_USHORT
:
2247 case FORMAT_TYPE_SHORT
:
2256 return (u32
*)(PTR_ALIGN(str
, sizeof(u32
))) - bin_buf
;
2259 EXPORT_SYMBOL_GPL(vbin_printf
);
2262 * bstr_printf - Format a string from binary arguments and place it in a buffer
2263 * @buf: The buffer to place the result into
2264 * @size: The size of the buffer, including the trailing null space
2265 * @fmt: The format string to use
2266 * @bin_buf: Binary arguments for the format string
2268 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2269 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2270 * a binary buffer that generated by vbin_printf.
2272 * The format follows C99 vsnprintf, but has some extensions:
2273 * see vsnprintf comment for details.
2275 * The return value is the number of characters which would
2276 * be generated for the given input, excluding the trailing
2277 * '\0', as per ISO C99. If you want to have the exact
2278 * number of characters written into @buf as return value
2279 * (not including the trailing '\0'), use vscnprintf(). If the
2280 * return is greater than or equal to @size, the resulting
2281 * string is truncated.
2283 int bstr_printf(char *buf
, size_t size
, const char *fmt
, const u32
*bin_buf
)
2285 struct printf_spec spec
= {0};
2287 const char *args
= (const char *)bin_buf
;
2289 if (WARN_ON_ONCE((int) size
< 0))
2295 #define get_arg(type) \
2297 typeof(type) value; \
2298 if (sizeof(type) == 8) { \
2299 args = PTR_ALIGN(args, sizeof(u32)); \
2300 *(u32 *)&value = *(u32 *)args; \
2301 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2303 args = PTR_ALIGN(args, sizeof(type)); \
2304 value = *(typeof(type) *)args; \
2306 args += sizeof(type); \
2310 /* Make sure end is always >= buf */
2317 const char *old_fmt
= fmt
;
2318 int read
= format_decode(fmt
, &spec
);
2322 switch (spec
.type
) {
2323 case FORMAT_TYPE_NONE
: {
2326 if (copy
> end
- str
)
2328 memcpy(str
, old_fmt
, copy
);
2334 case FORMAT_TYPE_WIDTH
:
2335 spec
.field_width
= get_arg(int);
2338 case FORMAT_TYPE_PRECISION
:
2339 spec
.precision
= get_arg(int);
2342 case FORMAT_TYPE_CHAR
: {
2345 if (!(spec
.flags
& LEFT
)) {
2346 while (--spec
.field_width
> 0) {
2352 c
= (unsigned char) get_arg(char);
2356 while (--spec
.field_width
> 0) {
2364 case FORMAT_TYPE_STR
: {
2365 const char *str_arg
= args
;
2366 args
+= strlen(str_arg
) + 1;
2367 str
= string(str
, end
, (char *)str_arg
, spec
);
2371 case FORMAT_TYPE_PTR
:
2372 str
= pointer(fmt
, str
, end
, get_arg(void *), spec
);
2373 while (isalnum(*fmt
))
2377 case FORMAT_TYPE_PERCENT_CHAR
:
2378 case FORMAT_TYPE_INVALID
:
2385 unsigned long long num
;
2387 switch (spec
.type
) {
2389 case FORMAT_TYPE_LONG_LONG
:
2390 num
= get_arg(long long);
2392 case FORMAT_TYPE_ULONG
:
2393 case FORMAT_TYPE_LONG
:
2394 num
= get_arg(unsigned long);
2396 case FORMAT_TYPE_SIZE_T
:
2397 num
= get_arg(size_t);
2399 case FORMAT_TYPE_PTRDIFF
:
2400 num
= get_arg(ptrdiff_t);
2402 case FORMAT_TYPE_UBYTE
:
2403 num
= get_arg(unsigned char);
2405 case FORMAT_TYPE_BYTE
:
2406 num
= get_arg(signed char);
2408 case FORMAT_TYPE_USHORT
:
2409 num
= get_arg(unsigned short);
2411 case FORMAT_TYPE_SHORT
:
2412 num
= get_arg(short);
2414 case FORMAT_TYPE_UINT
:
2415 num
= get_arg(unsigned int);
2421 str
= number(str
, end
, num
, spec
);
2423 } /* switch(spec.type) */
2435 /* the trailing null byte doesn't count towards the total */
2438 EXPORT_SYMBOL_GPL(bstr_printf
);
2441 * bprintf - Parse a format string and place args' binary value in a buffer
2442 * @bin_buf: The buffer to place args' binary value
2443 * @size: The size of the buffer(by words(32bits), not characters)
2444 * @fmt: The format string to use
2445 * @...: Arguments for the format string
2447 * The function returns the number of words(u32) written
2450 int bprintf(u32
*bin_buf
, size_t size
, const char *fmt
, ...)
2455 va_start(args
, fmt
);
2456 ret
= vbin_printf(bin_buf
, size
, fmt
, args
);
2461 EXPORT_SYMBOL_GPL(bprintf
);
2463 #endif /* CONFIG_BINARY_PRINTF */
2466 * vsscanf - Unformat a buffer into a list of arguments
2467 * @buf: input buffer
2468 * @fmt: format of buffer
2471 int vsscanf(const char *buf
, const char *fmt
, va_list args
)
2473 const char *str
= buf
;
2481 unsigned long long u
;
2487 /* skip any white space in format */
2488 /* white space in format matchs any amount of
2489 * white space, including none, in the input.
2491 if (isspace(*fmt
)) {
2492 fmt
= skip_spaces(++fmt
);
2493 str
= skip_spaces(str
);
2496 /* anything that is not a conversion must match exactly */
2497 if (*fmt
!= '%' && *fmt
) {
2498 if (*fmt
++ != *str
++)
2507 /* skip this conversion.
2508 * advance both strings to next white space
2513 while (!isspace(*fmt
) && *fmt
!= '%' && *fmt
)
2515 while (!isspace(*str
) && *str
)
2520 /* get field width */
2522 if (isdigit(*fmt
)) {
2523 field_width
= skip_atoi(&fmt
);
2524 if (field_width
<= 0)
2528 /* get conversion qualifier */
2530 if (*fmt
== 'h' || _tolower(*fmt
) == 'l' ||
2531 _tolower(*fmt
) == 'z') {
2533 if (unlikely(qualifier
== *fmt
)) {
2534 if (qualifier
== 'h') {
2537 } else if (qualifier
== 'l') {
2548 /* return number of characters read so far */
2549 *va_arg(args
, int *) = str
- buf
;
2563 char *s
= (char *)va_arg(args
, char*);
2564 if (field_width
== -1)
2568 } while (--field_width
> 0 && *str
);
2574 char *s
= (char *)va_arg(args
, char *);
2575 if (field_width
== -1)
2576 field_width
= SHRT_MAX
;
2577 /* first, skip leading white space in buffer */
2578 str
= skip_spaces(str
);
2580 /* now copy until next white space */
2581 while (*str
&& !isspace(*str
) && field_width
--)
2601 /* looking for '%' in str */
2606 /* invalid format; stop here */
2610 /* have some sort of integer conversion.
2611 * first, skip white space in buffer.
2613 str
= skip_spaces(str
);
2616 if (is_sign
&& digit
== '-')
2620 || (base
== 16 && !isxdigit(digit
))
2621 || (base
== 10 && !isdigit(digit
))
2622 || (base
== 8 && (!isdigit(digit
) || digit
> '7'))
2623 || (base
== 0 && !isdigit(digit
)))
2627 val
.s
= qualifier
!= 'L' ?
2628 simple_strtol(str
, &next
, base
) :
2629 simple_strtoll(str
, &next
, base
);
2631 val
.u
= qualifier
!= 'L' ?
2632 simple_strtoul(str
, &next
, base
) :
2633 simple_strtoull(str
, &next
, base
);
2635 if (field_width
> 0 && next
- str
> field_width
) {
2637 _parse_integer_fixup_radix(str
, &base
);
2638 while (next
- str
> field_width
) {
2640 val
.s
= div_s64(val
.s
, base
);
2642 val
.u
= div_u64(val
.u
, base
);
2647 switch (qualifier
) {
2648 case 'H': /* that's 'hh' in format */
2650 *va_arg(args
, signed char *) = val
.s
;
2652 *va_arg(args
, unsigned char *) = val
.u
;
2656 *va_arg(args
, short *) = val
.s
;
2658 *va_arg(args
, unsigned short *) = val
.u
;
2662 *va_arg(args
, long *) = val
.s
;
2664 *va_arg(args
, unsigned long *) = val
.u
;
2668 *va_arg(args
, long long *) = val
.s
;
2670 *va_arg(args
, unsigned long long *) = val
.u
;
2674 *va_arg(args
, size_t *) = val
.u
;
2678 *va_arg(args
, int *) = val
.s
;
2680 *va_arg(args
, unsigned int *) = val
.u
;
2692 EXPORT_SYMBOL(vsscanf
);
2695 * sscanf - Unformat a buffer into a list of arguments
2696 * @buf: input buffer
2697 * @fmt: formatting of buffer
2698 * @...: resulting arguments
2700 int sscanf(const char *buf
, const char *fmt
, ...)
2705 va_start(args
, fmt
);
2706 i
= vsscanf(buf
, fmt
, args
);
2711 EXPORT_SYMBOL(sscanf
);