1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1991, 1992 Linus Torvalds
8 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
10 * Wirzenius wrote this portably, Torvalds fucked it up :-)
14 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
15 * - changed to provide snprintf and vsnprintf functions
16 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
17 * - scnprintf and vscnprintf
20 #include <linux/stdarg.h>
21 #include <linux/build_bug.h>
22 #include <linux/clk.h>
23 #include <linux/clk-provider.h>
24 #include <linux/errname.h>
25 #include <linux/module.h> /* for KSYM_SYMBOL_LEN */
26 #include <linux/types.h>
27 #include <linux/string.h>
28 #include <linux/ctype.h>
29 #include <linux/kernel.h>
30 #include <linux/kallsyms.h>
31 #include <linux/math64.h>
32 #include <linux/uaccess.h>
33 #include <linux/ioport.h>
34 #include <linux/dcache.h>
35 #include <linux/cred.h>
36 #include <linux/rtc.h>
37 #include <linux/sprintf.h>
38 #include <linux/time.h>
39 #include <linux/uuid.h>
41 #include <net/addrconf.h>
42 #include <linux/siphash.h>
43 #include <linux/compiler.h>
44 #include <linux/property.h>
45 #include <linux/notifier.h>
47 #include <linux/blkdev.h>
50 #include "../mm/internal.h" /* For the trace_print_flags arrays */
52 #include <asm/page.h> /* for PAGE_SIZE */
53 #include <asm/byteorder.h> /* cpu_to_le16 */
54 #include <asm/unaligned.h>
56 #include <linux/string_helpers.h>
59 /* Disable pointer hashing if requested */
60 bool no_hash_pointers __ro_after_init
;
61 EXPORT_SYMBOL_GPL(no_hash_pointers
);
63 static noinline
unsigned long long simple_strntoull(const char *startp
, size_t max_chars
, char **endp
, unsigned int base
)
66 unsigned long long result
= 0ULL;
70 cp
= _parse_integer_fixup_radix(startp
, &base
);
71 prefix_chars
= cp
- startp
;
72 if (prefix_chars
< max_chars
) {
73 rv
= _parse_integer_limit(cp
, base
, &result
, max_chars
- prefix_chars
);
75 cp
+= (rv
& ~KSTRTOX_OVERFLOW
);
77 /* Field too short for prefix + digit, skip over without converting */
78 cp
= startp
+ max_chars
;
88 * simple_strtoull - convert a string to an unsigned long long
89 * @cp: The start of the string
90 * @endp: A pointer to the end of the parsed string will be placed here
91 * @base: The number base to use
93 * This function has caveats. Please use kstrtoull instead.
96 unsigned long long simple_strtoull(const char *cp
, char **endp
, unsigned int base
)
98 return simple_strntoull(cp
, INT_MAX
, endp
, base
);
100 EXPORT_SYMBOL(simple_strtoull
);
103 * simple_strtoul - convert a string to an unsigned long
104 * @cp: The start of the string
105 * @endp: A pointer to the end of the parsed string will be placed here
106 * @base: The number base to use
108 * This function has caveats. Please use kstrtoul instead.
110 unsigned long simple_strtoul(const char *cp
, char **endp
, unsigned int base
)
112 return simple_strtoull(cp
, endp
, base
);
114 EXPORT_SYMBOL(simple_strtoul
);
117 * simple_strtol - convert a string to a signed long
118 * @cp: The start of the string
119 * @endp: A pointer to the end of the parsed string will be placed here
120 * @base: The number base to use
122 * This function has caveats. Please use kstrtol instead.
124 long simple_strtol(const char *cp
, char **endp
, unsigned int base
)
127 return -simple_strtoul(cp
+ 1, endp
, base
);
129 return simple_strtoul(cp
, endp
, base
);
131 EXPORT_SYMBOL(simple_strtol
);
133 static long long simple_strntoll(const char *cp
, size_t max_chars
, char **endp
,
137 * simple_strntoull() safely handles receiving max_chars==0 in the
138 * case cp[0] == '-' && max_chars == 1.
139 * If max_chars == 0 we can drop through and pass it to simple_strntoull()
140 * and the content of *cp is irrelevant.
142 if (*cp
== '-' && max_chars
> 0)
143 return -simple_strntoull(cp
+ 1, max_chars
- 1, endp
, base
);
145 return simple_strntoull(cp
, max_chars
, endp
, base
);
149 * simple_strtoll - convert a string to a signed long long
150 * @cp: The start of the string
151 * @endp: A pointer to the end of the parsed string will be placed here
152 * @base: The number base to use
154 * This function has caveats. Please use kstrtoll instead.
156 long long simple_strtoll(const char *cp
, char **endp
, unsigned int base
)
158 return simple_strntoll(cp
, INT_MAX
, endp
, base
);
160 EXPORT_SYMBOL(simple_strtoll
);
162 static noinline_for_stack
163 int skip_atoi(const char **s
)
168 i
= i
*10 + *((*s
)++) - '0';
169 } while (isdigit(**s
));
175 * Decimal conversion is by far the most typical, and is used for
176 * /proc and /sys data. This directly impacts e.g. top performance
177 * with many processes running. We optimize it for speed by emitting
178 * two characters at a time, using a 200 byte lookup table. This
179 * roughly halves the number of multiplications compared to computing
180 * the digits one at a time. Implementation strongly inspired by the
181 * previous version, which in turn used ideas described at
182 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
183 * from the author, Douglas W. Jones).
185 * It turns out there is precisely one 26 bit fixed-point
186 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
187 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
188 * range happens to be somewhat larger (x <= 1073741898), but that's
189 * irrelevant for our purpose.
191 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
192 * need a 32x32->64 bit multiply, so we simply use the same constant.
194 * For dividing a number in the range [100, 10^4-1] by 100, there are
195 * several options. The simplest is (x * 0x147b) >> 19, which is valid
196 * for all x <= 43698.
199 static const u16 decpair
[100] = {
200 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
201 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
202 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
203 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
204 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
205 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
206 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
207 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
208 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
209 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
210 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
215 * This will print a single '0' even if r == 0, since we would
216 * immediately jump to out_r where two 0s would be written but only
217 * one of them accounted for in buf. This is needed by ip4_string
218 * below. All other callers pass a non-zero value of r.
220 static noinline_for_stack
221 char *put_dec_trunc8(char *buf
, unsigned r
)
229 /* 100 <= r < 10^8 */
230 q
= (r
* (u64
)0x28f5c29) >> 32;
231 *((u16
*)buf
) = decpair
[r
- 100*q
];
238 /* 100 <= q < 10^6 */
239 r
= (q
* (u64
)0x28f5c29) >> 32;
240 *((u16
*)buf
) = decpair
[q
- 100*r
];
247 /* 100 <= r < 10^4 */
248 q
= (r
* 0x147b) >> 19;
249 *((u16
*)buf
) = decpair
[r
- 100*q
];
256 *((u16
*)buf
) = decpair
[r
];
257 buf
+= r
< 10 ? 1 : 2;
261 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
262 static noinline_for_stack
263 char *put_dec_full8(char *buf
, unsigned r
)
268 q
= (r
* (u64
)0x28f5c29) >> 32;
269 *((u16
*)buf
) = decpair
[r
- 100*q
];
273 r
= (q
* (u64
)0x28f5c29) >> 32;
274 *((u16
*)buf
) = decpair
[q
- 100*r
];
278 q
= (r
* 0x147b) >> 19;
279 *((u16
*)buf
) = decpair
[r
- 100*q
];
283 *((u16
*)buf
) = decpair
[q
];
288 static noinline_for_stack
289 char *put_dec(char *buf
, unsigned long long n
)
291 if (n
>= 100*1000*1000)
292 buf
= put_dec_full8(buf
, do_div(n
, 100*1000*1000));
293 /* 1 <= n <= 1.6e11 */
294 if (n
>= 100*1000*1000)
295 buf
= put_dec_full8(buf
, do_div(n
, 100*1000*1000));
297 return put_dec_trunc8(buf
, n
);
300 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
303 put_dec_full4(char *buf
, unsigned r
)
308 q
= (r
* 0x147b) >> 19;
309 *((u16
*)buf
) = decpair
[r
- 100*q
];
312 *((u16
*)buf
) = decpair
[q
];
316 * Call put_dec_full4 on x % 10000, return x / 10000.
317 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
318 * holds for all x < 1,128,869,999. The largest value this
319 * helper will ever be asked to convert is 1,125,520,955.
320 * (second call in the put_dec code, assuming n is all-ones).
322 static noinline_for_stack
323 unsigned put_dec_helper4(char *buf
, unsigned x
)
325 uint32_t q
= (x
* (uint64_t)0x346DC5D7) >> 43;
327 put_dec_full4(buf
, x
- q
* 10000);
331 /* Based on code by Douglas W. Jones found at
332 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
333 * (with permission from the author).
334 * Performs no 64-bit division and hence should be fast on 32-bit machines.
337 char *put_dec(char *buf
, unsigned long long n
)
339 uint32_t d3
, d2
, d1
, q
, h
;
341 if (n
< 100*1000*1000)
342 return put_dec_trunc8(buf
, n
);
344 d1
= ((uint32_t)n
>> 16); /* implicit "& 0xffff" */
347 d3
= (h
>> 16); /* implicit "& 0xffff" */
349 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
350 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
351 q
= 656 * d3
+ 7296 * d2
+ 5536 * d1
+ ((uint32_t)n
& 0xffff);
352 q
= put_dec_helper4(buf
, q
);
354 q
+= 7671 * d3
+ 9496 * d2
+ 6 * d1
;
355 q
= put_dec_helper4(buf
+4, q
);
357 q
+= 4749 * d3
+ 42 * d2
;
358 q
= put_dec_helper4(buf
+8, q
);
363 buf
= put_dec_trunc8(buf
, q
);
364 else while (buf
[-1] == '0')
373 * Convert passed number to decimal string.
374 * Returns the length of string. On buffer overflow, returns 0.
376 * If speed is not important, use snprintf(). It's easy to read the code.
378 int num_to_str(char *buf
, int size
, unsigned long long num
, unsigned int width
)
380 /* put_dec requires 2-byte alignment of the buffer. */
381 char tmp
[sizeof(num
) * 3] __aligned(2);
384 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
389 len
= put_dec(tmp
, num
) - tmp
;
392 if (len
> size
|| width
> size
)
397 for (idx
= 0; idx
< width
; idx
++)
403 for (idx
= 0; idx
< len
; ++idx
)
404 buf
[idx
+ width
] = tmp
[len
- idx
- 1];
409 #define SIGN 1 /* unsigned/signed, must be 1 */
410 #define LEFT 2 /* left justified */
411 #define PLUS 4 /* show plus */
412 #define SPACE 8 /* space if plus */
413 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
414 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
415 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
417 static_assert(SIGN
== 1);
418 static_assert(ZEROPAD
== ('0' - ' '));
419 static_assert(SMALL
== ('a' ^ 'A'));
422 FORMAT_TYPE_NONE
, /* Just a string part */
424 FORMAT_TYPE_PRECISION
,
428 FORMAT_TYPE_PERCENT_CHAR
,
430 FORMAT_TYPE_LONG_LONG
,
444 unsigned int type
:8; /* format_type enum */
445 signed int field_width
:24; /* width of output field */
446 unsigned int flags
:8; /* flags to number() */
447 unsigned int base
:8; /* number base, 8, 10 or 16 only */
448 signed int precision
:16; /* # of digits/chars */
450 static_assert(sizeof(struct printf_spec
) == 8);
452 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
453 #define PRECISION_MAX ((1 << 15) - 1)
455 static noinline_for_stack
456 char *number(char *buf
, char *end
, unsigned long long num
,
457 struct printf_spec spec
)
459 /* put_dec requires 2-byte alignment of the buffer. */
460 char tmp
[3 * sizeof(num
)] __aligned(2);
463 int need_pfx
= ((spec
.flags
& SPECIAL
) && spec
.base
!= 10);
465 bool is_zero
= num
== 0LL;
466 int field_width
= spec
.field_width
;
467 int precision
= spec
.precision
;
469 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
470 * produces same digits or (maybe lowercased) letters */
471 locase
= (spec
.flags
& SMALL
);
472 if (spec
.flags
& LEFT
)
473 spec
.flags
&= ~ZEROPAD
;
475 if (spec
.flags
& SIGN
) {
476 if ((signed long long)num
< 0) {
478 num
= -(signed long long)num
;
480 } else if (spec
.flags
& PLUS
) {
483 } else if (spec
.flags
& SPACE
) {
495 /* generate full string in tmp[], in reverse order */
498 tmp
[i
++] = hex_asc_upper
[num
] | locase
;
499 else if (spec
.base
!= 10) { /* 8 or 16 */
500 int mask
= spec
.base
- 1;
506 tmp
[i
++] = (hex_asc_upper
[((unsigned char)num
) & mask
] | locase
);
509 } else { /* base 10 */
510 i
= put_dec(tmp
, num
) - tmp
;
513 /* printing 100 using %2d gives "100", not "00" */
516 /* leading space padding */
517 field_width
-= precision
;
518 if (!(spec
.flags
& (ZEROPAD
| LEFT
))) {
519 while (--field_width
>= 0) {
531 /* "0x" / "0" prefix */
533 if (spec
.base
== 16 || !is_zero
) {
538 if (spec
.base
== 16) {
540 *buf
= ('X' | locase
);
544 /* zero or space padding */
545 if (!(spec
.flags
& LEFT
)) {
546 char c
= ' ' + (spec
.flags
& ZEROPAD
);
548 while (--field_width
>= 0) {
554 /* hmm even more zero padding? */
555 while (i
<= --precision
) {
560 /* actual digits of result */
566 /* trailing space padding */
567 while (--field_width
>= 0) {
576 static noinline_for_stack
577 char *special_hex_number(char *buf
, char *end
, unsigned long long num
, int size
)
579 struct printf_spec spec
;
581 spec
.type
= FORMAT_TYPE_PTR
;
582 spec
.field_width
= 2 + 2 * size
; /* 0x + hex */
583 spec
.flags
= SPECIAL
| SMALL
| ZEROPAD
;
587 return number(buf
, end
, num
, spec
);
590 static void move_right(char *buf
, char *end
, unsigned len
, unsigned spaces
)
593 if (buf
>= end
) /* nowhere to put anything */
596 if (size
<= spaces
) {
597 memset(buf
, ' ', size
);
601 if (len
> size
- spaces
)
603 memmove(buf
+ spaces
, buf
, len
);
605 memset(buf
, ' ', spaces
);
609 * Handle field width padding for a string.
610 * @buf: current buffer position
611 * @n: length of string
612 * @end: end of output buffer
613 * @spec: for field width and flags
614 * Returns: new buffer position after padding.
616 static noinline_for_stack
617 char *widen_string(char *buf
, int n
, char *end
, struct printf_spec spec
)
621 if (likely(n
>= spec
.field_width
))
623 /* we want to pad the sucker */
624 spaces
= spec
.field_width
- n
;
625 if (!(spec
.flags
& LEFT
)) {
626 move_right(buf
- n
, end
, n
, spaces
);
637 /* Handle string from a well known address. */
638 static char *string_nocheck(char *buf
, char *end
, const char *s
,
639 struct printf_spec spec
)
642 int lim
= spec
.precision
;
653 return widen_string(buf
, len
, end
, spec
);
656 static char *err_ptr(char *buf
, char *end
, void *ptr
,
657 struct printf_spec spec
)
659 int err
= PTR_ERR(ptr
);
660 const char *sym
= errname(err
);
663 return string_nocheck(buf
, end
, sym
, spec
);
666 * Somebody passed ERR_PTR(-1234) or some other non-existing
667 * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to
668 * printing it as its decimal representation.
672 return number(buf
, end
, err
, spec
);
675 /* Be careful: error messages must fit into the given buffer. */
676 static char *error_string(char *buf
, char *end
, const char *s
,
677 struct printf_spec spec
)
680 * Hard limit to avoid a completely insane messages. It actually
681 * works pretty well because most error messages are in
682 * the many pointer format modifiers.
684 if (spec
.precision
== -1)
685 spec
.precision
= 2 * sizeof(void *);
687 return string_nocheck(buf
, end
, s
, spec
);
691 * Do not call any complex external code here. Nested printk()/vsprintf()
692 * might cause infinite loops. Failures might break printk() and would
695 static const char *check_pointer_msg(const void *ptr
)
700 if ((unsigned long)ptr
< PAGE_SIZE
|| IS_ERR_VALUE(ptr
))
706 static int check_pointer(char **buf
, char *end
, const void *ptr
,
707 struct printf_spec spec
)
711 err_msg
= check_pointer_msg(ptr
);
713 *buf
= error_string(*buf
, end
, err_msg
, spec
);
720 static noinline_for_stack
721 char *string(char *buf
, char *end
, const char *s
,
722 struct printf_spec spec
)
724 if (check_pointer(&buf
, end
, s
, spec
))
727 return string_nocheck(buf
, end
, s
, spec
);
730 static char *pointer_string(char *buf
, char *end
,
732 struct printf_spec spec
)
736 if (spec
.field_width
== -1) {
737 spec
.field_width
= 2 * sizeof(ptr
);
738 spec
.flags
|= ZEROPAD
;
741 return number(buf
, end
, (unsigned long int)ptr
, spec
);
744 /* Make pointers available for printing early in the boot sequence. */
745 static int debug_boot_weak_hash __ro_after_init
;
747 static int __init
debug_boot_weak_hash_enable(char *str
)
749 debug_boot_weak_hash
= 1;
750 pr_info("debug_boot_weak_hash enabled\n");
753 early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable
);
755 static bool filled_random_ptr_key __read_mostly
;
756 static siphash_key_t ptr_key __read_mostly
;
758 static int fill_ptr_key(struct notifier_block
*nb
, unsigned long action
, void *data
)
760 get_random_bytes(&ptr_key
, sizeof(ptr_key
));
762 /* Pairs with smp_rmb() before reading ptr_key. */
764 WRITE_ONCE(filled_random_ptr_key
, true);
768 static int __init
vsprintf_init_hashval(void)
770 static struct notifier_block fill_ptr_key_nb
= { .notifier_call
= fill_ptr_key
};
771 execute_with_initialized_rng(&fill_ptr_key_nb
);
774 subsys_initcall(vsprintf_init_hashval
)
776 /* Maps a pointer to a 32 bit unique identifier. */
777 static inline int __ptr_to_hashval(const void *ptr
, unsigned long *hashval_out
)
779 unsigned long hashval
;
781 if (!READ_ONCE(filled_random_ptr_key
))
784 /* Pairs with smp_wmb() after writing ptr_key. */
788 hashval
= (unsigned long)siphash_1u64((u64
)ptr
, &ptr_key
);
790 * Mask off the first 32 bits, this makes explicit that we have
791 * modified the address (and 32 bits is plenty for a unique ID).
793 hashval
= hashval
& 0xffffffff;
795 hashval
= (unsigned long)siphash_1u32((u32
)ptr
, &ptr_key
);
797 *hashval_out
= hashval
;
801 int ptr_to_hashval(const void *ptr
, unsigned long *hashval_out
)
803 return __ptr_to_hashval(ptr
, hashval_out
);
806 static char *ptr_to_id(char *buf
, char *end
, const void *ptr
,
807 struct printf_spec spec
)
809 const char *str
= sizeof(ptr
) == 8 ? "(____ptrval____)" : "(ptrval)";
810 unsigned long hashval
;
814 * Print the real pointer value for NULL and error pointers,
815 * as they are not actual addresses.
817 if (IS_ERR_OR_NULL(ptr
))
818 return pointer_string(buf
, end
, ptr
, spec
);
820 /* When debugging early boot use non-cryptographically secure hash. */
821 if (unlikely(debug_boot_weak_hash
)) {
822 hashval
= hash_long((unsigned long)ptr
, 32);
823 return pointer_string(buf
, end
, (const void *)hashval
, spec
);
826 ret
= __ptr_to_hashval(ptr
, &hashval
);
828 spec
.field_width
= 2 * sizeof(ptr
);
829 /* string length must be less than default_width */
830 return error_string(buf
, end
, str
, spec
);
833 return pointer_string(buf
, end
, (const void *)hashval
, spec
);
836 static char *default_pointer(char *buf
, char *end
, const void *ptr
,
837 struct printf_spec spec
)
840 * default is to _not_ leak addresses, so hash before printing,
841 * unless no_hash_pointers is specified on the command line.
843 if (unlikely(no_hash_pointers
))
844 return pointer_string(buf
, end
, ptr
, spec
);
846 return ptr_to_id(buf
, end
, ptr
, spec
);
849 int kptr_restrict __read_mostly
;
851 static noinline_for_stack
852 char *restricted_pointer(char *buf
, char *end
, const void *ptr
,
853 struct printf_spec spec
)
855 switch (kptr_restrict
) {
857 /* Handle as %p, hash and do _not_ leak addresses. */
858 return default_pointer(buf
, end
, ptr
, spec
);
860 const struct cred
*cred
;
863 * kptr_restrict==1 cannot be used in IRQ context
864 * because its test for CAP_SYSLOG would be meaningless.
866 if (in_hardirq() || in_serving_softirq() || in_nmi()) {
867 if (spec
.field_width
== -1)
868 spec
.field_width
= 2 * sizeof(ptr
);
869 return error_string(buf
, end
, "pK-error", spec
);
873 * Only print the real pointer value if the current
874 * process has CAP_SYSLOG and is running with the
875 * same credentials it started with. This is because
876 * access to files is checked at open() time, but %pK
877 * checks permission at read() time. We don't want to
878 * leak pointer values if a binary opens a file using
879 * %pK and then elevates privileges before reading it.
881 cred
= current_cred();
882 if (!has_capability_noaudit(current
, CAP_SYSLOG
) ||
883 !uid_eq(cred
->euid
, cred
->uid
) ||
884 !gid_eq(cred
->egid
, cred
->gid
))
890 /* Always print 0's for %pK */
895 return pointer_string(buf
, end
, ptr
, spec
);
898 static noinline_for_stack
899 char *dentry_name(char *buf
, char *end
, const struct dentry
*d
, struct printf_spec spec
,
902 const char *array
[4], *s
;
903 const struct dentry
*p
;
908 case '2': case '3': case '4':
909 depth
= fmt
[1] - '0';
916 for (i
= 0; i
< depth
; i
++, d
= p
) {
917 if (check_pointer(&buf
, end
, d
, spec
)) {
922 p
= READ_ONCE(d
->d_parent
);
923 array
[i
] = READ_ONCE(d
->d_name
.name
);
932 for (n
= 0; n
!= spec
.precision
; n
++, buf
++) {
944 return widen_string(buf
, n
, end
, spec
);
947 static noinline_for_stack
948 char *file_dentry_name(char *buf
, char *end
, const struct file
*f
,
949 struct printf_spec spec
, const char *fmt
)
951 if (check_pointer(&buf
, end
, f
, spec
))
954 return dentry_name(buf
, end
, f
->f_path
.dentry
, spec
, fmt
);
957 static noinline_for_stack
958 char *bdev_name(char *buf
, char *end
, struct block_device
*bdev
,
959 struct printf_spec spec
, const char *fmt
)
963 if (check_pointer(&buf
, end
, bdev
, spec
))
967 buf
= string(buf
, end
, hd
->disk_name
, spec
);
968 if (bdev
->bd_partno
) {
969 if (isdigit(hd
->disk_name
[strlen(hd
->disk_name
)-1])) {
974 buf
= number(buf
, end
, bdev
->bd_partno
, spec
);
980 static noinline_for_stack
981 char *symbol_string(char *buf
, char *end
, void *ptr
,
982 struct printf_spec spec
, const char *fmt
)
985 #ifdef CONFIG_KALLSYMS
986 char sym
[KSYM_SYMBOL_LEN
];
990 ptr
= __builtin_extract_return_addr(ptr
);
991 value
= (unsigned long)ptr
;
993 #ifdef CONFIG_KALLSYMS
994 if (*fmt
== 'B' && fmt
[1] == 'b')
995 sprint_backtrace_build_id(sym
, value
);
996 else if (*fmt
== 'B')
997 sprint_backtrace(sym
, value
);
998 else if (*fmt
== 'S' && (fmt
[1] == 'b' || (fmt
[1] == 'R' && fmt
[2] == 'b')))
999 sprint_symbol_build_id(sym
, value
);
1000 else if (*fmt
!= 's')
1001 sprint_symbol(sym
, value
);
1003 sprint_symbol_no_offset(sym
, value
);
1005 return string_nocheck(buf
, end
, sym
, spec
);
1007 return special_hex_number(buf
, end
, value
, sizeof(void *));
1011 static const struct printf_spec default_str_spec
= {
1016 static const struct printf_spec default_flag_spec
= {
1019 .flags
= SPECIAL
| SMALL
,
1022 static const struct printf_spec default_dec_spec
= {
1027 static const struct printf_spec default_dec02_spec
= {
1034 static const struct printf_spec default_dec04_spec
= {
1041 static noinline_for_stack
1042 char *resource_string(char *buf
, char *end
, struct resource
*res
,
1043 struct printf_spec spec
, const char *fmt
)
1045 #ifndef IO_RSRC_PRINTK_SIZE
1046 #define IO_RSRC_PRINTK_SIZE 6
1049 #ifndef MEM_RSRC_PRINTK_SIZE
1050 #define MEM_RSRC_PRINTK_SIZE 10
1052 static const struct printf_spec io_spec
= {
1054 .field_width
= IO_RSRC_PRINTK_SIZE
,
1056 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
1058 static const struct printf_spec mem_spec
= {
1060 .field_width
= MEM_RSRC_PRINTK_SIZE
,
1062 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
1064 static const struct printf_spec bus_spec
= {
1068 .flags
= SMALL
| ZEROPAD
,
1070 static const struct printf_spec str_spec
= {
1076 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1077 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1078 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1079 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
1080 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
1081 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1082 char sym
[max(2*RSRC_BUF_SIZE
+ DECODED_BUF_SIZE
,
1083 2*RSRC_BUF_SIZE
+ FLAG_BUF_SIZE
+ RAW_BUF_SIZE
)];
1085 char *p
= sym
, *pend
= sym
+ sizeof(sym
);
1086 int decode
= (fmt
[0] == 'R') ? 1 : 0;
1087 const struct printf_spec
*specp
;
1089 if (check_pointer(&buf
, end
, res
, spec
))
1093 if (res
->flags
& IORESOURCE_IO
) {
1094 p
= string_nocheck(p
, pend
, "io ", str_spec
);
1096 } else if (res
->flags
& IORESOURCE_MEM
) {
1097 p
= string_nocheck(p
, pend
, "mem ", str_spec
);
1099 } else if (res
->flags
& IORESOURCE_IRQ
) {
1100 p
= string_nocheck(p
, pend
, "irq ", str_spec
);
1101 specp
= &default_dec_spec
;
1102 } else if (res
->flags
& IORESOURCE_DMA
) {
1103 p
= string_nocheck(p
, pend
, "dma ", str_spec
);
1104 specp
= &default_dec_spec
;
1105 } else if (res
->flags
& IORESOURCE_BUS
) {
1106 p
= string_nocheck(p
, pend
, "bus ", str_spec
);
1109 p
= string_nocheck(p
, pend
, "??? ", str_spec
);
1113 if (decode
&& res
->flags
& IORESOURCE_UNSET
) {
1114 p
= string_nocheck(p
, pend
, "size ", str_spec
);
1115 p
= number(p
, pend
, resource_size(res
), *specp
);
1117 p
= number(p
, pend
, res
->start
, *specp
);
1118 if (res
->start
!= res
->end
) {
1120 p
= number(p
, pend
, res
->end
, *specp
);
1124 if (res
->flags
& IORESOURCE_MEM_64
)
1125 p
= string_nocheck(p
, pend
, " 64bit", str_spec
);
1126 if (res
->flags
& IORESOURCE_PREFETCH
)
1127 p
= string_nocheck(p
, pend
, " pref", str_spec
);
1128 if (res
->flags
& IORESOURCE_WINDOW
)
1129 p
= string_nocheck(p
, pend
, " window", str_spec
);
1130 if (res
->flags
& IORESOURCE_DISABLED
)
1131 p
= string_nocheck(p
, pend
, " disabled", str_spec
);
1133 p
= string_nocheck(p
, pend
, " flags ", str_spec
);
1134 p
= number(p
, pend
, res
->flags
, default_flag_spec
);
1139 return string_nocheck(buf
, end
, sym
, spec
);
1142 static noinline_for_stack
1143 char *hex_string(char *buf
, char *end
, u8
*addr
, struct printf_spec spec
,
1146 int i
, len
= 1; /* if we pass '%ph[CDN]', field width remains
1147 negative value, fallback to the default */
1150 if (spec
.field_width
== 0)
1151 /* nothing to print */
1154 if (check_pointer(&buf
, end
, addr
, spec
))
1172 if (spec
.field_width
> 0)
1173 len
= min_t(int, spec
.field_width
, 64);
1175 for (i
= 0; i
< len
; ++i
) {
1177 *buf
= hex_asc_hi(addr
[i
]);
1180 *buf
= hex_asc_lo(addr
[i
]);
1183 if (separator
&& i
!= len
- 1) {
1193 static noinline_for_stack
1194 char *bitmap_string(char *buf
, char *end
, const unsigned long *bitmap
,
1195 struct printf_spec spec
, const char *fmt
)
1197 const int CHUNKSZ
= 32;
1198 int nr_bits
= max_t(int, spec
.field_width
, 0);
1202 if (check_pointer(&buf
, end
, bitmap
, spec
))
1205 /* reused to print numbers */
1206 spec
= (struct printf_spec
){ .flags
= SMALL
| ZEROPAD
, .base
= 16 };
1208 chunksz
= nr_bits
& (CHUNKSZ
- 1);
1212 i
= ALIGN(nr_bits
, CHUNKSZ
) - CHUNKSZ
;
1213 for (; i
>= 0; i
-= CHUNKSZ
) {
1217 chunkmask
= ((1ULL << chunksz
) - 1);
1218 word
= i
/ BITS_PER_LONG
;
1219 bit
= i
% BITS_PER_LONG
;
1220 val
= (bitmap
[word
] >> bit
) & chunkmask
;
1229 spec
.field_width
= DIV_ROUND_UP(chunksz
, 4);
1230 buf
= number(buf
, end
, val
, spec
);
1237 static noinline_for_stack
1238 char *bitmap_list_string(char *buf
, char *end
, const unsigned long *bitmap
,
1239 struct printf_spec spec
, const char *fmt
)
1241 int nr_bits
= max_t(int, spec
.field_width
, 0);
1245 if (check_pointer(&buf
, end
, bitmap
, spec
))
1248 for_each_set_bitrange(rbot
, rtop
, bitmap
, nr_bits
) {
1256 buf
= number(buf
, end
, rbot
, default_dec_spec
);
1257 if (rtop
== rbot
+ 1)
1262 buf
= number(++buf
, end
, rtop
- 1, default_dec_spec
);
1267 static noinline_for_stack
1268 char *mac_address_string(char *buf
, char *end
, u8
*addr
,
1269 struct printf_spec spec
, const char *fmt
)
1271 char mac_addr
[sizeof("xx:xx:xx:xx:xx:xx")];
1275 bool reversed
= false;
1277 if (check_pointer(&buf
, end
, addr
, spec
))
1294 for (i
= 0; i
< 6; i
++) {
1296 p
= hex_byte_pack(p
, addr
[5 - i
]);
1298 p
= hex_byte_pack(p
, addr
[i
]);
1300 if (fmt
[0] == 'M' && i
!= 5)
1305 return string_nocheck(buf
, end
, mac_addr
, spec
);
1308 static noinline_for_stack
1309 char *ip4_string(char *p
, const u8
*addr
, const char *fmt
)
1312 bool leading_zeros
= (fmt
[0] == 'i');
1337 for (i
= 0; i
< 4; i
++) {
1338 char temp
[4] __aligned(2); /* hold each IP quad in reverse order */
1339 int digits
= put_dec_trunc8(temp
, addr
[index
]) - temp
;
1340 if (leading_zeros
) {
1346 /* reverse the digits in the quad */
1348 *p
++ = temp
[digits
];
1358 static noinline_for_stack
1359 char *ip6_compressed_string(char *p
, const char *addr
)
1362 unsigned char zerolength
[8];
1367 bool needcolon
= false;
1369 struct in6_addr in6
;
1371 memcpy(&in6
, addr
, sizeof(struct in6_addr
));
1373 useIPv4
= ipv6_addr_v4mapped(&in6
) || ipv6_addr_is_isatap(&in6
);
1375 memset(zerolength
, 0, sizeof(zerolength
));
1382 /* find position of longest 0 run */
1383 for (i
= 0; i
< range
; i
++) {
1384 for (j
= i
; j
< range
; j
++) {
1385 if (in6
.s6_addr16
[j
] != 0)
1390 for (i
= 0; i
< range
; i
++) {
1391 if (zerolength
[i
] > longest
) {
1392 longest
= zerolength
[i
];
1396 if (longest
== 1) /* don't compress a single 0 */
1400 for (i
= 0; i
< range
; i
++) {
1401 if (i
== colonpos
) {
1402 if (needcolon
|| i
== 0)
1413 /* hex u16 without leading 0s */
1414 word
= ntohs(in6
.s6_addr16
[i
]);
1419 p
= hex_byte_pack(p
, hi
);
1421 *p
++ = hex_asc_lo(hi
);
1422 p
= hex_byte_pack(p
, lo
);
1425 p
= hex_byte_pack(p
, lo
);
1427 *p
++ = hex_asc_lo(lo
);
1434 p
= ip4_string(p
, &in6
.s6_addr
[12], "I4");
1441 static noinline_for_stack
1442 char *ip6_string(char *p
, const char *addr
, const char *fmt
)
1446 for (i
= 0; i
< 8; i
++) {
1447 p
= hex_byte_pack(p
, *addr
++);
1448 p
= hex_byte_pack(p
, *addr
++);
1449 if (fmt
[0] == 'I' && i
!= 7)
1457 static noinline_for_stack
1458 char *ip6_addr_string(char *buf
, char *end
, const u8
*addr
,
1459 struct printf_spec spec
, const char *fmt
)
1461 char ip6_addr
[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1463 if (fmt
[0] == 'I' && fmt
[2] == 'c')
1464 ip6_compressed_string(ip6_addr
, addr
);
1466 ip6_string(ip6_addr
, addr
, fmt
);
1468 return string_nocheck(buf
, end
, ip6_addr
, spec
);
1471 static noinline_for_stack
1472 char *ip4_addr_string(char *buf
, char *end
, const u8
*addr
,
1473 struct printf_spec spec
, const char *fmt
)
1475 char ip4_addr
[sizeof("255.255.255.255")];
1477 ip4_string(ip4_addr
, addr
, fmt
);
1479 return string_nocheck(buf
, end
, ip4_addr
, spec
);
1482 static noinline_for_stack
1483 char *ip6_addr_string_sa(char *buf
, char *end
, const struct sockaddr_in6
*sa
,
1484 struct printf_spec spec
, const char *fmt
)
1486 bool have_p
= false, have_s
= false, have_f
= false, have_c
= false;
1487 char ip6_addr
[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1488 sizeof(":12345") + sizeof("/123456789") +
1489 sizeof("%1234567890")];
1490 char *p
= ip6_addr
, *pend
= ip6_addr
+ sizeof(ip6_addr
);
1491 const u8
*addr
= (const u8
*) &sa
->sin6_addr
;
1492 char fmt6
[2] = { fmt
[0], '6' };
1496 while (isalpha(*++fmt
)) {
1513 if (have_p
|| have_s
|| have_f
) {
1518 if (fmt6
[0] == 'I' && have_c
)
1519 p
= ip6_compressed_string(ip6_addr
+ off
, addr
);
1521 p
= ip6_string(ip6_addr
+ off
, addr
, fmt6
);
1523 if (have_p
|| have_s
|| have_f
)
1528 p
= number(p
, pend
, ntohs(sa
->sin6_port
), spec
);
1532 p
= number(p
, pend
, ntohl(sa
->sin6_flowinfo
&
1533 IPV6_FLOWINFO_MASK
), spec
);
1537 p
= number(p
, pend
, sa
->sin6_scope_id
, spec
);
1541 return string_nocheck(buf
, end
, ip6_addr
, spec
);
1544 static noinline_for_stack
1545 char *ip4_addr_string_sa(char *buf
, char *end
, const struct sockaddr_in
*sa
,
1546 struct printf_spec spec
, const char *fmt
)
1548 bool have_p
= false;
1549 char *p
, ip4_addr
[sizeof("255.255.255.255") + sizeof(":12345")];
1550 char *pend
= ip4_addr
+ sizeof(ip4_addr
);
1551 const u8
*addr
= (const u8
*) &sa
->sin_addr
.s_addr
;
1552 char fmt4
[3] = { fmt
[0], '4', 0 };
1555 while (isalpha(*++fmt
)) {
1569 p
= ip4_string(ip4_addr
, addr
, fmt4
);
1572 p
= number(p
, pend
, ntohs(sa
->sin_port
), spec
);
1576 return string_nocheck(buf
, end
, ip4_addr
, spec
);
1579 static noinline_for_stack
1580 char *ip_addr_string(char *buf
, char *end
, const void *ptr
,
1581 struct printf_spec spec
, const char *fmt
)
1585 if (check_pointer(&buf
, end
, ptr
, spec
))
1590 return ip6_addr_string(buf
, end
, ptr
, spec
, fmt
);
1592 return ip4_addr_string(buf
, end
, ptr
, spec
, fmt
);
1595 struct sockaddr raw
;
1596 struct sockaddr_in v4
;
1597 struct sockaddr_in6 v6
;
1600 switch (sa
->raw
.sa_family
) {
1602 return ip4_addr_string_sa(buf
, end
, &sa
->v4
, spec
, fmt
);
1604 return ip6_addr_string_sa(buf
, end
, &sa
->v6
, spec
, fmt
);
1606 return error_string(buf
, end
, "(einval)", spec
);
1610 err_fmt_msg
= fmt
[0] == 'i' ? "(%pi?)" : "(%pI?)";
1611 return error_string(buf
, end
, err_fmt_msg
, spec
);
1614 static noinline_for_stack
1615 char *escaped_string(char *buf
, char *end
, u8
*addr
, struct printf_spec spec
,
1620 unsigned int flags
= 0;
1623 if (spec
.field_width
== 0)
1624 return buf
; /* nothing to print */
1626 if (check_pointer(&buf
, end
, addr
, spec
))
1630 switch (fmt
[count
++]) {
1632 flags
|= ESCAPE_ANY
;
1635 flags
|= ESCAPE_SPECIAL
;
1638 flags
|= ESCAPE_HEX
;
1641 flags
|= ESCAPE_NULL
;
1644 flags
|= ESCAPE_OCTAL
;
1650 flags
|= ESCAPE_SPACE
;
1659 flags
= ESCAPE_ANY_NP
;
1661 len
= spec
.field_width
< 0 ? 1 : spec
.field_width
;
1664 * string_escape_mem() writes as many characters as it can to
1665 * the given buffer, and returns the total size of the output
1666 * had the buffer been big enough.
1668 buf
+= string_escape_mem(addr
, len
, buf
, buf
< end
? end
- buf
: 0, flags
, NULL
);
1673 static char *va_format(char *buf
, char *end
, struct va_format
*va_fmt
,
1674 struct printf_spec spec
, const char *fmt
)
1678 if (check_pointer(&buf
, end
, va_fmt
, spec
))
1681 va_copy(va
, *va_fmt
->va
);
1682 buf
+= vsnprintf(buf
, end
> buf
? end
- buf
: 0, va_fmt
->fmt
, va
);
1688 static noinline_for_stack
1689 char *uuid_string(char *buf
, char *end
, const u8
*addr
,
1690 struct printf_spec spec
, const char *fmt
)
1692 char uuid
[UUID_STRING_LEN
+ 1];
1695 const u8
*index
= uuid_index
;
1698 if (check_pointer(&buf
, end
, addr
, spec
))
1713 for (i
= 0; i
< 16; i
++) {
1715 p
= hex_byte_pack_upper(p
, addr
[index
[i
]]);
1717 p
= hex_byte_pack(p
, addr
[index
[i
]]);
1730 return string_nocheck(buf
, end
, uuid
, spec
);
1733 static noinline_for_stack
1734 char *netdev_bits(char *buf
, char *end
, const void *addr
,
1735 struct printf_spec spec
, const char *fmt
)
1737 unsigned long long num
;
1740 if (check_pointer(&buf
, end
, addr
, spec
))
1745 num
= *(const netdev_features_t
*)addr
;
1746 size
= sizeof(netdev_features_t
);
1749 return error_string(buf
, end
, "(%pN?)", spec
);
1752 return special_hex_number(buf
, end
, num
, size
);
1755 static noinline_for_stack
1756 char *fourcc_string(char *buf
, char *end
, const u32
*fourcc
,
1757 struct printf_spec spec
, const char *fmt
)
1759 char output
[sizeof("0123 little-endian (0x01234567)")];
1764 if (fmt
[1] != 'c' || fmt
[2] != 'c')
1765 return error_string(buf
, end
, "(%p4?)", spec
);
1767 if (check_pointer(&buf
, end
, fourcc
, spec
))
1770 orig
= get_unaligned(fourcc
);
1771 val
= orig
& ~BIT(31);
1773 for (i
= 0; i
< sizeof(u32
); i
++) {
1774 unsigned char c
= val
>> (i
* 8);
1776 /* Print non-control ASCII characters as-is, dot otherwise */
1777 *p
++ = isascii(c
) && isprint(c
) ? c
: '.';
1781 strcpy(p
, orig
& BIT(31) ? "big-endian" : "little-endian");
1786 p
= special_hex_number(p
, output
+ sizeof(output
) - 2, orig
, sizeof(u32
));
1790 return string(buf
, end
, output
, spec
);
1793 static noinline_for_stack
1794 char *address_val(char *buf
, char *end
, const void *addr
,
1795 struct printf_spec spec
, const char *fmt
)
1797 unsigned long long num
;
1800 if (check_pointer(&buf
, end
, addr
, spec
))
1805 num
= *(const dma_addr_t
*)addr
;
1806 size
= sizeof(dma_addr_t
);
1810 num
= *(const phys_addr_t
*)addr
;
1811 size
= sizeof(phys_addr_t
);
1815 return special_hex_number(buf
, end
, num
, size
);
1818 static noinline_for_stack
1819 char *date_str(char *buf
, char *end
, const struct rtc_time
*tm
, bool r
)
1821 int year
= tm
->tm_year
+ (r
? 0 : 1900);
1822 int mon
= tm
->tm_mon
+ (r
? 0 : 1);
1824 buf
= number(buf
, end
, year
, default_dec04_spec
);
1829 buf
= number(buf
, end
, mon
, default_dec02_spec
);
1834 return number(buf
, end
, tm
->tm_mday
, default_dec02_spec
);
1837 static noinline_for_stack
1838 char *time_str(char *buf
, char *end
, const struct rtc_time
*tm
, bool r
)
1840 buf
= number(buf
, end
, tm
->tm_hour
, default_dec02_spec
);
1845 buf
= number(buf
, end
, tm
->tm_min
, default_dec02_spec
);
1850 return number(buf
, end
, tm
->tm_sec
, default_dec02_spec
);
1853 static noinline_for_stack
1854 char *rtc_str(char *buf
, char *end
, const struct rtc_time
*tm
,
1855 struct printf_spec spec
, const char *fmt
)
1857 bool have_t
= true, have_d
= true;
1858 bool raw
= false, iso8601_separator
= true;
1862 if (check_pointer(&buf
, end
, tm
, spec
))
1865 switch (fmt
[count
]) {
1877 switch (fmt
[count
++]) {
1882 iso8601_separator
= false;
1891 buf
= date_str(buf
, end
, tm
, raw
);
1892 if (have_d
&& have_t
) {
1894 *buf
= iso8601_separator
? 'T' : ' ';
1898 buf
= time_str(buf
, end
, tm
, raw
);
1903 static noinline_for_stack
1904 char *time64_str(char *buf
, char *end
, const time64_t time
,
1905 struct printf_spec spec
, const char *fmt
)
1907 struct rtc_time rtc_time
;
1910 time64_to_tm(time
, 0, &tm
);
1912 rtc_time
.tm_sec
= tm
.tm_sec
;
1913 rtc_time
.tm_min
= tm
.tm_min
;
1914 rtc_time
.tm_hour
= tm
.tm_hour
;
1915 rtc_time
.tm_mday
= tm
.tm_mday
;
1916 rtc_time
.tm_mon
= tm
.tm_mon
;
1917 rtc_time
.tm_year
= tm
.tm_year
;
1918 rtc_time
.tm_wday
= tm
.tm_wday
;
1919 rtc_time
.tm_yday
= tm
.tm_yday
;
1921 rtc_time
.tm_isdst
= 0;
1923 return rtc_str(buf
, end
, &rtc_time
, spec
, fmt
);
1926 static noinline_for_stack
1927 char *time_and_date(char *buf
, char *end
, void *ptr
, struct printf_spec spec
,
1932 return rtc_str(buf
, end
, (const struct rtc_time
*)ptr
, spec
, fmt
);
1934 return time64_str(buf
, end
, *(const time64_t
*)ptr
, spec
, fmt
);
1936 return error_string(buf
, end
, "(%pt?)", spec
);
1940 static noinline_for_stack
1941 char *clock(char *buf
, char *end
, struct clk
*clk
, struct printf_spec spec
,
1944 if (!IS_ENABLED(CONFIG_HAVE_CLK
))
1945 return error_string(buf
, end
, "(%pC?)", spec
);
1947 if (check_pointer(&buf
, end
, clk
, spec
))
1953 #ifdef CONFIG_COMMON_CLK
1954 return string(buf
, end
, __clk_get_name(clk
), spec
);
1956 return ptr_to_id(buf
, end
, clk
, spec
);
1962 char *format_flags(char *buf
, char *end
, unsigned long flags
,
1963 const struct trace_print_flags
*names
)
1967 for ( ; flags
&& names
->name
; names
++) {
1969 if ((flags
& mask
) != mask
)
1972 buf
= string(buf
, end
, names
->name
, default_str_spec
);
1983 buf
= number(buf
, end
, flags
, default_flag_spec
);
1988 struct page_flags_fields
{
1992 const struct printf_spec
*spec
;
1996 static const struct page_flags_fields pff
[] = {
1997 {SECTIONS_WIDTH
, SECTIONS_PGSHIFT
, SECTIONS_MASK
,
1998 &default_dec_spec
, "section"},
1999 {NODES_WIDTH
, NODES_PGSHIFT
, NODES_MASK
,
2000 &default_dec_spec
, "node"},
2001 {ZONES_WIDTH
, ZONES_PGSHIFT
, ZONES_MASK
,
2002 &default_dec_spec
, "zone"},
2003 {LAST_CPUPID_WIDTH
, LAST_CPUPID_PGSHIFT
, LAST_CPUPID_MASK
,
2004 &default_flag_spec
, "lastcpupid"},
2005 {KASAN_TAG_WIDTH
, KASAN_TAG_PGSHIFT
, KASAN_TAG_MASK
,
2006 &default_flag_spec
, "kasantag"},
2010 char *format_page_flags(char *buf
, char *end
, unsigned long flags
)
2012 unsigned long main_flags
= flags
& PAGEFLAGS_MASK
;
2013 bool append
= false;
2016 buf
= number(buf
, end
, flags
, default_flag_spec
);
2021 /* Page flags from the main area. */
2023 buf
= format_flags(buf
, end
, main_flags
, pageflag_names
);
2027 /* Page flags from the fields area */
2028 for (i
= 0; i
< ARRAY_SIZE(pff
); i
++) {
2029 /* Skip undefined fields. */
2033 /* Format: Flag Name + '=' (equals sign) + Number + '|' (separator) */
2040 buf
= string(buf
, end
, pff
[i
].name
, default_str_spec
);
2044 buf
= number(buf
, end
, (flags
>> pff
[i
].shift
) & pff
[i
].mask
,
2057 char *format_page_type(char *buf
, char *end
, unsigned int page_type
)
2059 buf
= number(buf
, end
, page_type
, default_flag_spec
);
2065 if (page_type_has_type(page_type
))
2066 buf
= format_flags(buf
, end
, ~page_type
, pagetype_names
);
2075 static noinline_for_stack
2076 char *flags_string(char *buf
, char *end
, void *flags_ptr
,
2077 struct printf_spec spec
, const char *fmt
)
2079 unsigned long flags
;
2080 const struct trace_print_flags
*names
;
2082 if (check_pointer(&buf
, end
, flags_ptr
, spec
))
2087 return format_page_flags(buf
, end
, *(unsigned long *)flags_ptr
);
2089 return format_page_type(buf
, end
, *(unsigned int *)flags_ptr
);
2091 flags
= *(unsigned long *)flags_ptr
;
2092 names
= vmaflag_names
;
2095 flags
= (__force
unsigned long)(*(gfp_t
*)flags_ptr
);
2096 names
= gfpflag_names
;
2099 return error_string(buf
, end
, "(%pG?)", spec
);
2102 return format_flags(buf
, end
, flags
, names
);
2105 static noinline_for_stack
2106 char *fwnode_full_name_string(struct fwnode_handle
*fwnode
, char *buf
,
2111 /* Loop starting from the root node to the current node. */
2112 for (depth
= fwnode_count_parents(fwnode
); depth
>= 0; depth
--) {
2113 struct fwnode_handle
*__fwnode
=
2114 fwnode_get_nth_parent(fwnode
, depth
);
2116 buf
= string(buf
, end
, fwnode_get_name_prefix(__fwnode
),
2118 buf
= string(buf
, end
, fwnode_get_name(__fwnode
),
2121 fwnode_handle_put(__fwnode
);
2127 static noinline_for_stack
2128 char *device_node_string(char *buf
, char *end
, struct device_node
*dn
,
2129 struct printf_spec spec
, const char *fmt
)
2131 char tbuf
[sizeof("xxxx") + 1];
2134 char *buf_start
= buf
;
2135 struct property
*prop
;
2136 bool has_mult
, pass
;
2138 struct printf_spec str_spec
= spec
;
2139 str_spec
.field_width
= -1;
2142 return error_string(buf
, end
, "(%pO?)", spec
);
2144 if (!IS_ENABLED(CONFIG_OF
))
2145 return error_string(buf
, end
, "(%pOF?)", spec
);
2147 if (check_pointer(&buf
, end
, dn
, spec
))
2150 /* simple case without anything any more format specifiers */
2152 if (fmt
[0] == '\0' || strcspn(fmt
,"fnpPFcC") > 0)
2155 for (pass
= false; strspn(fmt
,"fnpPFcC"); fmt
++, pass
= true) {
2164 case 'f': /* full_name */
2165 buf
= fwnode_full_name_string(of_fwnode_handle(dn
), buf
,
2168 case 'n': /* name */
2169 p
= fwnode_get_name(of_fwnode_handle(dn
));
2170 precision
= str_spec
.precision
;
2171 str_spec
.precision
= strchrnul(p
, '@') - p
;
2172 buf
= string(buf
, end
, p
, str_spec
);
2173 str_spec
.precision
= precision
;
2175 case 'p': /* phandle */
2176 buf
= number(buf
, end
, (unsigned int)dn
->phandle
, default_dec_spec
);
2178 case 'P': /* path-spec */
2179 p
= fwnode_get_name(of_fwnode_handle(dn
));
2182 buf
= string(buf
, end
, p
, str_spec
);
2184 case 'F': /* flags */
2185 tbuf
[0] = of_node_check_flag(dn
, OF_DYNAMIC
) ? 'D' : '-';
2186 tbuf
[1] = of_node_check_flag(dn
, OF_DETACHED
) ? 'd' : '-';
2187 tbuf
[2] = of_node_check_flag(dn
, OF_POPULATED
) ? 'P' : '-';
2188 tbuf
[3] = of_node_check_flag(dn
, OF_POPULATED_BUS
) ? 'B' : '-';
2190 buf
= string_nocheck(buf
, end
, tbuf
, str_spec
);
2192 case 'c': /* major compatible string */
2193 ret
= of_property_read_string(dn
, "compatible", &p
);
2195 buf
= string(buf
, end
, p
, str_spec
);
2197 case 'C': /* full compatible string */
2199 of_property_for_each_string(dn
, "compatible", prop
, p
) {
2201 buf
= string_nocheck(buf
, end
, ",", str_spec
);
2202 buf
= string_nocheck(buf
, end
, "\"", str_spec
);
2203 buf
= string(buf
, end
, p
, str_spec
);
2204 buf
= string_nocheck(buf
, end
, "\"", str_spec
);
2214 return widen_string(buf
, buf
- buf_start
, end
, spec
);
2217 static noinline_for_stack
2218 char *fwnode_string(char *buf
, char *end
, struct fwnode_handle
*fwnode
,
2219 struct printf_spec spec
, const char *fmt
)
2221 struct printf_spec str_spec
= spec
;
2222 char *buf_start
= buf
;
2224 str_spec
.field_width
= -1;
2227 return error_string(buf
, end
, "(%pf?)", spec
);
2229 if (check_pointer(&buf
, end
, fwnode
, spec
))
2235 case 'P': /* name */
2236 buf
= string(buf
, end
, fwnode_get_name(fwnode
), str_spec
);
2238 case 'f': /* full_name */
2240 buf
= fwnode_full_name_string(fwnode
, buf
, end
);
2244 return widen_string(buf
, buf
- buf_start
, end
, spec
);
2247 int __init
no_hash_pointers_enable(char *str
)
2249 if (no_hash_pointers
)
2252 no_hash_pointers
= true;
2254 pr_warn("**********************************************************\n");
2255 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2257 pr_warn("** This system shows unhashed kernel memory addresses **\n");
2258 pr_warn("** via the console, logs, and other interfaces. This **\n");
2259 pr_warn("** might reduce the security of your system. **\n");
2261 pr_warn("** If you see this message and you are not debugging **\n");
2262 pr_warn("** the kernel, report this immediately to your system **\n");
2263 pr_warn("** administrator! **\n");
2265 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2266 pr_warn("**********************************************************\n");
2270 early_param("no_hash_pointers", no_hash_pointers_enable
);
2272 /* Used for Rust formatting ('%pA'). */
2273 char *rust_fmt_argument(char *buf
, char *end
, void *ptr
);
2276 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2277 * by an extra set of alphanumeric characters that are extended format
2280 * Please update scripts/checkpatch.pl when adding/removing conversion
2281 * characters. (Search for "check for vsprintf extension").
2283 * Right now we handle:
2285 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2286 * - 's' For symbolic direct pointers (or function descriptors) without offset
2287 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
2288 * - 'S[R]b' as above with module build ID (for use in backtraces)
2289 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2290 * %ps and %pS. Be careful when re-using these specifiers.
2291 * - 'B' For backtraced symbolic direct pointers with offset
2292 * - 'Bb' as above with module build ID (for use in backtraces)
2293 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2294 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2295 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2296 * width which must be explicitly specified either as part of the
2297 * format string '%32b[l]' or through '%*b[l]', [l] selects
2298 * range-list format instead of hex format
2299 * - 'M' For a 6-byte MAC address, it prints the address in the
2300 * usual colon-separated hex notation
2301 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2302 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2303 * with a dash-separated hex notation
2304 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2305 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2306 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2307 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
2309 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2310 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2311 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2312 * IPv6 omits the colons (01020304...0f)
2313 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2315 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2316 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2317 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2318 * - 'I[6S]c' for IPv6 addresses printed as specified by
2319 * https://tools.ietf.org/html/rfc5952
2320 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2321 * of the following flags (see string_escape_mem() for the
2324 * c - ESCAPE_SPECIAL
2330 * By default ESCAPE_ANY_NP is used.
2331 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2332 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2333 * Options for %pU are:
2334 * b big endian lower case hex (default)
2335 * B big endian UPPER case hex
2336 * l little endian lower case hex
2337 * L little endian UPPER case hex
2338 * big endian output byte order is:
2339 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2340 * little endian output byte order is:
2341 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2342 * - 'V' For a struct va_format which contains a format string * and va_list *,
2343 * call vsnprintf(->format, *->va_list).
2344 * Implements a "recursive vsnprintf".
2345 * Do not use this feature without some mechanism to verify the
2346 * correctness of the format string and va_list arguments.
2347 * - 'K' For a kernel pointer that should be hidden from unprivileged users.
2348 * Use only for procfs, sysfs and similar files, not printk(); please
2349 * read the documentation (path below) first.
2350 * - 'NF' For a netdev_features_t
2351 * - '4cc' V4L2 or DRM FourCC code, with endianness and raw numerical value.
2352 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2353 * a certain separator (' ' by default):
2357 * The maximum supported length is 64 bytes of the input. Consider
2358 * to use print_hex_dump() for the larger input.
2359 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2360 * (default assumed to be phys_addr_t, passed by reference)
2361 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2362 * - 'D[234]' Same as 'd' but for a struct file
2363 * - 'g' For block_device name (gendisk + partition number)
2364 * - 't[RT][dt][r][s]' For time and date as represented by:
2367 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2368 * (legacy clock framework) of the clock
2369 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2370 * (legacy clock framework) of the clock
2371 * - 'G' For flags to be printed as a collection of symbolic strings that would
2372 * construct the specific value. Supported flags given by option:
2373 * p page flags (see struct page) given as pointer to unsigned long
2374 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2375 * v vma flags (VM_*) given as pointer to unsigned long
2376 * - 'OF[fnpPcCF]' For a device tree object
2377 * Without any optional arguments prints the full_name
2378 * f device node full_name
2379 * n device node name
2380 * p device node phandle
2381 * P device node path spec (name + @unit)
2382 * F device node flags
2383 * c major compatible string
2384 * C full compatible string
2385 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2386 * Without an option prints the full name of the node
2388 * P node name, including a possible unit address
2389 * - 'x' For printing the address unmodified. Equivalent to "%lx".
2390 * Please read the documentation (path below) before using!
2391 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
2392 * bpf_trace_printk() where [ku] prefix specifies either kernel (k)
2393 * or user (u) memory to probe, and:
2394 * s a string, equivalent to "%s" on direct vsnprintf() use
2396 * ** When making changes please also update:
2397 * Documentation/core-api/printk-formats.rst
2399 * Note: The default behaviour (unadorned %p) is to hash the address,
2400 * rendering it useful as a unique identifier.
2402 * There is also a '%pA' format specifier, but it is only intended to be used
2403 * from Rust code to format core::fmt::Arguments. Do *not* use it from C.
2404 * See rust/kernel/print.rs for details.
2406 static noinline_for_stack
2407 char *pointer(const char *fmt
, char *buf
, char *end
, void *ptr
,
2408 struct printf_spec spec
)
2413 ptr
= dereference_symbol_descriptor(ptr
);
2416 return symbol_string(buf
, end
, ptr
, spec
, fmt
);
2419 return resource_string(buf
, end
, ptr
, spec
, fmt
);
2421 return hex_string(buf
, end
, ptr
, spec
, fmt
);
2425 return bitmap_list_string(buf
, end
, ptr
, spec
, fmt
);
2427 return bitmap_string(buf
, end
, ptr
, spec
, fmt
);
2429 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2430 case 'm': /* Contiguous: 000102030405 */
2432 /* [mM]R (Reverse order; Bluetooth) */
2433 return mac_address_string(buf
, end
, ptr
, spec
, fmt
);
2434 case 'I': /* Formatted IP supported
2436 * 6: 0001:0203:...:0708
2437 * 6c: 1::708 or 1::1.2.3.4
2439 case 'i': /* Contiguous:
2440 * 4: 001.002.003.004
2443 return ip_addr_string(buf
, end
, ptr
, spec
, fmt
);
2445 return escaped_string(buf
, end
, ptr
, spec
, fmt
);
2447 return uuid_string(buf
, end
, ptr
, spec
, fmt
);
2449 return va_format(buf
, end
, ptr
, spec
, fmt
);
2451 return restricted_pointer(buf
, end
, ptr
, spec
);
2453 return netdev_bits(buf
, end
, ptr
, spec
, fmt
);
2455 return fourcc_string(buf
, end
, ptr
, spec
, fmt
);
2457 return address_val(buf
, end
, ptr
, spec
, fmt
);
2459 return dentry_name(buf
, end
, ptr
, spec
, fmt
);
2461 return time_and_date(buf
, end
, ptr
, spec
, fmt
);
2463 return clock(buf
, end
, ptr
, spec
, fmt
);
2465 return file_dentry_name(buf
, end
, ptr
, spec
, fmt
);
2468 return bdev_name(buf
, end
, ptr
, spec
, fmt
);
2472 return flags_string(buf
, end
, ptr
, spec
, fmt
);
2474 return device_node_string(buf
, end
, ptr
, spec
, fmt
+ 1);
2476 return fwnode_string(buf
, end
, ptr
, spec
, fmt
+ 1);
2478 if (!IS_ENABLED(CONFIG_RUST
)) {
2479 WARN_ONCE(1, "Please remove %%pA from non-Rust code\n");
2480 return error_string(buf
, end
, "(%pA?)", spec
);
2482 return rust_fmt_argument(buf
, end
, ptr
);
2484 return pointer_string(buf
, end
, ptr
, spec
);
2486 /* %pe with a non-ERR_PTR gets treated as plain %p */
2488 return default_pointer(buf
, end
, ptr
, spec
);
2489 return err_ptr(buf
, end
, ptr
, spec
);
2494 return string(buf
, end
, ptr
, spec
);
2496 return error_string(buf
, end
, "(einval)", spec
);
2499 return default_pointer(buf
, end
, ptr
, spec
);
2504 * Helper function to decode printf style format.
2505 * Each call decode a token from the format and return the
2506 * number of characters read (or likely the delta where it wants
2507 * to go on the next call).
2508 * The decoded token is returned through the parameters
2510 * 'h', 'l', or 'L' for integer fields
2511 * 'z' support added 23/7/1999 S.H.
2512 * 'z' changed to 'Z' --davidm 1/25/99
2513 * 'Z' changed to 'z' --adobriyan 2017-01-25
2514 * 't' added for ptrdiff_t
2516 * @fmt: the format string
2517 * @type of the token returned
2518 * @flags: various flags such as +, -, # tokens..
2519 * @field_width: overwritten width
2520 * @base: base of the number (octal, hex, ...)
2521 * @precision: precision of a number
2522 * @qualifier: qualifier of a number (long, size_t, ...)
2524 static noinline_for_stack
2525 int format_decode(const char *fmt
, struct printf_spec
*spec
)
2527 const char *start
= fmt
;
2530 /* we finished early by reading the field width */
2531 if (spec
->type
== FORMAT_TYPE_WIDTH
) {
2532 if (spec
->field_width
< 0) {
2533 spec
->field_width
= -spec
->field_width
;
2534 spec
->flags
|= LEFT
;
2536 spec
->type
= FORMAT_TYPE_NONE
;
2540 /* we finished early by reading the precision */
2541 if (spec
->type
== FORMAT_TYPE_PRECISION
) {
2542 if (spec
->precision
< 0)
2543 spec
->precision
= 0;
2545 spec
->type
= FORMAT_TYPE_NONE
;
2550 spec
->type
= FORMAT_TYPE_NONE
;
2552 for (; *fmt
; ++fmt
) {
2557 /* Return the current non-format string */
2558 if (fmt
!= start
|| !*fmt
)
2564 while (1) { /* this also skips first '%' */
2570 case '-': spec
->flags
|= LEFT
; break;
2571 case '+': spec
->flags
|= PLUS
; break;
2572 case ' ': spec
->flags
|= SPACE
; break;
2573 case '#': spec
->flags
|= SPECIAL
; break;
2574 case '0': spec
->flags
|= ZEROPAD
; break;
2575 default: found
= false;
2582 /* get field width */
2583 spec
->field_width
= -1;
2586 spec
->field_width
= skip_atoi(&fmt
);
2587 else if (*fmt
== '*') {
2588 /* it's the next argument */
2589 spec
->type
= FORMAT_TYPE_WIDTH
;
2590 return ++fmt
- start
;
2594 /* get the precision */
2595 spec
->precision
= -1;
2598 if (isdigit(*fmt
)) {
2599 spec
->precision
= skip_atoi(&fmt
);
2600 if (spec
->precision
< 0)
2601 spec
->precision
= 0;
2602 } else if (*fmt
== '*') {
2603 /* it's the next argument */
2604 spec
->type
= FORMAT_TYPE_PRECISION
;
2605 return ++fmt
- start
;
2610 /* get the conversion qualifier */
2612 if (*fmt
== 'h' || _tolower(*fmt
) == 'l' ||
2613 *fmt
== 'z' || *fmt
== 't') {
2615 if (unlikely(qualifier
== *fmt
)) {
2616 if (qualifier
== 'l') {
2619 } else if (qualifier
== 'h') {
2630 spec
->type
= FORMAT_TYPE_CHAR
;
2631 return ++fmt
- start
;
2634 spec
->type
= FORMAT_TYPE_STR
;
2635 return ++fmt
- start
;
2638 spec
->type
= FORMAT_TYPE_PTR
;
2639 return ++fmt
- start
;
2642 spec
->type
= FORMAT_TYPE_PERCENT_CHAR
;
2643 return ++fmt
- start
;
2645 /* integer number formats - set up the flags and "break" */
2651 spec
->flags
|= SMALL
;
2660 spec
->flags
|= SIGN
;
2667 * Since %n poses a greater security risk than
2668 * utility, treat it as any other invalid or
2669 * unsupported format specifier.
2674 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt
);
2675 spec
->type
= FORMAT_TYPE_INVALID
;
2679 if (qualifier
== 'L')
2680 spec
->type
= FORMAT_TYPE_LONG_LONG
;
2681 else if (qualifier
== 'l') {
2682 BUILD_BUG_ON(FORMAT_TYPE_ULONG
+ SIGN
!= FORMAT_TYPE_LONG
);
2683 spec
->type
= FORMAT_TYPE_ULONG
+ (spec
->flags
& SIGN
);
2684 } else if (qualifier
== 'z') {
2685 spec
->type
= FORMAT_TYPE_SIZE_T
;
2686 } else if (qualifier
== 't') {
2687 spec
->type
= FORMAT_TYPE_PTRDIFF
;
2688 } else if (qualifier
== 'H') {
2689 BUILD_BUG_ON(FORMAT_TYPE_UBYTE
+ SIGN
!= FORMAT_TYPE_BYTE
);
2690 spec
->type
= FORMAT_TYPE_UBYTE
+ (spec
->flags
& SIGN
);
2691 } else if (qualifier
== 'h') {
2692 BUILD_BUG_ON(FORMAT_TYPE_USHORT
+ SIGN
!= FORMAT_TYPE_SHORT
);
2693 spec
->type
= FORMAT_TYPE_USHORT
+ (spec
->flags
& SIGN
);
2695 BUILD_BUG_ON(FORMAT_TYPE_UINT
+ SIGN
!= FORMAT_TYPE_INT
);
2696 spec
->type
= FORMAT_TYPE_UINT
+ (spec
->flags
& SIGN
);
2699 return ++fmt
- start
;
2703 set_field_width(struct printf_spec
*spec
, int width
)
2705 spec
->field_width
= width
;
2706 if (WARN_ONCE(spec
->field_width
!= width
, "field width %d too large", width
)) {
2707 spec
->field_width
= clamp(width
, -FIELD_WIDTH_MAX
, FIELD_WIDTH_MAX
);
2712 set_precision(struct printf_spec
*spec
, int prec
)
2714 spec
->precision
= prec
;
2715 if (WARN_ONCE(spec
->precision
!= prec
, "precision %d too large", prec
)) {
2716 spec
->precision
= clamp(prec
, 0, PRECISION_MAX
);
2721 * vsnprintf - Format a string and place it in a buffer
2722 * @buf: The buffer to place the result into
2723 * @size: The size of the buffer, including the trailing null space
2724 * @fmt: The format string to use
2725 * @args: Arguments for the format string
2727 * This function generally follows C99 vsnprintf, but has some
2728 * extensions and a few limitations:
2730 * - ``%n`` is unsupported
2731 * - ``%p*`` is handled by pointer()
2733 * See pointer() or Documentation/core-api/printk-formats.rst for more
2734 * extensive description.
2736 * **Please update the documentation in both places when making changes**
2738 * The return value is the number of characters which would
2739 * be generated for the given input, excluding the trailing
2740 * '\0', as per ISO C99. If you want to have the exact
2741 * number of characters written into @buf as return value
2742 * (not including the trailing '\0'), use vscnprintf(). If the
2743 * return is greater than or equal to @size, the resulting
2744 * string is truncated.
2746 * If you're not already dealing with a va_list consider using snprintf().
2748 int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
2750 unsigned long long num
;
2752 struct printf_spec spec
= {0};
2754 /* Reject out-of-range values early. Large positive sizes are
2755 used for unknown buffer sizes. */
2756 if (WARN_ON_ONCE(size
> INT_MAX
))
2762 /* Make sure end is always >= buf */
2769 const char *old_fmt
= fmt
;
2770 int read
= format_decode(fmt
, &spec
);
2774 switch (spec
.type
) {
2775 case FORMAT_TYPE_NONE
: {
2778 if (copy
> end
- str
)
2780 memcpy(str
, old_fmt
, copy
);
2786 case FORMAT_TYPE_WIDTH
:
2787 set_field_width(&spec
, va_arg(args
, int));
2790 case FORMAT_TYPE_PRECISION
:
2791 set_precision(&spec
, va_arg(args
, int));
2794 case FORMAT_TYPE_CHAR
: {
2797 if (!(spec
.flags
& LEFT
)) {
2798 while (--spec
.field_width
> 0) {
2805 c
= (unsigned char) va_arg(args
, int);
2809 while (--spec
.field_width
> 0) {
2817 case FORMAT_TYPE_STR
:
2818 str
= string(str
, end
, va_arg(args
, char *), spec
);
2821 case FORMAT_TYPE_PTR
:
2822 str
= pointer(fmt
, str
, end
, va_arg(args
, void *),
2824 while (isalnum(*fmt
))
2828 case FORMAT_TYPE_PERCENT_CHAR
:
2834 case FORMAT_TYPE_INVALID
:
2836 * Presumably the arguments passed gcc's type
2837 * checking, but there is no safe or sane way
2838 * for us to continue parsing the format and
2839 * fetching from the va_list; the remaining
2840 * specifiers and arguments would be out of
2846 switch (spec
.type
) {
2847 case FORMAT_TYPE_LONG_LONG
:
2848 num
= va_arg(args
, long long);
2850 case FORMAT_TYPE_ULONG
:
2851 num
= va_arg(args
, unsigned long);
2853 case FORMAT_TYPE_LONG
:
2854 num
= va_arg(args
, long);
2856 case FORMAT_TYPE_SIZE_T
:
2857 if (spec
.flags
& SIGN
)
2858 num
= va_arg(args
, ssize_t
);
2860 num
= va_arg(args
, size_t);
2862 case FORMAT_TYPE_PTRDIFF
:
2863 num
= va_arg(args
, ptrdiff_t);
2865 case FORMAT_TYPE_UBYTE
:
2866 num
= (unsigned char) va_arg(args
, int);
2868 case FORMAT_TYPE_BYTE
:
2869 num
= (signed char) va_arg(args
, int);
2871 case FORMAT_TYPE_USHORT
:
2872 num
= (unsigned short) va_arg(args
, int);
2874 case FORMAT_TYPE_SHORT
:
2875 num
= (short) va_arg(args
, int);
2877 case FORMAT_TYPE_INT
:
2878 num
= (int) va_arg(args
, int);
2881 num
= va_arg(args
, unsigned int);
2884 str
= number(str
, end
, num
, spec
);
2896 /* the trailing null byte doesn't count towards the total */
2900 EXPORT_SYMBOL(vsnprintf
);
2903 * vscnprintf - Format a string and place it in a buffer
2904 * @buf: The buffer to place the result into
2905 * @size: The size of the buffer, including the trailing null space
2906 * @fmt: The format string to use
2907 * @args: Arguments for the format string
2909 * The return value is the number of characters which have been written into
2910 * the @buf not including the trailing '\0'. If @size is == 0 the function
2913 * If you're not already dealing with a va_list consider using scnprintf().
2915 * See the vsnprintf() documentation for format string extensions over C99.
2917 int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
2921 if (unlikely(!size
))
2924 i
= vsnprintf(buf
, size
, fmt
, args
);
2926 if (likely(i
< size
))
2931 EXPORT_SYMBOL(vscnprintf
);
2934 * snprintf - Format a string and place it in a buffer
2935 * @buf: The buffer to place the result into
2936 * @size: The size of the buffer, including the trailing null space
2937 * @fmt: The format string to use
2938 * @...: Arguments for the format string
2940 * The return value is the number of characters which would be
2941 * generated for the given input, excluding the trailing null,
2942 * as per ISO C99. If the return is greater than or equal to
2943 * @size, the resulting string is truncated.
2945 * See the vsnprintf() documentation for format string extensions over C99.
2947 int snprintf(char *buf
, size_t size
, const char *fmt
, ...)
2952 va_start(args
, fmt
);
2953 i
= vsnprintf(buf
, size
, fmt
, args
);
2958 EXPORT_SYMBOL(snprintf
);
2961 * scnprintf - Format a string and place it in a buffer
2962 * @buf: The buffer to place the result into
2963 * @size: The size of the buffer, including the trailing null space
2964 * @fmt: The format string to use
2965 * @...: Arguments for the format string
2967 * The return value is the number of characters written into @buf not including
2968 * the trailing '\0'. If @size is == 0 the function returns 0.
2971 int scnprintf(char *buf
, size_t size
, const char *fmt
, ...)
2976 va_start(args
, fmt
);
2977 i
= vscnprintf(buf
, size
, fmt
, args
);
2982 EXPORT_SYMBOL(scnprintf
);
2985 * vsprintf - Format a string and place it in a buffer
2986 * @buf: The buffer to place the result into
2987 * @fmt: The format string to use
2988 * @args: Arguments for the format string
2990 * The function returns the number of characters written
2991 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2994 * If you're not already dealing with a va_list consider using sprintf().
2996 * See the vsnprintf() documentation for format string extensions over C99.
2998 int vsprintf(char *buf
, const char *fmt
, va_list args
)
3000 return vsnprintf(buf
, INT_MAX
, fmt
, args
);
3002 EXPORT_SYMBOL(vsprintf
);
3005 * sprintf - Format a string and place it in a buffer
3006 * @buf: The buffer to place the result into
3007 * @fmt: The format string to use
3008 * @...: Arguments for the format string
3010 * The function returns the number of characters written
3011 * into @buf. Use snprintf() or scnprintf() in order to avoid
3014 * See the vsnprintf() documentation for format string extensions over C99.
3016 int sprintf(char *buf
, const char *fmt
, ...)
3021 va_start(args
, fmt
);
3022 i
= vsnprintf(buf
, INT_MAX
, fmt
, args
);
3027 EXPORT_SYMBOL(sprintf
);
3029 #ifdef CONFIG_BINARY_PRINTF
3032 * vbin_printf() - VA arguments to binary data
3033 * bstr_printf() - Binary data to text string
3037 * vbin_printf - Parse a format string and place args' binary value in a buffer
3038 * @bin_buf: The buffer to place args' binary value
3039 * @size: The size of the buffer(by words(32bits), not characters)
3040 * @fmt: The format string to use
3041 * @args: Arguments for the format string
3043 * The format follows C99 vsnprintf, except %n is ignored, and its argument
3046 * The return value is the number of words(32bits) which would be generated for
3050 * If the return value is greater than @size, the resulting bin_buf is NOT
3051 * valid for bstr_printf().
3053 int vbin_printf(u32
*bin_buf
, size_t size
, const char *fmt
, va_list args
)
3055 struct printf_spec spec
= {0};
3059 str
= (char *)bin_buf
;
3060 end
= (char *)(bin_buf
+ size
);
3062 #define save_arg(type) \
3064 unsigned long long value; \
3065 if (sizeof(type) == 8) { \
3066 unsigned long long val8; \
3067 str = PTR_ALIGN(str, sizeof(u32)); \
3068 val8 = va_arg(args, unsigned long long); \
3069 if (str + sizeof(type) <= end) { \
3070 *(u32 *)str = *(u32 *)&val8; \
3071 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
3075 unsigned int val4; \
3076 str = PTR_ALIGN(str, sizeof(type)); \
3077 val4 = va_arg(args, int); \
3078 if (str + sizeof(type) <= end) \
3079 *(typeof(type) *)str = (type)(long)val4; \
3080 value = (unsigned long long)val4; \
3082 str += sizeof(type); \
3087 int read
= format_decode(fmt
, &spec
);
3091 switch (spec
.type
) {
3092 case FORMAT_TYPE_NONE
:
3093 case FORMAT_TYPE_PERCENT_CHAR
:
3095 case FORMAT_TYPE_INVALID
:
3098 case FORMAT_TYPE_WIDTH
:
3099 case FORMAT_TYPE_PRECISION
:
3100 width
= (int)save_arg(int);
3101 /* Pointers may require the width */
3103 set_field_width(&spec
, width
);
3106 case FORMAT_TYPE_CHAR
:
3110 case FORMAT_TYPE_STR
: {
3111 const char *save_str
= va_arg(args
, char *);
3112 const char *err_msg
;
3115 err_msg
= check_pointer_msg(save_str
);
3119 len
= strlen(save_str
) + 1;
3120 if (str
+ len
< end
)
3121 memcpy(str
, save_str
, len
);
3126 case FORMAT_TYPE_PTR
:
3127 /* Dereferenced pointers must be done now */
3129 /* Dereference of functions is still OK */
3138 if (!isalnum(*fmt
)) {
3142 str
= pointer(fmt
, str
, end
, va_arg(args
, void *),
3147 end
[-1] = '\0'; /* Must be nul terminated */
3149 /* skip all alphanumeric pointer suffixes */
3150 while (isalnum(*fmt
))
3155 switch (spec
.type
) {
3157 case FORMAT_TYPE_LONG_LONG
:
3158 save_arg(long long);
3160 case FORMAT_TYPE_ULONG
:
3161 case FORMAT_TYPE_LONG
:
3162 save_arg(unsigned long);
3164 case FORMAT_TYPE_SIZE_T
:
3167 case FORMAT_TYPE_PTRDIFF
:
3168 save_arg(ptrdiff_t);
3170 case FORMAT_TYPE_UBYTE
:
3171 case FORMAT_TYPE_BYTE
:
3174 case FORMAT_TYPE_USHORT
:
3175 case FORMAT_TYPE_SHORT
:
3185 return (u32
*)(PTR_ALIGN(str
, sizeof(u32
))) - bin_buf
;
3188 EXPORT_SYMBOL_GPL(vbin_printf
);
3191 * bstr_printf - Format a string from binary arguments and place it in a buffer
3192 * @buf: The buffer to place the result into
3193 * @size: The size of the buffer, including the trailing null space
3194 * @fmt: The format string to use
3195 * @bin_buf: Binary arguments for the format string
3197 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
3198 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
3199 * a binary buffer that generated by vbin_printf.
3201 * The format follows C99 vsnprintf, but has some extensions:
3202 * see vsnprintf comment for details.
3204 * The return value is the number of characters which would
3205 * be generated for the given input, excluding the trailing
3206 * '\0', as per ISO C99. If you want to have the exact
3207 * number of characters written into @buf as return value
3208 * (not including the trailing '\0'), use vscnprintf(). If the
3209 * return is greater than or equal to @size, the resulting
3210 * string is truncated.
3212 int bstr_printf(char *buf
, size_t size
, const char *fmt
, const u32
*bin_buf
)
3214 struct printf_spec spec
= {0};
3216 const char *args
= (const char *)bin_buf
;
3218 if (WARN_ON_ONCE(size
> INT_MAX
))
3224 #define get_arg(type) \
3226 typeof(type) value; \
3227 if (sizeof(type) == 8) { \
3228 args = PTR_ALIGN(args, sizeof(u32)); \
3229 *(u32 *)&value = *(u32 *)args; \
3230 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3232 args = PTR_ALIGN(args, sizeof(type)); \
3233 value = *(typeof(type) *)args; \
3235 args += sizeof(type); \
3239 /* Make sure end is always >= buf */
3246 const char *old_fmt
= fmt
;
3247 int read
= format_decode(fmt
, &spec
);
3251 switch (spec
.type
) {
3252 case FORMAT_TYPE_NONE
: {
3255 if (copy
> end
- str
)
3257 memcpy(str
, old_fmt
, copy
);
3263 case FORMAT_TYPE_WIDTH
:
3264 set_field_width(&spec
, get_arg(int));
3267 case FORMAT_TYPE_PRECISION
:
3268 set_precision(&spec
, get_arg(int));
3271 case FORMAT_TYPE_CHAR
: {
3274 if (!(spec
.flags
& LEFT
)) {
3275 while (--spec
.field_width
> 0) {
3281 c
= (unsigned char) get_arg(char);
3285 while (--spec
.field_width
> 0) {
3293 case FORMAT_TYPE_STR
: {
3294 const char *str_arg
= args
;
3295 args
+= strlen(str_arg
) + 1;
3296 str
= string(str
, end
, (char *)str_arg
, spec
);
3300 case FORMAT_TYPE_PTR
: {
3301 bool process
= false;
3303 /* Non function dereferences were already done */
3313 if (!isalnum(*fmt
)) {
3317 /* Pointer dereference was already processed */
3319 len
= copy
= strlen(args
);
3320 if (copy
> end
- str
)
3322 memcpy(str
, args
, copy
);
3328 str
= pointer(fmt
, str
, end
, get_arg(void *), spec
);
3330 while (isalnum(*fmt
))
3335 case FORMAT_TYPE_PERCENT_CHAR
:
3341 case FORMAT_TYPE_INVALID
:
3345 unsigned long long num
;
3347 switch (spec
.type
) {
3349 case FORMAT_TYPE_LONG_LONG
:
3350 num
= get_arg(long long);
3352 case FORMAT_TYPE_ULONG
:
3353 case FORMAT_TYPE_LONG
:
3354 num
= get_arg(unsigned long);
3356 case FORMAT_TYPE_SIZE_T
:
3357 num
= get_arg(size_t);
3359 case FORMAT_TYPE_PTRDIFF
:
3360 num
= get_arg(ptrdiff_t);
3362 case FORMAT_TYPE_UBYTE
:
3363 num
= get_arg(unsigned char);
3365 case FORMAT_TYPE_BYTE
:
3366 num
= get_arg(signed char);
3368 case FORMAT_TYPE_USHORT
:
3369 num
= get_arg(unsigned short);
3371 case FORMAT_TYPE_SHORT
:
3372 num
= get_arg(short);
3374 case FORMAT_TYPE_UINT
:
3375 num
= get_arg(unsigned int);
3381 str
= number(str
, end
, num
, spec
);
3383 } /* switch(spec.type) */
3396 /* the trailing null byte doesn't count towards the total */
3399 EXPORT_SYMBOL_GPL(bstr_printf
);
3402 * bprintf - Parse a format string and place args' binary value in a buffer
3403 * @bin_buf: The buffer to place args' binary value
3404 * @size: The size of the buffer(by words(32bits), not characters)
3405 * @fmt: The format string to use
3406 * @...: Arguments for the format string
3408 * The function returns the number of words(u32) written
3411 int bprintf(u32
*bin_buf
, size_t size
, const char *fmt
, ...)
3416 va_start(args
, fmt
);
3417 ret
= vbin_printf(bin_buf
, size
, fmt
, args
);
3422 EXPORT_SYMBOL_GPL(bprintf
);
3424 #endif /* CONFIG_BINARY_PRINTF */
3427 * vsscanf - Unformat a buffer into a list of arguments
3428 * @buf: input buffer
3429 * @fmt: format of buffer
3432 int vsscanf(const char *buf
, const char *fmt
, va_list args
)
3434 const char *str
= buf
;
3442 unsigned long long u
;
3448 /* skip any white space in format */
3449 /* white space in format matches any amount of
3450 * white space, including none, in the input.
3452 if (isspace(*fmt
)) {
3453 fmt
= skip_spaces(++fmt
);
3454 str
= skip_spaces(str
);
3457 /* anything that is not a conversion must match exactly */
3458 if (*fmt
!= '%' && *fmt
) {
3459 if (*fmt
++ != *str
++)
3468 /* skip this conversion.
3469 * advance both strings to next white space
3474 while (!isspace(*fmt
) && *fmt
!= '%' && *fmt
) {
3475 /* '%*[' not yet supported, invalid format */
3480 while (!isspace(*str
) && *str
)
3485 /* get field width */
3487 if (isdigit(*fmt
)) {
3488 field_width
= skip_atoi(&fmt
);
3489 if (field_width
<= 0)
3493 /* get conversion qualifier */
3495 if (*fmt
== 'h' || _tolower(*fmt
) == 'l' ||
3498 if (unlikely(qualifier
== *fmt
)) {
3499 if (qualifier
== 'h') {
3502 } else if (qualifier
== 'l') {
3513 /* return number of characters read so far */
3514 *va_arg(args
, int *) = str
- buf
;
3528 char *s
= (char *)va_arg(args
, char*);
3529 if (field_width
== -1)
3533 } while (--field_width
> 0 && *str
);
3539 char *s
= (char *)va_arg(args
, char *);
3540 if (field_width
== -1)
3541 field_width
= SHRT_MAX
;
3542 /* first, skip leading white space in buffer */
3543 str
= skip_spaces(str
);
3545 /* now copy until next white space */
3546 while (*str
&& !isspace(*str
) && field_width
--)
3553 * Warning: This implementation of the '[' conversion specifier
3554 * deviates from its glibc counterpart in the following ways:
3555 * (1) It does NOT support ranges i.e. '-' is NOT a special
3557 * (2) It cannot match the closing bracket ']' itself
3558 * (3) A field width is required
3559 * (4) '%*[' (discard matching input) is currently not supported
3562 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3563 * buf1, buf2, buf3);
3569 char *s
= (char *)va_arg(args
, char *);
3570 DECLARE_BITMAP(set
, 256) = {0};
3571 unsigned int len
= 0;
3572 bool negate
= (*fmt
== '^');
3574 /* field width is required */
3575 if (field_width
== -1)
3581 for ( ; *fmt
&& *fmt
!= ']'; ++fmt
, ++len
)
3582 __set_bit((u8
)*fmt
, set
);
3584 /* no ']' or no character set found */
3590 bitmap_complement(set
, set
, 256);
3591 /* exclude null '\0' byte */
3592 __clear_bit(0, set
);
3595 /* match must be non-empty */
3596 if (!test_bit((u8
)*str
, set
))
3599 while (test_bit((u8
)*str
, set
) && field_width
--)
3621 /* looking for '%' in str */
3626 /* invalid format; stop here */
3630 /* have some sort of integer conversion.
3631 * first, skip white space in buffer.
3633 str
= skip_spaces(str
);
3636 if (is_sign
&& digit
== '-') {
3637 if (field_width
== 1)
3644 || (base
== 16 && !isxdigit(digit
))
3645 || (base
== 10 && !isdigit(digit
))
3646 || (base
== 8 && !isodigit(digit
))
3647 || (base
== 0 && !isdigit(digit
)))
3651 val
.s
= simple_strntoll(str
,
3652 field_width
>= 0 ? field_width
: INT_MAX
,
3655 val
.u
= simple_strntoull(str
,
3656 field_width
>= 0 ? field_width
: INT_MAX
,
3659 switch (qualifier
) {
3660 case 'H': /* that's 'hh' in format */
3662 *va_arg(args
, signed char *) = val
.s
;
3664 *va_arg(args
, unsigned char *) = val
.u
;
3668 *va_arg(args
, short *) = val
.s
;
3670 *va_arg(args
, unsigned short *) = val
.u
;
3674 *va_arg(args
, long *) = val
.s
;
3676 *va_arg(args
, unsigned long *) = val
.u
;
3680 *va_arg(args
, long long *) = val
.s
;
3682 *va_arg(args
, unsigned long long *) = val
.u
;
3685 *va_arg(args
, size_t *) = val
.u
;
3689 *va_arg(args
, int *) = val
.s
;
3691 *va_arg(args
, unsigned int *) = val
.u
;
3703 EXPORT_SYMBOL(vsscanf
);
3706 * sscanf - Unformat a buffer into a list of arguments
3707 * @buf: input buffer
3708 * @fmt: formatting of buffer
3709 * @...: resulting arguments
3711 int sscanf(const char *buf
, const char *fmt
, ...)
3716 va_start(args
, fmt
);
3717 i
= vsscanf(buf
, fmt
, args
);
3722 EXPORT_SYMBOL(sscanf
);