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
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 */
53 #include <linux/string_helpers.h>
56 static unsigned long long simple_strntoull(const char *startp, size_t max_chars,
57 char **endp, unsigned int base)
60 unsigned long long result = 0ULL;
64 cp = _parse_integer_fixup_radix(startp, &base);
65 prefix_chars = cp - startp;
66 if (prefix_chars < max_chars) {
67 rv = _parse_integer_limit(cp, base, &result, max_chars - prefix_chars);
69 cp += (rv & ~KSTRTOX_OVERFLOW);
71 /* Field too short for prefix + digit, skip over without converting */
72 cp = startp + max_chars;
82 * simple_strtoull - convert a string to an unsigned long long
83 * @cp: The start of the string
84 * @endp: A pointer to the end of the parsed string will be placed here
85 * @base: The number base to use
87 * This function has caveats. Please use kstrtoull instead.
89 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
91 return simple_strntoull(cp, INT_MAX, endp, base);
93 EXPORT_SYMBOL(simple_strtoull);
96 * simple_strtoul - convert a string to an unsigned long
97 * @cp: The start of the string
98 * @endp: A pointer to the end of the parsed string will be placed here
99 * @base: The number base to use
101 * This function has caveats. Please use kstrtoul instead.
103 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
105 return simple_strtoull(cp, endp, base);
107 EXPORT_SYMBOL(simple_strtoul);
110 * simple_strtol - convert a string to a signed long
111 * @cp: The start of the string
112 * @endp: A pointer to the end of the parsed string will be placed here
113 * @base: The number base to use
115 * This function has caveats. Please use kstrtol instead.
117 long simple_strtol(const char *cp, char **endp, unsigned int base)
120 return -simple_strtoul(cp + 1, endp, base);
122 return simple_strtoul(cp, endp, base);
124 EXPORT_SYMBOL(simple_strtol);
126 static long long simple_strntoll(const char *cp, size_t max_chars, char **endp,
130 * simple_strntoull() safely handles receiving max_chars==0 in the
131 * case cp[0] == '-' && max_chars == 1.
132 * If max_chars == 0 we can drop through and pass it to simple_strntoull()
133 * and the content of *cp is irrelevant.
135 if (*cp == '-' && max_chars > 0)
136 return -simple_strntoull(cp + 1, max_chars - 1, endp, base);
138 return simple_strntoull(cp, max_chars, endp, base);
142 * simple_strtoll - convert a string to a signed long long
143 * @cp: The start of the string
144 * @endp: A pointer to the end of the parsed string will be placed here
145 * @base: The number base to use
147 * This function has caveats. Please use kstrtoll instead.
149 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
151 return simple_strntoll(cp, INT_MAX, endp, base);
153 EXPORT_SYMBOL(simple_strtoll);
155 static noinline_for_stack
156 int skip_atoi(const char **s)
161 i = i*10 + *((*s)++) - '0';
162 } while (isdigit(**s));
168 * Decimal conversion is by far the most typical, and is used for
169 * /proc and /sys data. This directly impacts e.g. top performance
170 * with many processes running. We optimize it for speed by emitting
171 * two characters at a time, using a 200 byte lookup table. This
172 * roughly halves the number of multiplications compared to computing
173 * the digits one at a time. Implementation strongly inspired by the
174 * previous version, which in turn used ideas described at
175 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
176 * from the author, Douglas W. Jones).
178 * It turns out there is precisely one 26 bit fixed-point
179 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
180 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
181 * range happens to be somewhat larger (x <= 1073741898), but that's
182 * irrelevant for our purpose.
184 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
185 * need a 32x32->64 bit multiply, so we simply use the same constant.
187 * For dividing a number in the range [100, 10^4-1] by 100, there are
188 * several options. The simplest is (x * 0x147b) >> 19, which is valid
189 * for all x <= 43698.
192 static const u16 decpair[100] = {
193 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
194 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
195 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
196 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
197 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
198 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
199 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
200 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
201 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
202 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
203 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
208 * This will print a single '0' even if r == 0, since we would
209 * immediately jump to out_r where two 0s would be written but only
210 * one of them accounted for in buf. This is needed by ip4_string
211 * below. All other callers pass a non-zero value of r.
213 static noinline_for_stack
214 char *put_dec_trunc8(char *buf, unsigned r)
222 /* 100 <= r < 10^8 */
223 q = (r * (u64)0x28f5c29) >> 32;
224 *((u16 *)buf) = decpair[r - 100*q];
231 /* 100 <= q < 10^6 */
232 r = (q * (u64)0x28f5c29) >> 32;
233 *((u16 *)buf) = decpair[q - 100*r];
240 /* 100 <= r < 10^4 */
241 q = (r * 0x147b) >> 19;
242 *((u16 *)buf) = decpair[r - 100*q];
249 *((u16 *)buf) = decpair[r];
250 buf += r < 10 ? 1 : 2;
254 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
255 static noinline_for_stack
256 char *put_dec_full8(char *buf, unsigned r)
261 q = (r * (u64)0x28f5c29) >> 32;
262 *((u16 *)buf) = decpair[r - 100*q];
266 r = (q * (u64)0x28f5c29) >> 32;
267 *((u16 *)buf) = decpair[q - 100*r];
271 q = (r * 0x147b) >> 19;
272 *((u16 *)buf) = decpair[r - 100*q];
276 *((u16 *)buf) = decpair[q];
281 static noinline_for_stack
282 char *put_dec(char *buf, unsigned long long n)
284 if (n >= 100*1000*1000)
285 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
286 /* 1 <= n <= 1.6e11 */
287 if (n >= 100*1000*1000)
288 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
290 return put_dec_trunc8(buf, n);
293 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
296 put_dec_full4(char *buf, unsigned r)
301 q = (r * 0x147b) >> 19;
302 *((u16 *)buf) = decpair[r - 100*q];
305 *((u16 *)buf) = decpair[q];
309 * Call put_dec_full4 on x % 10000, return x / 10000.
310 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
311 * holds for all x < 1,128,869,999. The largest value this
312 * helper will ever be asked to convert is 1,125,520,955.
313 * (second call in the put_dec code, assuming n is all-ones).
315 static noinline_for_stack
316 unsigned put_dec_helper4(char *buf, unsigned x)
318 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
320 put_dec_full4(buf, x - q * 10000);
324 /* Based on code by Douglas W. Jones found at
325 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
326 * (with permission from the author).
327 * Performs no 64-bit division and hence should be fast on 32-bit machines.
330 char *put_dec(char *buf, unsigned long long n)
332 uint32_t d3, d2, d1, q, h;
334 if (n < 100*1000*1000)
335 return put_dec_trunc8(buf, n);
337 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
340 d3 = (h >> 16); /* implicit "& 0xffff" */
342 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
343 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
344 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
345 q = put_dec_helper4(buf, q);
347 q += 7671 * d3 + 9496 * d2 + 6 * d1;
348 q = put_dec_helper4(buf+4, q);
350 q += 4749 * d3 + 42 * d2;
351 q = put_dec_helper4(buf+8, q);
356 buf = put_dec_trunc8(buf, q);
357 else while (buf[-1] == '0')
366 * Convert passed number to decimal string.
367 * Returns the length of string. On buffer overflow, returns 0.
369 * If speed is not important, use snprintf(). It's easy to read the code.
371 int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
373 /* put_dec requires 2-byte alignment of the buffer. */
374 char tmp[sizeof(num) * 3] __aligned(2);
377 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
382 len = put_dec(tmp, num) - tmp;
385 if (len > size || width > size)
390 for (idx = 0; idx < width; idx++)
396 for (idx = 0; idx < len; ++idx)
397 buf[idx + width] = tmp[len - idx - 1];
402 #define SIGN 1 /* unsigned/signed, must be 1 */
403 #define LEFT 2 /* left justified */
404 #define PLUS 4 /* show plus */
405 #define SPACE 8 /* space if plus */
406 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
407 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
408 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
410 static_assert(ZEROPAD == ('0' - ' '));
411 static_assert(SMALL == ' ');
414 FORMAT_TYPE_NONE, /* Just a string part */
416 FORMAT_TYPE_PRECISION,
420 FORMAT_TYPE_PERCENT_CHAR,
422 FORMAT_TYPE_LONG_LONG,
436 unsigned int type:8; /* format_type enum */
437 signed int field_width:24; /* width of output field */
438 unsigned int flags:8; /* flags to number() */
439 unsigned int base:8; /* number base, 8, 10 or 16 only */
440 signed int precision:16; /* # of digits/chars */
442 static_assert(sizeof(struct printf_spec) == 8);
444 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
445 #define PRECISION_MAX ((1 << 15) - 1)
447 static noinline_for_stack
448 char *number(char *buf, char *end, unsigned long long num,
449 struct printf_spec spec)
451 /* put_dec requires 2-byte alignment of the buffer. */
452 char tmp[3 * sizeof(num)] __aligned(2);
455 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
457 bool is_zero = num == 0LL;
458 int field_width = spec.field_width;
459 int precision = spec.precision;
461 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
462 * produces same digits or (maybe lowercased) letters */
463 locase = (spec.flags & SMALL);
464 if (spec.flags & LEFT)
465 spec.flags &= ~ZEROPAD;
467 if (spec.flags & SIGN) {
468 if ((signed long long)num < 0) {
470 num = -(signed long long)num;
472 } else if (spec.flags & PLUS) {
475 } else if (spec.flags & SPACE) {
487 /* generate full string in tmp[], in reverse order */
490 tmp[i++] = hex_asc_upper[num] | locase;
491 else if (spec.base != 10) { /* 8 or 16 */
492 int mask = spec.base - 1;
498 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
501 } else { /* base 10 */
502 i = put_dec(tmp, num) - tmp;
505 /* printing 100 using %2d gives "100", not "00" */
508 /* leading space padding */
509 field_width -= precision;
510 if (!(spec.flags & (ZEROPAD | LEFT))) {
511 while (--field_width >= 0) {
523 /* "0x" / "0" prefix */
525 if (spec.base == 16 || !is_zero) {
530 if (spec.base == 16) {
532 *buf = ('X' | locase);
536 /* zero or space padding */
537 if (!(spec.flags & LEFT)) {
538 char c = ' ' + (spec.flags & ZEROPAD);
540 while (--field_width >= 0) {
546 /* hmm even more zero padding? */
547 while (i <= --precision) {
552 /* actual digits of result */
558 /* trailing space padding */
559 while (--field_width >= 0) {
568 static noinline_for_stack
569 char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
571 struct printf_spec spec;
573 spec.type = FORMAT_TYPE_PTR;
574 spec.field_width = 2 + 2 * size; /* 0x + hex */
575 spec.flags = SPECIAL | SMALL | ZEROPAD;
579 return number(buf, end, num, spec);
582 static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
585 if (buf >= end) /* nowhere to put anything */
588 if (size <= spaces) {
589 memset(buf, ' ', size);
593 if (len > size - spaces)
595 memmove(buf + spaces, buf, len);
597 memset(buf, ' ', spaces);
601 * Handle field width padding for a string.
602 * @buf: current buffer position
603 * @n: length of string
604 * @end: end of output buffer
605 * @spec: for field width and flags
606 * Returns: new buffer position after padding.
608 static noinline_for_stack
609 char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
613 if (likely(n >= spec.field_width))
615 /* we want to pad the sucker */
616 spaces = spec.field_width - n;
617 if (!(spec.flags & LEFT)) {
618 move_right(buf - n, end, n, spaces);
629 /* Handle string from a well known address. */
630 static char *string_nocheck(char *buf, char *end, const char *s,
631 struct printf_spec spec)
634 int lim = spec.precision;
645 return widen_string(buf, len, end, spec);
648 static char *err_ptr(char *buf, char *end, void *ptr,
649 struct printf_spec spec)
651 int err = PTR_ERR(ptr);
652 const char *sym = errname(err);
655 return string_nocheck(buf, end, sym, spec);
658 * Somebody passed ERR_PTR(-1234) or some other non-existing
659 * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to
660 * printing it as its decimal representation.
664 return number(buf, end, err, spec);
667 /* Be careful: error messages must fit into the given buffer. */
668 static char *error_string(char *buf, char *end, const char *s,
669 struct printf_spec spec)
672 * Hard limit to avoid a completely insane messages. It actually
673 * works pretty well because most error messages are in
674 * the many pointer format modifiers.
676 if (spec.precision == -1)
677 spec.precision = 2 * sizeof(void *);
679 return string_nocheck(buf, end, s, spec);
683 * Do not call any complex external code here. Nested printk()/vsprintf()
684 * might cause infinite loops. Failures might break printk() and would
687 static const char *check_pointer_msg(const void *ptr)
692 if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
698 static int check_pointer(char **buf, char *end, const void *ptr,
699 struct printf_spec spec)
703 err_msg = check_pointer_msg(ptr);
705 *buf = error_string(*buf, end, err_msg, spec);
712 static noinline_for_stack
713 char *string(char *buf, char *end, const char *s,
714 struct printf_spec spec)
716 if (check_pointer(&buf, end, s, spec))
719 return string_nocheck(buf, end, s, spec);
722 static char *pointer_string(char *buf, char *end,
724 struct printf_spec spec)
728 if (spec.field_width == -1) {
729 spec.field_width = 2 * sizeof(ptr);
730 spec.flags |= ZEROPAD;
733 return number(buf, end, (unsigned long int)ptr, spec);
736 /* Make pointers available for printing early in the boot sequence. */
737 static int debug_boot_weak_hash __ro_after_init;
739 static int __init debug_boot_weak_hash_enable(char *str)
741 debug_boot_weak_hash = 1;
742 pr_info("debug_boot_weak_hash enabled\n");
745 early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable);
747 static DEFINE_STATIC_KEY_TRUE(not_filled_random_ptr_key);
748 static siphash_key_t ptr_key __read_mostly;
750 static void enable_ptr_key_workfn(struct work_struct *work)
752 get_random_bytes(&ptr_key, sizeof(ptr_key));
753 /* Needs to run from preemptible context */
754 static_branch_disable(¬_filled_random_ptr_key);
757 static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn);
759 static void fill_random_ptr_key(struct random_ready_callback *unused)
761 /* This may be in an interrupt handler. */
762 queue_work(system_unbound_wq, &enable_ptr_key_work);
765 static struct random_ready_callback random_ready = {
766 .func = fill_random_ptr_key
769 static int __init initialize_ptr_random(void)
771 int key_size = sizeof(ptr_key);
774 /* Use hw RNG if available. */
775 if (get_random_bytes_arch(&ptr_key, key_size) == key_size) {
776 static_branch_disable(¬_filled_random_ptr_key);
780 ret = add_random_ready_callback(&random_ready);
783 } else if (ret == -EALREADY) {
784 /* This is in preemptible context */
785 enable_ptr_key_workfn(&enable_ptr_key_work);
791 early_initcall(initialize_ptr_random);
793 /* Maps a pointer to a 32 bit unique identifier. */
794 static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
796 unsigned long hashval;
798 if (static_branch_unlikely(¬_filled_random_ptr_key))
802 hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
804 * Mask off the first 32 bits, this makes explicit that we have
805 * modified the address (and 32 bits is plenty for a unique ID).
807 hashval = hashval & 0xffffffff;
809 hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
811 *hashval_out = hashval;
815 int ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
817 return __ptr_to_hashval(ptr, hashval_out);
820 static char *ptr_to_id(char *buf, char *end, const void *ptr,
821 struct printf_spec spec)
823 const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
824 unsigned long hashval;
828 * Print the real pointer value for NULL and error pointers,
829 * as they are not actual addresses.
831 if (IS_ERR_OR_NULL(ptr))
832 return pointer_string(buf, end, ptr, spec);
834 /* When debugging early boot use non-cryptographically secure hash. */
835 if (unlikely(debug_boot_weak_hash)) {
836 hashval = hash_long((unsigned long)ptr, 32);
837 return pointer_string(buf, end, (const void *)hashval, spec);
840 ret = __ptr_to_hashval(ptr, &hashval);
842 spec.field_width = 2 * sizeof(ptr);
843 /* string length must be less than default_width */
844 return error_string(buf, end, str, spec);
847 return pointer_string(buf, end, (const void *)hashval, spec);
850 int kptr_restrict __read_mostly;
852 static noinline_for_stack
853 char *restricted_pointer(char *buf, char *end, const void *ptr,
854 struct printf_spec spec)
856 switch (kptr_restrict) {
858 /* Handle as %p, hash and do _not_ leak addresses. */
859 return ptr_to_id(buf, end, ptr, spec);
861 const struct cred *cred;
864 * kptr_restrict==1 cannot be used in IRQ context
865 * because its test for CAP_SYSLOG would be meaningless.
867 if (in_irq() || in_serving_softirq() || in_nmi()) {
868 if (spec.field_width == -1)
869 spec.field_width = 2 * sizeof(ptr);
870 return error_string(buf, end, "pK-error", spec);
874 * Only print the real pointer value if the current
875 * process has CAP_SYSLOG and is running with the
876 * same credentials it started with. This is because
877 * access to files is checked at open() time, but %pK
878 * checks permission at read() time. We don't want to
879 * leak pointer values if a binary opens a file using
880 * %pK and then elevates privileges before reading it.
882 cred = current_cred();
883 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
884 !uid_eq(cred->euid, cred->uid) ||
885 !gid_eq(cred->egid, cred->gid))
891 /* Always print 0's for %pK */
896 return pointer_string(buf, end, ptr, spec);
899 static noinline_for_stack
900 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
903 const char *array[4], *s;
904 const struct dentry *p;
909 case '2': case '3': case '4':
910 depth = fmt[1] - '0';
917 for (i = 0; i < depth; i++, d = p) {
918 if (check_pointer(&buf, end, d, spec)) {
923 p = READ_ONCE(d->d_parent);
924 array[i] = READ_ONCE(d->d_name.name);
933 for (n = 0; n != spec.precision; n++, buf++) {
945 return widen_string(buf, n, end, spec);
948 static noinline_for_stack
949 char *file_dentry_name(char *buf, char *end, const struct file *f,
950 struct printf_spec spec, const char *fmt)
952 if (check_pointer(&buf, end, f, spec))
955 return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
958 static noinline_for_stack
959 char *bdev_name(char *buf, char *end, struct block_device *bdev,
960 struct printf_spec spec, const char *fmt)
964 if (check_pointer(&buf, end, bdev, spec))
968 buf = string(buf, end, hd->disk_name, spec);
969 if (bdev->bd_partno) {
970 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
975 buf = number(buf, end, bdev->bd_partno, spec);
981 static noinline_for_stack
982 char *symbol_string(char *buf, char *end, void *ptr,
983 struct printf_spec spec, const char *fmt)
986 #ifdef CONFIG_KALLSYMS
987 char sym[KSYM_SYMBOL_LEN];
991 ptr = __builtin_extract_return_addr(ptr);
992 value = (unsigned long)ptr;
994 #ifdef CONFIG_KALLSYMS
996 sprint_backtrace(sym, value);
997 else if (*fmt != 's')
998 sprint_symbol(sym, value);
1000 sprint_symbol_no_offset(sym, value);
1002 return string_nocheck(buf, end, sym, spec);
1004 return special_hex_number(buf, end, value, sizeof(void *));
1008 static const struct printf_spec default_str_spec = {
1013 static const struct printf_spec default_flag_spec = {
1016 .flags = SPECIAL | SMALL,
1019 static const struct printf_spec default_dec_spec = {
1024 static const struct printf_spec default_dec02_spec = {
1031 static const struct printf_spec default_dec04_spec = {
1038 static noinline_for_stack
1039 char *resource_string(char *buf, char *end, struct resource *res,
1040 struct printf_spec spec, const char *fmt)
1042 #ifndef IO_RSRC_PRINTK_SIZE
1043 #define IO_RSRC_PRINTK_SIZE 6
1046 #ifndef MEM_RSRC_PRINTK_SIZE
1047 #define MEM_RSRC_PRINTK_SIZE 10
1049 static const struct printf_spec io_spec = {
1051 .field_width = IO_RSRC_PRINTK_SIZE,
1053 .flags = SPECIAL | SMALL | ZEROPAD,
1055 static const struct printf_spec mem_spec = {
1057 .field_width = MEM_RSRC_PRINTK_SIZE,
1059 .flags = SPECIAL | SMALL | ZEROPAD,
1061 static const struct printf_spec bus_spec = {
1065 .flags = SMALL | ZEROPAD,
1067 static const struct printf_spec str_spec = {
1073 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1074 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1075 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1076 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
1077 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
1078 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1079 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
1080 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
1082 char *p = sym, *pend = sym + sizeof(sym);
1083 int decode = (fmt[0] == 'R') ? 1 : 0;
1084 const struct printf_spec *specp;
1086 if (check_pointer(&buf, end, res, spec))
1090 if (res->flags & IORESOURCE_IO) {
1091 p = string_nocheck(p, pend, "io ", str_spec);
1093 } else if (res->flags & IORESOURCE_MEM) {
1094 p = string_nocheck(p, pend, "mem ", str_spec);
1096 } else if (res->flags & IORESOURCE_IRQ) {
1097 p = string_nocheck(p, pend, "irq ", str_spec);
1098 specp = &default_dec_spec;
1099 } else if (res->flags & IORESOURCE_DMA) {
1100 p = string_nocheck(p, pend, "dma ", str_spec);
1101 specp = &default_dec_spec;
1102 } else if (res->flags & IORESOURCE_BUS) {
1103 p = string_nocheck(p, pend, "bus ", str_spec);
1106 p = string_nocheck(p, pend, "??? ", str_spec);
1110 if (decode && res->flags & IORESOURCE_UNSET) {
1111 p = string_nocheck(p, pend, "size ", str_spec);
1112 p = number(p, pend, resource_size(res), *specp);
1114 p = number(p, pend, res->start, *specp);
1115 if (res->start != res->end) {
1117 p = number(p, pend, res->end, *specp);
1121 if (res->flags & IORESOURCE_MEM_64)
1122 p = string_nocheck(p, pend, " 64bit", str_spec);
1123 if (res->flags & IORESOURCE_PREFETCH)
1124 p = string_nocheck(p, pend, " pref", str_spec);
1125 if (res->flags & IORESOURCE_WINDOW)
1126 p = string_nocheck(p, pend, " window", str_spec);
1127 if (res->flags & IORESOURCE_DISABLED)
1128 p = string_nocheck(p, pend, " disabled", str_spec);
1130 p = string_nocheck(p, pend, " flags ", str_spec);
1131 p = number(p, pend, res->flags, default_flag_spec);
1136 return string_nocheck(buf, end, sym, spec);
1139 static noinline_for_stack
1140 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1143 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
1144 negative value, fallback to the default */
1147 if (spec.field_width == 0)
1148 /* nothing to print */
1151 if (check_pointer(&buf, end, addr, spec))
1169 if (spec.field_width > 0)
1170 len = min_t(int, spec.field_width, 64);
1172 for (i = 0; i < len; ++i) {
1174 *buf = hex_asc_hi(addr[i]);
1177 *buf = hex_asc_lo(addr[i]);
1180 if (separator && i != len - 1) {
1190 static noinline_for_stack
1191 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
1192 struct printf_spec spec, const char *fmt)
1194 const int CHUNKSZ = 32;
1195 int nr_bits = max_t(int, spec.field_width, 0);
1199 if (check_pointer(&buf, end, bitmap, spec))
1202 /* reused to print numbers */
1203 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
1205 chunksz = nr_bits & (CHUNKSZ - 1);
1209 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
1210 for (; i >= 0; i -= CHUNKSZ) {
1214 chunkmask = ((1ULL << chunksz) - 1);
1215 word = i / BITS_PER_LONG;
1216 bit = i % BITS_PER_LONG;
1217 val = (bitmap[word] >> bit) & chunkmask;
1226 spec.field_width = DIV_ROUND_UP(chunksz, 4);
1227 buf = number(buf, end, val, spec);
1234 static noinline_for_stack
1235 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
1236 struct printf_spec spec, const char *fmt)
1238 int nr_bits = max_t(int, spec.field_width, 0);
1239 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
1240 int cur, rbot, rtop;
1243 if (check_pointer(&buf, end, bitmap, spec))
1246 rbot = cur = find_first_bit(bitmap, nr_bits);
1247 while (cur < nr_bits) {
1249 cur = find_next_bit(bitmap, nr_bits, cur + 1);
1250 if (cur < nr_bits && cur <= rtop + 1)
1260 buf = number(buf, end, rbot, default_dec_spec);
1266 buf = number(buf, end, rtop, default_dec_spec);
1274 static noinline_for_stack
1275 char *mac_address_string(char *buf, char *end, u8 *addr,
1276 struct printf_spec spec, const char *fmt)
1278 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
1282 bool reversed = false;
1284 if (check_pointer(&buf, end, addr, spec))
1301 for (i = 0; i < 6; i++) {
1303 p = hex_byte_pack(p, addr[5 - i]);
1305 p = hex_byte_pack(p, addr[i]);
1307 if (fmt[0] == 'M' && i != 5)
1312 return string_nocheck(buf, end, mac_addr, spec);
1315 static noinline_for_stack
1316 char *ip4_string(char *p, const u8 *addr, const char *fmt)
1319 bool leading_zeros = (fmt[0] == 'i');
1344 for (i = 0; i < 4; i++) {
1345 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
1346 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1347 if (leading_zeros) {
1353 /* reverse the digits in the quad */
1355 *p++ = temp[digits];
1365 static noinline_for_stack
1366 char *ip6_compressed_string(char *p, const char *addr)
1369 unsigned char zerolength[8];
1374 bool needcolon = false;
1376 struct in6_addr in6;
1378 memcpy(&in6, addr, sizeof(struct in6_addr));
1380 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1382 memset(zerolength, 0, sizeof(zerolength));
1389 /* find position of longest 0 run */
1390 for (i = 0; i < range; i++) {
1391 for (j = i; j < range; j++) {
1392 if (in6.s6_addr16[j] != 0)
1397 for (i = 0; i < range; i++) {
1398 if (zerolength[i] > longest) {
1399 longest = zerolength[i];
1403 if (longest == 1) /* don't compress a single 0 */
1407 for (i = 0; i < range; i++) {
1408 if (i == colonpos) {
1409 if (needcolon || i == 0)
1420 /* hex u16 without leading 0s */
1421 word = ntohs(in6.s6_addr16[i]);
1426 p = hex_byte_pack(p, hi);
1428 *p++ = hex_asc_lo(hi);
1429 p = hex_byte_pack(p, lo);
1432 p = hex_byte_pack(p, lo);
1434 *p++ = hex_asc_lo(lo);
1441 p = ip4_string(p, &in6.s6_addr[12], "I4");
1448 static noinline_for_stack
1449 char *ip6_string(char *p, const char *addr, const char *fmt)
1453 for (i = 0; i < 8; i++) {
1454 p = hex_byte_pack(p, *addr++);
1455 p = hex_byte_pack(p, *addr++);
1456 if (fmt[0] == 'I' && i != 7)
1464 static noinline_for_stack
1465 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1466 struct printf_spec spec, const char *fmt)
1468 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1470 if (fmt[0] == 'I' && fmt[2] == 'c')
1471 ip6_compressed_string(ip6_addr, addr);
1473 ip6_string(ip6_addr, addr, fmt);
1475 return string_nocheck(buf, end, ip6_addr, spec);
1478 static noinline_for_stack
1479 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1480 struct printf_spec spec, const char *fmt)
1482 char ip4_addr[sizeof("255.255.255.255")];
1484 ip4_string(ip4_addr, addr, fmt);
1486 return string_nocheck(buf, end, ip4_addr, spec);
1489 static noinline_for_stack
1490 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1491 struct printf_spec spec, const char *fmt)
1493 bool have_p = false, have_s = false, have_f = false, have_c = false;
1494 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1495 sizeof(":12345") + sizeof("/123456789") +
1496 sizeof("%1234567890")];
1497 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1498 const u8 *addr = (const u8 *) &sa->sin6_addr;
1499 char fmt6[2] = { fmt[0], '6' };
1503 while (isalpha(*++fmt)) {
1520 if (have_p || have_s || have_f) {
1525 if (fmt6[0] == 'I' && have_c)
1526 p = ip6_compressed_string(ip6_addr + off, addr);
1528 p = ip6_string(ip6_addr + off, addr, fmt6);
1530 if (have_p || have_s || have_f)
1535 p = number(p, pend, ntohs(sa->sin6_port), spec);
1539 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1540 IPV6_FLOWINFO_MASK), spec);
1544 p = number(p, pend, sa->sin6_scope_id, spec);
1548 return string_nocheck(buf, end, ip6_addr, spec);
1551 static noinline_for_stack
1552 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1553 struct printf_spec spec, const char *fmt)
1555 bool have_p = false;
1556 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1557 char *pend = ip4_addr + sizeof(ip4_addr);
1558 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1559 char fmt4[3] = { fmt[0], '4', 0 };
1562 while (isalpha(*++fmt)) {
1576 p = ip4_string(ip4_addr, addr, fmt4);
1579 p = number(p, pend, ntohs(sa->sin_port), spec);
1583 return string_nocheck(buf, end, ip4_addr, spec);
1586 static noinline_for_stack
1587 char *ip_addr_string(char *buf, char *end, const void *ptr,
1588 struct printf_spec spec, const char *fmt)
1592 if (check_pointer(&buf, end, ptr, spec))
1597 return ip6_addr_string(buf, end, ptr, spec, fmt);
1599 return ip4_addr_string(buf, end, ptr, spec, fmt);
1602 struct sockaddr raw;
1603 struct sockaddr_in v4;
1604 struct sockaddr_in6 v6;
1607 switch (sa->raw.sa_family) {
1609 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1611 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1613 return error_string(buf, end, "(einval)", spec);
1617 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
1618 return error_string(buf, end, err_fmt_msg, spec);
1621 static noinline_for_stack
1622 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1627 unsigned int flags = 0;
1630 if (spec.field_width == 0)
1631 return buf; /* nothing to print */
1633 if (check_pointer(&buf, end, addr, spec))
1637 switch (fmt[count++]) {
1639 flags |= ESCAPE_ANY;
1642 flags |= ESCAPE_SPECIAL;
1645 flags |= ESCAPE_HEX;
1648 flags |= ESCAPE_NULL;
1651 flags |= ESCAPE_OCTAL;
1657 flags |= ESCAPE_SPACE;
1666 flags = ESCAPE_ANY_NP;
1668 len = spec.field_width < 0 ? 1 : spec.field_width;
1671 * string_escape_mem() writes as many characters as it can to
1672 * the given buffer, and returns the total size of the output
1673 * had the buffer been big enough.
1675 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1680 static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1681 struct printf_spec spec, const char *fmt)
1685 if (check_pointer(&buf, end, va_fmt, spec))
1688 va_copy(va, *va_fmt->va);
1689 buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
1695 static noinline_for_stack
1696 char *uuid_string(char *buf, char *end, const u8 *addr,
1697 struct printf_spec spec, const char *fmt)
1699 char uuid[UUID_STRING_LEN + 1];
1702 const u8 *index = uuid_index;
1705 if (check_pointer(&buf, end, addr, spec))
1720 for (i = 0; i < 16; i++) {
1722 p = hex_byte_pack_upper(p, addr[index[i]]);
1724 p = hex_byte_pack(p, addr[index[i]]);
1737 return string_nocheck(buf, end, uuid, spec);
1740 static noinline_for_stack
1741 char *netdev_bits(char *buf, char *end, const void *addr,
1742 struct printf_spec spec, const char *fmt)
1744 unsigned long long num;
1747 if (check_pointer(&buf, end, addr, spec))
1752 num = *(const netdev_features_t *)addr;
1753 size = sizeof(netdev_features_t);
1756 return error_string(buf, end, "(%pN?)", spec);
1759 return special_hex_number(buf, end, num, size);
1762 static noinline_for_stack
1763 char *fourcc_string(char *buf, char *end, const u32 *fourcc,
1764 struct printf_spec spec, const char *fmt)
1766 char output[sizeof("0123 little-endian (0x01234567)")];
1771 if (fmt[1] != 'c' || fmt[2] != 'c')
1772 return error_string(buf, end, "(%p4?)", spec);
1774 if (check_pointer(&buf, end, fourcc, spec))
1777 val = *fourcc & ~BIT(31);
1779 for (i = 0; i < sizeof(*fourcc); i++) {
1780 unsigned char c = val >> (i * 8);
1782 /* Print non-control ASCII characters as-is, dot otherwise */
1783 *p++ = isascii(c) && isprint(c) ? c : '.';
1786 strcpy(p, *fourcc & BIT(31) ? " big-endian" : " little-endian");
1791 p = special_hex_number(p, output + sizeof(output) - 2, *fourcc, sizeof(u32));
1795 return string(buf, end, output, spec);
1798 static noinline_for_stack
1799 char *address_val(char *buf, char *end, const void *addr,
1800 struct printf_spec spec, const char *fmt)
1802 unsigned long long num;
1805 if (check_pointer(&buf, end, addr, spec))
1810 num = *(const dma_addr_t *)addr;
1811 size = sizeof(dma_addr_t);
1815 num = *(const phys_addr_t *)addr;
1816 size = sizeof(phys_addr_t);
1820 return special_hex_number(buf, end, num, size);
1823 static noinline_for_stack
1824 char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1826 int year = tm->tm_year + (r ? 0 : 1900);
1827 int mon = tm->tm_mon + (r ? 0 : 1);
1829 buf = number(buf, end, year, default_dec04_spec);
1834 buf = number(buf, end, mon, default_dec02_spec);
1839 return number(buf, end, tm->tm_mday, default_dec02_spec);
1842 static noinline_for_stack
1843 char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1845 buf = number(buf, end, tm->tm_hour, default_dec02_spec);
1850 buf = number(buf, end, tm->tm_min, default_dec02_spec);
1855 return number(buf, end, tm->tm_sec, default_dec02_spec);
1858 static noinline_for_stack
1859 char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1860 struct printf_spec spec, const char *fmt)
1862 bool have_t = true, have_d = true;
1863 bool raw = false, iso8601_separator = true;
1867 if (check_pointer(&buf, end, tm, spec))
1870 switch (fmt[count]) {
1882 switch (fmt[count++]) {
1887 iso8601_separator = false;
1896 buf = date_str(buf, end, tm, raw);
1897 if (have_d && have_t) {
1899 *buf = iso8601_separator ? 'T' : ' ';
1903 buf = time_str(buf, end, tm, raw);
1908 static noinline_for_stack
1909 char *time64_str(char *buf, char *end, const time64_t time,
1910 struct printf_spec spec, const char *fmt)
1912 struct rtc_time rtc_time;
1915 time64_to_tm(time, 0, &tm);
1917 rtc_time.tm_sec = tm.tm_sec;
1918 rtc_time.tm_min = tm.tm_min;
1919 rtc_time.tm_hour = tm.tm_hour;
1920 rtc_time.tm_mday = tm.tm_mday;
1921 rtc_time.tm_mon = tm.tm_mon;
1922 rtc_time.tm_year = tm.tm_year;
1923 rtc_time.tm_wday = tm.tm_wday;
1924 rtc_time.tm_yday = tm.tm_yday;
1926 rtc_time.tm_isdst = 0;
1928 return rtc_str(buf, end, &rtc_time, spec, fmt);
1931 static noinline_for_stack
1932 char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
1937 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
1939 return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
1941 return error_string(buf, end, "(%pt?)", spec);
1945 static noinline_for_stack
1946 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1949 if (!IS_ENABLED(CONFIG_HAVE_CLK))
1950 return error_string(buf, end, "(%pC?)", spec);
1952 if (check_pointer(&buf, end, clk, spec))
1958 #ifdef CONFIG_COMMON_CLK
1959 return string(buf, end, __clk_get_name(clk), spec);
1961 return ptr_to_id(buf, end, clk, spec);
1967 char *format_flags(char *buf, char *end, unsigned long flags,
1968 const struct trace_print_flags *names)
1972 for ( ; flags && names->name; names++) {
1974 if ((flags & mask) != mask)
1977 buf = string(buf, end, names->name, default_str_spec);
1988 buf = number(buf, end, flags, default_flag_spec);
1993 struct page_flags_fields {
1997 const struct printf_spec *spec;
2001 static const struct page_flags_fields pff[] = {
2002 {SECTIONS_WIDTH, SECTIONS_PGSHIFT, SECTIONS_MASK,
2003 &default_dec_spec, "section"},
2004 {NODES_WIDTH, NODES_PGSHIFT, NODES_MASK,
2005 &default_dec_spec, "node"},
2006 {ZONES_WIDTH, ZONES_PGSHIFT, ZONES_MASK,
2007 &default_dec_spec, "zone"},
2008 {LAST_CPUPID_WIDTH, LAST_CPUPID_PGSHIFT, LAST_CPUPID_MASK,
2009 &default_flag_spec, "lastcpupid"},
2010 {KASAN_TAG_WIDTH, KASAN_TAG_PGSHIFT, KASAN_TAG_MASK,
2011 &default_flag_spec, "kasantag"},
2015 char *format_page_flags(char *buf, char *end, unsigned long flags)
2017 unsigned long main_flags = flags & (BIT(NR_PAGEFLAGS) - 1);
2018 bool append = false;
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,
2053 static noinline_for_stack
2054 char *flags_string(char *buf, char *end, void *flags_ptr,
2055 struct printf_spec spec, const char *fmt)
2057 unsigned long flags;
2058 const struct trace_print_flags *names;
2060 if (check_pointer(&buf, end, flags_ptr, spec))
2065 return format_page_flags(buf, end, *(unsigned long *)flags_ptr);
2067 flags = *(unsigned long *)flags_ptr;
2068 names = vmaflag_names;
2071 flags = (__force unsigned long)(*(gfp_t *)flags_ptr);
2072 names = gfpflag_names;
2075 return error_string(buf, end, "(%pG?)", spec);
2078 return format_flags(buf, end, flags, names);
2081 static noinline_for_stack
2082 char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
2087 /* Loop starting from the root node to the current node. */
2088 for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
2089 struct fwnode_handle *__fwnode =
2090 fwnode_get_nth_parent(fwnode, depth);
2092 buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
2094 buf = string(buf, end, fwnode_get_name(__fwnode),
2097 fwnode_handle_put(__fwnode);
2103 static noinline_for_stack
2104 char *device_node_string(char *buf, char *end, struct device_node *dn,
2105 struct printf_spec spec, const char *fmt)
2107 char tbuf[sizeof("xxxx") + 1];
2110 char *buf_start = buf;
2111 struct property *prop;
2112 bool has_mult, pass;
2114 struct printf_spec str_spec = spec;
2115 str_spec.field_width = -1;
2118 return error_string(buf, end, "(%pO?)", spec);
2120 if (!IS_ENABLED(CONFIG_OF))
2121 return error_string(buf, end, "(%pOF?)", spec);
2123 if (check_pointer(&buf, end, dn, spec))
2126 /* simple case without anything any more format specifiers */
2128 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
2131 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
2140 case 'f': /* full_name */
2141 buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
2144 case 'n': /* name */
2145 p = fwnode_get_name(of_fwnode_handle(dn));
2146 precision = str_spec.precision;
2147 str_spec.precision = strchrnul(p, '@') - p;
2148 buf = string(buf, end, p, str_spec);
2149 str_spec.precision = precision;
2151 case 'p': /* phandle */
2152 buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec);
2154 case 'P': /* path-spec */
2155 p = fwnode_get_name(of_fwnode_handle(dn));
2158 buf = string(buf, end, p, str_spec);
2160 case 'F': /* flags */
2161 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2162 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2163 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2164 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2166 buf = string_nocheck(buf, end, tbuf, str_spec);
2168 case 'c': /* major compatible string */
2169 ret = of_property_read_string(dn, "compatible", &p);
2171 buf = string(buf, end, p, str_spec);
2173 case 'C': /* full compatible string */
2175 of_property_for_each_string(dn, "compatible", prop, p) {
2177 buf = string_nocheck(buf, end, ",", str_spec);
2178 buf = string_nocheck(buf, end, "\"", str_spec);
2179 buf = string(buf, end, p, str_spec);
2180 buf = string_nocheck(buf, end, "\"", str_spec);
2190 return widen_string(buf, buf - buf_start, end, spec);
2193 static noinline_for_stack
2194 char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
2195 struct printf_spec spec, const char *fmt)
2197 struct printf_spec str_spec = spec;
2198 char *buf_start = buf;
2200 str_spec.field_width = -1;
2203 return error_string(buf, end, "(%pf?)", spec);
2205 if (check_pointer(&buf, end, fwnode, spec))
2211 case 'P': /* name */
2212 buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
2214 case 'f': /* full_name */
2216 buf = fwnode_full_name_string(fwnode, buf, end);
2220 return widen_string(buf, buf - buf_start, end, spec);
2223 /* Disable pointer hashing if requested */
2224 bool no_hash_pointers __ro_after_init;
2225 EXPORT_SYMBOL_GPL(no_hash_pointers);
2227 int __init no_hash_pointers_enable(char *str)
2229 if (no_hash_pointers)
2232 no_hash_pointers = true;
2234 pr_warn("**********************************************************\n");
2235 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2237 pr_warn("** This system shows unhashed kernel memory addresses **\n");
2238 pr_warn("** via the console, logs, and other interfaces. This **\n");
2239 pr_warn("** might reduce the security of your system. **\n");
2241 pr_warn("** If you see this message and you are not debugging **\n");
2242 pr_warn("** the kernel, report this immediately to your system **\n");
2243 pr_warn("** administrator! **\n");
2245 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2246 pr_warn("**********************************************************\n");
2250 early_param("no_hash_pointers", no_hash_pointers_enable);
2253 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2254 * by an extra set of alphanumeric characters that are extended format
2257 * Please update scripts/checkpatch.pl when adding/removing conversion
2258 * characters. (Search for "check for vsprintf extension").
2260 * Right now we handle:
2262 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2263 * - 's' For symbolic direct pointers (or function descriptors) without offset
2264 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
2265 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2266 * %ps and %pS. Be careful when re-using these specifiers.
2267 * - 'B' For backtraced symbolic direct pointers with offset
2268 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2269 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2270 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2271 * width which must be explicitly specified either as part of the
2272 * format string '%32b[l]' or through '%*b[l]', [l] selects
2273 * range-list format instead of hex format
2274 * - 'M' For a 6-byte MAC address, it prints the address in the
2275 * usual colon-separated hex notation
2276 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2277 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2278 * with a dash-separated hex notation
2279 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2280 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2281 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2282 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
2284 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2285 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2286 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2287 * IPv6 omits the colons (01020304...0f)
2288 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2290 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2291 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2292 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2293 * - 'I[6S]c' for IPv6 addresses printed as specified by
2294 * https://tools.ietf.org/html/rfc5952
2295 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2296 * of the following flags (see string_escape_mem() for the
2299 * c - ESCAPE_SPECIAL
2305 * By default ESCAPE_ANY_NP is used.
2306 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2307 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2308 * Options for %pU are:
2309 * b big endian lower case hex (default)
2310 * B big endian UPPER case hex
2311 * l little endian lower case hex
2312 * L little endian UPPER case hex
2313 * big endian output byte order is:
2314 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2315 * little endian output byte order is:
2316 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2317 * - 'V' For a struct va_format which contains a format string * and va_list *,
2318 * call vsnprintf(->format, *->va_list).
2319 * Implements a "recursive vsnprintf".
2320 * Do not use this feature without some mechanism to verify the
2321 * correctness of the format string and va_list arguments.
2322 * - 'K' For a kernel pointer that should be hidden from unprivileged users.
2323 * Use only for procfs, sysfs and similar files, not printk(); please
2324 * read the documentation (path below) first.
2325 * - 'NF' For a netdev_features_t
2326 * - '4cc' V4L2 or DRM FourCC code, with endianness and raw numerical value.
2327 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2328 * a certain separator (' ' by default):
2332 * The maximum supported length is 64 bytes of the input. Consider
2333 * to use print_hex_dump() for the larger input.
2334 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2335 * (default assumed to be phys_addr_t, passed by reference)
2336 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2337 * - 'D[234]' Same as 'd' but for a struct file
2338 * - 'g' For block_device name (gendisk + partition number)
2339 * - 't[RT][dt][r][s]' For time and date as represented by:
2342 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2343 * (legacy clock framework) of the clock
2344 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2345 * (legacy clock framework) of the clock
2346 * - 'G' For flags to be printed as a collection of symbolic strings that would
2347 * construct the specific value. Supported flags given by option:
2348 * p page flags (see struct page) given as pointer to unsigned long
2349 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2350 * v vma flags (VM_*) given as pointer to unsigned long
2351 * - 'OF[fnpPcCF]' For a device tree object
2352 * Without any optional arguments prints the full_name
2353 * f device node full_name
2354 * n device node name
2355 * p device node phandle
2356 * P device node path spec (name + @unit)
2357 * F device node flags
2358 * c major compatible string
2359 * C full compatible string
2360 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2361 * Without an option prints the full name of the node
2363 * P node name, including a possible unit address
2364 * - 'x' For printing the address unmodified. Equivalent to "%lx".
2365 * Please read the documentation (path below) before using!
2366 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
2367 * bpf_trace_printk() where [ku] prefix specifies either kernel (k)
2368 * or user (u) memory to probe, and:
2369 * s a string, equivalent to "%s" on direct vsnprintf() use
2371 * ** When making changes please also update:
2372 * Documentation/core-api/printk-formats.rst
2374 * Note: The default behaviour (unadorned %p) is to hash the address,
2375 * rendering it useful as a unique identifier.
2377 static noinline_for_stack
2378 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2379 struct printf_spec spec)
2384 ptr = dereference_symbol_descriptor(ptr);
2387 return symbol_string(buf, end, ptr, spec, fmt);
2390 return resource_string(buf, end, ptr, spec, fmt);
2392 return hex_string(buf, end, ptr, spec, fmt);
2396 return bitmap_list_string(buf, end, ptr, spec, fmt);
2398 return bitmap_string(buf, end, ptr, spec, fmt);
2400 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2401 case 'm': /* Contiguous: 000102030405 */
2403 /* [mM]R (Reverse order; Bluetooth) */
2404 return mac_address_string(buf, end, ptr, spec, fmt);
2405 case 'I': /* Formatted IP supported
2407 * 6: 0001:0203:...:0708
2408 * 6c: 1::708 or 1::1.2.3.4
2410 case 'i': /* Contiguous:
2411 * 4: 001.002.003.004
2414 return ip_addr_string(buf, end, ptr, spec, fmt);
2416 return escaped_string(buf, end, ptr, spec, fmt);
2418 return uuid_string(buf, end, ptr, spec, fmt);
2420 return va_format(buf, end, ptr, spec, fmt);
2422 return restricted_pointer(buf, end, ptr, spec);
2424 return netdev_bits(buf, end, ptr, spec, fmt);
2426 return fourcc_string(buf, end, ptr, spec, fmt);
2428 return address_val(buf, end, ptr, spec, fmt);
2430 return dentry_name(buf, end, ptr, spec, fmt);
2432 return time_and_date(buf, end, ptr, spec, fmt);
2434 return clock(buf, end, ptr, spec, fmt);
2436 return file_dentry_name(buf, end, ptr, spec, fmt);
2439 return bdev_name(buf, end, ptr, spec, fmt);
2443 return flags_string(buf, end, ptr, spec, fmt);
2445 return device_node_string(buf, end, ptr, spec, fmt + 1);
2447 return fwnode_string(buf, end, ptr, spec, fmt + 1);
2449 return pointer_string(buf, end, ptr, spec);
2451 /* %pe with a non-ERR_PTR gets treated as plain %p */
2454 return err_ptr(buf, end, ptr, spec);
2459 return string(buf, end, ptr, spec);
2461 return error_string(buf, end, "(einval)", spec);
2466 * default is to _not_ leak addresses, so hash before printing,
2467 * unless no_hash_pointers is specified on the command line.
2469 if (unlikely(no_hash_pointers))
2470 return pointer_string(buf, end, ptr, spec);
2472 return ptr_to_id(buf, end, ptr, spec);
2476 * Helper function to decode printf style format.
2477 * Each call decode a token from the format and return the
2478 * number of characters read (or likely the delta where it wants
2479 * to go on the next call).
2480 * The decoded token is returned through the parameters
2482 * 'h', 'l', or 'L' for integer fields
2483 * 'z' support added 23/7/1999 S.H.
2484 * 'z' changed to 'Z' --davidm 1/25/99
2485 * 'Z' changed to 'z' --adobriyan 2017-01-25
2486 * 't' added for ptrdiff_t
2488 * @fmt: the format string
2489 * @type of the token returned
2490 * @flags: various flags such as +, -, # tokens..
2491 * @field_width: overwritten width
2492 * @base: base of the number (octal, hex, ...)
2493 * @precision: precision of a number
2494 * @qualifier: qualifier of a number (long, size_t, ...)
2496 static noinline_for_stack
2497 int format_decode(const char *fmt, struct printf_spec *spec)
2499 const char *start = fmt;
2502 /* we finished early by reading the field width */
2503 if (spec->type == FORMAT_TYPE_WIDTH) {
2504 if (spec->field_width < 0) {
2505 spec->field_width = -spec->field_width;
2506 spec->flags |= LEFT;
2508 spec->type = FORMAT_TYPE_NONE;
2512 /* we finished early by reading the precision */
2513 if (spec->type == FORMAT_TYPE_PRECISION) {
2514 if (spec->precision < 0)
2515 spec->precision = 0;
2517 spec->type = FORMAT_TYPE_NONE;
2522 spec->type = FORMAT_TYPE_NONE;
2524 for (; *fmt ; ++fmt) {
2529 /* Return the current non-format string */
2530 if (fmt != start || !*fmt)
2536 while (1) { /* this also skips first '%' */
2542 case '-': spec->flags |= LEFT; break;
2543 case '+': spec->flags |= PLUS; break;
2544 case ' ': spec->flags |= SPACE; break;
2545 case '#': spec->flags |= SPECIAL; break;
2546 case '0': spec->flags |= ZEROPAD; break;
2547 default: found = false;
2554 /* get field width */
2555 spec->field_width = -1;
2558 spec->field_width = skip_atoi(&fmt);
2559 else if (*fmt == '*') {
2560 /* it's the next argument */
2561 spec->type = FORMAT_TYPE_WIDTH;
2562 return ++fmt - start;
2566 /* get the precision */
2567 spec->precision = -1;
2570 if (isdigit(*fmt)) {
2571 spec->precision = skip_atoi(&fmt);
2572 if (spec->precision < 0)
2573 spec->precision = 0;
2574 } else if (*fmt == '*') {
2575 /* it's the next argument */
2576 spec->type = FORMAT_TYPE_PRECISION;
2577 return ++fmt - start;
2582 /* get the conversion qualifier */
2584 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2585 *fmt == 'z' || *fmt == 't') {
2587 if (unlikely(qualifier == *fmt)) {
2588 if (qualifier == 'l') {
2591 } else if (qualifier == 'h') {
2602 spec->type = FORMAT_TYPE_CHAR;
2603 return ++fmt - start;
2606 spec->type = FORMAT_TYPE_STR;
2607 return ++fmt - start;
2610 spec->type = FORMAT_TYPE_PTR;
2611 return ++fmt - start;
2614 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2615 return ++fmt - start;
2617 /* integer number formats - set up the flags and "break" */
2623 spec->flags |= SMALL;
2632 spec->flags |= SIGN;
2639 * Since %n poses a greater security risk than
2640 * utility, treat it as any other invalid or
2641 * unsupported format specifier.
2646 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2647 spec->type = FORMAT_TYPE_INVALID;
2651 if (qualifier == 'L')
2652 spec->type = FORMAT_TYPE_LONG_LONG;
2653 else if (qualifier == 'l') {
2654 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2655 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2656 } else if (qualifier == 'z') {
2657 spec->type = FORMAT_TYPE_SIZE_T;
2658 } else if (qualifier == 't') {
2659 spec->type = FORMAT_TYPE_PTRDIFF;
2660 } else if (qualifier == 'H') {
2661 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2662 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2663 } else if (qualifier == 'h') {
2664 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2665 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2667 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2668 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2671 return ++fmt - start;
2675 set_field_width(struct printf_spec *spec, int width)
2677 spec->field_width = width;
2678 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2679 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2684 set_precision(struct printf_spec *spec, int prec)
2686 spec->precision = prec;
2687 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2688 spec->precision = clamp(prec, 0, PRECISION_MAX);
2693 * vsnprintf - Format a string and place it in a buffer
2694 * @buf: The buffer to place the result into
2695 * @size: The size of the buffer, including the trailing null space
2696 * @fmt: The format string to use
2697 * @args: Arguments for the format string
2699 * This function generally follows C99 vsnprintf, but has some
2700 * extensions and a few limitations:
2702 * - ``%n`` is unsupported
2703 * - ``%p*`` is handled by pointer()
2705 * See pointer() or Documentation/core-api/printk-formats.rst for more
2706 * extensive description.
2708 * **Please update the documentation in both places when making changes**
2710 * The return value is the number of characters which would
2711 * be generated for the given input, excluding the trailing
2712 * '\0', as per ISO C99. If you want to have the exact
2713 * number of characters written into @buf as return value
2714 * (not including the trailing '\0'), use vscnprintf(). If the
2715 * return is greater than or equal to @size, the resulting
2716 * string is truncated.
2718 * If you're not already dealing with a va_list consider using snprintf().
2720 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2722 unsigned long long num;
2724 struct printf_spec spec = {0};
2726 /* Reject out-of-range values early. Large positive sizes are
2727 used for unknown buffer sizes. */
2728 if (WARN_ON_ONCE(size > INT_MAX))
2734 /* Make sure end is always >= buf */
2741 const char *old_fmt = fmt;
2742 int read = format_decode(fmt, &spec);
2746 switch (spec.type) {
2747 case FORMAT_TYPE_NONE: {
2750 if (copy > end - str)
2752 memcpy(str, old_fmt, copy);
2758 case FORMAT_TYPE_WIDTH:
2759 set_field_width(&spec, va_arg(args, int));
2762 case FORMAT_TYPE_PRECISION:
2763 set_precision(&spec, va_arg(args, int));
2766 case FORMAT_TYPE_CHAR: {
2769 if (!(spec.flags & LEFT)) {
2770 while (--spec.field_width > 0) {
2777 c = (unsigned char) va_arg(args, int);
2781 while (--spec.field_width > 0) {
2789 case FORMAT_TYPE_STR:
2790 str = string(str, end, va_arg(args, char *), spec);
2793 case FORMAT_TYPE_PTR:
2794 str = pointer(fmt, str, end, va_arg(args, void *),
2796 while (isalnum(*fmt))
2800 case FORMAT_TYPE_PERCENT_CHAR:
2806 case FORMAT_TYPE_INVALID:
2808 * Presumably the arguments passed gcc's type
2809 * checking, but there is no safe or sane way
2810 * for us to continue parsing the format and
2811 * fetching from the va_list; the remaining
2812 * specifiers and arguments would be out of
2818 switch (spec.type) {
2819 case FORMAT_TYPE_LONG_LONG:
2820 num = va_arg(args, long long);
2822 case FORMAT_TYPE_ULONG:
2823 num = va_arg(args, unsigned long);
2825 case FORMAT_TYPE_LONG:
2826 num = va_arg(args, long);
2828 case FORMAT_TYPE_SIZE_T:
2829 if (spec.flags & SIGN)
2830 num = va_arg(args, ssize_t);
2832 num = va_arg(args, size_t);
2834 case FORMAT_TYPE_PTRDIFF:
2835 num = va_arg(args, ptrdiff_t);
2837 case FORMAT_TYPE_UBYTE:
2838 num = (unsigned char) va_arg(args, int);
2840 case FORMAT_TYPE_BYTE:
2841 num = (signed char) va_arg(args, int);
2843 case FORMAT_TYPE_USHORT:
2844 num = (unsigned short) va_arg(args, int);
2846 case FORMAT_TYPE_SHORT:
2847 num = (short) va_arg(args, int);
2849 case FORMAT_TYPE_INT:
2850 num = (int) va_arg(args, int);
2853 num = va_arg(args, unsigned int);
2856 str = number(str, end, num, spec);
2868 /* the trailing null byte doesn't count towards the total */
2872 EXPORT_SYMBOL(vsnprintf);
2875 * vscnprintf - Format a string and place it in a buffer
2876 * @buf: The buffer to place the result into
2877 * @size: The size of the buffer, including the trailing null space
2878 * @fmt: The format string to use
2879 * @args: Arguments for the format string
2881 * The return value is the number of characters which have been written into
2882 * the @buf not including the trailing '\0'. If @size is == 0 the function
2885 * If you're not already dealing with a va_list consider using scnprintf().
2887 * See the vsnprintf() documentation for format string extensions over C99.
2889 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2893 i = vsnprintf(buf, size, fmt, args);
2895 if (likely(i < size))
2901 EXPORT_SYMBOL(vscnprintf);
2904 * snprintf - Format a string and place it in a buffer
2905 * @buf: The buffer to place the result into
2906 * @size: The size of the buffer, including the trailing null space
2907 * @fmt: The format string to use
2908 * @...: Arguments for the format string
2910 * The return value is the number of characters which would be
2911 * generated for the given input, excluding the trailing null,
2912 * as per ISO C99. If the return is greater than or equal to
2913 * @size, the resulting string is truncated.
2915 * See the vsnprintf() documentation for format string extensions over C99.
2917 int snprintf(char *buf, size_t size, const char *fmt, ...)
2922 va_start(args, fmt);
2923 i = vsnprintf(buf, size, fmt, args);
2928 EXPORT_SYMBOL(snprintf);
2931 * scnprintf - Format a string and place it in a buffer
2932 * @buf: The buffer to place the result into
2933 * @size: The size of the buffer, including the trailing null space
2934 * @fmt: The format string to use
2935 * @...: Arguments for the format string
2937 * The return value is the number of characters written into @buf not including
2938 * the trailing '\0'. If @size is == 0 the function returns 0.
2941 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2946 va_start(args, fmt);
2947 i = vscnprintf(buf, size, fmt, args);
2952 EXPORT_SYMBOL(scnprintf);
2955 * vsprintf - Format a string and place it in a buffer
2956 * @buf: The buffer to place the result into
2957 * @fmt: The format string to use
2958 * @args: Arguments for the format string
2960 * The function returns the number of characters written
2961 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2964 * If you're not already dealing with a va_list consider using sprintf().
2966 * See the vsnprintf() documentation for format string extensions over C99.
2968 int vsprintf(char *buf, const char *fmt, va_list args)
2970 return vsnprintf(buf, INT_MAX, fmt, args);
2972 EXPORT_SYMBOL(vsprintf);
2975 * sprintf - Format a string and place it in a buffer
2976 * @buf: The buffer to place the result into
2977 * @fmt: The format string to use
2978 * @...: Arguments for the format string
2980 * The function returns the number of characters written
2981 * into @buf. Use snprintf() or scnprintf() in order to avoid
2984 * See the vsnprintf() documentation for format string extensions over C99.
2986 int sprintf(char *buf, const char *fmt, ...)
2991 va_start(args, fmt);
2992 i = vsnprintf(buf, INT_MAX, fmt, args);
2997 EXPORT_SYMBOL(sprintf);
2999 #ifdef CONFIG_BINARY_PRINTF
3002 * vbin_printf() - VA arguments to binary data
3003 * bstr_printf() - Binary data to text string
3007 * vbin_printf - Parse a format string and place args' binary value in a buffer
3008 * @bin_buf: The buffer to place args' binary value
3009 * @size: The size of the buffer(by words(32bits), not characters)
3010 * @fmt: The format string to use
3011 * @args: Arguments for the format string
3013 * The format follows C99 vsnprintf, except %n is ignored, and its argument
3016 * The return value is the number of words(32bits) which would be generated for
3020 * If the return value is greater than @size, the resulting bin_buf is NOT
3021 * valid for bstr_printf().
3023 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
3025 struct printf_spec spec = {0};
3029 str = (char *)bin_buf;
3030 end = (char *)(bin_buf + size);
3032 #define save_arg(type) \
3034 unsigned long long value; \
3035 if (sizeof(type) == 8) { \
3036 unsigned long long val8; \
3037 str = PTR_ALIGN(str, sizeof(u32)); \
3038 val8 = va_arg(args, unsigned long long); \
3039 if (str + sizeof(type) <= end) { \
3040 *(u32 *)str = *(u32 *)&val8; \
3041 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
3045 unsigned int val4; \
3046 str = PTR_ALIGN(str, sizeof(type)); \
3047 val4 = va_arg(args, int); \
3048 if (str + sizeof(type) <= end) \
3049 *(typeof(type) *)str = (type)(long)val4; \
3050 value = (unsigned long long)val4; \
3052 str += sizeof(type); \
3057 int read = format_decode(fmt, &spec);
3061 switch (spec.type) {
3062 case FORMAT_TYPE_NONE:
3063 case FORMAT_TYPE_PERCENT_CHAR:
3065 case FORMAT_TYPE_INVALID:
3068 case FORMAT_TYPE_WIDTH:
3069 case FORMAT_TYPE_PRECISION:
3070 width = (int)save_arg(int);
3071 /* Pointers may require the width */
3073 set_field_width(&spec, width);
3076 case FORMAT_TYPE_CHAR:
3080 case FORMAT_TYPE_STR: {
3081 const char *save_str = va_arg(args, char *);
3082 const char *err_msg;
3085 err_msg = check_pointer_msg(save_str);
3089 len = strlen(save_str) + 1;
3090 if (str + len < end)
3091 memcpy(str, save_str, len);
3096 case FORMAT_TYPE_PTR:
3097 /* Dereferenced pointers must be done now */
3099 /* Dereference of functions is still OK */
3108 if (!isalnum(*fmt)) {
3112 str = pointer(fmt, str, end, va_arg(args, void *),
3117 end[-1] = '\0'; /* Must be nul terminated */
3119 /* skip all alphanumeric pointer suffixes */
3120 while (isalnum(*fmt))
3125 switch (spec.type) {
3127 case FORMAT_TYPE_LONG_LONG:
3128 save_arg(long long);
3130 case FORMAT_TYPE_ULONG:
3131 case FORMAT_TYPE_LONG:
3132 save_arg(unsigned long);
3134 case FORMAT_TYPE_SIZE_T:
3137 case FORMAT_TYPE_PTRDIFF:
3138 save_arg(ptrdiff_t);
3140 case FORMAT_TYPE_UBYTE:
3141 case FORMAT_TYPE_BYTE:
3144 case FORMAT_TYPE_USHORT:
3145 case FORMAT_TYPE_SHORT:
3155 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
3158 EXPORT_SYMBOL_GPL(vbin_printf);
3161 * bstr_printf - Format a string from binary arguments and place it in a buffer
3162 * @buf: The buffer to place the result into
3163 * @size: The size of the buffer, including the trailing null space
3164 * @fmt: The format string to use
3165 * @bin_buf: Binary arguments for the format string
3167 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
3168 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
3169 * a binary buffer that generated by vbin_printf.
3171 * The format follows C99 vsnprintf, but has some extensions:
3172 * see vsnprintf comment for details.
3174 * The return value is the number of characters which would
3175 * be generated for the given input, excluding the trailing
3176 * '\0', as per ISO C99. If you want to have the exact
3177 * number of characters written into @buf as return value
3178 * (not including the trailing '\0'), use vscnprintf(). If the
3179 * return is greater than or equal to @size, the resulting
3180 * string is truncated.
3182 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
3184 struct printf_spec spec = {0};
3186 const char *args = (const char *)bin_buf;
3188 if (WARN_ON_ONCE(size > INT_MAX))
3194 #define get_arg(type) \
3196 typeof(type) value; \
3197 if (sizeof(type) == 8) { \
3198 args = PTR_ALIGN(args, sizeof(u32)); \
3199 *(u32 *)&value = *(u32 *)args; \
3200 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3202 args = PTR_ALIGN(args, sizeof(type)); \
3203 value = *(typeof(type) *)args; \
3205 args += sizeof(type); \
3209 /* Make sure end is always >= buf */
3216 const char *old_fmt = fmt;
3217 int read = format_decode(fmt, &spec);
3221 switch (spec.type) {
3222 case FORMAT_TYPE_NONE: {
3225 if (copy > end - str)
3227 memcpy(str, old_fmt, copy);
3233 case FORMAT_TYPE_WIDTH:
3234 set_field_width(&spec, get_arg(int));
3237 case FORMAT_TYPE_PRECISION:
3238 set_precision(&spec, get_arg(int));
3241 case FORMAT_TYPE_CHAR: {
3244 if (!(spec.flags & LEFT)) {
3245 while (--spec.field_width > 0) {
3251 c = (unsigned char) get_arg(char);
3255 while (--spec.field_width > 0) {
3263 case FORMAT_TYPE_STR: {
3264 const char *str_arg = args;
3265 args += strlen(str_arg) + 1;
3266 str = string(str, end, (char *)str_arg, spec);
3270 case FORMAT_TYPE_PTR: {
3271 bool process = false;
3273 /* Non function dereferences were already done */
3283 if (!isalnum(*fmt)) {
3287 /* Pointer dereference was already processed */
3289 len = copy = strlen(args);
3290 if (copy > end - str)
3292 memcpy(str, args, copy);
3298 str = pointer(fmt, str, end, get_arg(void *), spec);
3300 while (isalnum(*fmt))
3305 case FORMAT_TYPE_PERCENT_CHAR:
3311 case FORMAT_TYPE_INVALID:
3315 unsigned long long num;
3317 switch (spec.type) {
3319 case FORMAT_TYPE_LONG_LONG:
3320 num = get_arg(long long);
3322 case FORMAT_TYPE_ULONG:
3323 case FORMAT_TYPE_LONG:
3324 num = get_arg(unsigned long);
3326 case FORMAT_TYPE_SIZE_T:
3327 num = get_arg(size_t);
3329 case FORMAT_TYPE_PTRDIFF:
3330 num = get_arg(ptrdiff_t);
3332 case FORMAT_TYPE_UBYTE:
3333 num = get_arg(unsigned char);
3335 case FORMAT_TYPE_BYTE:
3336 num = get_arg(signed char);
3338 case FORMAT_TYPE_USHORT:
3339 num = get_arg(unsigned short);
3341 case FORMAT_TYPE_SHORT:
3342 num = get_arg(short);
3344 case FORMAT_TYPE_UINT:
3345 num = get_arg(unsigned int);
3351 str = number(str, end, num, spec);
3353 } /* switch(spec.type) */
3366 /* the trailing null byte doesn't count towards the total */
3369 EXPORT_SYMBOL_GPL(bstr_printf);
3372 * bprintf - Parse a format string and place args' binary value in a buffer
3373 * @bin_buf: The buffer to place args' binary value
3374 * @size: The size of the buffer(by words(32bits), not characters)
3375 * @fmt: The format string to use
3376 * @...: Arguments for the format string
3378 * The function returns the number of words(u32) written
3381 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3386 va_start(args, fmt);
3387 ret = vbin_printf(bin_buf, size, fmt, args);
3392 EXPORT_SYMBOL_GPL(bprintf);
3394 #endif /* CONFIG_BINARY_PRINTF */
3397 * vsscanf - Unformat a buffer into a list of arguments
3398 * @buf: input buffer
3399 * @fmt: format of buffer
3402 int vsscanf(const char *buf, const char *fmt, va_list args)
3404 const char *str = buf;
3412 unsigned long long u;
3418 /* skip any white space in format */
3419 /* white space in format matchs any amount of
3420 * white space, including none, in the input.
3422 if (isspace(*fmt)) {
3423 fmt = skip_spaces(++fmt);
3424 str = skip_spaces(str);
3427 /* anything that is not a conversion must match exactly */
3428 if (*fmt != '%' && *fmt) {
3429 if (*fmt++ != *str++)
3438 /* skip this conversion.
3439 * advance both strings to next white space
3444 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3445 /* '%*[' not yet supported, invalid format */
3450 while (!isspace(*str) && *str)
3455 /* get field width */
3457 if (isdigit(*fmt)) {
3458 field_width = skip_atoi(&fmt);
3459 if (field_width <= 0)
3463 /* get conversion qualifier */
3465 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
3468 if (unlikely(qualifier == *fmt)) {
3469 if (qualifier == 'h') {
3472 } else if (qualifier == 'l') {
3483 /* return number of characters read so far */
3484 *va_arg(args, int *) = str - buf;
3498 char *s = (char *)va_arg(args, char*);
3499 if (field_width == -1)
3503 } while (--field_width > 0 && *str);
3509 char *s = (char *)va_arg(args, char *);
3510 if (field_width == -1)
3511 field_width = SHRT_MAX;
3512 /* first, skip leading white space in buffer */
3513 str = skip_spaces(str);
3515 /* now copy until next white space */
3516 while (*str && !isspace(*str) && field_width--)
3523 * Warning: This implementation of the '[' conversion specifier
3524 * deviates from its glibc counterpart in the following ways:
3525 * (1) It does NOT support ranges i.e. '-' is NOT a special
3527 * (2) It cannot match the closing bracket ']' itself
3528 * (3) A field width is required
3529 * (4) '%*[' (discard matching input) is currently not supported
3532 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3533 * buf1, buf2, buf3);
3539 char *s = (char *)va_arg(args, char *);
3540 DECLARE_BITMAP(set, 256) = {0};
3541 unsigned int len = 0;
3542 bool negate = (*fmt == '^');
3544 /* field width is required */
3545 if (field_width == -1)
3551 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3552 set_bit((u8)*fmt, set);
3554 /* no ']' or no character set found */
3560 bitmap_complement(set, set, 256);
3561 /* exclude null '\0' byte */
3565 /* match must be non-empty */
3566 if (!test_bit((u8)*str, set))
3569 while (test_bit((u8)*str, set) && field_width--)
3591 /* looking for '%' in str */
3596 /* invalid format; stop here */
3600 /* have some sort of integer conversion.
3601 * first, skip white space in buffer.
3603 str = skip_spaces(str);
3606 if (is_sign && digit == '-') {
3607 if (field_width == 1)
3614 || (base == 16 && !isxdigit(digit))
3615 || (base == 10 && !isdigit(digit))
3616 || (base == 8 && (!isdigit(digit) || digit > '7'))
3617 || (base == 0 && !isdigit(digit)))
3621 val.s = simple_strntoll(str,
3622 field_width >= 0 ? field_width : INT_MAX,
3625 val.u = simple_strntoull(str,
3626 field_width >= 0 ? field_width : INT_MAX,
3629 switch (qualifier) {
3630 case 'H': /* that's 'hh' in format */
3632 *va_arg(args, signed char *) = val.s;
3634 *va_arg(args, unsigned char *) = val.u;
3638 *va_arg(args, short *) = val.s;
3640 *va_arg(args, unsigned short *) = val.u;
3644 *va_arg(args, long *) = val.s;
3646 *va_arg(args, unsigned long *) = val.u;
3650 *va_arg(args, long long *) = val.s;
3652 *va_arg(args, unsigned long long *) = val.u;
3655 *va_arg(args, size_t *) = val.u;
3659 *va_arg(args, int *) = val.s;
3661 *va_arg(args, unsigned int *) = val.u;
3673 EXPORT_SYMBOL(vsscanf);
3676 * sscanf - Unformat a buffer into a list of arguments
3677 * @buf: input buffer
3678 * @fmt: formatting of buffer
3679 * @...: resulting arguments
3681 int sscanf(const char *buf, const char *fmt, ...)
3686 va_start(args, fmt);
3687 i = vsscanf(buf, fmt, args);
3692 EXPORT_SYMBOL(sscanf);