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/time.h>
38 #include <linux/uuid.h>
40 #include <net/addrconf.h>
41 #include <linux/siphash.h>
42 #include <linux/compiler.h>
43 #include <linux/property.h>
45 #include <linux/blkdev.h>
48 #include "../mm/internal.h" /* For the trace_print_flags arrays */
50 #include <asm/page.h> /* for PAGE_SIZE */
51 #include <asm/byteorder.h> /* cpu_to_le16 */
52 #include <asm/unaligned.h>
54 #include <linux/string_helpers.h>
57 /* Disable pointer hashing if requested */
58 bool no_hash_pointers __ro_after_init;
59 EXPORT_SYMBOL_GPL(no_hash_pointers);
61 static noinline unsigned long long simple_strntoull(const char *startp, size_t max_chars, char **endp, unsigned int base)
64 unsigned long long result = 0ULL;
68 cp = _parse_integer_fixup_radix(startp, &base);
69 prefix_chars = cp - startp;
70 if (prefix_chars < max_chars) {
71 rv = _parse_integer_limit(cp, base, &result, max_chars - prefix_chars);
73 cp += (rv & ~KSTRTOX_OVERFLOW);
75 /* Field too short for prefix + digit, skip over without converting */
76 cp = startp + max_chars;
86 * simple_strtoull - convert a string to an unsigned long long
87 * @cp: The start of the string
88 * @endp: A pointer to the end of the parsed string will be placed here
89 * @base: The number base to use
91 * This function has caveats. Please use kstrtoull instead.
94 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
96 return simple_strntoull(cp, INT_MAX, endp, base);
98 EXPORT_SYMBOL(simple_strtoull);
101 * simple_strtoul - convert a string to an unsigned long
102 * @cp: The start of the string
103 * @endp: A pointer to the end of the parsed string will be placed here
104 * @base: The number base to use
106 * This function has caveats. Please use kstrtoul instead.
108 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
110 return simple_strtoull(cp, endp, base);
112 EXPORT_SYMBOL(simple_strtoul);
115 * simple_strtol - convert a string to a signed long
116 * @cp: The start of the string
117 * @endp: A pointer to the end of the parsed string will be placed here
118 * @base: The number base to use
120 * This function has caveats. Please use kstrtol instead.
122 long simple_strtol(const char *cp, char **endp, unsigned int base)
125 return -simple_strtoul(cp + 1, endp, base);
127 return simple_strtoul(cp, endp, base);
129 EXPORT_SYMBOL(simple_strtol);
131 static long long simple_strntoll(const char *cp, size_t max_chars, char **endp,
135 * simple_strntoull() safely handles receiving max_chars==0 in the
136 * case cp[0] == '-' && max_chars == 1.
137 * If max_chars == 0 we can drop through and pass it to simple_strntoull()
138 * and the content of *cp is irrelevant.
140 if (*cp == '-' && max_chars > 0)
141 return -simple_strntoull(cp + 1, max_chars - 1, endp, base);
143 return simple_strntoull(cp, max_chars, endp, base);
147 * simple_strtoll - convert a string to a signed long long
148 * @cp: The start of the string
149 * @endp: A pointer to the end of the parsed string will be placed here
150 * @base: The number base to use
152 * This function has caveats. Please use kstrtoll instead.
154 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
156 return simple_strntoll(cp, INT_MAX, endp, base);
158 EXPORT_SYMBOL(simple_strtoll);
160 static noinline_for_stack
161 int skip_atoi(const char **s)
166 i = i*10 + *((*s)++) - '0';
167 } while (isdigit(**s));
173 * Decimal conversion is by far the most typical, and is used for
174 * /proc and /sys data. This directly impacts e.g. top performance
175 * with many processes running. We optimize it for speed by emitting
176 * two characters at a time, using a 200 byte lookup table. This
177 * roughly halves the number of multiplications compared to computing
178 * the digits one at a time. Implementation strongly inspired by the
179 * previous version, which in turn used ideas described at
180 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
181 * from the author, Douglas W. Jones).
183 * It turns out there is precisely one 26 bit fixed-point
184 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
185 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
186 * range happens to be somewhat larger (x <= 1073741898), but that's
187 * irrelevant for our purpose.
189 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
190 * need a 32x32->64 bit multiply, so we simply use the same constant.
192 * For dividing a number in the range [100, 10^4-1] by 100, there are
193 * several options. The simplest is (x * 0x147b) >> 19, which is valid
194 * for all x <= 43698.
197 static const u16 decpair[100] = {
198 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
199 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
200 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
201 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
202 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
203 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
204 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
205 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
206 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
207 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
208 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
213 * This will print a single '0' even if r == 0, since we would
214 * immediately jump to out_r where two 0s would be written but only
215 * one of them accounted for in buf. This is needed by ip4_string
216 * below. All other callers pass a non-zero value of r.
218 static noinline_for_stack
219 char *put_dec_trunc8(char *buf, unsigned r)
227 /* 100 <= r < 10^8 */
228 q = (r * (u64)0x28f5c29) >> 32;
229 *((u16 *)buf) = decpair[r - 100*q];
236 /* 100 <= q < 10^6 */
237 r = (q * (u64)0x28f5c29) >> 32;
238 *((u16 *)buf) = decpair[q - 100*r];
245 /* 100 <= r < 10^4 */
246 q = (r * 0x147b) >> 19;
247 *((u16 *)buf) = decpair[r - 100*q];
254 *((u16 *)buf) = decpair[r];
255 buf += r < 10 ? 1 : 2;
259 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
260 static noinline_for_stack
261 char *put_dec_full8(char *buf, unsigned r)
266 q = (r * (u64)0x28f5c29) >> 32;
267 *((u16 *)buf) = decpair[r - 100*q];
271 r = (q * (u64)0x28f5c29) >> 32;
272 *((u16 *)buf) = decpair[q - 100*r];
276 q = (r * 0x147b) >> 19;
277 *((u16 *)buf) = decpair[r - 100*q];
281 *((u16 *)buf) = decpair[q];
286 static noinline_for_stack
287 char *put_dec(char *buf, unsigned long long n)
289 if (n >= 100*1000*1000)
290 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
291 /* 1 <= n <= 1.6e11 */
292 if (n >= 100*1000*1000)
293 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
295 return put_dec_trunc8(buf, n);
298 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
301 put_dec_full4(char *buf, unsigned r)
306 q = (r * 0x147b) >> 19;
307 *((u16 *)buf) = decpair[r - 100*q];
310 *((u16 *)buf) = decpair[q];
314 * Call put_dec_full4 on x % 10000, return x / 10000.
315 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
316 * holds for all x < 1,128,869,999. The largest value this
317 * helper will ever be asked to convert is 1,125,520,955.
318 * (second call in the put_dec code, assuming n is all-ones).
320 static noinline_for_stack
321 unsigned put_dec_helper4(char *buf, unsigned x)
323 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
325 put_dec_full4(buf, x - q * 10000);
329 /* Based on code by Douglas W. Jones found at
330 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
331 * (with permission from the author).
332 * Performs no 64-bit division and hence should be fast on 32-bit machines.
335 char *put_dec(char *buf, unsigned long long n)
337 uint32_t d3, d2, d1, q, h;
339 if (n < 100*1000*1000)
340 return put_dec_trunc8(buf, n);
342 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
345 d3 = (h >> 16); /* implicit "& 0xffff" */
347 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
348 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
349 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
350 q = put_dec_helper4(buf, q);
352 q += 7671 * d3 + 9496 * d2 + 6 * d1;
353 q = put_dec_helper4(buf+4, q);
355 q += 4749 * d3 + 42 * d2;
356 q = put_dec_helper4(buf+8, q);
361 buf = put_dec_trunc8(buf, q);
362 else while (buf[-1] == '0')
371 * Convert passed number to decimal string.
372 * Returns the length of string. On buffer overflow, returns 0.
374 * If speed is not important, use snprintf(). It's easy to read the code.
376 int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
378 /* put_dec requires 2-byte alignment of the buffer. */
379 char tmp[sizeof(num) * 3] __aligned(2);
382 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
387 len = put_dec(tmp, num) - tmp;
390 if (len > size || width > size)
395 for (idx = 0; idx < width; idx++)
401 for (idx = 0; idx < len; ++idx)
402 buf[idx + width] = tmp[len - idx - 1];
407 #define SIGN 1 /* unsigned/signed, must be 1 */
408 #define LEFT 2 /* left justified */
409 #define PLUS 4 /* show plus */
410 #define SPACE 8 /* space if plus */
411 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
412 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
413 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
415 static_assert(SIGN == 1);
416 static_assert(ZEROPAD == ('0' - ' '));
417 static_assert(SMALL == ('a' ^ 'A'));
420 FORMAT_TYPE_NONE, /* Just a string part */
422 FORMAT_TYPE_PRECISION,
426 FORMAT_TYPE_PERCENT_CHAR,
428 FORMAT_TYPE_LONG_LONG,
442 unsigned int type:8; /* format_type enum */
443 signed int field_width:24; /* width of output field */
444 unsigned int flags:8; /* flags to number() */
445 unsigned int base:8; /* number base, 8, 10 or 16 only */
446 signed int precision:16; /* # of digits/chars */
448 static_assert(sizeof(struct printf_spec) == 8);
450 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
451 #define PRECISION_MAX ((1 << 15) - 1)
453 static noinline_for_stack
454 char *number(char *buf, char *end, unsigned long long num,
455 struct printf_spec spec)
457 /* put_dec requires 2-byte alignment of the buffer. */
458 char tmp[3 * sizeof(num)] __aligned(2);
461 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
463 bool is_zero = num == 0LL;
464 int field_width = spec.field_width;
465 int precision = spec.precision;
467 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
468 * produces same digits or (maybe lowercased) letters */
469 locase = (spec.flags & SMALL);
470 if (spec.flags & LEFT)
471 spec.flags &= ~ZEROPAD;
473 if (spec.flags & SIGN) {
474 if ((signed long long)num < 0) {
476 num = -(signed long long)num;
478 } else if (spec.flags & PLUS) {
481 } else if (spec.flags & SPACE) {
493 /* generate full string in tmp[], in reverse order */
496 tmp[i++] = hex_asc_upper[num] | locase;
497 else if (spec.base != 10) { /* 8 or 16 */
498 int mask = spec.base - 1;
504 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
507 } else { /* base 10 */
508 i = put_dec(tmp, num) - tmp;
511 /* printing 100 using %2d gives "100", not "00" */
514 /* leading space padding */
515 field_width -= precision;
516 if (!(spec.flags & (ZEROPAD | LEFT))) {
517 while (--field_width >= 0) {
529 /* "0x" / "0" prefix */
531 if (spec.base == 16 || !is_zero) {
536 if (spec.base == 16) {
538 *buf = ('X' | locase);
542 /* zero or space padding */
543 if (!(spec.flags & LEFT)) {
544 char c = ' ' + (spec.flags & ZEROPAD);
546 while (--field_width >= 0) {
552 /* hmm even more zero padding? */
553 while (i <= --precision) {
558 /* actual digits of result */
564 /* trailing space padding */
565 while (--field_width >= 0) {
574 static noinline_for_stack
575 char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
577 struct printf_spec spec;
579 spec.type = FORMAT_TYPE_PTR;
580 spec.field_width = 2 + 2 * size; /* 0x + hex */
581 spec.flags = SPECIAL | SMALL | ZEROPAD;
585 return number(buf, end, num, spec);
588 static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
591 if (buf >= end) /* nowhere to put anything */
594 if (size <= spaces) {
595 memset(buf, ' ', size);
599 if (len > size - spaces)
601 memmove(buf + spaces, buf, len);
603 memset(buf, ' ', spaces);
607 * Handle field width padding for a string.
608 * @buf: current buffer position
609 * @n: length of string
610 * @end: end of output buffer
611 * @spec: for field width and flags
612 * Returns: new buffer position after padding.
614 static noinline_for_stack
615 char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
619 if (likely(n >= spec.field_width))
621 /* we want to pad the sucker */
622 spaces = spec.field_width - n;
623 if (!(spec.flags & LEFT)) {
624 move_right(buf - n, end, n, spaces);
635 /* Handle string from a well known address. */
636 static char *string_nocheck(char *buf, char *end, const char *s,
637 struct printf_spec spec)
640 int lim = spec.precision;
651 return widen_string(buf, len, end, spec);
654 static char *err_ptr(char *buf, char *end, void *ptr,
655 struct printf_spec spec)
657 int err = PTR_ERR(ptr);
658 const char *sym = errname(err);
661 return string_nocheck(buf, end, sym, spec);
664 * Somebody passed ERR_PTR(-1234) or some other non-existing
665 * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to
666 * printing it as its decimal representation.
670 return number(buf, end, err, spec);
673 /* Be careful: error messages must fit into the given buffer. */
674 static char *error_string(char *buf, char *end, const char *s,
675 struct printf_spec spec)
678 * Hard limit to avoid a completely insane messages. It actually
679 * works pretty well because most error messages are in
680 * the many pointer format modifiers.
682 if (spec.precision == -1)
683 spec.precision = 2 * sizeof(void *);
685 return string_nocheck(buf, end, s, spec);
689 * Do not call any complex external code here. Nested printk()/vsprintf()
690 * might cause infinite loops. Failures might break printk() and would
693 static const char *check_pointer_msg(const void *ptr)
698 if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
704 static int check_pointer(char **buf, char *end, const void *ptr,
705 struct printf_spec spec)
709 err_msg = check_pointer_msg(ptr);
711 *buf = error_string(*buf, end, err_msg, spec);
718 static noinline_for_stack
719 char *string(char *buf, char *end, const char *s,
720 struct printf_spec spec)
722 if (check_pointer(&buf, end, s, spec))
725 return string_nocheck(buf, end, s, spec);
728 static char *pointer_string(char *buf, char *end,
730 struct printf_spec spec)
734 if (spec.field_width == -1) {
735 spec.field_width = 2 * sizeof(ptr);
736 spec.flags |= ZEROPAD;
739 return number(buf, end, (unsigned long int)ptr, spec);
742 /* Make pointers available for printing early in the boot sequence. */
743 static int debug_boot_weak_hash __ro_after_init;
745 static int __init debug_boot_weak_hash_enable(char *str)
747 debug_boot_weak_hash = 1;
748 pr_info("debug_boot_weak_hash enabled\n");
751 early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable);
753 static DEFINE_STATIC_KEY_FALSE(filled_random_ptr_key);
755 static void enable_ptr_key_workfn(struct work_struct *work)
757 static_branch_enable(&filled_random_ptr_key);
760 /* Maps a pointer to a 32 bit unique identifier. */
761 static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
763 static siphash_key_t ptr_key __read_mostly;
764 unsigned long hashval;
766 if (!static_branch_likely(&filled_random_ptr_key)) {
767 static bool filled = false;
768 static DEFINE_SPINLOCK(filling);
769 static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn);
772 if (!system_unbound_wq || !rng_is_initialized() ||
773 !spin_trylock_irqsave(&filling, flags))
777 get_random_bytes(&ptr_key, sizeof(ptr_key));
778 queue_work(system_unbound_wq, &enable_ptr_key_work);
781 spin_unlock_irqrestore(&filling, flags);
786 hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
788 * Mask off the first 32 bits, this makes explicit that we have
789 * modified the address (and 32 bits is plenty for a unique ID).
791 hashval = hashval & 0xffffffff;
793 hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
795 *hashval_out = hashval;
799 int ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
801 return __ptr_to_hashval(ptr, hashval_out);
804 static char *ptr_to_id(char *buf, char *end, const void *ptr,
805 struct printf_spec spec)
807 const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
808 unsigned long hashval;
812 * Print the real pointer value for NULL and error pointers,
813 * as they are not actual addresses.
815 if (IS_ERR_OR_NULL(ptr))
816 return pointer_string(buf, end, ptr, spec);
818 /* When debugging early boot use non-cryptographically secure hash. */
819 if (unlikely(debug_boot_weak_hash)) {
820 hashval = hash_long((unsigned long)ptr, 32);
821 return pointer_string(buf, end, (const void *)hashval, spec);
824 ret = __ptr_to_hashval(ptr, &hashval);
826 spec.field_width = 2 * sizeof(ptr);
827 /* string length must be less than default_width */
828 return error_string(buf, end, str, spec);
831 return pointer_string(buf, end, (const void *)hashval, spec);
834 static char *default_pointer(char *buf, char *end, const void *ptr,
835 struct printf_spec spec)
838 * default is to _not_ leak addresses, so hash before printing,
839 * unless no_hash_pointers is specified on the command line.
841 if (unlikely(no_hash_pointers))
842 return pointer_string(buf, end, ptr, spec);
844 return ptr_to_id(buf, end, ptr, spec);
847 int kptr_restrict __read_mostly;
849 static noinline_for_stack
850 char *restricted_pointer(char *buf, char *end, const void *ptr,
851 struct printf_spec spec)
853 switch (kptr_restrict) {
855 /* Handle as %p, hash and do _not_ leak addresses. */
856 return default_pointer(buf, end, ptr, spec);
858 const struct cred *cred;
861 * kptr_restrict==1 cannot be used in IRQ context
862 * because its test for CAP_SYSLOG would be meaningless.
864 if (in_irq() || in_serving_softirq() || in_nmi()) {
865 if (spec.field_width == -1)
866 spec.field_width = 2 * sizeof(ptr);
867 return error_string(buf, end, "pK-error", spec);
871 * Only print the real pointer value if the current
872 * process has CAP_SYSLOG and is running with the
873 * same credentials it started with. This is because
874 * access to files is checked at open() time, but %pK
875 * checks permission at read() time. We don't want to
876 * leak pointer values if a binary opens a file using
877 * %pK and then elevates privileges before reading it.
879 cred = current_cred();
880 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
881 !uid_eq(cred->euid, cred->uid) ||
882 !gid_eq(cred->egid, cred->gid))
888 /* Always print 0's for %pK */
893 return pointer_string(buf, end, ptr, spec);
896 static noinline_for_stack
897 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
900 const char *array[4], *s;
901 const struct dentry *p;
906 case '2': case '3': case '4':
907 depth = fmt[1] - '0';
914 for (i = 0; i < depth; i++, d = p) {
915 if (check_pointer(&buf, end, d, spec)) {
920 p = READ_ONCE(d->d_parent);
921 array[i] = READ_ONCE(d->d_name.name);
930 for (n = 0; n != spec.precision; n++, buf++) {
942 return widen_string(buf, n, end, spec);
945 static noinline_for_stack
946 char *file_dentry_name(char *buf, char *end, const struct file *f,
947 struct printf_spec spec, const char *fmt)
949 if (check_pointer(&buf, end, f, spec))
952 return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
955 static noinline_for_stack
956 char *bdev_name(char *buf, char *end, struct block_device *bdev,
957 struct printf_spec spec, const char *fmt)
961 if (check_pointer(&buf, end, bdev, spec))
965 buf = string(buf, end, hd->disk_name, spec);
966 if (bdev->bd_partno) {
967 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
972 buf = number(buf, end, bdev->bd_partno, spec);
978 static noinline_for_stack
979 char *symbol_string(char *buf, char *end, void *ptr,
980 struct printf_spec spec, const char *fmt)
983 #ifdef CONFIG_KALLSYMS
984 char sym[KSYM_SYMBOL_LEN];
988 ptr = __builtin_extract_return_addr(ptr);
989 value = (unsigned long)ptr;
991 #ifdef CONFIG_KALLSYMS
992 if (*fmt == 'B' && fmt[1] == 'b')
993 sprint_backtrace_build_id(sym, value);
994 else if (*fmt == 'B')
995 sprint_backtrace(sym, value);
996 else if (*fmt == 'S' && (fmt[1] == 'b' || (fmt[1] == 'R' && fmt[2] == 'b')))
997 sprint_symbol_build_id(sym, value);
998 else if (*fmt != 's')
999 sprint_symbol(sym, value);
1001 sprint_symbol_no_offset(sym, value);
1003 return string_nocheck(buf, end, sym, spec);
1005 return special_hex_number(buf, end, value, sizeof(void *));
1009 static const struct printf_spec default_str_spec = {
1014 static const struct printf_spec default_flag_spec = {
1017 .flags = SPECIAL | SMALL,
1020 static const struct printf_spec default_dec_spec = {
1025 static const struct printf_spec default_dec02_spec = {
1032 static const struct printf_spec default_dec04_spec = {
1039 static noinline_for_stack
1040 char *resource_string(char *buf, char *end, struct resource *res,
1041 struct printf_spec spec, const char *fmt)
1043 #ifndef IO_RSRC_PRINTK_SIZE
1044 #define IO_RSRC_PRINTK_SIZE 6
1047 #ifndef MEM_RSRC_PRINTK_SIZE
1048 #define MEM_RSRC_PRINTK_SIZE 10
1050 static const struct printf_spec io_spec = {
1052 .field_width = IO_RSRC_PRINTK_SIZE,
1054 .flags = SPECIAL | SMALL | ZEROPAD,
1056 static const struct printf_spec mem_spec = {
1058 .field_width = MEM_RSRC_PRINTK_SIZE,
1060 .flags = SPECIAL | SMALL | ZEROPAD,
1062 static const struct printf_spec bus_spec = {
1066 .flags = SMALL | ZEROPAD,
1068 static const struct printf_spec str_spec = {
1074 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1075 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1076 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1077 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
1078 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
1079 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1080 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
1081 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
1083 char *p = sym, *pend = sym + sizeof(sym);
1084 int decode = (fmt[0] == 'R') ? 1 : 0;
1085 const struct printf_spec *specp;
1087 if (check_pointer(&buf, end, res, spec))
1091 if (res->flags & IORESOURCE_IO) {
1092 p = string_nocheck(p, pend, "io ", str_spec);
1094 } else if (res->flags & IORESOURCE_MEM) {
1095 p = string_nocheck(p, pend, "mem ", str_spec);
1097 } else if (res->flags & IORESOURCE_IRQ) {
1098 p = string_nocheck(p, pend, "irq ", str_spec);
1099 specp = &default_dec_spec;
1100 } else if (res->flags & IORESOURCE_DMA) {
1101 p = string_nocheck(p, pend, "dma ", str_spec);
1102 specp = &default_dec_spec;
1103 } else if (res->flags & IORESOURCE_BUS) {
1104 p = string_nocheck(p, pend, "bus ", str_spec);
1107 p = string_nocheck(p, pend, "??? ", str_spec);
1111 if (decode && res->flags & IORESOURCE_UNSET) {
1112 p = string_nocheck(p, pend, "size ", str_spec);
1113 p = number(p, pend, resource_size(res), *specp);
1115 p = number(p, pend, res->start, *specp);
1116 if (res->start != res->end) {
1118 p = number(p, pend, res->end, *specp);
1122 if (res->flags & IORESOURCE_MEM_64)
1123 p = string_nocheck(p, pend, " 64bit", str_spec);
1124 if (res->flags & IORESOURCE_PREFETCH)
1125 p = string_nocheck(p, pend, " pref", str_spec);
1126 if (res->flags & IORESOURCE_WINDOW)
1127 p = string_nocheck(p, pend, " window", str_spec);
1128 if (res->flags & IORESOURCE_DISABLED)
1129 p = string_nocheck(p, pend, " disabled", str_spec);
1131 p = string_nocheck(p, pend, " flags ", str_spec);
1132 p = number(p, pend, res->flags, default_flag_spec);
1137 return string_nocheck(buf, end, sym, spec);
1140 static noinline_for_stack
1141 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1144 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
1145 negative value, fallback to the default */
1148 if (spec.field_width == 0)
1149 /* nothing to print */
1152 if (check_pointer(&buf, end, addr, spec))
1170 if (spec.field_width > 0)
1171 len = min_t(int, spec.field_width, 64);
1173 for (i = 0; i < len; ++i) {
1175 *buf = hex_asc_hi(addr[i]);
1178 *buf = hex_asc_lo(addr[i]);
1181 if (separator && i != len - 1) {
1191 static noinline_for_stack
1192 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
1193 struct printf_spec spec, const char *fmt)
1195 const int CHUNKSZ = 32;
1196 int nr_bits = max_t(int, spec.field_width, 0);
1200 if (check_pointer(&buf, end, bitmap, spec))
1203 /* reused to print numbers */
1204 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
1206 chunksz = nr_bits & (CHUNKSZ - 1);
1210 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
1211 for (; i >= 0; i -= CHUNKSZ) {
1215 chunkmask = ((1ULL << chunksz) - 1);
1216 word = i / BITS_PER_LONG;
1217 bit = i % BITS_PER_LONG;
1218 val = (bitmap[word] >> bit) & chunkmask;
1227 spec.field_width = DIV_ROUND_UP(chunksz, 4);
1228 buf = number(buf, end, val, spec);
1235 static noinline_for_stack
1236 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
1237 struct printf_spec spec, const char *fmt)
1239 int nr_bits = max_t(int, spec.field_width, 0);
1243 if (check_pointer(&buf, end, bitmap, spec))
1246 for_each_set_bitrange(rbot, rtop, bitmap, nr_bits) {
1254 buf = number(buf, end, rbot, default_dec_spec);
1255 if (rtop == rbot + 1)
1260 buf = number(++buf, end, rtop - 1, default_dec_spec);
1265 static noinline_for_stack
1266 char *mac_address_string(char *buf, char *end, u8 *addr,
1267 struct printf_spec spec, const char *fmt)
1269 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
1273 bool reversed = false;
1275 if (check_pointer(&buf, end, addr, spec))
1292 for (i = 0; i < 6; i++) {
1294 p = hex_byte_pack(p, addr[5 - i]);
1296 p = hex_byte_pack(p, addr[i]);
1298 if (fmt[0] == 'M' && i != 5)
1303 return string_nocheck(buf, end, mac_addr, spec);
1306 static noinline_for_stack
1307 char *ip4_string(char *p, const u8 *addr, const char *fmt)
1310 bool leading_zeros = (fmt[0] == 'i');
1335 for (i = 0; i < 4; i++) {
1336 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
1337 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1338 if (leading_zeros) {
1344 /* reverse the digits in the quad */
1346 *p++ = temp[digits];
1356 static noinline_for_stack
1357 char *ip6_compressed_string(char *p, const char *addr)
1360 unsigned char zerolength[8];
1365 bool needcolon = false;
1367 struct in6_addr in6;
1369 memcpy(&in6, addr, sizeof(struct in6_addr));
1371 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1373 memset(zerolength, 0, sizeof(zerolength));
1380 /* find position of longest 0 run */
1381 for (i = 0; i < range; i++) {
1382 for (j = i; j < range; j++) {
1383 if (in6.s6_addr16[j] != 0)
1388 for (i = 0; i < range; i++) {
1389 if (zerolength[i] > longest) {
1390 longest = zerolength[i];
1394 if (longest == 1) /* don't compress a single 0 */
1398 for (i = 0; i < range; i++) {
1399 if (i == colonpos) {
1400 if (needcolon || i == 0)
1411 /* hex u16 without leading 0s */
1412 word = ntohs(in6.s6_addr16[i]);
1417 p = hex_byte_pack(p, hi);
1419 *p++ = hex_asc_lo(hi);
1420 p = hex_byte_pack(p, lo);
1423 p = hex_byte_pack(p, lo);
1425 *p++ = hex_asc_lo(lo);
1432 p = ip4_string(p, &in6.s6_addr[12], "I4");
1439 static noinline_for_stack
1440 char *ip6_string(char *p, const char *addr, const char *fmt)
1444 for (i = 0; i < 8; i++) {
1445 p = hex_byte_pack(p, *addr++);
1446 p = hex_byte_pack(p, *addr++);
1447 if (fmt[0] == 'I' && i != 7)
1455 static noinline_for_stack
1456 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1457 struct printf_spec spec, const char *fmt)
1459 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1461 if (fmt[0] == 'I' && fmt[2] == 'c')
1462 ip6_compressed_string(ip6_addr, addr);
1464 ip6_string(ip6_addr, addr, fmt);
1466 return string_nocheck(buf, end, ip6_addr, spec);
1469 static noinline_for_stack
1470 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1471 struct printf_spec spec, const char *fmt)
1473 char ip4_addr[sizeof("255.255.255.255")];
1475 ip4_string(ip4_addr, addr, fmt);
1477 return string_nocheck(buf, end, ip4_addr, spec);
1480 static noinline_for_stack
1481 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1482 struct printf_spec spec, const char *fmt)
1484 bool have_p = false, have_s = false, have_f = false, have_c = false;
1485 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1486 sizeof(":12345") + sizeof("/123456789") +
1487 sizeof("%1234567890")];
1488 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1489 const u8 *addr = (const u8 *) &sa->sin6_addr;
1490 char fmt6[2] = { fmt[0], '6' };
1494 while (isalpha(*++fmt)) {
1511 if (have_p || have_s || have_f) {
1516 if (fmt6[0] == 'I' && have_c)
1517 p = ip6_compressed_string(ip6_addr + off, addr);
1519 p = ip6_string(ip6_addr + off, addr, fmt6);
1521 if (have_p || have_s || have_f)
1526 p = number(p, pend, ntohs(sa->sin6_port), spec);
1530 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1531 IPV6_FLOWINFO_MASK), spec);
1535 p = number(p, pend, sa->sin6_scope_id, spec);
1539 return string_nocheck(buf, end, ip6_addr, spec);
1542 static noinline_for_stack
1543 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1544 struct printf_spec spec, const char *fmt)
1546 bool have_p = false;
1547 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1548 char *pend = ip4_addr + sizeof(ip4_addr);
1549 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1550 char fmt4[3] = { fmt[0], '4', 0 };
1553 while (isalpha(*++fmt)) {
1567 p = ip4_string(ip4_addr, addr, fmt4);
1570 p = number(p, pend, ntohs(sa->sin_port), spec);
1574 return string_nocheck(buf, end, ip4_addr, spec);
1577 static noinline_for_stack
1578 char *ip_addr_string(char *buf, char *end, const void *ptr,
1579 struct printf_spec spec, const char *fmt)
1583 if (check_pointer(&buf, end, ptr, spec))
1588 return ip6_addr_string(buf, end, ptr, spec, fmt);
1590 return ip4_addr_string(buf, end, ptr, spec, fmt);
1593 struct sockaddr raw;
1594 struct sockaddr_in v4;
1595 struct sockaddr_in6 v6;
1598 switch (sa->raw.sa_family) {
1600 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1602 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1604 return error_string(buf, end, "(einval)", spec);
1608 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
1609 return error_string(buf, end, err_fmt_msg, spec);
1612 static noinline_for_stack
1613 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1618 unsigned int flags = 0;
1621 if (spec.field_width == 0)
1622 return buf; /* nothing to print */
1624 if (check_pointer(&buf, end, addr, spec))
1628 switch (fmt[count++]) {
1630 flags |= ESCAPE_ANY;
1633 flags |= ESCAPE_SPECIAL;
1636 flags |= ESCAPE_HEX;
1639 flags |= ESCAPE_NULL;
1642 flags |= ESCAPE_OCTAL;
1648 flags |= ESCAPE_SPACE;
1657 flags = ESCAPE_ANY_NP;
1659 len = spec.field_width < 0 ? 1 : spec.field_width;
1662 * string_escape_mem() writes as many characters as it can to
1663 * the given buffer, and returns the total size of the output
1664 * had the buffer been big enough.
1666 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1671 static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1672 struct printf_spec spec, const char *fmt)
1676 if (check_pointer(&buf, end, va_fmt, spec))
1679 va_copy(va, *va_fmt->va);
1680 buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
1686 static noinline_for_stack
1687 char *uuid_string(char *buf, char *end, const u8 *addr,
1688 struct printf_spec spec, const char *fmt)
1690 char uuid[UUID_STRING_LEN + 1];
1693 const u8 *index = uuid_index;
1696 if (check_pointer(&buf, end, addr, spec))
1711 for (i = 0; i < 16; i++) {
1713 p = hex_byte_pack_upper(p, addr[index[i]]);
1715 p = hex_byte_pack(p, addr[index[i]]);
1728 return string_nocheck(buf, end, uuid, spec);
1731 static noinline_for_stack
1732 char *netdev_bits(char *buf, char *end, const void *addr,
1733 struct printf_spec spec, const char *fmt)
1735 unsigned long long num;
1738 if (check_pointer(&buf, end, addr, spec))
1743 num = *(const netdev_features_t *)addr;
1744 size = sizeof(netdev_features_t);
1747 return error_string(buf, end, "(%pN?)", spec);
1750 return special_hex_number(buf, end, num, size);
1753 static noinline_for_stack
1754 char *fourcc_string(char *buf, char *end, const u32 *fourcc,
1755 struct printf_spec spec, const char *fmt)
1757 char output[sizeof("0123 little-endian (0x01234567)")];
1762 if (fmt[1] != 'c' || fmt[2] != 'c')
1763 return error_string(buf, end, "(%p4?)", spec);
1765 if (check_pointer(&buf, end, fourcc, spec))
1768 orig = get_unaligned(fourcc);
1769 val = orig & ~BIT(31);
1771 for (i = 0; i < sizeof(u32); i++) {
1772 unsigned char c = val >> (i * 8);
1774 /* Print non-control ASCII characters as-is, dot otherwise */
1775 *p++ = isascii(c) && isprint(c) ? c : '.';
1779 strcpy(p, orig & BIT(31) ? "big-endian" : "little-endian");
1784 p = special_hex_number(p, output + sizeof(output) - 2, orig, sizeof(u32));
1788 return string(buf, end, output, spec);
1791 static noinline_for_stack
1792 char *address_val(char *buf, char *end, const void *addr,
1793 struct printf_spec spec, const char *fmt)
1795 unsigned long long num;
1798 if (check_pointer(&buf, end, addr, spec))
1803 num = *(const dma_addr_t *)addr;
1804 size = sizeof(dma_addr_t);
1808 num = *(const phys_addr_t *)addr;
1809 size = sizeof(phys_addr_t);
1813 return special_hex_number(buf, end, num, size);
1816 static noinline_for_stack
1817 char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1819 int year = tm->tm_year + (r ? 0 : 1900);
1820 int mon = tm->tm_mon + (r ? 0 : 1);
1822 buf = number(buf, end, year, default_dec04_spec);
1827 buf = number(buf, end, mon, default_dec02_spec);
1832 return number(buf, end, tm->tm_mday, default_dec02_spec);
1835 static noinline_for_stack
1836 char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1838 buf = number(buf, end, tm->tm_hour, default_dec02_spec);
1843 buf = number(buf, end, tm->tm_min, default_dec02_spec);
1848 return number(buf, end, tm->tm_sec, default_dec02_spec);
1851 static noinline_for_stack
1852 char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1853 struct printf_spec spec, const char *fmt)
1855 bool have_t = true, have_d = true;
1856 bool raw = false, iso8601_separator = true;
1860 if (check_pointer(&buf, end, tm, spec))
1863 switch (fmt[count]) {
1875 switch (fmt[count++]) {
1880 iso8601_separator = false;
1889 buf = date_str(buf, end, tm, raw);
1890 if (have_d && have_t) {
1892 *buf = iso8601_separator ? 'T' : ' ';
1896 buf = time_str(buf, end, tm, raw);
1901 static noinline_for_stack
1902 char *time64_str(char *buf, char *end, const time64_t time,
1903 struct printf_spec spec, const char *fmt)
1905 struct rtc_time rtc_time;
1908 time64_to_tm(time, 0, &tm);
1910 rtc_time.tm_sec = tm.tm_sec;
1911 rtc_time.tm_min = tm.tm_min;
1912 rtc_time.tm_hour = tm.tm_hour;
1913 rtc_time.tm_mday = tm.tm_mday;
1914 rtc_time.tm_mon = tm.tm_mon;
1915 rtc_time.tm_year = tm.tm_year;
1916 rtc_time.tm_wday = tm.tm_wday;
1917 rtc_time.tm_yday = tm.tm_yday;
1919 rtc_time.tm_isdst = 0;
1921 return rtc_str(buf, end, &rtc_time, spec, fmt);
1924 static noinline_for_stack
1925 char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
1930 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
1932 return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
1934 return error_string(buf, end, "(%pt?)", spec);
1938 static noinline_for_stack
1939 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1942 if (!IS_ENABLED(CONFIG_HAVE_CLK))
1943 return error_string(buf, end, "(%pC?)", spec);
1945 if (check_pointer(&buf, end, clk, spec))
1951 #ifdef CONFIG_COMMON_CLK
1952 return string(buf, end, __clk_get_name(clk), spec);
1954 return ptr_to_id(buf, end, clk, spec);
1960 char *format_flags(char *buf, char *end, unsigned long flags,
1961 const struct trace_print_flags *names)
1965 for ( ; flags && names->name; names++) {
1967 if ((flags & mask) != mask)
1970 buf = string(buf, end, names->name, default_str_spec);
1981 buf = number(buf, end, flags, default_flag_spec);
1986 struct page_flags_fields {
1990 const struct printf_spec *spec;
1994 static const struct page_flags_fields pff[] = {
1995 {SECTIONS_WIDTH, SECTIONS_PGSHIFT, SECTIONS_MASK,
1996 &default_dec_spec, "section"},
1997 {NODES_WIDTH, NODES_PGSHIFT, NODES_MASK,
1998 &default_dec_spec, "node"},
1999 {ZONES_WIDTH, ZONES_PGSHIFT, ZONES_MASK,
2000 &default_dec_spec, "zone"},
2001 {LAST_CPUPID_WIDTH, LAST_CPUPID_PGSHIFT, LAST_CPUPID_MASK,
2002 &default_flag_spec, "lastcpupid"},
2003 {KASAN_TAG_WIDTH, KASAN_TAG_PGSHIFT, KASAN_TAG_MASK,
2004 &default_flag_spec, "kasantag"},
2008 char *format_page_flags(char *buf, char *end, unsigned long flags)
2010 unsigned long main_flags = flags & PAGEFLAGS_MASK;
2011 bool append = false;
2014 buf = number(buf, end, flags, default_flag_spec);
2019 /* Page flags from the main area. */
2021 buf = format_flags(buf, end, main_flags, pageflag_names);
2025 /* Page flags from the fields area */
2026 for (i = 0; i < ARRAY_SIZE(pff); i++) {
2027 /* Skip undefined fields. */
2031 /* Format: Flag Name + '=' (equals sign) + Number + '|' (separator) */
2038 buf = string(buf, end, pff[i].name, default_str_spec);
2042 buf = number(buf, end, (flags >> pff[i].shift) & pff[i].mask,
2054 static noinline_for_stack
2055 char *flags_string(char *buf, char *end, void *flags_ptr,
2056 struct printf_spec spec, const char *fmt)
2058 unsigned long flags;
2059 const struct trace_print_flags *names;
2061 if (check_pointer(&buf, end, flags_ptr, spec))
2066 return format_page_flags(buf, end, *(unsigned long *)flags_ptr);
2068 flags = *(unsigned long *)flags_ptr;
2069 names = vmaflag_names;
2072 flags = (__force unsigned long)(*(gfp_t *)flags_ptr);
2073 names = gfpflag_names;
2076 return error_string(buf, end, "(%pG?)", spec);
2079 return format_flags(buf, end, flags, names);
2082 static noinline_for_stack
2083 char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
2088 /* Loop starting from the root node to the current node. */
2089 for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
2090 struct fwnode_handle *__fwnode =
2091 fwnode_get_nth_parent(fwnode, depth);
2093 buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
2095 buf = string(buf, end, fwnode_get_name(__fwnode),
2098 fwnode_handle_put(__fwnode);
2104 static noinline_for_stack
2105 char *device_node_string(char *buf, char *end, struct device_node *dn,
2106 struct printf_spec spec, const char *fmt)
2108 char tbuf[sizeof("xxxx") + 1];
2111 char *buf_start = buf;
2112 struct property *prop;
2113 bool has_mult, pass;
2115 struct printf_spec str_spec = spec;
2116 str_spec.field_width = -1;
2119 return error_string(buf, end, "(%pO?)", spec);
2121 if (!IS_ENABLED(CONFIG_OF))
2122 return error_string(buf, end, "(%pOF?)", spec);
2124 if (check_pointer(&buf, end, dn, spec))
2127 /* simple case without anything any more format specifiers */
2129 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
2132 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
2141 case 'f': /* full_name */
2142 buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
2145 case 'n': /* name */
2146 p = fwnode_get_name(of_fwnode_handle(dn));
2147 precision = str_spec.precision;
2148 str_spec.precision = strchrnul(p, '@') - p;
2149 buf = string(buf, end, p, str_spec);
2150 str_spec.precision = precision;
2152 case 'p': /* phandle */
2153 buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec);
2155 case 'P': /* path-spec */
2156 p = fwnode_get_name(of_fwnode_handle(dn));
2159 buf = string(buf, end, p, str_spec);
2161 case 'F': /* flags */
2162 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2163 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2164 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2165 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2167 buf = string_nocheck(buf, end, tbuf, str_spec);
2169 case 'c': /* major compatible string */
2170 ret = of_property_read_string(dn, "compatible", &p);
2172 buf = string(buf, end, p, str_spec);
2174 case 'C': /* full compatible string */
2176 of_property_for_each_string(dn, "compatible", prop, p) {
2178 buf = string_nocheck(buf, end, ",", str_spec);
2179 buf = string_nocheck(buf, end, "\"", str_spec);
2180 buf = string(buf, end, p, str_spec);
2181 buf = string_nocheck(buf, end, "\"", str_spec);
2191 return widen_string(buf, buf - buf_start, end, spec);
2194 static noinline_for_stack
2195 char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
2196 struct printf_spec spec, const char *fmt)
2198 struct printf_spec str_spec = spec;
2199 char *buf_start = buf;
2201 str_spec.field_width = -1;
2204 return error_string(buf, end, "(%pf?)", spec);
2206 if (check_pointer(&buf, end, fwnode, spec))
2212 case 'P': /* name */
2213 buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
2215 case 'f': /* full_name */
2217 buf = fwnode_full_name_string(fwnode, buf, end);
2221 return widen_string(buf, buf - buf_start, end, spec);
2224 int __init no_hash_pointers_enable(char *str)
2226 if (no_hash_pointers)
2229 no_hash_pointers = true;
2231 pr_warn("**********************************************************\n");
2232 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2234 pr_warn("** This system shows unhashed kernel memory addresses **\n");
2235 pr_warn("** via the console, logs, and other interfaces. This **\n");
2236 pr_warn("** might reduce the security of your system. **\n");
2238 pr_warn("** If you see this message and you are not debugging **\n");
2239 pr_warn("** the kernel, report this immediately to your system **\n");
2240 pr_warn("** administrator! **\n");
2242 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2243 pr_warn("**********************************************************\n");
2247 early_param("no_hash_pointers", no_hash_pointers_enable);
2250 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2251 * by an extra set of alphanumeric characters that are extended format
2254 * Please update scripts/checkpatch.pl when adding/removing conversion
2255 * characters. (Search for "check for vsprintf extension").
2257 * Right now we handle:
2259 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2260 * - 's' For symbolic direct pointers (or function descriptors) without offset
2261 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
2262 * - 'S[R]b' as above with module build ID (for use in backtraces)
2263 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2264 * %ps and %pS. Be careful when re-using these specifiers.
2265 * - 'B' For backtraced symbolic direct pointers with offset
2266 * - 'Bb' as above with module build ID (for use in backtraces)
2267 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2268 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2269 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2270 * width which must be explicitly specified either as part of the
2271 * format string '%32b[l]' or through '%*b[l]', [l] selects
2272 * range-list format instead of hex format
2273 * - 'M' For a 6-byte MAC address, it prints the address in the
2274 * usual colon-separated hex notation
2275 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2276 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2277 * with a dash-separated hex notation
2278 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2279 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2280 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2281 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
2283 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2284 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2285 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2286 * IPv6 omits the colons (01020304...0f)
2287 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2289 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2290 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2291 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2292 * - 'I[6S]c' for IPv6 addresses printed as specified by
2293 * https://tools.ietf.org/html/rfc5952
2294 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2295 * of the following flags (see string_escape_mem() for the
2298 * c - ESCAPE_SPECIAL
2304 * By default ESCAPE_ANY_NP is used.
2305 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2306 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2307 * Options for %pU are:
2308 * b big endian lower case hex (default)
2309 * B big endian UPPER case hex
2310 * l little endian lower case hex
2311 * L little endian UPPER case hex
2312 * big endian output byte order is:
2313 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2314 * little endian output byte order is:
2315 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2316 * - 'V' For a struct va_format which contains a format string * and va_list *,
2317 * call vsnprintf(->format, *->va_list).
2318 * Implements a "recursive vsnprintf".
2319 * Do not use this feature without some mechanism to verify the
2320 * correctness of the format string and va_list arguments.
2321 * - 'K' For a kernel pointer that should be hidden from unprivileged users.
2322 * Use only for procfs, sysfs and similar files, not printk(); please
2323 * read the documentation (path below) first.
2324 * - 'NF' For a netdev_features_t
2325 * - '4cc' V4L2 or DRM FourCC code, with endianness and raw numerical value.
2326 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2327 * a certain separator (' ' by default):
2331 * The maximum supported length is 64 bytes of the input. Consider
2332 * to use print_hex_dump() for the larger input.
2333 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2334 * (default assumed to be phys_addr_t, passed by reference)
2335 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2336 * - 'D[234]' Same as 'd' but for a struct file
2337 * - 'g' For block_device name (gendisk + partition number)
2338 * - 't[RT][dt][r][s]' For time and date as represented by:
2341 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2342 * (legacy clock framework) of the clock
2343 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2344 * (legacy clock framework) of the clock
2345 * - 'G' For flags to be printed as a collection of symbolic strings that would
2346 * construct the specific value. Supported flags given by option:
2347 * p page flags (see struct page) given as pointer to unsigned long
2348 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2349 * v vma flags (VM_*) given as pointer to unsigned long
2350 * - 'OF[fnpPcCF]' For a device tree object
2351 * Without any optional arguments prints the full_name
2352 * f device node full_name
2353 * n device node name
2354 * p device node phandle
2355 * P device node path spec (name + @unit)
2356 * F device node flags
2357 * c major compatible string
2358 * C full compatible string
2359 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2360 * Without an option prints the full name of the node
2362 * P node name, including a possible unit address
2363 * - 'x' For printing the address unmodified. Equivalent to "%lx".
2364 * Please read the documentation (path below) before using!
2365 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
2366 * bpf_trace_printk() where [ku] prefix specifies either kernel (k)
2367 * or user (u) memory to probe, and:
2368 * s a string, equivalent to "%s" on direct vsnprintf() use
2370 * ** When making changes please also update:
2371 * Documentation/core-api/printk-formats.rst
2373 * Note: The default behaviour (unadorned %p) is to hash the address,
2374 * rendering it useful as a unique identifier.
2376 static noinline_for_stack
2377 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2378 struct printf_spec spec)
2383 ptr = dereference_symbol_descriptor(ptr);
2386 return symbol_string(buf, end, ptr, spec, fmt);
2389 return resource_string(buf, end, ptr, spec, fmt);
2391 return hex_string(buf, end, ptr, spec, fmt);
2395 return bitmap_list_string(buf, end, ptr, spec, fmt);
2397 return bitmap_string(buf, end, ptr, spec, fmt);
2399 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2400 case 'm': /* Contiguous: 000102030405 */
2402 /* [mM]R (Reverse order; Bluetooth) */
2403 return mac_address_string(buf, end, ptr, spec, fmt);
2404 case 'I': /* Formatted IP supported
2406 * 6: 0001:0203:...:0708
2407 * 6c: 1::708 or 1::1.2.3.4
2409 case 'i': /* Contiguous:
2410 * 4: 001.002.003.004
2413 return ip_addr_string(buf, end, ptr, spec, fmt);
2415 return escaped_string(buf, end, ptr, spec, fmt);
2417 return uuid_string(buf, end, ptr, spec, fmt);
2419 return va_format(buf, end, ptr, spec, fmt);
2421 return restricted_pointer(buf, end, ptr, spec);
2423 return netdev_bits(buf, end, ptr, spec, fmt);
2425 return fourcc_string(buf, end, ptr, spec, fmt);
2427 return address_val(buf, end, ptr, spec, fmt);
2429 return dentry_name(buf, end, ptr, spec, fmt);
2431 return time_and_date(buf, end, ptr, spec, fmt);
2433 return clock(buf, end, ptr, spec, fmt);
2435 return file_dentry_name(buf, end, ptr, spec, fmt);
2438 return bdev_name(buf, end, ptr, spec, fmt);
2442 return flags_string(buf, end, ptr, spec, fmt);
2444 return device_node_string(buf, end, ptr, spec, fmt + 1);
2446 return fwnode_string(buf, end, ptr, spec, fmt + 1);
2448 return pointer_string(buf, end, ptr, spec);
2450 /* %pe with a non-ERR_PTR gets treated as plain %p */
2452 return default_pointer(buf, end, ptr, spec);
2453 return err_ptr(buf, end, ptr, spec);
2458 return string(buf, end, ptr, spec);
2460 return error_string(buf, end, "(einval)", spec);
2463 return default_pointer(buf, end, ptr, spec);
2468 * Helper function to decode printf style format.
2469 * Each call decode a token from the format and return the
2470 * number of characters read (or likely the delta where it wants
2471 * to go on the next call).
2472 * The decoded token is returned through the parameters
2474 * 'h', 'l', or 'L' for integer fields
2475 * 'z' support added 23/7/1999 S.H.
2476 * 'z' changed to 'Z' --davidm 1/25/99
2477 * 'Z' changed to 'z' --adobriyan 2017-01-25
2478 * 't' added for ptrdiff_t
2480 * @fmt: the format string
2481 * @type of the token returned
2482 * @flags: various flags such as +, -, # tokens..
2483 * @field_width: overwritten width
2484 * @base: base of the number (octal, hex, ...)
2485 * @precision: precision of a number
2486 * @qualifier: qualifier of a number (long, size_t, ...)
2488 static noinline_for_stack
2489 int format_decode(const char *fmt, struct printf_spec *spec)
2491 const char *start = fmt;
2494 /* we finished early by reading the field width */
2495 if (spec->type == FORMAT_TYPE_WIDTH) {
2496 if (spec->field_width < 0) {
2497 spec->field_width = -spec->field_width;
2498 spec->flags |= LEFT;
2500 spec->type = FORMAT_TYPE_NONE;
2504 /* we finished early by reading the precision */
2505 if (spec->type == FORMAT_TYPE_PRECISION) {
2506 if (spec->precision < 0)
2507 spec->precision = 0;
2509 spec->type = FORMAT_TYPE_NONE;
2514 spec->type = FORMAT_TYPE_NONE;
2516 for (; *fmt ; ++fmt) {
2521 /* Return the current non-format string */
2522 if (fmt != start || !*fmt)
2528 while (1) { /* this also skips first '%' */
2534 case '-': spec->flags |= LEFT; break;
2535 case '+': spec->flags |= PLUS; break;
2536 case ' ': spec->flags |= SPACE; break;
2537 case '#': spec->flags |= SPECIAL; break;
2538 case '0': spec->flags |= ZEROPAD; break;
2539 default: found = false;
2546 /* get field width */
2547 spec->field_width = -1;
2550 spec->field_width = skip_atoi(&fmt);
2551 else if (*fmt == '*') {
2552 /* it's the next argument */
2553 spec->type = FORMAT_TYPE_WIDTH;
2554 return ++fmt - start;
2558 /* get the precision */
2559 spec->precision = -1;
2562 if (isdigit(*fmt)) {
2563 spec->precision = skip_atoi(&fmt);
2564 if (spec->precision < 0)
2565 spec->precision = 0;
2566 } else if (*fmt == '*') {
2567 /* it's the next argument */
2568 spec->type = FORMAT_TYPE_PRECISION;
2569 return ++fmt - start;
2574 /* get the conversion qualifier */
2576 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2577 *fmt == 'z' || *fmt == 't') {
2579 if (unlikely(qualifier == *fmt)) {
2580 if (qualifier == 'l') {
2583 } else if (qualifier == 'h') {
2594 spec->type = FORMAT_TYPE_CHAR;
2595 return ++fmt - start;
2598 spec->type = FORMAT_TYPE_STR;
2599 return ++fmt - start;
2602 spec->type = FORMAT_TYPE_PTR;
2603 return ++fmt - start;
2606 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2607 return ++fmt - start;
2609 /* integer number formats - set up the flags and "break" */
2615 spec->flags |= SMALL;
2624 spec->flags |= SIGN;
2631 * Since %n poses a greater security risk than
2632 * utility, treat it as any other invalid or
2633 * unsupported format specifier.
2638 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2639 spec->type = FORMAT_TYPE_INVALID;
2643 if (qualifier == 'L')
2644 spec->type = FORMAT_TYPE_LONG_LONG;
2645 else if (qualifier == 'l') {
2646 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2647 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2648 } else if (qualifier == 'z') {
2649 spec->type = FORMAT_TYPE_SIZE_T;
2650 } else if (qualifier == 't') {
2651 spec->type = FORMAT_TYPE_PTRDIFF;
2652 } else if (qualifier == 'H') {
2653 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2654 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2655 } else if (qualifier == 'h') {
2656 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2657 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2659 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2660 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2663 return ++fmt - start;
2667 set_field_width(struct printf_spec *spec, int width)
2669 spec->field_width = width;
2670 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2671 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2676 set_precision(struct printf_spec *spec, int prec)
2678 spec->precision = prec;
2679 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2680 spec->precision = clamp(prec, 0, PRECISION_MAX);
2685 * vsnprintf - Format a string and place it in a buffer
2686 * @buf: The buffer to place the result into
2687 * @size: The size of the buffer, including the trailing null space
2688 * @fmt: The format string to use
2689 * @args: Arguments for the format string
2691 * This function generally follows C99 vsnprintf, but has some
2692 * extensions and a few limitations:
2694 * - ``%n`` is unsupported
2695 * - ``%p*`` is handled by pointer()
2697 * See pointer() or Documentation/core-api/printk-formats.rst for more
2698 * extensive description.
2700 * **Please update the documentation in both places when making changes**
2702 * The return value is the number of characters which would
2703 * be generated for the given input, excluding the trailing
2704 * '\0', as per ISO C99. If you want to have the exact
2705 * number of characters written into @buf as return value
2706 * (not including the trailing '\0'), use vscnprintf(). If the
2707 * return is greater than or equal to @size, the resulting
2708 * string is truncated.
2710 * If you're not already dealing with a va_list consider using snprintf().
2712 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2714 unsigned long long num;
2716 struct printf_spec spec = {0};
2718 /* Reject out-of-range values early. Large positive sizes are
2719 used for unknown buffer sizes. */
2720 if (WARN_ON_ONCE(size > INT_MAX))
2726 /* Make sure end is always >= buf */
2733 const char *old_fmt = fmt;
2734 int read = format_decode(fmt, &spec);
2738 switch (spec.type) {
2739 case FORMAT_TYPE_NONE: {
2742 if (copy > end - str)
2744 memcpy(str, old_fmt, copy);
2750 case FORMAT_TYPE_WIDTH:
2751 set_field_width(&spec, va_arg(args, int));
2754 case FORMAT_TYPE_PRECISION:
2755 set_precision(&spec, va_arg(args, int));
2758 case FORMAT_TYPE_CHAR: {
2761 if (!(spec.flags & LEFT)) {
2762 while (--spec.field_width > 0) {
2769 c = (unsigned char) va_arg(args, int);
2773 while (--spec.field_width > 0) {
2781 case FORMAT_TYPE_STR:
2782 str = string(str, end, va_arg(args, char *), spec);
2785 case FORMAT_TYPE_PTR:
2786 str = pointer(fmt, str, end, va_arg(args, void *),
2788 while (isalnum(*fmt))
2792 case FORMAT_TYPE_PERCENT_CHAR:
2798 case FORMAT_TYPE_INVALID:
2800 * Presumably the arguments passed gcc's type
2801 * checking, but there is no safe or sane way
2802 * for us to continue parsing the format and
2803 * fetching from the va_list; the remaining
2804 * specifiers and arguments would be out of
2810 switch (spec.type) {
2811 case FORMAT_TYPE_LONG_LONG:
2812 num = va_arg(args, long long);
2814 case FORMAT_TYPE_ULONG:
2815 num = va_arg(args, unsigned long);
2817 case FORMAT_TYPE_LONG:
2818 num = va_arg(args, long);
2820 case FORMAT_TYPE_SIZE_T:
2821 if (spec.flags & SIGN)
2822 num = va_arg(args, ssize_t);
2824 num = va_arg(args, size_t);
2826 case FORMAT_TYPE_PTRDIFF:
2827 num = va_arg(args, ptrdiff_t);
2829 case FORMAT_TYPE_UBYTE:
2830 num = (unsigned char) va_arg(args, int);
2832 case FORMAT_TYPE_BYTE:
2833 num = (signed char) va_arg(args, int);
2835 case FORMAT_TYPE_USHORT:
2836 num = (unsigned short) va_arg(args, int);
2838 case FORMAT_TYPE_SHORT:
2839 num = (short) va_arg(args, int);
2841 case FORMAT_TYPE_INT:
2842 num = (int) va_arg(args, int);
2845 num = va_arg(args, unsigned int);
2848 str = number(str, end, num, spec);
2860 /* the trailing null byte doesn't count towards the total */
2864 EXPORT_SYMBOL(vsnprintf);
2867 * vscnprintf - Format a string and place it in a buffer
2868 * @buf: The buffer to place the result into
2869 * @size: The size of the buffer, including the trailing null space
2870 * @fmt: The format string to use
2871 * @args: Arguments for the format string
2873 * The return value is the number of characters which have been written into
2874 * the @buf not including the trailing '\0'. If @size is == 0 the function
2877 * If you're not already dealing with a va_list consider using scnprintf().
2879 * See the vsnprintf() documentation for format string extensions over C99.
2881 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2885 if (unlikely(!size))
2888 i = vsnprintf(buf, size, fmt, args);
2890 if (likely(i < size))
2895 EXPORT_SYMBOL(vscnprintf);
2898 * snprintf - Format a string and place it in a buffer
2899 * @buf: The buffer to place the result into
2900 * @size: The size of the buffer, including the trailing null space
2901 * @fmt: The format string to use
2902 * @...: Arguments for the format string
2904 * The return value is the number of characters which would be
2905 * generated for the given input, excluding the trailing null,
2906 * as per ISO C99. If the return is greater than or equal to
2907 * @size, the resulting string is truncated.
2909 * See the vsnprintf() documentation for format string extensions over C99.
2911 int snprintf(char *buf, size_t size, const char *fmt, ...)
2916 va_start(args, fmt);
2917 i = vsnprintf(buf, size, fmt, args);
2922 EXPORT_SYMBOL(snprintf);
2925 * scnprintf - Format a string and place it in a buffer
2926 * @buf: The buffer to place the result into
2927 * @size: The size of the buffer, including the trailing null space
2928 * @fmt: The format string to use
2929 * @...: Arguments for the format string
2931 * The return value is the number of characters written into @buf not including
2932 * the trailing '\0'. If @size is == 0 the function returns 0.
2935 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2940 va_start(args, fmt);
2941 i = vscnprintf(buf, size, fmt, args);
2946 EXPORT_SYMBOL(scnprintf);
2949 * vsprintf - Format a string and place it in a buffer
2950 * @buf: The buffer to place the result into
2951 * @fmt: The format string to use
2952 * @args: Arguments for the format string
2954 * The function returns the number of characters written
2955 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2958 * If you're not already dealing with a va_list consider using sprintf().
2960 * See the vsnprintf() documentation for format string extensions over C99.
2962 int vsprintf(char *buf, const char *fmt, va_list args)
2964 return vsnprintf(buf, INT_MAX, fmt, args);
2966 EXPORT_SYMBOL(vsprintf);
2969 * sprintf - Format a string and place it in a buffer
2970 * @buf: The buffer to place the result into
2971 * @fmt: The format string to use
2972 * @...: Arguments for the format string
2974 * The function returns the number of characters written
2975 * into @buf. Use snprintf() or scnprintf() in order to avoid
2978 * See the vsnprintf() documentation for format string extensions over C99.
2980 int sprintf(char *buf, const char *fmt, ...)
2985 va_start(args, fmt);
2986 i = vsnprintf(buf, INT_MAX, fmt, args);
2991 EXPORT_SYMBOL(sprintf);
2993 #ifdef CONFIG_BINARY_PRINTF
2996 * vbin_printf() - VA arguments to binary data
2997 * bstr_printf() - Binary data to text string
3001 * vbin_printf - Parse a format string and place args' binary value in a buffer
3002 * @bin_buf: The buffer to place args' binary value
3003 * @size: The size of the buffer(by words(32bits), not characters)
3004 * @fmt: The format string to use
3005 * @args: Arguments for the format string
3007 * The format follows C99 vsnprintf, except %n is ignored, and its argument
3010 * The return value is the number of words(32bits) which would be generated for
3014 * If the return value is greater than @size, the resulting bin_buf is NOT
3015 * valid for bstr_printf().
3017 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
3019 struct printf_spec spec = {0};
3023 str = (char *)bin_buf;
3024 end = (char *)(bin_buf + size);
3026 #define save_arg(type) \
3028 unsigned long long value; \
3029 if (sizeof(type) == 8) { \
3030 unsigned long long val8; \
3031 str = PTR_ALIGN(str, sizeof(u32)); \
3032 val8 = va_arg(args, unsigned long long); \
3033 if (str + sizeof(type) <= end) { \
3034 *(u32 *)str = *(u32 *)&val8; \
3035 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
3039 unsigned int val4; \
3040 str = PTR_ALIGN(str, sizeof(type)); \
3041 val4 = va_arg(args, int); \
3042 if (str + sizeof(type) <= end) \
3043 *(typeof(type) *)str = (type)(long)val4; \
3044 value = (unsigned long long)val4; \
3046 str += sizeof(type); \
3051 int read = format_decode(fmt, &spec);
3055 switch (spec.type) {
3056 case FORMAT_TYPE_NONE:
3057 case FORMAT_TYPE_PERCENT_CHAR:
3059 case FORMAT_TYPE_INVALID:
3062 case FORMAT_TYPE_WIDTH:
3063 case FORMAT_TYPE_PRECISION:
3064 width = (int)save_arg(int);
3065 /* Pointers may require the width */
3067 set_field_width(&spec, width);
3070 case FORMAT_TYPE_CHAR:
3074 case FORMAT_TYPE_STR: {
3075 const char *save_str = va_arg(args, char *);
3076 const char *err_msg;
3079 err_msg = check_pointer_msg(save_str);
3083 len = strlen(save_str) + 1;
3084 if (str + len < end)
3085 memcpy(str, save_str, len);
3090 case FORMAT_TYPE_PTR:
3091 /* Dereferenced pointers must be done now */
3093 /* Dereference of functions is still OK */
3102 if (!isalnum(*fmt)) {
3106 str = pointer(fmt, str, end, va_arg(args, void *),
3111 end[-1] = '\0'; /* Must be nul terminated */
3113 /* skip all alphanumeric pointer suffixes */
3114 while (isalnum(*fmt))
3119 switch (spec.type) {
3121 case FORMAT_TYPE_LONG_LONG:
3122 save_arg(long long);
3124 case FORMAT_TYPE_ULONG:
3125 case FORMAT_TYPE_LONG:
3126 save_arg(unsigned long);
3128 case FORMAT_TYPE_SIZE_T:
3131 case FORMAT_TYPE_PTRDIFF:
3132 save_arg(ptrdiff_t);
3134 case FORMAT_TYPE_UBYTE:
3135 case FORMAT_TYPE_BYTE:
3138 case FORMAT_TYPE_USHORT:
3139 case FORMAT_TYPE_SHORT:
3149 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
3152 EXPORT_SYMBOL_GPL(vbin_printf);
3155 * bstr_printf - Format a string from binary arguments and place it in a buffer
3156 * @buf: The buffer to place the result into
3157 * @size: The size of the buffer, including the trailing null space
3158 * @fmt: The format string to use
3159 * @bin_buf: Binary arguments for the format string
3161 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
3162 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
3163 * a binary buffer that generated by vbin_printf.
3165 * The format follows C99 vsnprintf, but has some extensions:
3166 * see vsnprintf comment for details.
3168 * The return value is the number of characters which would
3169 * be generated for the given input, excluding the trailing
3170 * '\0', as per ISO C99. If you want to have the exact
3171 * number of characters written into @buf as return value
3172 * (not including the trailing '\0'), use vscnprintf(). If the
3173 * return is greater than or equal to @size, the resulting
3174 * string is truncated.
3176 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
3178 struct printf_spec spec = {0};
3180 const char *args = (const char *)bin_buf;
3182 if (WARN_ON_ONCE(size > INT_MAX))
3188 #define get_arg(type) \
3190 typeof(type) value; \
3191 if (sizeof(type) == 8) { \
3192 args = PTR_ALIGN(args, sizeof(u32)); \
3193 *(u32 *)&value = *(u32 *)args; \
3194 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3196 args = PTR_ALIGN(args, sizeof(type)); \
3197 value = *(typeof(type) *)args; \
3199 args += sizeof(type); \
3203 /* Make sure end is always >= buf */
3210 const char *old_fmt = fmt;
3211 int read = format_decode(fmt, &spec);
3215 switch (spec.type) {
3216 case FORMAT_TYPE_NONE: {
3219 if (copy > end - str)
3221 memcpy(str, old_fmt, copy);
3227 case FORMAT_TYPE_WIDTH:
3228 set_field_width(&spec, get_arg(int));
3231 case FORMAT_TYPE_PRECISION:
3232 set_precision(&spec, get_arg(int));
3235 case FORMAT_TYPE_CHAR: {
3238 if (!(spec.flags & LEFT)) {
3239 while (--spec.field_width > 0) {
3245 c = (unsigned char) get_arg(char);
3249 while (--spec.field_width > 0) {
3257 case FORMAT_TYPE_STR: {
3258 const char *str_arg = args;
3259 args += strlen(str_arg) + 1;
3260 str = string(str, end, (char *)str_arg, spec);
3264 case FORMAT_TYPE_PTR: {
3265 bool process = false;
3267 /* Non function dereferences were already done */
3277 if (!isalnum(*fmt)) {
3281 /* Pointer dereference was already processed */
3283 len = copy = strlen(args);
3284 if (copy > end - str)
3286 memcpy(str, args, copy);
3292 str = pointer(fmt, str, end, get_arg(void *), spec);
3294 while (isalnum(*fmt))
3299 case FORMAT_TYPE_PERCENT_CHAR:
3305 case FORMAT_TYPE_INVALID:
3309 unsigned long long num;
3311 switch (spec.type) {
3313 case FORMAT_TYPE_LONG_LONG:
3314 num = get_arg(long long);
3316 case FORMAT_TYPE_ULONG:
3317 case FORMAT_TYPE_LONG:
3318 num = get_arg(unsigned long);
3320 case FORMAT_TYPE_SIZE_T:
3321 num = get_arg(size_t);
3323 case FORMAT_TYPE_PTRDIFF:
3324 num = get_arg(ptrdiff_t);
3326 case FORMAT_TYPE_UBYTE:
3327 num = get_arg(unsigned char);
3329 case FORMAT_TYPE_BYTE:
3330 num = get_arg(signed char);
3332 case FORMAT_TYPE_USHORT:
3333 num = get_arg(unsigned short);
3335 case FORMAT_TYPE_SHORT:
3336 num = get_arg(short);
3338 case FORMAT_TYPE_UINT:
3339 num = get_arg(unsigned int);
3345 str = number(str, end, num, spec);
3347 } /* switch(spec.type) */
3360 /* the trailing null byte doesn't count towards the total */
3363 EXPORT_SYMBOL_GPL(bstr_printf);
3366 * bprintf - Parse a format string and place args' binary value in a buffer
3367 * @bin_buf: The buffer to place args' binary value
3368 * @size: The size of the buffer(by words(32bits), not characters)
3369 * @fmt: The format string to use
3370 * @...: Arguments for the format string
3372 * The function returns the number of words(u32) written
3375 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3380 va_start(args, fmt);
3381 ret = vbin_printf(bin_buf, size, fmt, args);
3386 EXPORT_SYMBOL_GPL(bprintf);
3388 #endif /* CONFIG_BINARY_PRINTF */
3391 * vsscanf - Unformat a buffer into a list of arguments
3392 * @buf: input buffer
3393 * @fmt: format of buffer
3396 int vsscanf(const char *buf, const char *fmt, va_list args)
3398 const char *str = buf;
3406 unsigned long long u;
3412 /* skip any white space in format */
3413 /* white space in format matches any amount of
3414 * white space, including none, in the input.
3416 if (isspace(*fmt)) {
3417 fmt = skip_spaces(++fmt);
3418 str = skip_spaces(str);
3421 /* anything that is not a conversion must match exactly */
3422 if (*fmt != '%' && *fmt) {
3423 if (*fmt++ != *str++)
3432 /* skip this conversion.
3433 * advance both strings to next white space
3438 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3439 /* '%*[' not yet supported, invalid format */
3444 while (!isspace(*str) && *str)
3449 /* get field width */
3451 if (isdigit(*fmt)) {
3452 field_width = skip_atoi(&fmt);
3453 if (field_width <= 0)
3457 /* get conversion qualifier */
3459 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
3462 if (unlikely(qualifier == *fmt)) {
3463 if (qualifier == 'h') {
3466 } else if (qualifier == 'l') {
3477 /* return number of characters read so far */
3478 *va_arg(args, int *) = str - buf;
3492 char *s = (char *)va_arg(args, char*);
3493 if (field_width == -1)
3497 } while (--field_width > 0 && *str);
3503 char *s = (char *)va_arg(args, char *);
3504 if (field_width == -1)
3505 field_width = SHRT_MAX;
3506 /* first, skip leading white space in buffer */
3507 str = skip_spaces(str);
3509 /* now copy until next white space */
3510 while (*str && !isspace(*str) && field_width--)
3517 * Warning: This implementation of the '[' conversion specifier
3518 * deviates from its glibc counterpart in the following ways:
3519 * (1) It does NOT support ranges i.e. '-' is NOT a special
3521 * (2) It cannot match the closing bracket ']' itself
3522 * (3) A field width is required
3523 * (4) '%*[' (discard matching input) is currently not supported
3526 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3527 * buf1, buf2, buf3);
3533 char *s = (char *)va_arg(args, char *);
3534 DECLARE_BITMAP(set, 256) = {0};
3535 unsigned int len = 0;
3536 bool negate = (*fmt == '^');
3538 /* field width is required */
3539 if (field_width == -1)
3545 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3546 __set_bit((u8)*fmt, set);
3548 /* no ']' or no character set found */
3554 bitmap_complement(set, set, 256);
3555 /* exclude null '\0' byte */
3556 __clear_bit(0, set);
3559 /* match must be non-empty */
3560 if (!test_bit((u8)*str, set))
3563 while (test_bit((u8)*str, set) && field_width--)
3585 /* looking for '%' in str */
3590 /* invalid format; stop here */
3594 /* have some sort of integer conversion.
3595 * first, skip white space in buffer.
3597 str = skip_spaces(str);
3600 if (is_sign && digit == '-') {
3601 if (field_width == 1)
3608 || (base == 16 && !isxdigit(digit))
3609 || (base == 10 && !isdigit(digit))
3610 || (base == 8 && (!isdigit(digit) || digit > '7'))
3611 || (base == 0 && !isdigit(digit)))
3615 val.s = simple_strntoll(str,
3616 field_width >= 0 ? field_width : INT_MAX,
3619 val.u = simple_strntoull(str,
3620 field_width >= 0 ? field_width : INT_MAX,
3623 switch (qualifier) {
3624 case 'H': /* that's 'hh' in format */
3626 *va_arg(args, signed char *) = val.s;
3628 *va_arg(args, unsigned char *) = val.u;
3632 *va_arg(args, short *) = val.s;
3634 *va_arg(args, unsigned short *) = val.u;
3638 *va_arg(args, long *) = val.s;
3640 *va_arg(args, unsigned long *) = val.u;
3644 *va_arg(args, long long *) = val.s;
3646 *va_arg(args, unsigned long long *) = val.u;
3649 *va_arg(args, size_t *) = val.u;
3653 *va_arg(args, int *) = val.s;
3655 *va_arg(args, unsigned int *) = val.u;
3667 EXPORT_SYMBOL(vsscanf);
3670 * sscanf - Unformat a buffer into a list of arguments
3671 * @buf: input buffer
3672 * @fmt: formatting of buffer
3673 * @...: resulting arguments
3675 int sscanf(const char *buf, const char *fmt, ...)
3680 va_start(args, fmt);
3681 i = vsscanf(buf, fmt, args);
3686 EXPORT_SYMBOL(sscanf);