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 int fill_random_ptr_key(struct notifier_block *nb,
760 unsigned long action, void *data)
762 /* This may be in an interrupt handler. */
763 queue_work(system_unbound_wq, &enable_ptr_key_work);
767 static struct notifier_block random_ready = {
768 .notifier_call = fill_random_ptr_key
771 static int __init initialize_ptr_random(void)
773 int key_size = sizeof(ptr_key);
776 /* Use hw RNG if available. */
777 if (get_random_bytes_arch(&ptr_key, key_size) == key_size) {
778 static_branch_disable(¬_filled_random_ptr_key);
782 ret = register_random_ready_notifier(&random_ready);
785 } else if (ret == -EALREADY) {
786 /* This is in preemptible context */
787 enable_ptr_key_workfn(&enable_ptr_key_work);
793 early_initcall(initialize_ptr_random);
795 /* Maps a pointer to a 32 bit unique identifier. */
796 static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
798 unsigned long hashval;
800 if (static_branch_unlikely(¬_filled_random_ptr_key))
804 hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
806 * Mask off the first 32 bits, this makes explicit that we have
807 * modified the address (and 32 bits is plenty for a unique ID).
809 hashval = hashval & 0xffffffff;
811 hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
813 *hashval_out = hashval;
817 int ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
819 return __ptr_to_hashval(ptr, hashval_out);
822 static char *ptr_to_id(char *buf, char *end, const void *ptr,
823 struct printf_spec spec)
825 const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
826 unsigned long hashval;
830 * Print the real pointer value for NULL and error pointers,
831 * as they are not actual addresses.
833 if (IS_ERR_OR_NULL(ptr))
834 return pointer_string(buf, end, ptr, spec);
836 /* When debugging early boot use non-cryptographically secure hash. */
837 if (unlikely(debug_boot_weak_hash)) {
838 hashval = hash_long((unsigned long)ptr, 32);
839 return pointer_string(buf, end, (const void *)hashval, spec);
842 ret = __ptr_to_hashval(ptr, &hashval);
844 spec.field_width = 2 * sizeof(ptr);
845 /* string length must be less than default_width */
846 return error_string(buf, end, str, spec);
849 return pointer_string(buf, end, (const void *)hashval, spec);
852 int kptr_restrict __read_mostly;
854 static noinline_for_stack
855 char *restricted_pointer(char *buf, char *end, const void *ptr,
856 struct printf_spec spec)
858 switch (kptr_restrict) {
860 /* Handle as %p, hash and do _not_ leak addresses. */
861 return ptr_to_id(buf, end, ptr, spec);
863 const struct cred *cred;
866 * kptr_restrict==1 cannot be used in IRQ context
867 * because its test for CAP_SYSLOG would be meaningless.
869 if (in_irq() || in_serving_softirq() || in_nmi()) {
870 if (spec.field_width == -1)
871 spec.field_width = 2 * sizeof(ptr);
872 return error_string(buf, end, "pK-error", spec);
876 * Only print the real pointer value if the current
877 * process has CAP_SYSLOG and is running with the
878 * same credentials it started with. This is because
879 * access to files is checked at open() time, but %pK
880 * checks permission at read() time. We don't want to
881 * leak pointer values if a binary opens a file using
882 * %pK and then elevates privileges before reading it.
884 cred = current_cred();
885 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
886 !uid_eq(cred->euid, cred->uid) ||
887 !gid_eq(cred->egid, cred->gid))
893 /* Always print 0's for %pK */
898 return pointer_string(buf, end, ptr, spec);
901 static noinline_for_stack
902 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
905 const char *array[4], *s;
906 const struct dentry *p;
911 case '2': case '3': case '4':
912 depth = fmt[1] - '0';
919 for (i = 0; i < depth; i++, d = p) {
920 if (check_pointer(&buf, end, d, spec)) {
925 p = READ_ONCE(d->d_parent);
926 array[i] = READ_ONCE(d->d_name.name);
935 for (n = 0; n != spec.precision; n++, buf++) {
947 return widen_string(buf, n, end, spec);
950 static noinline_for_stack
951 char *file_dentry_name(char *buf, char *end, const struct file *f,
952 struct printf_spec spec, const char *fmt)
954 if (check_pointer(&buf, end, f, spec))
957 return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
960 static noinline_for_stack
961 char *bdev_name(char *buf, char *end, struct block_device *bdev,
962 struct printf_spec spec, const char *fmt)
966 if (check_pointer(&buf, end, bdev, spec))
970 buf = string(buf, end, hd->disk_name, spec);
971 if (bdev->bd_partno) {
972 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
977 buf = number(buf, end, bdev->bd_partno, spec);
983 static noinline_for_stack
984 char *symbol_string(char *buf, char *end, void *ptr,
985 struct printf_spec spec, const char *fmt)
988 #ifdef CONFIG_KALLSYMS
989 char sym[KSYM_SYMBOL_LEN];
993 ptr = __builtin_extract_return_addr(ptr);
994 value = (unsigned long)ptr;
996 #ifdef CONFIG_KALLSYMS
998 sprint_backtrace(sym, value);
999 else if (*fmt != 's')
1000 sprint_symbol(sym, value);
1002 sprint_symbol_no_offset(sym, value);
1004 return string_nocheck(buf, end, sym, spec);
1006 return special_hex_number(buf, end, value, sizeof(void *));
1010 static const struct printf_spec default_str_spec = {
1015 static const struct printf_spec default_flag_spec = {
1018 .flags = SPECIAL | SMALL,
1021 static const struct printf_spec default_dec_spec = {
1026 static const struct printf_spec default_dec02_spec = {
1033 static const struct printf_spec default_dec04_spec = {
1040 static noinline_for_stack
1041 char *resource_string(char *buf, char *end, struct resource *res,
1042 struct printf_spec spec, const char *fmt)
1044 #ifndef IO_RSRC_PRINTK_SIZE
1045 #define IO_RSRC_PRINTK_SIZE 6
1048 #ifndef MEM_RSRC_PRINTK_SIZE
1049 #define MEM_RSRC_PRINTK_SIZE 10
1051 static const struct printf_spec io_spec = {
1053 .field_width = IO_RSRC_PRINTK_SIZE,
1055 .flags = SPECIAL | SMALL | ZEROPAD,
1057 static const struct printf_spec mem_spec = {
1059 .field_width = MEM_RSRC_PRINTK_SIZE,
1061 .flags = SPECIAL | SMALL | ZEROPAD,
1063 static const struct printf_spec bus_spec = {
1067 .flags = SMALL | ZEROPAD,
1069 static const struct printf_spec str_spec = {
1075 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1076 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1077 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1078 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
1079 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
1080 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1081 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
1082 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
1084 char *p = sym, *pend = sym + sizeof(sym);
1085 int decode = (fmt[0] == 'R') ? 1 : 0;
1086 const struct printf_spec *specp;
1088 if (check_pointer(&buf, end, res, spec))
1092 if (res->flags & IORESOURCE_IO) {
1093 p = string_nocheck(p, pend, "io ", str_spec);
1095 } else if (res->flags & IORESOURCE_MEM) {
1096 p = string_nocheck(p, pend, "mem ", str_spec);
1098 } else if (res->flags & IORESOURCE_IRQ) {
1099 p = string_nocheck(p, pend, "irq ", str_spec);
1100 specp = &default_dec_spec;
1101 } else if (res->flags & IORESOURCE_DMA) {
1102 p = string_nocheck(p, pend, "dma ", str_spec);
1103 specp = &default_dec_spec;
1104 } else if (res->flags & IORESOURCE_BUS) {
1105 p = string_nocheck(p, pend, "bus ", str_spec);
1108 p = string_nocheck(p, pend, "??? ", str_spec);
1112 if (decode && res->flags & IORESOURCE_UNSET) {
1113 p = string_nocheck(p, pend, "size ", str_spec);
1114 p = number(p, pend, resource_size(res), *specp);
1116 p = number(p, pend, res->start, *specp);
1117 if (res->start != res->end) {
1119 p = number(p, pend, res->end, *specp);
1123 if (res->flags & IORESOURCE_MEM_64)
1124 p = string_nocheck(p, pend, " 64bit", str_spec);
1125 if (res->flags & IORESOURCE_PREFETCH)
1126 p = string_nocheck(p, pend, " pref", str_spec);
1127 if (res->flags & IORESOURCE_WINDOW)
1128 p = string_nocheck(p, pend, " window", str_spec);
1129 if (res->flags & IORESOURCE_DISABLED)
1130 p = string_nocheck(p, pend, " disabled", str_spec);
1132 p = string_nocheck(p, pend, " flags ", str_spec);
1133 p = number(p, pend, res->flags, default_flag_spec);
1138 return string_nocheck(buf, end, sym, spec);
1141 static noinline_for_stack
1142 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1145 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
1146 negative value, fallback to the default */
1149 if (spec.field_width == 0)
1150 /* nothing to print */
1153 if (check_pointer(&buf, end, addr, spec))
1171 if (spec.field_width > 0)
1172 len = min_t(int, spec.field_width, 64);
1174 for (i = 0; i < len; ++i) {
1176 *buf = hex_asc_hi(addr[i]);
1179 *buf = hex_asc_lo(addr[i]);
1182 if (separator && i != len - 1) {
1192 static noinline_for_stack
1193 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
1194 struct printf_spec spec, const char *fmt)
1196 const int CHUNKSZ = 32;
1197 int nr_bits = max_t(int, spec.field_width, 0);
1201 if (check_pointer(&buf, end, bitmap, spec))
1204 /* reused to print numbers */
1205 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
1207 chunksz = nr_bits & (CHUNKSZ - 1);
1211 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
1212 for (; i >= 0; i -= CHUNKSZ) {
1216 chunkmask = ((1ULL << chunksz) - 1);
1217 word = i / BITS_PER_LONG;
1218 bit = i % BITS_PER_LONG;
1219 val = (bitmap[word] >> bit) & chunkmask;
1228 spec.field_width = DIV_ROUND_UP(chunksz, 4);
1229 buf = number(buf, end, val, spec);
1236 static noinline_for_stack
1237 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
1238 struct printf_spec spec, const char *fmt)
1240 int nr_bits = max_t(int, spec.field_width, 0);
1241 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
1242 int cur, rbot, rtop;
1245 if (check_pointer(&buf, end, bitmap, spec))
1248 rbot = cur = find_first_bit(bitmap, nr_bits);
1249 while (cur < nr_bits) {
1251 cur = find_next_bit(bitmap, nr_bits, cur + 1);
1252 if (cur < nr_bits && cur <= rtop + 1)
1262 buf = number(buf, end, rbot, default_dec_spec);
1268 buf = number(buf, end, rtop, default_dec_spec);
1276 static noinline_for_stack
1277 char *mac_address_string(char *buf, char *end, u8 *addr,
1278 struct printf_spec spec, const char *fmt)
1280 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
1284 bool reversed = false;
1286 if (check_pointer(&buf, end, addr, spec))
1303 for (i = 0; i < 6; i++) {
1305 p = hex_byte_pack(p, addr[5 - i]);
1307 p = hex_byte_pack(p, addr[i]);
1309 if (fmt[0] == 'M' && i != 5)
1314 return string_nocheck(buf, end, mac_addr, spec);
1317 static noinline_for_stack
1318 char *ip4_string(char *p, const u8 *addr, const char *fmt)
1321 bool leading_zeros = (fmt[0] == 'i');
1346 for (i = 0; i < 4; i++) {
1347 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
1348 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1349 if (leading_zeros) {
1355 /* reverse the digits in the quad */
1357 *p++ = temp[digits];
1367 static noinline_for_stack
1368 char *ip6_compressed_string(char *p, const char *addr)
1371 unsigned char zerolength[8];
1376 bool needcolon = false;
1378 struct in6_addr in6;
1380 memcpy(&in6, addr, sizeof(struct in6_addr));
1382 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1384 memset(zerolength, 0, sizeof(zerolength));
1391 /* find position of longest 0 run */
1392 for (i = 0; i < range; i++) {
1393 for (j = i; j < range; j++) {
1394 if (in6.s6_addr16[j] != 0)
1399 for (i = 0; i < range; i++) {
1400 if (zerolength[i] > longest) {
1401 longest = zerolength[i];
1405 if (longest == 1) /* don't compress a single 0 */
1409 for (i = 0; i < range; i++) {
1410 if (i == colonpos) {
1411 if (needcolon || i == 0)
1422 /* hex u16 without leading 0s */
1423 word = ntohs(in6.s6_addr16[i]);
1428 p = hex_byte_pack(p, hi);
1430 *p++ = hex_asc_lo(hi);
1431 p = hex_byte_pack(p, lo);
1434 p = hex_byte_pack(p, lo);
1436 *p++ = hex_asc_lo(lo);
1443 p = ip4_string(p, &in6.s6_addr[12], "I4");
1450 static noinline_for_stack
1451 char *ip6_string(char *p, const char *addr, const char *fmt)
1455 for (i = 0; i < 8; i++) {
1456 p = hex_byte_pack(p, *addr++);
1457 p = hex_byte_pack(p, *addr++);
1458 if (fmt[0] == 'I' && i != 7)
1466 static noinline_for_stack
1467 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1468 struct printf_spec spec, const char *fmt)
1470 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1472 if (fmt[0] == 'I' && fmt[2] == 'c')
1473 ip6_compressed_string(ip6_addr, addr);
1475 ip6_string(ip6_addr, addr, fmt);
1477 return string_nocheck(buf, end, ip6_addr, spec);
1480 static noinline_for_stack
1481 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1482 struct printf_spec spec, const char *fmt)
1484 char ip4_addr[sizeof("255.255.255.255")];
1486 ip4_string(ip4_addr, addr, fmt);
1488 return string_nocheck(buf, end, ip4_addr, spec);
1491 static noinline_for_stack
1492 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1493 struct printf_spec spec, const char *fmt)
1495 bool have_p = false, have_s = false, have_f = false, have_c = false;
1496 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1497 sizeof(":12345") + sizeof("/123456789") +
1498 sizeof("%1234567890")];
1499 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1500 const u8 *addr = (const u8 *) &sa->sin6_addr;
1501 char fmt6[2] = { fmt[0], '6' };
1505 while (isalpha(*++fmt)) {
1522 if (have_p || have_s || have_f) {
1527 if (fmt6[0] == 'I' && have_c)
1528 p = ip6_compressed_string(ip6_addr + off, addr);
1530 p = ip6_string(ip6_addr + off, addr, fmt6);
1532 if (have_p || have_s || have_f)
1537 p = number(p, pend, ntohs(sa->sin6_port), spec);
1541 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1542 IPV6_FLOWINFO_MASK), spec);
1546 p = number(p, pend, sa->sin6_scope_id, spec);
1550 return string_nocheck(buf, end, ip6_addr, spec);
1553 static noinline_for_stack
1554 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1555 struct printf_spec spec, const char *fmt)
1557 bool have_p = false;
1558 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1559 char *pend = ip4_addr + sizeof(ip4_addr);
1560 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1561 char fmt4[3] = { fmt[0], '4', 0 };
1564 while (isalpha(*++fmt)) {
1578 p = ip4_string(ip4_addr, addr, fmt4);
1581 p = number(p, pend, ntohs(sa->sin_port), spec);
1585 return string_nocheck(buf, end, ip4_addr, spec);
1588 static noinline_for_stack
1589 char *ip_addr_string(char *buf, char *end, const void *ptr,
1590 struct printf_spec spec, const char *fmt)
1594 if (check_pointer(&buf, end, ptr, spec))
1599 return ip6_addr_string(buf, end, ptr, spec, fmt);
1601 return ip4_addr_string(buf, end, ptr, spec, fmt);
1604 struct sockaddr raw;
1605 struct sockaddr_in v4;
1606 struct sockaddr_in6 v6;
1609 switch (sa->raw.sa_family) {
1611 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1613 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1615 return error_string(buf, end, "(einval)", spec);
1619 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
1620 return error_string(buf, end, err_fmt_msg, spec);
1623 static noinline_for_stack
1624 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1629 unsigned int flags = 0;
1632 if (spec.field_width == 0)
1633 return buf; /* nothing to print */
1635 if (check_pointer(&buf, end, addr, spec))
1639 switch (fmt[count++]) {
1641 flags |= ESCAPE_ANY;
1644 flags |= ESCAPE_SPECIAL;
1647 flags |= ESCAPE_HEX;
1650 flags |= ESCAPE_NULL;
1653 flags |= ESCAPE_OCTAL;
1659 flags |= ESCAPE_SPACE;
1668 flags = ESCAPE_ANY_NP;
1670 len = spec.field_width < 0 ? 1 : spec.field_width;
1673 * string_escape_mem() writes as many characters as it can to
1674 * the given buffer, and returns the total size of the output
1675 * had the buffer been big enough.
1677 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1682 static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1683 struct printf_spec spec, const char *fmt)
1687 if (check_pointer(&buf, end, va_fmt, spec))
1690 va_copy(va, *va_fmt->va);
1691 buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
1697 static noinline_for_stack
1698 char *uuid_string(char *buf, char *end, const u8 *addr,
1699 struct printf_spec spec, const char *fmt)
1701 char uuid[UUID_STRING_LEN + 1];
1704 const u8 *index = uuid_index;
1707 if (check_pointer(&buf, end, addr, spec))
1722 for (i = 0; i < 16; i++) {
1724 p = hex_byte_pack_upper(p, addr[index[i]]);
1726 p = hex_byte_pack(p, addr[index[i]]);
1739 return string_nocheck(buf, end, uuid, spec);
1742 static noinline_for_stack
1743 char *netdev_bits(char *buf, char *end, const void *addr,
1744 struct printf_spec spec, const char *fmt)
1746 unsigned long long num;
1749 if (check_pointer(&buf, end, addr, spec))
1754 num = *(const netdev_features_t *)addr;
1755 size = sizeof(netdev_features_t);
1758 return error_string(buf, end, "(%pN?)", spec);
1761 return special_hex_number(buf, end, num, size);
1764 static noinline_for_stack
1765 char *address_val(char *buf, char *end, const void *addr,
1766 struct printf_spec spec, const char *fmt)
1768 unsigned long long num;
1771 if (check_pointer(&buf, end, addr, spec))
1776 num = *(const dma_addr_t *)addr;
1777 size = sizeof(dma_addr_t);
1781 num = *(const phys_addr_t *)addr;
1782 size = sizeof(phys_addr_t);
1786 return special_hex_number(buf, end, num, size);
1789 static noinline_for_stack
1790 char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1792 int year = tm->tm_year + (r ? 0 : 1900);
1793 int mon = tm->tm_mon + (r ? 0 : 1);
1795 buf = number(buf, end, year, default_dec04_spec);
1800 buf = number(buf, end, mon, default_dec02_spec);
1805 return number(buf, end, tm->tm_mday, default_dec02_spec);
1808 static noinline_for_stack
1809 char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1811 buf = number(buf, end, tm->tm_hour, default_dec02_spec);
1816 buf = number(buf, end, tm->tm_min, default_dec02_spec);
1821 return number(buf, end, tm->tm_sec, default_dec02_spec);
1824 static noinline_for_stack
1825 char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1826 struct printf_spec spec, const char *fmt)
1828 bool have_t = true, have_d = true;
1832 if (check_pointer(&buf, end, tm, spec))
1835 switch (fmt[count]) {
1846 raw = fmt[count] == 'r';
1849 buf = date_str(buf, end, tm, raw);
1850 if (have_d && have_t) {
1851 /* Respect ISO 8601 */
1857 buf = time_str(buf, end, tm, raw);
1862 static noinline_for_stack
1863 char *time64_str(char *buf, char *end, const time64_t time,
1864 struct printf_spec spec, const char *fmt)
1866 struct rtc_time rtc_time;
1869 time64_to_tm(time, 0, &tm);
1871 rtc_time.tm_sec = tm.tm_sec;
1872 rtc_time.tm_min = tm.tm_min;
1873 rtc_time.tm_hour = tm.tm_hour;
1874 rtc_time.tm_mday = tm.tm_mday;
1875 rtc_time.tm_mon = tm.tm_mon;
1876 rtc_time.tm_year = tm.tm_year;
1877 rtc_time.tm_wday = tm.tm_wday;
1878 rtc_time.tm_yday = tm.tm_yday;
1880 rtc_time.tm_isdst = 0;
1882 return rtc_str(buf, end, &rtc_time, spec, fmt);
1885 static noinline_for_stack
1886 char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
1891 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
1893 return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
1895 return error_string(buf, end, "(%pt?)", spec);
1899 static noinline_for_stack
1900 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1903 if (!IS_ENABLED(CONFIG_HAVE_CLK))
1904 return error_string(buf, end, "(%pC?)", spec);
1906 if (check_pointer(&buf, end, clk, spec))
1912 #ifdef CONFIG_COMMON_CLK
1913 return string(buf, end, __clk_get_name(clk), spec);
1915 return ptr_to_id(buf, end, clk, spec);
1921 char *format_flags(char *buf, char *end, unsigned long flags,
1922 const struct trace_print_flags *names)
1926 for ( ; flags && names->name; names++) {
1928 if ((flags & mask) != mask)
1931 buf = string(buf, end, names->name, default_str_spec);
1942 buf = number(buf, end, flags, default_flag_spec);
1947 static noinline_for_stack
1948 char *flags_string(char *buf, char *end, void *flags_ptr,
1949 struct printf_spec spec, const char *fmt)
1951 unsigned long flags;
1952 const struct trace_print_flags *names;
1954 if (check_pointer(&buf, end, flags_ptr, spec))
1959 flags = *(unsigned long *)flags_ptr;
1960 /* Remove zone id */
1961 flags &= (1UL << NR_PAGEFLAGS) - 1;
1962 names = pageflag_names;
1965 flags = *(unsigned long *)flags_ptr;
1966 names = vmaflag_names;
1969 flags = (__force unsigned long)(*(gfp_t *)flags_ptr);
1970 names = gfpflag_names;
1973 return error_string(buf, end, "(%pG?)", spec);
1976 return format_flags(buf, end, flags, names);
1979 static noinline_for_stack
1980 char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
1985 /* Loop starting from the root node to the current node. */
1986 for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
1987 struct fwnode_handle *__fwnode =
1988 fwnode_get_nth_parent(fwnode, depth);
1990 buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
1992 buf = string(buf, end, fwnode_get_name(__fwnode),
1995 fwnode_handle_put(__fwnode);
2001 static noinline_for_stack
2002 char *device_node_string(char *buf, char *end, struct device_node *dn,
2003 struct printf_spec spec, const char *fmt)
2005 char tbuf[sizeof("xxxx") + 1];
2008 char *buf_start = buf;
2009 struct property *prop;
2010 bool has_mult, pass;
2012 struct printf_spec str_spec = spec;
2013 str_spec.field_width = -1;
2016 return error_string(buf, end, "(%pO?)", spec);
2018 if (!IS_ENABLED(CONFIG_OF))
2019 return error_string(buf, end, "(%pOF?)", spec);
2021 if (check_pointer(&buf, end, dn, spec))
2024 /* simple case without anything any more format specifiers */
2026 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
2029 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
2038 case 'f': /* full_name */
2039 buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
2042 case 'n': /* name */
2043 p = fwnode_get_name(of_fwnode_handle(dn));
2044 precision = str_spec.precision;
2045 str_spec.precision = strchrnul(p, '@') - p;
2046 buf = string(buf, end, p, str_spec);
2047 str_spec.precision = precision;
2049 case 'p': /* phandle */
2050 buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec);
2052 case 'P': /* path-spec */
2053 p = fwnode_get_name(of_fwnode_handle(dn));
2056 buf = string(buf, end, p, str_spec);
2058 case 'F': /* flags */
2059 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2060 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2061 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2062 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2064 buf = string_nocheck(buf, end, tbuf, str_spec);
2066 case 'c': /* major compatible string */
2067 ret = of_property_read_string(dn, "compatible", &p);
2069 buf = string(buf, end, p, str_spec);
2071 case 'C': /* full compatible string */
2073 of_property_for_each_string(dn, "compatible", prop, p) {
2075 buf = string_nocheck(buf, end, ",", str_spec);
2076 buf = string_nocheck(buf, end, "\"", str_spec);
2077 buf = string(buf, end, p, str_spec);
2078 buf = string_nocheck(buf, end, "\"", str_spec);
2088 return widen_string(buf, buf - buf_start, end, spec);
2091 static noinline_for_stack
2092 char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
2093 struct printf_spec spec, const char *fmt)
2095 struct printf_spec str_spec = spec;
2096 char *buf_start = buf;
2098 str_spec.field_width = -1;
2101 return error_string(buf, end, "(%pf?)", spec);
2103 if (check_pointer(&buf, end, fwnode, spec))
2109 case 'P': /* name */
2110 buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
2112 case 'f': /* full_name */
2114 buf = fwnode_full_name_string(fwnode, buf, end);
2118 return widen_string(buf, buf - buf_start, end, spec);
2122 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2123 * by an extra set of alphanumeric characters that are extended format
2126 * Please update scripts/checkpatch.pl when adding/removing conversion
2127 * characters. (Search for "check for vsprintf extension").
2129 * Right now we handle:
2131 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2132 * - 's' For symbolic direct pointers (or function descriptors) without offset
2133 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
2134 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2135 * %ps and %pS. Be careful when re-using these specifiers.
2136 * - 'B' For backtraced symbolic direct pointers with offset
2137 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2138 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2139 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2140 * width which must be explicitly specified either as part of the
2141 * format string '%32b[l]' or through '%*b[l]', [l] selects
2142 * range-list format instead of hex format
2143 * - 'M' For a 6-byte MAC address, it prints the address in the
2144 * usual colon-separated hex notation
2145 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2146 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2147 * with a dash-separated hex notation
2148 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2149 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2150 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2151 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
2153 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2154 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2155 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2156 * IPv6 omits the colons (01020304...0f)
2157 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2159 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2160 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2161 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2162 * - 'I[6S]c' for IPv6 addresses printed as specified by
2163 * https://tools.ietf.org/html/rfc5952
2164 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2165 * of the following flags (see string_escape_mem() for the
2168 * c - ESCAPE_SPECIAL
2174 * By default ESCAPE_ANY_NP is used.
2175 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2176 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2177 * Options for %pU are:
2178 * b big endian lower case hex (default)
2179 * B big endian UPPER case hex
2180 * l little endian lower case hex
2181 * L little endian UPPER case hex
2182 * big endian output byte order is:
2183 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2184 * little endian output byte order is:
2185 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2186 * - 'V' For a struct va_format which contains a format string * and va_list *,
2187 * call vsnprintf(->format, *->va_list).
2188 * Implements a "recursive vsnprintf".
2189 * Do not use this feature without some mechanism to verify the
2190 * correctness of the format string and va_list arguments.
2191 * - 'K' For a kernel pointer that should be hidden from unprivileged users
2192 * - 'NF' For a netdev_features_t
2193 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2194 * a certain separator (' ' by default):
2198 * The maximum supported length is 64 bytes of the input. Consider
2199 * to use print_hex_dump() for the larger input.
2200 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2201 * (default assumed to be phys_addr_t, passed by reference)
2202 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2203 * - 'D[234]' Same as 'd' but for a struct file
2204 * - 'g' For block_device name (gendisk + partition number)
2205 * - 't[RT][dt][r]' For time and date as represented by:
2208 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2209 * (legacy clock framework) of the clock
2210 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2211 * (legacy clock framework) of the clock
2212 * - 'G' For flags to be printed as a collection of symbolic strings that would
2213 * construct the specific value. Supported flags given by option:
2214 * p page flags (see struct page) given as pointer to unsigned long
2215 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2216 * v vma flags (VM_*) given as pointer to unsigned long
2217 * - 'OF[fnpPcCF]' For a device tree object
2218 * Without any optional arguments prints the full_name
2219 * f device node full_name
2220 * n device node name
2221 * p device node phandle
2222 * P device node path spec (name + @unit)
2223 * F device node flags
2224 * c major compatible string
2225 * C full compatible string
2226 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2227 * Without an option prints the full name of the node
2229 * P node name, including a possible unit address
2230 * - 'x' For printing the address. Equivalent to "%lx".
2231 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
2232 * bpf_trace_printk() where [ku] prefix specifies either kernel (k)
2233 * or user (u) memory to probe, and:
2234 * s a string, equivalent to "%s" on direct vsnprintf() use
2236 * ** When making changes please also update:
2237 * Documentation/core-api/printk-formats.rst
2239 * Note: The default behaviour (unadorned %p) is to hash the address,
2240 * rendering it useful as a unique identifier.
2242 static noinline_for_stack
2243 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2244 struct printf_spec spec)
2249 ptr = dereference_symbol_descriptor(ptr);
2252 return symbol_string(buf, end, ptr, spec, fmt);
2255 return resource_string(buf, end, ptr, spec, fmt);
2257 return hex_string(buf, end, ptr, spec, fmt);
2261 return bitmap_list_string(buf, end, ptr, spec, fmt);
2263 return bitmap_string(buf, end, ptr, spec, fmt);
2265 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2266 case 'm': /* Contiguous: 000102030405 */
2268 /* [mM]R (Reverse order; Bluetooth) */
2269 return mac_address_string(buf, end, ptr, spec, fmt);
2270 case 'I': /* Formatted IP supported
2272 * 6: 0001:0203:...:0708
2273 * 6c: 1::708 or 1::1.2.3.4
2275 case 'i': /* Contiguous:
2276 * 4: 001.002.003.004
2279 return ip_addr_string(buf, end, ptr, spec, fmt);
2281 return escaped_string(buf, end, ptr, spec, fmt);
2283 return uuid_string(buf, end, ptr, spec, fmt);
2285 return va_format(buf, end, ptr, spec, fmt);
2287 return restricted_pointer(buf, end, ptr, spec);
2289 return netdev_bits(buf, end, ptr, spec, fmt);
2291 return address_val(buf, end, ptr, spec, fmt);
2293 return dentry_name(buf, end, ptr, spec, fmt);
2295 return time_and_date(buf, end, ptr, spec, fmt);
2297 return clock(buf, end, ptr, spec, fmt);
2299 return file_dentry_name(buf, end, ptr, spec, fmt);
2302 return bdev_name(buf, end, ptr, spec, fmt);
2306 return flags_string(buf, end, ptr, spec, fmt);
2308 return device_node_string(buf, end, ptr, spec, fmt + 1);
2310 return fwnode_string(buf, end, ptr, spec, fmt + 1);
2312 return pointer_string(buf, end, ptr, spec);
2314 /* %pe with a non-ERR_PTR gets treated as plain %p */
2317 return err_ptr(buf, end, ptr, spec);
2322 return string(buf, end, ptr, spec);
2324 return error_string(buf, end, "(einval)", spec);
2328 /* default is to _not_ leak addresses, hash before printing */
2329 return ptr_to_id(buf, end, ptr, spec);
2333 * Helper function to decode printf style format.
2334 * Each call decode a token from the format and return the
2335 * number of characters read (or likely the delta where it wants
2336 * to go on the next call).
2337 * The decoded token is returned through the parameters
2339 * 'h', 'l', or 'L' for integer fields
2340 * 'z' support added 23/7/1999 S.H.
2341 * 'z' changed to 'Z' --davidm 1/25/99
2342 * 'Z' changed to 'z' --adobriyan 2017-01-25
2343 * 't' added for ptrdiff_t
2345 * @fmt: the format string
2346 * @type of the token returned
2347 * @flags: various flags such as +, -, # tokens..
2348 * @field_width: overwritten width
2349 * @base: base of the number (octal, hex, ...)
2350 * @precision: precision of a number
2351 * @qualifier: qualifier of a number (long, size_t, ...)
2353 static noinline_for_stack
2354 int format_decode(const char *fmt, struct printf_spec *spec)
2356 const char *start = fmt;
2359 /* we finished early by reading the field width */
2360 if (spec->type == FORMAT_TYPE_WIDTH) {
2361 if (spec->field_width < 0) {
2362 spec->field_width = -spec->field_width;
2363 spec->flags |= LEFT;
2365 spec->type = FORMAT_TYPE_NONE;
2369 /* we finished early by reading the precision */
2370 if (spec->type == FORMAT_TYPE_PRECISION) {
2371 if (spec->precision < 0)
2372 spec->precision = 0;
2374 spec->type = FORMAT_TYPE_NONE;
2379 spec->type = FORMAT_TYPE_NONE;
2381 for (; *fmt ; ++fmt) {
2386 /* Return the current non-format string */
2387 if (fmt != start || !*fmt)
2393 while (1) { /* this also skips first '%' */
2399 case '-': spec->flags |= LEFT; break;
2400 case '+': spec->flags |= PLUS; break;
2401 case ' ': spec->flags |= SPACE; break;
2402 case '#': spec->flags |= SPECIAL; break;
2403 case '0': spec->flags |= ZEROPAD; break;
2404 default: found = false;
2411 /* get field width */
2412 spec->field_width = -1;
2415 spec->field_width = skip_atoi(&fmt);
2416 else if (*fmt == '*') {
2417 /* it's the next argument */
2418 spec->type = FORMAT_TYPE_WIDTH;
2419 return ++fmt - start;
2423 /* get the precision */
2424 spec->precision = -1;
2427 if (isdigit(*fmt)) {
2428 spec->precision = skip_atoi(&fmt);
2429 if (spec->precision < 0)
2430 spec->precision = 0;
2431 } else if (*fmt == '*') {
2432 /* it's the next argument */
2433 spec->type = FORMAT_TYPE_PRECISION;
2434 return ++fmt - start;
2439 /* get the conversion qualifier */
2441 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2442 *fmt == 'z' || *fmt == 't') {
2444 if (unlikely(qualifier == *fmt)) {
2445 if (qualifier == 'l') {
2448 } else if (qualifier == 'h') {
2459 spec->type = FORMAT_TYPE_CHAR;
2460 return ++fmt - start;
2463 spec->type = FORMAT_TYPE_STR;
2464 return ++fmt - start;
2467 spec->type = FORMAT_TYPE_PTR;
2468 return ++fmt - start;
2471 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2472 return ++fmt - start;
2474 /* integer number formats - set up the flags and "break" */
2480 spec->flags |= SMALL;
2489 spec->flags |= SIGN;
2495 * Since %n poses a greater security risk than
2496 * utility, treat it as any other invalid or
2497 * unsupported format specifier.
2502 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2503 spec->type = FORMAT_TYPE_INVALID;
2507 if (qualifier == 'L')
2508 spec->type = FORMAT_TYPE_LONG_LONG;
2509 else if (qualifier == 'l') {
2510 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2511 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2512 } else if (qualifier == 'z') {
2513 spec->type = FORMAT_TYPE_SIZE_T;
2514 } else if (qualifier == 't') {
2515 spec->type = FORMAT_TYPE_PTRDIFF;
2516 } else if (qualifier == 'H') {
2517 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2518 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2519 } else if (qualifier == 'h') {
2520 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2521 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2523 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2524 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2527 return ++fmt - start;
2531 set_field_width(struct printf_spec *spec, int width)
2533 spec->field_width = width;
2534 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2535 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2540 set_precision(struct printf_spec *spec, int prec)
2542 spec->precision = prec;
2543 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2544 spec->precision = clamp(prec, 0, PRECISION_MAX);
2549 * vsnprintf - Format a string and place it in a buffer
2550 * @buf: The buffer to place the result into
2551 * @size: The size of the buffer, including the trailing null space
2552 * @fmt: The format string to use
2553 * @args: Arguments for the format string
2555 * This function generally follows C99 vsnprintf, but has some
2556 * extensions and a few limitations:
2558 * - ``%n`` is unsupported
2559 * - ``%p*`` is handled by pointer()
2561 * See pointer() or Documentation/core-api/printk-formats.rst for more
2562 * extensive description.
2564 * **Please update the documentation in both places when making changes**
2566 * The return value is the number of characters which would
2567 * be generated for the given input, excluding the trailing
2568 * '\0', as per ISO C99. If you want to have the exact
2569 * number of characters written into @buf as return value
2570 * (not including the trailing '\0'), use vscnprintf(). If the
2571 * return is greater than or equal to @size, the resulting
2572 * string is truncated.
2574 * If you're not already dealing with a va_list consider using snprintf().
2576 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2578 unsigned long long num;
2580 struct printf_spec spec = {0};
2582 /* Reject out-of-range values early. Large positive sizes are
2583 used for unknown buffer sizes. */
2584 if (WARN_ON_ONCE(size > INT_MAX))
2590 /* Make sure end is always >= buf */
2597 const char *old_fmt = fmt;
2598 int read = format_decode(fmt, &spec);
2602 switch (spec.type) {
2603 case FORMAT_TYPE_NONE: {
2606 if (copy > end - str)
2608 memcpy(str, old_fmt, copy);
2614 case FORMAT_TYPE_WIDTH:
2615 set_field_width(&spec, va_arg(args, int));
2618 case FORMAT_TYPE_PRECISION:
2619 set_precision(&spec, va_arg(args, int));
2622 case FORMAT_TYPE_CHAR: {
2625 if (!(spec.flags & LEFT)) {
2626 while (--spec.field_width > 0) {
2633 c = (unsigned char) va_arg(args, int);
2637 while (--spec.field_width > 0) {
2645 case FORMAT_TYPE_STR:
2646 str = string(str, end, va_arg(args, char *), spec);
2649 case FORMAT_TYPE_PTR:
2650 str = pointer(fmt, str, end, va_arg(args, void *),
2652 while (isalnum(*fmt))
2656 case FORMAT_TYPE_PERCENT_CHAR:
2662 case FORMAT_TYPE_INVALID:
2664 * Presumably the arguments passed gcc's type
2665 * checking, but there is no safe or sane way
2666 * for us to continue parsing the format and
2667 * fetching from the va_list; the remaining
2668 * specifiers and arguments would be out of
2674 switch (spec.type) {
2675 case FORMAT_TYPE_LONG_LONG:
2676 num = va_arg(args, long long);
2678 case FORMAT_TYPE_ULONG:
2679 num = va_arg(args, unsigned long);
2681 case FORMAT_TYPE_LONG:
2682 num = va_arg(args, long);
2684 case FORMAT_TYPE_SIZE_T:
2685 if (spec.flags & SIGN)
2686 num = va_arg(args, ssize_t);
2688 num = va_arg(args, size_t);
2690 case FORMAT_TYPE_PTRDIFF:
2691 num = va_arg(args, ptrdiff_t);
2693 case FORMAT_TYPE_UBYTE:
2694 num = (unsigned char) va_arg(args, int);
2696 case FORMAT_TYPE_BYTE:
2697 num = (signed char) va_arg(args, int);
2699 case FORMAT_TYPE_USHORT:
2700 num = (unsigned short) va_arg(args, int);
2702 case FORMAT_TYPE_SHORT:
2703 num = (short) va_arg(args, int);
2705 case FORMAT_TYPE_INT:
2706 num = (int) va_arg(args, int);
2709 num = va_arg(args, unsigned int);
2712 str = number(str, end, num, spec);
2724 /* the trailing null byte doesn't count towards the total */
2728 EXPORT_SYMBOL(vsnprintf);
2731 * vscnprintf - Format a string and place it in a buffer
2732 * @buf: The buffer to place the result into
2733 * @size: The size of the buffer, including the trailing null space
2734 * @fmt: The format string to use
2735 * @args: Arguments for the format string
2737 * The return value is the number of characters which have been written into
2738 * the @buf not including the trailing '\0'. If @size is == 0 the function
2741 * If you're not already dealing with a va_list consider using scnprintf().
2743 * See the vsnprintf() documentation for format string extensions over C99.
2745 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2749 i = vsnprintf(buf, size, fmt, args);
2751 if (likely(i < size))
2757 EXPORT_SYMBOL(vscnprintf);
2760 * snprintf - Format a string and place it in a buffer
2761 * @buf: The buffer to place the result into
2762 * @size: The size of the buffer, including the trailing null space
2763 * @fmt: The format string to use
2764 * @...: Arguments for the format string
2766 * The return value is the number of characters which would be
2767 * generated for the given input, excluding the trailing null,
2768 * as per ISO C99. If the return is greater than or equal to
2769 * @size, the resulting string is truncated.
2771 * See the vsnprintf() documentation for format string extensions over C99.
2773 int snprintf(char *buf, size_t size, const char *fmt, ...)
2778 va_start(args, fmt);
2779 i = vsnprintf(buf, size, fmt, args);
2784 EXPORT_SYMBOL(snprintf);
2787 * scnprintf - Format a string and place it in a buffer
2788 * @buf: The buffer to place the result into
2789 * @size: The size of the buffer, including the trailing null space
2790 * @fmt: The format string to use
2791 * @...: Arguments for the format string
2793 * The return value is the number of characters written into @buf not including
2794 * the trailing '\0'. If @size is == 0 the function returns 0.
2797 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2802 va_start(args, fmt);
2803 i = vscnprintf(buf, size, fmt, args);
2808 EXPORT_SYMBOL(scnprintf);
2811 * vsprintf - Format a string and place it in a buffer
2812 * @buf: The buffer to place the result into
2813 * @fmt: The format string to use
2814 * @args: Arguments for the format string
2816 * The function returns the number of characters written
2817 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2820 * If you're not already dealing with a va_list consider using sprintf().
2822 * See the vsnprintf() documentation for format string extensions over C99.
2824 int vsprintf(char *buf, const char *fmt, va_list args)
2826 return vsnprintf(buf, INT_MAX, fmt, args);
2828 EXPORT_SYMBOL(vsprintf);
2831 * sprintf - Format a string and place it in a buffer
2832 * @buf: The buffer to place the result into
2833 * @fmt: The format string to use
2834 * @...: Arguments for the format string
2836 * The function returns the number of characters written
2837 * into @buf. Use snprintf() or scnprintf() in order to avoid
2840 * See the vsnprintf() documentation for format string extensions over C99.
2842 int sprintf(char *buf, const char *fmt, ...)
2847 va_start(args, fmt);
2848 i = vsnprintf(buf, INT_MAX, fmt, args);
2853 EXPORT_SYMBOL(sprintf);
2855 #ifdef CONFIG_BINARY_PRINTF
2858 * vbin_printf() - VA arguments to binary data
2859 * bstr_printf() - Binary data to text string
2863 * vbin_printf - Parse a format string and place args' binary value in a buffer
2864 * @bin_buf: The buffer to place args' binary value
2865 * @size: The size of the buffer(by words(32bits), not characters)
2866 * @fmt: The format string to use
2867 * @args: Arguments for the format string
2869 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2872 * The return value is the number of words(32bits) which would be generated for
2876 * If the return value is greater than @size, the resulting bin_buf is NOT
2877 * valid for bstr_printf().
2879 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2881 struct printf_spec spec = {0};
2885 str = (char *)bin_buf;
2886 end = (char *)(bin_buf + size);
2888 #define save_arg(type) \
2890 unsigned long long value; \
2891 if (sizeof(type) == 8) { \
2892 unsigned long long val8; \
2893 str = PTR_ALIGN(str, sizeof(u32)); \
2894 val8 = va_arg(args, unsigned long long); \
2895 if (str + sizeof(type) <= end) { \
2896 *(u32 *)str = *(u32 *)&val8; \
2897 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
2901 unsigned int val4; \
2902 str = PTR_ALIGN(str, sizeof(type)); \
2903 val4 = va_arg(args, int); \
2904 if (str + sizeof(type) <= end) \
2905 *(typeof(type) *)str = (type)(long)val4; \
2906 value = (unsigned long long)val4; \
2908 str += sizeof(type); \
2913 int read = format_decode(fmt, &spec);
2917 switch (spec.type) {
2918 case FORMAT_TYPE_NONE:
2919 case FORMAT_TYPE_PERCENT_CHAR:
2921 case FORMAT_TYPE_INVALID:
2924 case FORMAT_TYPE_WIDTH:
2925 case FORMAT_TYPE_PRECISION:
2926 width = (int)save_arg(int);
2927 /* Pointers may require the width */
2929 set_field_width(&spec, width);
2932 case FORMAT_TYPE_CHAR:
2936 case FORMAT_TYPE_STR: {
2937 const char *save_str = va_arg(args, char *);
2938 const char *err_msg;
2941 err_msg = check_pointer_msg(save_str);
2945 len = strlen(save_str) + 1;
2946 if (str + len < end)
2947 memcpy(str, save_str, len);
2952 case FORMAT_TYPE_PTR:
2953 /* Dereferenced pointers must be done now */
2955 /* Dereference of functions is still OK */
2964 if (!isalnum(*fmt)) {
2968 str = pointer(fmt, str, end, va_arg(args, void *),
2973 end[-1] = '\0'; /* Must be nul terminated */
2975 /* skip all alphanumeric pointer suffixes */
2976 while (isalnum(*fmt))
2981 switch (spec.type) {
2983 case FORMAT_TYPE_LONG_LONG:
2984 save_arg(long long);
2986 case FORMAT_TYPE_ULONG:
2987 case FORMAT_TYPE_LONG:
2988 save_arg(unsigned long);
2990 case FORMAT_TYPE_SIZE_T:
2993 case FORMAT_TYPE_PTRDIFF:
2994 save_arg(ptrdiff_t);
2996 case FORMAT_TYPE_UBYTE:
2997 case FORMAT_TYPE_BYTE:
3000 case FORMAT_TYPE_USHORT:
3001 case FORMAT_TYPE_SHORT:
3011 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
3014 EXPORT_SYMBOL_GPL(vbin_printf);
3017 * bstr_printf - Format a string from binary arguments and place it in a buffer
3018 * @buf: The buffer to place the result into
3019 * @size: The size of the buffer, including the trailing null space
3020 * @fmt: The format string to use
3021 * @bin_buf: Binary arguments for the format string
3023 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
3024 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
3025 * a binary buffer that generated by vbin_printf.
3027 * The format follows C99 vsnprintf, but has some extensions:
3028 * see vsnprintf comment for details.
3030 * The return value is the number of characters which would
3031 * be generated for the given input, excluding the trailing
3032 * '\0', as per ISO C99. If you want to have the exact
3033 * number of characters written into @buf as return value
3034 * (not including the trailing '\0'), use vscnprintf(). If the
3035 * return is greater than or equal to @size, the resulting
3036 * string is truncated.
3038 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
3040 struct printf_spec spec = {0};
3042 const char *args = (const char *)bin_buf;
3044 if (WARN_ON_ONCE(size > INT_MAX))
3050 #define get_arg(type) \
3052 typeof(type) value; \
3053 if (sizeof(type) == 8) { \
3054 args = PTR_ALIGN(args, sizeof(u32)); \
3055 *(u32 *)&value = *(u32 *)args; \
3056 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3058 args = PTR_ALIGN(args, sizeof(type)); \
3059 value = *(typeof(type) *)args; \
3061 args += sizeof(type); \
3065 /* Make sure end is always >= buf */
3072 const char *old_fmt = fmt;
3073 int read = format_decode(fmt, &spec);
3077 switch (spec.type) {
3078 case FORMAT_TYPE_NONE: {
3081 if (copy > end - str)
3083 memcpy(str, old_fmt, copy);
3089 case FORMAT_TYPE_WIDTH:
3090 set_field_width(&spec, get_arg(int));
3093 case FORMAT_TYPE_PRECISION:
3094 set_precision(&spec, get_arg(int));
3097 case FORMAT_TYPE_CHAR: {
3100 if (!(spec.flags & LEFT)) {
3101 while (--spec.field_width > 0) {
3107 c = (unsigned char) get_arg(char);
3111 while (--spec.field_width > 0) {
3119 case FORMAT_TYPE_STR: {
3120 const char *str_arg = args;
3121 args += strlen(str_arg) + 1;
3122 str = string(str, end, (char *)str_arg, spec);
3126 case FORMAT_TYPE_PTR: {
3127 bool process = false;
3129 /* Non function dereferences were already done */
3139 if (!isalnum(*fmt)) {
3143 /* Pointer dereference was already processed */
3145 len = copy = strlen(args);
3146 if (copy > end - str)
3148 memcpy(str, args, copy);
3154 str = pointer(fmt, str, end, get_arg(void *), spec);
3156 while (isalnum(*fmt))
3161 case FORMAT_TYPE_PERCENT_CHAR:
3167 case FORMAT_TYPE_INVALID:
3171 unsigned long long num;
3173 switch (spec.type) {
3175 case FORMAT_TYPE_LONG_LONG:
3176 num = get_arg(long long);
3178 case FORMAT_TYPE_ULONG:
3179 case FORMAT_TYPE_LONG:
3180 num = get_arg(unsigned long);
3182 case FORMAT_TYPE_SIZE_T:
3183 num = get_arg(size_t);
3185 case FORMAT_TYPE_PTRDIFF:
3186 num = get_arg(ptrdiff_t);
3188 case FORMAT_TYPE_UBYTE:
3189 num = get_arg(unsigned char);
3191 case FORMAT_TYPE_BYTE:
3192 num = get_arg(signed char);
3194 case FORMAT_TYPE_USHORT:
3195 num = get_arg(unsigned short);
3197 case FORMAT_TYPE_SHORT:
3198 num = get_arg(short);
3200 case FORMAT_TYPE_UINT:
3201 num = get_arg(unsigned int);
3207 str = number(str, end, num, spec);
3209 } /* switch(spec.type) */
3222 /* the trailing null byte doesn't count towards the total */
3225 EXPORT_SYMBOL_GPL(bstr_printf);
3228 * bprintf - Parse a format string and place args' binary value in a buffer
3229 * @bin_buf: The buffer to place args' binary value
3230 * @size: The size of the buffer(by words(32bits), not characters)
3231 * @fmt: The format string to use
3232 * @...: Arguments for the format string
3234 * The function returns the number of words(u32) written
3237 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3242 va_start(args, fmt);
3243 ret = vbin_printf(bin_buf, size, fmt, args);
3248 EXPORT_SYMBOL_GPL(bprintf);
3250 #endif /* CONFIG_BINARY_PRINTF */
3253 * vsscanf - Unformat a buffer into a list of arguments
3254 * @buf: input buffer
3255 * @fmt: format of buffer
3258 int vsscanf(const char *buf, const char *fmt, va_list args)
3260 const char *str = buf;
3268 unsigned long long u;
3274 /* skip any white space in format */
3275 /* white space in format matchs any amount of
3276 * white space, including none, in the input.
3278 if (isspace(*fmt)) {
3279 fmt = skip_spaces(++fmt);
3280 str = skip_spaces(str);
3283 /* anything that is not a conversion must match exactly */
3284 if (*fmt != '%' && *fmt) {
3285 if (*fmt++ != *str++)
3294 /* skip this conversion.
3295 * advance both strings to next white space
3300 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3301 /* '%*[' not yet supported, invalid format */
3306 while (!isspace(*str) && *str)
3311 /* get field width */
3313 if (isdigit(*fmt)) {
3314 field_width = skip_atoi(&fmt);
3315 if (field_width <= 0)
3319 /* get conversion qualifier */
3321 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
3324 if (unlikely(qualifier == *fmt)) {
3325 if (qualifier == 'h') {
3328 } else if (qualifier == 'l') {
3339 /* return number of characters read so far */
3340 *va_arg(args, int *) = str - buf;
3354 char *s = (char *)va_arg(args, char*);
3355 if (field_width == -1)
3359 } while (--field_width > 0 && *str);
3365 char *s = (char *)va_arg(args, char *);
3366 if (field_width == -1)
3367 field_width = SHRT_MAX;
3368 /* first, skip leading white space in buffer */
3369 str = skip_spaces(str);
3371 /* now copy until next white space */
3372 while (*str && !isspace(*str) && field_width--)
3379 * Warning: This implementation of the '[' conversion specifier
3380 * deviates from its glibc counterpart in the following ways:
3381 * (1) It does NOT support ranges i.e. '-' is NOT a special
3383 * (2) It cannot match the closing bracket ']' itself
3384 * (3) A field width is required
3385 * (4) '%*[' (discard matching input) is currently not supported
3388 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3389 * buf1, buf2, buf3);
3395 char *s = (char *)va_arg(args, char *);
3396 DECLARE_BITMAP(set, 256) = {0};
3397 unsigned int len = 0;
3398 bool negate = (*fmt == '^');
3400 /* field width is required */
3401 if (field_width == -1)
3407 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3408 set_bit((u8)*fmt, set);
3410 /* no ']' or no character set found */
3416 bitmap_complement(set, set, 256);
3417 /* exclude null '\0' byte */
3421 /* match must be non-empty */
3422 if (!test_bit((u8)*str, set))
3425 while (test_bit((u8)*str, set) && field_width--)
3447 /* looking for '%' in str */
3452 /* invalid format; stop here */
3456 /* have some sort of integer conversion.
3457 * first, skip white space in buffer.
3459 str = skip_spaces(str);
3462 if (is_sign && digit == '-')
3466 || (base == 16 && !isxdigit(digit))
3467 || (base == 10 && !isdigit(digit))
3468 || (base == 8 && (!isdigit(digit) || digit > '7'))
3469 || (base == 0 && !isdigit(digit)))
3473 val.s = simple_strntoll(str,
3474 field_width >= 0 ? field_width : INT_MAX,
3477 val.u = simple_strntoull(str,
3478 field_width >= 0 ? field_width : INT_MAX,
3481 switch (qualifier) {
3482 case 'H': /* that's 'hh' in format */
3484 *va_arg(args, signed char *) = val.s;
3486 *va_arg(args, unsigned char *) = val.u;
3490 *va_arg(args, short *) = val.s;
3492 *va_arg(args, unsigned short *) = val.u;
3496 *va_arg(args, long *) = val.s;
3498 *va_arg(args, unsigned long *) = val.u;
3502 *va_arg(args, long long *) = val.s;
3504 *va_arg(args, unsigned long long *) = val.u;
3507 *va_arg(args, size_t *) = val.u;
3511 *va_arg(args, int *) = val.s;
3513 *va_arg(args, unsigned int *) = val.u;
3525 EXPORT_SYMBOL(vsscanf);
3528 * sscanf - Unformat a buffer into a list of arguments
3529 * @buf: input buffer
3530 * @fmt: formatting of buffer
3531 * @...: resulting arguments
3533 int sscanf(const char *buf, const char *fmt, ...)
3538 va_start(args, fmt);
3539 i = vsscanf(buf, fmt, args);
3544 EXPORT_SYMBOL(sscanf);