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/module.h> /* for KSYM_SYMBOL_LEN */
25 #include <linux/types.h>
26 #include <linux/string.h>
27 #include <linux/ctype.h>
28 #include <linux/kernel.h>
29 #include <linux/kallsyms.h>
30 #include <linux/math64.h>
31 #include <linux/uaccess.h>
32 #include <linux/ioport.h>
33 #include <linux/dcache.h>
34 #include <linux/cred.h>
35 #include <linux/rtc.h>
36 #include <linux/uuid.h>
38 #include <net/addrconf.h>
39 #include <linux/siphash.h>
40 #include <linux/compiler.h>
42 #include <linux/blkdev.h>
45 #include "../mm/internal.h" /* For the trace_print_flags arrays */
47 #include <asm/page.h> /* for PAGE_SIZE */
48 #include <asm/byteorder.h> /* cpu_to_le16 */
50 #include <linux/string_helpers.h>
53 static unsigned long long simple_strntoull(const char *startp, size_t max_chars,
54 char **endp, unsigned int base)
57 unsigned long long result = 0ULL;
61 cp = _parse_integer_fixup_radix(startp, &base);
62 prefix_chars = cp - startp;
63 if (prefix_chars < max_chars) {
64 rv = _parse_integer_limit(cp, base, &result, max_chars - prefix_chars);
66 cp += (rv & ~KSTRTOX_OVERFLOW);
68 /* Field too short for prefix + digit, skip over without converting */
69 cp = startp + max_chars;
79 * simple_strtoull - convert a string to an unsigned long long
80 * @cp: The start of the string
81 * @endp: A pointer to the end of the parsed string will be placed here
82 * @base: The number base to use
84 * This function is obsolete. Please use kstrtoull instead.
86 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
88 return simple_strntoull(cp, INT_MAX, endp, base);
90 EXPORT_SYMBOL(simple_strtoull);
93 * simple_strtoul - convert a string to an unsigned long
94 * @cp: The start of the string
95 * @endp: A pointer to the end of the parsed string will be placed here
96 * @base: The number base to use
98 * This function is obsolete. Please use kstrtoul instead.
100 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
102 return simple_strtoull(cp, endp, base);
104 EXPORT_SYMBOL(simple_strtoul);
107 * simple_strtol - convert a string to a signed long
108 * @cp: The start of the string
109 * @endp: A pointer to the end of the parsed string will be placed here
110 * @base: The number base to use
112 * This function is obsolete. Please use kstrtol instead.
114 long simple_strtol(const char *cp, char **endp, unsigned int base)
117 return -simple_strtoul(cp + 1, endp, base);
119 return simple_strtoul(cp, endp, base);
121 EXPORT_SYMBOL(simple_strtol);
123 static long long simple_strntoll(const char *cp, size_t max_chars, char **endp,
127 * simple_strntoull() safely handles receiving max_chars==0 in the
128 * case cp[0] == '-' && max_chars == 1.
129 * If max_chars == 0 we can drop through and pass it to simple_strntoull()
130 * and the content of *cp is irrelevant.
132 if (*cp == '-' && max_chars > 0)
133 return -simple_strntoull(cp + 1, max_chars - 1, endp, base);
135 return simple_strntoull(cp, max_chars, endp, base);
139 * simple_strtoll - convert a string to a signed long long
140 * @cp: The start of the string
141 * @endp: A pointer to the end of the parsed string will be placed here
142 * @base: The number base to use
144 * This function is obsolete. Please use kstrtoll instead.
146 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
148 return simple_strntoll(cp, INT_MAX, endp, base);
150 EXPORT_SYMBOL(simple_strtoll);
152 static noinline_for_stack
153 int skip_atoi(const char **s)
158 i = i*10 + *((*s)++) - '0';
159 } while (isdigit(**s));
165 * Decimal conversion is by far the most typical, and is used for
166 * /proc and /sys data. This directly impacts e.g. top performance
167 * with many processes running. We optimize it for speed by emitting
168 * two characters at a time, using a 200 byte lookup table. This
169 * roughly halves the number of multiplications compared to computing
170 * the digits one at a time. Implementation strongly inspired by the
171 * previous version, which in turn used ideas described at
172 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
173 * from the author, Douglas W. Jones).
175 * It turns out there is precisely one 26 bit fixed-point
176 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
177 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
178 * range happens to be somewhat larger (x <= 1073741898), but that's
179 * irrelevant for our purpose.
181 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
182 * need a 32x32->64 bit multiply, so we simply use the same constant.
184 * For dividing a number in the range [100, 10^4-1] by 100, there are
185 * several options. The simplest is (x * 0x147b) >> 19, which is valid
186 * for all x <= 43698.
189 static const u16 decpair[100] = {
190 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
191 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
192 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
193 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
194 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
195 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
196 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
197 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
198 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
199 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
200 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
205 * This will print a single '0' even if r == 0, since we would
206 * immediately jump to out_r where two 0s would be written but only
207 * one of them accounted for in buf. This is needed by ip4_string
208 * below. All other callers pass a non-zero value of r.
210 static noinline_for_stack
211 char *put_dec_trunc8(char *buf, unsigned r)
219 /* 100 <= r < 10^8 */
220 q = (r * (u64)0x28f5c29) >> 32;
221 *((u16 *)buf) = decpair[r - 100*q];
228 /* 100 <= q < 10^6 */
229 r = (q * (u64)0x28f5c29) >> 32;
230 *((u16 *)buf) = decpair[q - 100*r];
237 /* 100 <= r < 10^4 */
238 q = (r * 0x147b) >> 19;
239 *((u16 *)buf) = decpair[r - 100*q];
246 *((u16 *)buf) = decpair[r];
247 buf += r < 10 ? 1 : 2;
251 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
252 static noinline_for_stack
253 char *put_dec_full8(char *buf, unsigned r)
258 q = (r * (u64)0x28f5c29) >> 32;
259 *((u16 *)buf) = decpair[r - 100*q];
263 r = (q * (u64)0x28f5c29) >> 32;
264 *((u16 *)buf) = decpair[q - 100*r];
268 q = (r * 0x147b) >> 19;
269 *((u16 *)buf) = decpair[r - 100*q];
273 *((u16 *)buf) = decpair[q];
278 static noinline_for_stack
279 char *put_dec(char *buf, unsigned long long n)
281 if (n >= 100*1000*1000)
282 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
283 /* 1 <= n <= 1.6e11 */
284 if (n >= 100*1000*1000)
285 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
287 return put_dec_trunc8(buf, n);
290 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
293 put_dec_full4(char *buf, unsigned r)
298 q = (r * 0x147b) >> 19;
299 *((u16 *)buf) = decpair[r - 100*q];
302 *((u16 *)buf) = decpair[q];
306 * Call put_dec_full4 on x % 10000, return x / 10000.
307 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
308 * holds for all x < 1,128,869,999. The largest value this
309 * helper will ever be asked to convert is 1,125,520,955.
310 * (second call in the put_dec code, assuming n is all-ones).
312 static noinline_for_stack
313 unsigned put_dec_helper4(char *buf, unsigned x)
315 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
317 put_dec_full4(buf, x - q * 10000);
321 /* Based on code by Douglas W. Jones found at
322 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
323 * (with permission from the author).
324 * Performs no 64-bit division and hence should be fast on 32-bit machines.
327 char *put_dec(char *buf, unsigned long long n)
329 uint32_t d3, d2, d1, q, h;
331 if (n < 100*1000*1000)
332 return put_dec_trunc8(buf, n);
334 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
337 d3 = (h >> 16); /* implicit "& 0xffff" */
339 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
340 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
341 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
342 q = put_dec_helper4(buf, q);
344 q += 7671 * d3 + 9496 * d2 + 6 * d1;
345 q = put_dec_helper4(buf+4, q);
347 q += 4749 * d3 + 42 * d2;
348 q = put_dec_helper4(buf+8, q);
353 buf = put_dec_trunc8(buf, q);
354 else while (buf[-1] == '0')
363 * Convert passed number to decimal string.
364 * Returns the length of string. On buffer overflow, returns 0.
366 * If speed is not important, use snprintf(). It's easy to read the code.
368 int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
370 /* put_dec requires 2-byte alignment of the buffer. */
371 char tmp[sizeof(num) * 3] __aligned(2);
374 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
379 len = put_dec(tmp, num) - tmp;
382 if (len > size || width > size)
387 for (idx = 0; idx < width; idx++)
393 for (idx = 0; idx < len; ++idx)
394 buf[idx + width] = tmp[len - idx - 1];
399 #define SIGN 1 /* unsigned/signed, must be 1 */
400 #define LEFT 2 /* left justified */
401 #define PLUS 4 /* show plus */
402 #define SPACE 8 /* space if plus */
403 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
404 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
405 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
408 FORMAT_TYPE_NONE, /* Just a string part */
410 FORMAT_TYPE_PRECISION,
414 FORMAT_TYPE_PERCENT_CHAR,
416 FORMAT_TYPE_LONG_LONG,
430 unsigned int type:8; /* format_type enum */
431 signed int field_width:24; /* width of output field */
432 unsigned int flags:8; /* flags to number() */
433 unsigned int base:8; /* number base, 8, 10 or 16 only */
434 signed int precision:16; /* # of digits/chars */
436 static_assert(sizeof(struct printf_spec) == 8);
438 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
439 #define PRECISION_MAX ((1 << 15) - 1)
441 static noinline_for_stack
442 char *number(char *buf, char *end, unsigned long long num,
443 struct printf_spec spec)
445 /* put_dec requires 2-byte alignment of the buffer. */
446 char tmp[3 * sizeof(num)] __aligned(2);
449 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
451 bool is_zero = num == 0LL;
452 int field_width = spec.field_width;
453 int precision = spec.precision;
455 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
456 * produces same digits or (maybe lowercased) letters */
457 locase = (spec.flags & SMALL);
458 if (spec.flags & LEFT)
459 spec.flags &= ~ZEROPAD;
461 if (spec.flags & SIGN) {
462 if ((signed long long)num < 0) {
464 num = -(signed long long)num;
466 } else if (spec.flags & PLUS) {
469 } else if (spec.flags & SPACE) {
481 /* generate full string in tmp[], in reverse order */
484 tmp[i++] = hex_asc_upper[num] | locase;
485 else if (spec.base != 10) { /* 8 or 16 */
486 int mask = spec.base - 1;
492 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
495 } else { /* base 10 */
496 i = put_dec(tmp, num) - tmp;
499 /* printing 100 using %2d gives "100", not "00" */
502 /* leading space padding */
503 field_width -= precision;
504 if (!(spec.flags & (ZEROPAD | LEFT))) {
505 while (--field_width >= 0) {
517 /* "0x" / "0" prefix */
519 if (spec.base == 16 || !is_zero) {
524 if (spec.base == 16) {
526 *buf = ('X' | locase);
530 /* zero or space padding */
531 if (!(spec.flags & LEFT)) {
532 char c = ' ' + (spec.flags & ZEROPAD);
533 BUILD_BUG_ON(' ' + ZEROPAD != '0');
534 while (--field_width >= 0) {
540 /* hmm even more zero padding? */
541 while (i <= --precision) {
546 /* actual digits of result */
552 /* trailing space padding */
553 while (--field_width >= 0) {
562 static noinline_for_stack
563 char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
565 struct printf_spec spec;
567 spec.type = FORMAT_TYPE_PTR;
568 spec.field_width = 2 + 2 * size; /* 0x + hex */
569 spec.flags = SPECIAL | SMALL | ZEROPAD;
573 return number(buf, end, num, spec);
576 static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
579 if (buf >= end) /* nowhere to put anything */
582 if (size <= spaces) {
583 memset(buf, ' ', size);
587 if (len > size - spaces)
589 memmove(buf + spaces, buf, len);
591 memset(buf, ' ', spaces);
595 * Handle field width padding for a string.
596 * @buf: current buffer position
597 * @n: length of string
598 * @end: end of output buffer
599 * @spec: for field width and flags
600 * Returns: new buffer position after padding.
602 static noinline_for_stack
603 char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
607 if (likely(n >= spec.field_width))
609 /* we want to pad the sucker */
610 spaces = spec.field_width - n;
611 if (!(spec.flags & LEFT)) {
612 move_right(buf - n, end, n, spaces);
623 /* Handle string from a well known address. */
624 static char *string_nocheck(char *buf, char *end, const char *s,
625 struct printf_spec spec)
628 int lim = spec.precision;
639 return widen_string(buf, len, end, spec);
642 /* Be careful: error messages must fit into the given buffer. */
643 static char *error_string(char *buf, char *end, const char *s,
644 struct printf_spec spec)
647 * Hard limit to avoid a completely insane messages. It actually
648 * works pretty well because most error messages are in
649 * the many pointer format modifiers.
651 if (spec.precision == -1)
652 spec.precision = 2 * sizeof(void *);
654 return string_nocheck(buf, end, s, spec);
658 * Do not call any complex external code here. Nested printk()/vsprintf()
659 * might cause infinite loops. Failures might break printk() and would
662 static const char *check_pointer_msg(const void *ptr)
667 if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
673 static int check_pointer(char **buf, char *end, const void *ptr,
674 struct printf_spec spec)
678 err_msg = check_pointer_msg(ptr);
680 *buf = error_string(*buf, end, err_msg, spec);
687 static noinline_for_stack
688 char *string(char *buf, char *end, const char *s,
689 struct printf_spec spec)
691 if (check_pointer(&buf, end, s, spec))
694 return string_nocheck(buf, end, s, spec);
697 static char *pointer_string(char *buf, char *end,
699 struct printf_spec spec)
703 if (spec.field_width == -1) {
704 spec.field_width = 2 * sizeof(ptr);
705 spec.flags |= ZEROPAD;
708 return number(buf, end, (unsigned long int)ptr, spec);
711 /* Make pointers available for printing early in the boot sequence. */
712 static int debug_boot_weak_hash __ro_after_init;
714 static int __init debug_boot_weak_hash_enable(char *str)
716 debug_boot_weak_hash = 1;
717 pr_info("debug_boot_weak_hash enabled\n");
720 early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable);
722 static DEFINE_STATIC_KEY_TRUE(not_filled_random_ptr_key);
723 static siphash_key_t ptr_key __read_mostly;
725 static void enable_ptr_key_workfn(struct work_struct *work)
727 get_random_bytes(&ptr_key, sizeof(ptr_key));
728 /* Needs to run from preemptible context */
729 static_branch_disable(¬_filled_random_ptr_key);
732 static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn);
734 static int fill_random_ptr_key(struct notifier_block *nb,
735 unsigned long action, void *data)
737 /* This may be in an interrupt handler. */
738 queue_work(system_unbound_wq, &enable_ptr_key_work);
742 static struct notifier_block random_ready = {
743 .notifier_call = fill_random_ptr_key
746 static int __init initialize_ptr_random(void)
748 int key_size = sizeof(ptr_key);
751 /* Use hw RNG if available. */
752 if (get_random_bytes_arch(&ptr_key, key_size) == key_size) {
753 static_branch_disable(¬_filled_random_ptr_key);
757 ret = register_random_ready_notifier(&random_ready);
760 } else if (ret == -EALREADY) {
761 /* This is in preemptible context */
762 enable_ptr_key_workfn(&enable_ptr_key_work);
768 early_initcall(initialize_ptr_random);
770 /* Maps a pointer to a 32 bit unique identifier. */
771 static char *ptr_to_id(char *buf, char *end, const void *ptr,
772 struct printf_spec spec)
774 const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
775 unsigned long hashval;
778 * Print the real pointer value for NULL and error pointers,
779 * as they are not actual addresses.
781 if (IS_ERR_OR_NULL(ptr))
782 return pointer_string(buf, end, ptr, spec);
784 /* When debugging early boot use non-cryptographically secure hash. */
785 if (unlikely(debug_boot_weak_hash)) {
786 hashval = hash_long((unsigned long)ptr, 32);
787 return pointer_string(buf, end, (const void *)hashval, spec);
790 if (static_branch_unlikely(¬_filled_random_ptr_key)) {
791 spec.field_width = 2 * sizeof(ptr);
792 /* string length must be less than default_width */
793 return error_string(buf, end, str, spec);
797 hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
799 * Mask off the first 32 bits, this makes explicit that we have
800 * modified the address (and 32 bits is plenty for a unique ID).
802 hashval = hashval & 0xffffffff;
804 hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
806 return pointer_string(buf, end, (const void *)hashval, spec);
809 int kptr_restrict __read_mostly;
811 static noinline_for_stack
812 char *restricted_pointer(char *buf, char *end, const void *ptr,
813 struct printf_spec spec)
815 switch (kptr_restrict) {
817 /* Handle as %p, hash and do _not_ leak addresses. */
818 return ptr_to_id(buf, end, ptr, spec);
820 const struct cred *cred;
823 * kptr_restrict==1 cannot be used in IRQ context
824 * because its test for CAP_SYSLOG would be meaningless.
826 if (in_irq() || in_serving_softirq() || in_nmi()) {
827 if (spec.field_width == -1)
828 spec.field_width = 2 * sizeof(ptr);
829 return error_string(buf, end, "pK-error", spec);
833 * Only print the real pointer value if the current
834 * process has CAP_SYSLOG and is running with the
835 * same credentials it started with. This is because
836 * access to files is checked at open() time, but %pK
837 * checks permission at read() time. We don't want to
838 * leak pointer values if a binary opens a file using
839 * %pK and then elevates privileges before reading it.
841 cred = current_cred();
842 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
843 !uid_eq(cred->euid, cred->uid) ||
844 !gid_eq(cred->egid, cred->gid))
850 /* Always print 0's for %pK */
855 return pointer_string(buf, end, ptr, spec);
858 static noinline_for_stack
859 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
862 const char *array[4], *s;
863 const struct dentry *p;
868 case '2': case '3': case '4':
869 depth = fmt[1] - '0';
876 for (i = 0; i < depth; i++, d = p) {
877 if (check_pointer(&buf, end, d, spec)) {
882 p = READ_ONCE(d->d_parent);
883 array[i] = READ_ONCE(d->d_name.name);
892 for (n = 0; n != spec.precision; n++, buf++) {
904 return widen_string(buf, n, end, spec);
907 static noinline_for_stack
908 char *file_dentry_name(char *buf, char *end, const struct file *f,
909 struct printf_spec spec, const char *fmt)
911 if (check_pointer(&buf, end, f, spec))
914 return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
917 static noinline_for_stack
918 char *bdev_name(char *buf, char *end, struct block_device *bdev,
919 struct printf_spec spec, const char *fmt)
923 if (check_pointer(&buf, end, bdev, spec))
927 buf = string(buf, end, hd->disk_name, spec);
928 if (bdev->bd_part->partno) {
929 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
934 buf = number(buf, end, bdev->bd_part->partno, spec);
940 static noinline_for_stack
941 char *symbol_string(char *buf, char *end, void *ptr,
942 struct printf_spec spec, const char *fmt)
945 #ifdef CONFIG_KALLSYMS
946 char sym[KSYM_SYMBOL_LEN];
950 ptr = __builtin_extract_return_addr(ptr);
951 value = (unsigned long)ptr;
953 #ifdef CONFIG_KALLSYMS
955 sprint_backtrace(sym, value);
956 else if (*fmt != 'f' && *fmt != 's')
957 sprint_symbol(sym, value);
959 sprint_symbol_no_offset(sym, value);
961 return string_nocheck(buf, end, sym, spec);
963 return special_hex_number(buf, end, value, sizeof(void *));
967 static const struct printf_spec default_str_spec = {
972 static const struct printf_spec default_flag_spec = {
975 .flags = SPECIAL | SMALL,
978 static const struct printf_spec default_dec_spec = {
983 static const struct printf_spec default_dec02_spec = {
990 static const struct printf_spec default_dec04_spec = {
997 static noinline_for_stack
998 char *resource_string(char *buf, char *end, struct resource *res,
999 struct printf_spec spec, const char *fmt)
1001 #ifndef IO_RSRC_PRINTK_SIZE
1002 #define IO_RSRC_PRINTK_SIZE 6
1005 #ifndef MEM_RSRC_PRINTK_SIZE
1006 #define MEM_RSRC_PRINTK_SIZE 10
1008 static const struct printf_spec io_spec = {
1010 .field_width = IO_RSRC_PRINTK_SIZE,
1012 .flags = SPECIAL | SMALL | ZEROPAD,
1014 static const struct printf_spec mem_spec = {
1016 .field_width = MEM_RSRC_PRINTK_SIZE,
1018 .flags = SPECIAL | SMALL | ZEROPAD,
1020 static const struct printf_spec bus_spec = {
1024 .flags = SMALL | ZEROPAD,
1026 static const struct printf_spec str_spec = {
1032 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1033 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1034 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1035 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
1036 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
1037 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1038 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
1039 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
1041 char *p = sym, *pend = sym + sizeof(sym);
1042 int decode = (fmt[0] == 'R') ? 1 : 0;
1043 const struct printf_spec *specp;
1045 if (check_pointer(&buf, end, res, spec))
1049 if (res->flags & IORESOURCE_IO) {
1050 p = string_nocheck(p, pend, "io ", str_spec);
1052 } else if (res->flags & IORESOURCE_MEM) {
1053 p = string_nocheck(p, pend, "mem ", str_spec);
1055 } else if (res->flags & IORESOURCE_IRQ) {
1056 p = string_nocheck(p, pend, "irq ", str_spec);
1057 specp = &default_dec_spec;
1058 } else if (res->flags & IORESOURCE_DMA) {
1059 p = string_nocheck(p, pend, "dma ", str_spec);
1060 specp = &default_dec_spec;
1061 } else if (res->flags & IORESOURCE_BUS) {
1062 p = string_nocheck(p, pend, "bus ", str_spec);
1065 p = string_nocheck(p, pend, "??? ", str_spec);
1069 if (decode && res->flags & IORESOURCE_UNSET) {
1070 p = string_nocheck(p, pend, "size ", str_spec);
1071 p = number(p, pend, resource_size(res), *specp);
1073 p = number(p, pend, res->start, *specp);
1074 if (res->start != res->end) {
1076 p = number(p, pend, res->end, *specp);
1080 if (res->flags & IORESOURCE_MEM_64)
1081 p = string_nocheck(p, pend, " 64bit", str_spec);
1082 if (res->flags & IORESOURCE_PREFETCH)
1083 p = string_nocheck(p, pend, " pref", str_spec);
1084 if (res->flags & IORESOURCE_WINDOW)
1085 p = string_nocheck(p, pend, " window", str_spec);
1086 if (res->flags & IORESOURCE_DISABLED)
1087 p = string_nocheck(p, pend, " disabled", str_spec);
1089 p = string_nocheck(p, pend, " flags ", str_spec);
1090 p = number(p, pend, res->flags, default_flag_spec);
1095 return string_nocheck(buf, end, sym, spec);
1098 static noinline_for_stack
1099 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1102 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
1103 negative value, fallback to the default */
1106 if (spec.field_width == 0)
1107 /* nothing to print */
1110 if (check_pointer(&buf, end, addr, spec))
1128 if (spec.field_width > 0)
1129 len = min_t(int, spec.field_width, 64);
1131 for (i = 0; i < len; ++i) {
1133 *buf = hex_asc_hi(addr[i]);
1136 *buf = hex_asc_lo(addr[i]);
1139 if (separator && i != len - 1) {
1149 static noinline_for_stack
1150 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
1151 struct printf_spec spec, const char *fmt)
1153 const int CHUNKSZ = 32;
1154 int nr_bits = max_t(int, spec.field_width, 0);
1158 if (check_pointer(&buf, end, bitmap, spec))
1161 /* reused to print numbers */
1162 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
1164 chunksz = nr_bits & (CHUNKSZ - 1);
1168 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
1169 for (; i >= 0; i -= CHUNKSZ) {
1173 chunkmask = ((1ULL << chunksz) - 1);
1174 word = i / BITS_PER_LONG;
1175 bit = i % BITS_PER_LONG;
1176 val = (bitmap[word] >> bit) & chunkmask;
1185 spec.field_width = DIV_ROUND_UP(chunksz, 4);
1186 buf = number(buf, end, val, spec);
1193 static noinline_for_stack
1194 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
1195 struct printf_spec spec, const char *fmt)
1197 int nr_bits = max_t(int, spec.field_width, 0);
1198 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
1199 int cur, rbot, rtop;
1202 if (check_pointer(&buf, end, bitmap, spec))
1205 rbot = cur = find_first_bit(bitmap, nr_bits);
1206 while (cur < nr_bits) {
1208 cur = find_next_bit(bitmap, nr_bits, cur + 1);
1209 if (cur < nr_bits && cur <= rtop + 1)
1219 buf = number(buf, end, rbot, default_dec_spec);
1225 buf = number(buf, end, rtop, default_dec_spec);
1233 static noinline_for_stack
1234 char *mac_address_string(char *buf, char *end, u8 *addr,
1235 struct printf_spec spec, const char *fmt)
1237 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
1241 bool reversed = false;
1243 if (check_pointer(&buf, end, addr, spec))
1260 for (i = 0; i < 6; i++) {
1262 p = hex_byte_pack(p, addr[5 - i]);
1264 p = hex_byte_pack(p, addr[i]);
1266 if (fmt[0] == 'M' && i != 5)
1271 return string_nocheck(buf, end, mac_addr, spec);
1274 static noinline_for_stack
1275 char *ip4_string(char *p, const u8 *addr, const char *fmt)
1278 bool leading_zeros = (fmt[0] == 'i');
1303 for (i = 0; i < 4; i++) {
1304 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
1305 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1306 if (leading_zeros) {
1312 /* reverse the digits in the quad */
1314 *p++ = temp[digits];
1324 static noinline_for_stack
1325 char *ip6_compressed_string(char *p, const char *addr)
1328 unsigned char zerolength[8];
1333 bool needcolon = false;
1335 struct in6_addr in6;
1337 memcpy(&in6, addr, sizeof(struct in6_addr));
1339 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1341 memset(zerolength, 0, sizeof(zerolength));
1348 /* find position of longest 0 run */
1349 for (i = 0; i < range; i++) {
1350 for (j = i; j < range; j++) {
1351 if (in6.s6_addr16[j] != 0)
1356 for (i = 0; i < range; i++) {
1357 if (zerolength[i] > longest) {
1358 longest = zerolength[i];
1362 if (longest == 1) /* don't compress a single 0 */
1366 for (i = 0; i < range; i++) {
1367 if (i == colonpos) {
1368 if (needcolon || i == 0)
1379 /* hex u16 without leading 0s */
1380 word = ntohs(in6.s6_addr16[i]);
1385 p = hex_byte_pack(p, hi);
1387 *p++ = hex_asc_lo(hi);
1388 p = hex_byte_pack(p, lo);
1391 p = hex_byte_pack(p, lo);
1393 *p++ = hex_asc_lo(lo);
1400 p = ip4_string(p, &in6.s6_addr[12], "I4");
1407 static noinline_for_stack
1408 char *ip6_string(char *p, const char *addr, const char *fmt)
1412 for (i = 0; i < 8; i++) {
1413 p = hex_byte_pack(p, *addr++);
1414 p = hex_byte_pack(p, *addr++);
1415 if (fmt[0] == 'I' && i != 7)
1423 static noinline_for_stack
1424 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1425 struct printf_spec spec, const char *fmt)
1427 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1429 if (fmt[0] == 'I' && fmt[2] == 'c')
1430 ip6_compressed_string(ip6_addr, addr);
1432 ip6_string(ip6_addr, addr, fmt);
1434 return string_nocheck(buf, end, ip6_addr, spec);
1437 static noinline_for_stack
1438 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1439 struct printf_spec spec, const char *fmt)
1441 char ip4_addr[sizeof("255.255.255.255")];
1443 ip4_string(ip4_addr, addr, fmt);
1445 return string_nocheck(buf, end, ip4_addr, spec);
1448 static noinline_for_stack
1449 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1450 struct printf_spec spec, const char *fmt)
1452 bool have_p = false, have_s = false, have_f = false, have_c = false;
1453 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1454 sizeof(":12345") + sizeof("/123456789") +
1455 sizeof("%1234567890")];
1456 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1457 const u8 *addr = (const u8 *) &sa->sin6_addr;
1458 char fmt6[2] = { fmt[0], '6' };
1462 while (isalpha(*++fmt)) {
1479 if (have_p || have_s || have_f) {
1484 if (fmt6[0] == 'I' && have_c)
1485 p = ip6_compressed_string(ip6_addr + off, addr);
1487 p = ip6_string(ip6_addr + off, addr, fmt6);
1489 if (have_p || have_s || have_f)
1494 p = number(p, pend, ntohs(sa->sin6_port), spec);
1498 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1499 IPV6_FLOWINFO_MASK), spec);
1503 p = number(p, pend, sa->sin6_scope_id, spec);
1507 return string_nocheck(buf, end, ip6_addr, spec);
1510 static noinline_for_stack
1511 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1512 struct printf_spec spec, const char *fmt)
1514 bool have_p = false;
1515 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1516 char *pend = ip4_addr + sizeof(ip4_addr);
1517 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1518 char fmt4[3] = { fmt[0], '4', 0 };
1521 while (isalpha(*++fmt)) {
1535 p = ip4_string(ip4_addr, addr, fmt4);
1538 p = number(p, pend, ntohs(sa->sin_port), spec);
1542 return string_nocheck(buf, end, ip4_addr, spec);
1545 static noinline_for_stack
1546 char *ip_addr_string(char *buf, char *end, const void *ptr,
1547 struct printf_spec spec, const char *fmt)
1551 if (check_pointer(&buf, end, ptr, spec))
1556 return ip6_addr_string(buf, end, ptr, spec, fmt);
1558 return ip4_addr_string(buf, end, ptr, spec, fmt);
1561 struct sockaddr raw;
1562 struct sockaddr_in v4;
1563 struct sockaddr_in6 v6;
1566 switch (sa->raw.sa_family) {
1568 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1570 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1572 return error_string(buf, end, "(einval)", spec);
1576 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
1577 return error_string(buf, end, err_fmt_msg, spec);
1580 static noinline_for_stack
1581 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1586 unsigned int flags = 0;
1589 if (spec.field_width == 0)
1590 return buf; /* nothing to print */
1592 if (check_pointer(&buf, end, addr, spec))
1596 switch (fmt[count++]) {
1598 flags |= ESCAPE_ANY;
1601 flags |= ESCAPE_SPECIAL;
1604 flags |= ESCAPE_HEX;
1607 flags |= ESCAPE_NULL;
1610 flags |= ESCAPE_OCTAL;
1616 flags |= ESCAPE_SPACE;
1625 flags = ESCAPE_ANY_NP;
1627 len = spec.field_width < 0 ? 1 : spec.field_width;
1630 * string_escape_mem() writes as many characters as it can to
1631 * the given buffer, and returns the total size of the output
1632 * had the buffer been big enough.
1634 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1639 static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1640 struct printf_spec spec, const char *fmt)
1644 if (check_pointer(&buf, end, va_fmt, spec))
1647 va_copy(va, *va_fmt->va);
1648 buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
1654 static noinline_for_stack
1655 char *uuid_string(char *buf, char *end, const u8 *addr,
1656 struct printf_spec spec, const char *fmt)
1658 char uuid[UUID_STRING_LEN + 1];
1661 const u8 *index = uuid_index;
1664 if (check_pointer(&buf, end, addr, spec))
1669 uc = true; /* fall-through */
1678 for (i = 0; i < 16; i++) {
1680 p = hex_byte_pack_upper(p, addr[index[i]]);
1682 p = hex_byte_pack(p, addr[index[i]]);
1695 return string_nocheck(buf, end, uuid, spec);
1698 static noinline_for_stack
1699 char *netdev_bits(char *buf, char *end, const void *addr,
1700 struct printf_spec spec, const char *fmt)
1702 unsigned long long num;
1705 if (check_pointer(&buf, end, addr, spec))
1710 num = *(const netdev_features_t *)addr;
1711 size = sizeof(netdev_features_t);
1714 return error_string(buf, end, "(%pN?)", spec);
1717 return special_hex_number(buf, end, num, size);
1720 static noinline_for_stack
1721 char *address_val(char *buf, char *end, const void *addr,
1722 struct printf_spec spec, const char *fmt)
1724 unsigned long long num;
1727 if (check_pointer(&buf, end, addr, spec))
1732 num = *(const dma_addr_t *)addr;
1733 size = sizeof(dma_addr_t);
1737 num = *(const phys_addr_t *)addr;
1738 size = sizeof(phys_addr_t);
1742 return special_hex_number(buf, end, num, size);
1745 static noinline_for_stack
1746 char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1748 int year = tm->tm_year + (r ? 0 : 1900);
1749 int mon = tm->tm_mon + (r ? 0 : 1);
1751 buf = number(buf, end, year, default_dec04_spec);
1756 buf = number(buf, end, mon, default_dec02_spec);
1761 return number(buf, end, tm->tm_mday, default_dec02_spec);
1764 static noinline_for_stack
1765 char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1767 buf = number(buf, end, tm->tm_hour, default_dec02_spec);
1772 buf = number(buf, end, tm->tm_min, default_dec02_spec);
1777 return number(buf, end, tm->tm_sec, default_dec02_spec);
1780 static noinline_for_stack
1781 char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1782 struct printf_spec spec, const char *fmt)
1784 bool have_t = true, have_d = true;
1788 if (check_pointer(&buf, end, tm, spec))
1791 switch (fmt[count]) {
1802 raw = fmt[count] == 'r';
1805 buf = date_str(buf, end, tm, raw);
1806 if (have_d && have_t) {
1807 /* Respect ISO 8601 */
1813 buf = time_str(buf, end, tm, raw);
1818 static noinline_for_stack
1819 char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
1824 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
1826 return error_string(buf, end, "(%ptR?)", spec);
1830 static noinline_for_stack
1831 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1834 if (!IS_ENABLED(CONFIG_HAVE_CLK))
1835 return error_string(buf, end, "(%pC?)", spec);
1837 if (check_pointer(&buf, end, clk, spec))
1843 #ifdef CONFIG_COMMON_CLK
1844 return string(buf, end, __clk_get_name(clk), spec);
1846 return ptr_to_id(buf, end, clk, spec);
1852 char *format_flags(char *buf, char *end, unsigned long flags,
1853 const struct trace_print_flags *names)
1857 for ( ; flags && names->name; names++) {
1859 if ((flags & mask) != mask)
1862 buf = string(buf, end, names->name, default_str_spec);
1873 buf = number(buf, end, flags, default_flag_spec);
1878 static noinline_for_stack
1879 char *flags_string(char *buf, char *end, void *flags_ptr,
1880 struct printf_spec spec, const char *fmt)
1882 unsigned long flags;
1883 const struct trace_print_flags *names;
1885 if (check_pointer(&buf, end, flags_ptr, spec))
1890 flags = *(unsigned long *)flags_ptr;
1891 /* Remove zone id */
1892 flags &= (1UL << NR_PAGEFLAGS) - 1;
1893 names = pageflag_names;
1896 flags = *(unsigned long *)flags_ptr;
1897 names = vmaflag_names;
1900 flags = *(gfp_t *)flags_ptr;
1901 names = gfpflag_names;
1904 return error_string(buf, end, "(%pG?)", spec);
1907 return format_flags(buf, end, flags, names);
1910 static const char *device_node_name_for_depth(const struct device_node *np, int depth)
1912 for ( ; np && depth; depth--)
1915 return kbasename(np->full_name);
1918 static noinline_for_stack
1919 char *device_node_gen_full_name(const struct device_node *np, char *buf, char *end)
1922 const struct device_node *parent = np->parent;
1924 /* special case for root node */
1926 return string_nocheck(buf, end, "/", default_str_spec);
1928 for (depth = 0; parent->parent; depth++)
1929 parent = parent->parent;
1931 for ( ; depth >= 0; depth--) {
1932 buf = string_nocheck(buf, end, "/", default_str_spec);
1933 buf = string(buf, end, device_node_name_for_depth(np, depth),
1939 static noinline_for_stack
1940 char *device_node_string(char *buf, char *end, struct device_node *dn,
1941 struct printf_spec spec, const char *fmt)
1943 char tbuf[sizeof("xxxx") + 1];
1946 char *buf_start = buf;
1947 struct property *prop;
1948 bool has_mult, pass;
1949 static const struct printf_spec num_spec = {
1956 struct printf_spec str_spec = spec;
1957 str_spec.field_width = -1;
1959 if (!IS_ENABLED(CONFIG_OF))
1960 return error_string(buf, end, "(%pOF?)", spec);
1962 if (check_pointer(&buf, end, dn, spec))
1965 /* simple case without anything any more format specifiers */
1967 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
1970 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
1979 case 'f': /* full_name */
1980 buf = device_node_gen_full_name(dn, buf, end);
1982 case 'n': /* name */
1983 p = kbasename(of_node_full_name(dn));
1984 precision = str_spec.precision;
1985 str_spec.precision = strchrnul(p, '@') - p;
1986 buf = string(buf, end, p, str_spec);
1987 str_spec.precision = precision;
1989 case 'p': /* phandle */
1990 buf = number(buf, end, (unsigned int)dn->phandle, num_spec);
1992 case 'P': /* path-spec */
1993 p = kbasename(of_node_full_name(dn));
1996 buf = string(buf, end, p, str_spec);
1998 case 'F': /* flags */
1999 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2000 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2001 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2002 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2004 buf = string_nocheck(buf, end, tbuf, str_spec);
2006 case 'c': /* major compatible string */
2007 ret = of_property_read_string(dn, "compatible", &p);
2009 buf = string(buf, end, p, str_spec);
2011 case 'C': /* full compatible string */
2013 of_property_for_each_string(dn, "compatible", prop, p) {
2015 buf = string_nocheck(buf, end, ",", str_spec);
2016 buf = string_nocheck(buf, end, "\"", str_spec);
2017 buf = string(buf, end, p, str_spec);
2018 buf = string_nocheck(buf, end, "\"", str_spec);
2028 return widen_string(buf, buf - buf_start, end, spec);
2031 static char *kobject_string(char *buf, char *end, void *ptr,
2032 struct printf_spec spec, const char *fmt)
2036 return device_node_string(buf, end, ptr, spec, fmt + 1);
2039 return error_string(buf, end, "(%pO?)", spec);
2043 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2044 * by an extra set of alphanumeric characters that are extended format
2047 * Please update scripts/checkpatch.pl when adding/removing conversion
2048 * characters. (Search for "check for vsprintf extension").
2050 * Right now we handle:
2052 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2053 * - 's' For symbolic direct pointers (or function descriptors) without offset
2056 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
2057 * - 'B' For backtraced symbolic direct pointers with offset
2058 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2059 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2060 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2061 * width which must be explicitly specified either as part of the
2062 * format string '%32b[l]' or through '%*b[l]', [l] selects
2063 * range-list format instead of hex format
2064 * - 'M' For a 6-byte MAC address, it prints the address in the
2065 * usual colon-separated hex notation
2066 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2067 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2068 * with a dash-separated hex notation
2069 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2070 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2071 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2072 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
2074 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2075 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2076 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2077 * IPv6 omits the colons (01020304...0f)
2078 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2080 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2081 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2082 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2083 * - 'I[6S]c' for IPv6 addresses printed as specified by
2084 * http://tools.ietf.org/html/rfc5952
2085 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2086 * of the following flags (see string_escape_mem() for the
2089 * c - ESCAPE_SPECIAL
2095 * By default ESCAPE_ANY_NP is used.
2096 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2097 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2098 * Options for %pU are:
2099 * b big endian lower case hex (default)
2100 * B big endian UPPER case hex
2101 * l little endian lower case hex
2102 * L little endian UPPER case hex
2103 * big endian output byte order is:
2104 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2105 * little endian output byte order is:
2106 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2107 * - 'V' For a struct va_format which contains a format string * and va_list *,
2108 * call vsnprintf(->format, *->va_list).
2109 * Implements a "recursive vsnprintf".
2110 * Do not use this feature without some mechanism to verify the
2111 * correctness of the format string and va_list arguments.
2112 * - 'K' For a kernel pointer that should be hidden from unprivileged users
2113 * - 'NF' For a netdev_features_t
2114 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2115 * a certain separator (' ' by default):
2119 * The maximum supported length is 64 bytes of the input. Consider
2120 * to use print_hex_dump() for the larger input.
2121 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2122 * (default assumed to be phys_addr_t, passed by reference)
2123 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2124 * - 'D[234]' Same as 'd' but for a struct file
2125 * - 'g' For block_device name (gendisk + partition number)
2126 * - 't[R][dt][r]' For time and date as represented:
2128 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2129 * (legacy clock framework) of the clock
2130 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2131 * (legacy clock framework) of the clock
2132 * - 'G' For flags to be printed as a collection of symbolic strings that would
2133 * construct the specific value. Supported flags given by option:
2134 * p page flags (see struct page) given as pointer to unsigned long
2135 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2136 * v vma flags (VM_*) given as pointer to unsigned long
2137 * - 'OF[fnpPcCF]' For a device tree object
2138 * Without any optional arguments prints the full_name
2139 * f device node full_name
2140 * n device node name
2141 * p device node phandle
2142 * P device node path spec (name + @unit)
2143 * F device node flags
2144 * c major compatible string
2145 * C full compatible string
2146 * - 'x' For printing the address. Equivalent to "%lx".
2148 * ** When making changes please also update:
2149 * Documentation/core-api/printk-formats.rst
2151 * Note: The default behaviour (unadorned %p) is to hash the address,
2152 * rendering it useful as a unique identifier.
2154 static noinline_for_stack
2155 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2156 struct printf_spec spec)
2163 ptr = dereference_symbol_descriptor(ptr);
2166 return symbol_string(buf, end, ptr, spec, fmt);
2169 return resource_string(buf, end, ptr, spec, fmt);
2171 return hex_string(buf, end, ptr, spec, fmt);
2175 return bitmap_list_string(buf, end, ptr, spec, fmt);
2177 return bitmap_string(buf, end, ptr, spec, fmt);
2179 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2180 case 'm': /* Contiguous: 000102030405 */
2182 /* [mM]R (Reverse order; Bluetooth) */
2183 return mac_address_string(buf, end, ptr, spec, fmt);
2184 case 'I': /* Formatted IP supported
2186 * 6: 0001:0203:...:0708
2187 * 6c: 1::708 or 1::1.2.3.4
2189 case 'i': /* Contiguous:
2190 * 4: 001.002.003.004
2193 return ip_addr_string(buf, end, ptr, spec, fmt);
2195 return escaped_string(buf, end, ptr, spec, fmt);
2197 return uuid_string(buf, end, ptr, spec, fmt);
2199 return va_format(buf, end, ptr, spec, fmt);
2201 return restricted_pointer(buf, end, ptr, spec);
2203 return netdev_bits(buf, end, ptr, spec, fmt);
2205 return address_val(buf, end, ptr, spec, fmt);
2207 return dentry_name(buf, end, ptr, spec, fmt);
2209 return time_and_date(buf, end, ptr, spec, fmt);
2211 return clock(buf, end, ptr, spec, fmt);
2213 return file_dentry_name(buf, end, ptr, spec, fmt);
2216 return bdev_name(buf, end, ptr, spec, fmt);
2220 return flags_string(buf, end, ptr, spec, fmt);
2222 return kobject_string(buf, end, ptr, spec, fmt);
2224 return pointer_string(buf, end, ptr, spec);
2227 /* default is to _not_ leak addresses, hash before printing */
2228 return ptr_to_id(buf, end, ptr, spec);
2232 * Helper function to decode printf style format.
2233 * Each call decode a token from the format and return the
2234 * number of characters read (or likely the delta where it wants
2235 * to go on the next call).
2236 * The decoded token is returned through the parameters
2238 * 'h', 'l', or 'L' for integer fields
2239 * 'z' support added 23/7/1999 S.H.
2240 * 'z' changed to 'Z' --davidm 1/25/99
2241 * 'Z' changed to 'z' --adobriyan 2017-01-25
2242 * 't' added for ptrdiff_t
2244 * @fmt: the format string
2245 * @type of the token returned
2246 * @flags: various flags such as +, -, # tokens..
2247 * @field_width: overwritten width
2248 * @base: base of the number (octal, hex, ...)
2249 * @precision: precision of a number
2250 * @qualifier: qualifier of a number (long, size_t, ...)
2252 static noinline_for_stack
2253 int format_decode(const char *fmt, struct printf_spec *spec)
2255 const char *start = fmt;
2258 /* we finished early by reading the field width */
2259 if (spec->type == FORMAT_TYPE_WIDTH) {
2260 if (spec->field_width < 0) {
2261 spec->field_width = -spec->field_width;
2262 spec->flags |= LEFT;
2264 spec->type = FORMAT_TYPE_NONE;
2268 /* we finished early by reading the precision */
2269 if (spec->type == FORMAT_TYPE_PRECISION) {
2270 if (spec->precision < 0)
2271 spec->precision = 0;
2273 spec->type = FORMAT_TYPE_NONE;
2278 spec->type = FORMAT_TYPE_NONE;
2280 for (; *fmt ; ++fmt) {
2285 /* Return the current non-format string */
2286 if (fmt != start || !*fmt)
2292 while (1) { /* this also skips first '%' */
2298 case '-': spec->flags |= LEFT; break;
2299 case '+': spec->flags |= PLUS; break;
2300 case ' ': spec->flags |= SPACE; break;
2301 case '#': spec->flags |= SPECIAL; break;
2302 case '0': spec->flags |= ZEROPAD; break;
2303 default: found = false;
2310 /* get field width */
2311 spec->field_width = -1;
2314 spec->field_width = skip_atoi(&fmt);
2315 else if (*fmt == '*') {
2316 /* it's the next argument */
2317 spec->type = FORMAT_TYPE_WIDTH;
2318 return ++fmt - start;
2322 /* get the precision */
2323 spec->precision = -1;
2326 if (isdigit(*fmt)) {
2327 spec->precision = skip_atoi(&fmt);
2328 if (spec->precision < 0)
2329 spec->precision = 0;
2330 } else if (*fmt == '*') {
2331 /* it's the next argument */
2332 spec->type = FORMAT_TYPE_PRECISION;
2333 return ++fmt - start;
2338 /* get the conversion qualifier */
2340 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2341 *fmt == 'z' || *fmt == 't') {
2343 if (unlikely(qualifier == *fmt)) {
2344 if (qualifier == 'l') {
2347 } else if (qualifier == 'h') {
2358 spec->type = FORMAT_TYPE_CHAR;
2359 return ++fmt - start;
2362 spec->type = FORMAT_TYPE_STR;
2363 return ++fmt - start;
2366 spec->type = FORMAT_TYPE_PTR;
2367 return ++fmt - start;
2370 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2371 return ++fmt - start;
2373 /* integer number formats - set up the flags and "break" */
2379 spec->flags |= SMALL;
2388 spec->flags |= SIGN;
2394 * Since %n poses a greater security risk than
2395 * utility, treat it as any other invalid or
2396 * unsupported format specifier.
2401 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2402 spec->type = FORMAT_TYPE_INVALID;
2406 if (qualifier == 'L')
2407 spec->type = FORMAT_TYPE_LONG_LONG;
2408 else if (qualifier == 'l') {
2409 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2410 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2411 } else if (qualifier == 'z') {
2412 spec->type = FORMAT_TYPE_SIZE_T;
2413 } else if (qualifier == 't') {
2414 spec->type = FORMAT_TYPE_PTRDIFF;
2415 } else if (qualifier == 'H') {
2416 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2417 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2418 } else if (qualifier == 'h') {
2419 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2420 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2422 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2423 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2426 return ++fmt - start;
2430 set_field_width(struct printf_spec *spec, int width)
2432 spec->field_width = width;
2433 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2434 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2439 set_precision(struct printf_spec *spec, int prec)
2441 spec->precision = prec;
2442 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2443 spec->precision = clamp(prec, 0, PRECISION_MAX);
2448 * vsnprintf - Format a string and place it in a buffer
2449 * @buf: The buffer to place the result into
2450 * @size: The size of the buffer, including the trailing null space
2451 * @fmt: The format string to use
2452 * @args: Arguments for the format string
2454 * This function generally follows C99 vsnprintf, but has some
2455 * extensions and a few limitations:
2457 * - ``%n`` is unsupported
2458 * - ``%p*`` is handled by pointer()
2460 * See pointer() or Documentation/core-api/printk-formats.rst for more
2461 * extensive description.
2463 * **Please update the documentation in both places when making changes**
2465 * The return value is the number of characters which would
2466 * be generated for the given input, excluding the trailing
2467 * '\0', as per ISO C99. If you want to have the exact
2468 * number of characters written into @buf as return value
2469 * (not including the trailing '\0'), use vscnprintf(). If the
2470 * return is greater than or equal to @size, the resulting
2471 * string is truncated.
2473 * If you're not already dealing with a va_list consider using snprintf().
2475 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2477 unsigned long long num;
2479 struct printf_spec spec = {0};
2481 /* Reject out-of-range values early. Large positive sizes are
2482 used for unknown buffer sizes. */
2483 if (WARN_ON_ONCE(size > INT_MAX))
2489 /* Make sure end is always >= buf */
2496 const char *old_fmt = fmt;
2497 int read = format_decode(fmt, &spec);
2501 switch (spec.type) {
2502 case FORMAT_TYPE_NONE: {
2505 if (copy > end - str)
2507 memcpy(str, old_fmt, copy);
2513 case FORMAT_TYPE_WIDTH:
2514 set_field_width(&spec, va_arg(args, int));
2517 case FORMAT_TYPE_PRECISION:
2518 set_precision(&spec, va_arg(args, int));
2521 case FORMAT_TYPE_CHAR: {
2524 if (!(spec.flags & LEFT)) {
2525 while (--spec.field_width > 0) {
2532 c = (unsigned char) va_arg(args, int);
2536 while (--spec.field_width > 0) {
2544 case FORMAT_TYPE_STR:
2545 str = string(str, end, va_arg(args, char *), spec);
2548 case FORMAT_TYPE_PTR:
2549 str = pointer(fmt, str, end, va_arg(args, void *),
2551 while (isalnum(*fmt))
2555 case FORMAT_TYPE_PERCENT_CHAR:
2561 case FORMAT_TYPE_INVALID:
2563 * Presumably the arguments passed gcc's type
2564 * checking, but there is no safe or sane way
2565 * for us to continue parsing the format and
2566 * fetching from the va_list; the remaining
2567 * specifiers and arguments would be out of
2573 switch (spec.type) {
2574 case FORMAT_TYPE_LONG_LONG:
2575 num = va_arg(args, long long);
2577 case FORMAT_TYPE_ULONG:
2578 num = va_arg(args, unsigned long);
2580 case FORMAT_TYPE_LONG:
2581 num = va_arg(args, long);
2583 case FORMAT_TYPE_SIZE_T:
2584 if (spec.flags & SIGN)
2585 num = va_arg(args, ssize_t);
2587 num = va_arg(args, size_t);
2589 case FORMAT_TYPE_PTRDIFF:
2590 num = va_arg(args, ptrdiff_t);
2592 case FORMAT_TYPE_UBYTE:
2593 num = (unsigned char) va_arg(args, int);
2595 case FORMAT_TYPE_BYTE:
2596 num = (signed char) va_arg(args, int);
2598 case FORMAT_TYPE_USHORT:
2599 num = (unsigned short) va_arg(args, int);
2601 case FORMAT_TYPE_SHORT:
2602 num = (short) va_arg(args, int);
2604 case FORMAT_TYPE_INT:
2605 num = (int) va_arg(args, int);
2608 num = va_arg(args, unsigned int);
2611 str = number(str, end, num, spec);
2623 /* the trailing null byte doesn't count towards the total */
2627 EXPORT_SYMBOL(vsnprintf);
2630 * vscnprintf - Format a string and place it in a buffer
2631 * @buf: The buffer to place the result into
2632 * @size: The size of the buffer, including the trailing null space
2633 * @fmt: The format string to use
2634 * @args: Arguments for the format string
2636 * The return value is the number of characters which have been written into
2637 * the @buf not including the trailing '\0'. If @size is == 0 the function
2640 * If you're not already dealing with a va_list consider using scnprintf().
2642 * See the vsnprintf() documentation for format string extensions over C99.
2644 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2648 i = vsnprintf(buf, size, fmt, args);
2650 if (likely(i < size))
2656 EXPORT_SYMBOL(vscnprintf);
2659 * snprintf - Format a string and place it in a buffer
2660 * @buf: The buffer to place the result into
2661 * @size: The size of the buffer, including the trailing null space
2662 * @fmt: The format string to use
2663 * @...: Arguments for the format string
2665 * The return value is the number of characters which would be
2666 * generated for the given input, excluding the trailing null,
2667 * as per ISO C99. If the return is greater than or equal to
2668 * @size, the resulting string is truncated.
2670 * See the vsnprintf() documentation for format string extensions over C99.
2672 int snprintf(char *buf, size_t size, const char *fmt, ...)
2677 va_start(args, fmt);
2678 i = vsnprintf(buf, size, fmt, args);
2683 EXPORT_SYMBOL(snprintf);
2686 * scnprintf - Format a string and place it in a buffer
2687 * @buf: The buffer to place the result into
2688 * @size: The size of the buffer, including the trailing null space
2689 * @fmt: The format string to use
2690 * @...: Arguments for the format string
2692 * The return value is the number of characters written into @buf not including
2693 * the trailing '\0'. If @size is == 0 the function returns 0.
2696 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2701 va_start(args, fmt);
2702 i = vscnprintf(buf, size, fmt, args);
2707 EXPORT_SYMBOL(scnprintf);
2710 * vsprintf - Format a string and place it in a buffer
2711 * @buf: The buffer to place the result into
2712 * @fmt: The format string to use
2713 * @args: Arguments for the format string
2715 * The function returns the number of characters written
2716 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2719 * If you're not already dealing with a va_list consider using sprintf().
2721 * See the vsnprintf() documentation for format string extensions over C99.
2723 int vsprintf(char *buf, const char *fmt, va_list args)
2725 return vsnprintf(buf, INT_MAX, fmt, args);
2727 EXPORT_SYMBOL(vsprintf);
2730 * sprintf - Format a string and place it in a buffer
2731 * @buf: The buffer to place the result into
2732 * @fmt: The format string to use
2733 * @...: Arguments for the format string
2735 * The function returns the number of characters written
2736 * into @buf. Use snprintf() or scnprintf() in order to avoid
2739 * See the vsnprintf() documentation for format string extensions over C99.
2741 int sprintf(char *buf, const char *fmt, ...)
2746 va_start(args, fmt);
2747 i = vsnprintf(buf, INT_MAX, fmt, args);
2752 EXPORT_SYMBOL(sprintf);
2754 #ifdef CONFIG_BINARY_PRINTF
2757 * vbin_printf() - VA arguments to binary data
2758 * bstr_printf() - Binary data to text string
2762 * vbin_printf - Parse a format string and place args' binary value in a buffer
2763 * @bin_buf: The buffer to place args' binary value
2764 * @size: The size of the buffer(by words(32bits), not characters)
2765 * @fmt: The format string to use
2766 * @args: Arguments for the format string
2768 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2771 * The return value is the number of words(32bits) which would be generated for
2775 * If the return value is greater than @size, the resulting bin_buf is NOT
2776 * valid for bstr_printf().
2778 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2780 struct printf_spec spec = {0};
2784 str = (char *)bin_buf;
2785 end = (char *)(bin_buf + size);
2787 #define save_arg(type) \
2789 unsigned long long value; \
2790 if (sizeof(type) == 8) { \
2791 unsigned long long val8; \
2792 str = PTR_ALIGN(str, sizeof(u32)); \
2793 val8 = va_arg(args, unsigned long long); \
2794 if (str + sizeof(type) <= end) { \
2795 *(u32 *)str = *(u32 *)&val8; \
2796 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
2800 unsigned int val4; \
2801 str = PTR_ALIGN(str, sizeof(type)); \
2802 val4 = va_arg(args, int); \
2803 if (str + sizeof(type) <= end) \
2804 *(typeof(type) *)str = (type)(long)val4; \
2805 value = (unsigned long long)val4; \
2807 str += sizeof(type); \
2812 int read = format_decode(fmt, &spec);
2816 switch (spec.type) {
2817 case FORMAT_TYPE_NONE:
2818 case FORMAT_TYPE_PERCENT_CHAR:
2820 case FORMAT_TYPE_INVALID:
2823 case FORMAT_TYPE_WIDTH:
2824 case FORMAT_TYPE_PRECISION:
2825 width = (int)save_arg(int);
2826 /* Pointers may require the width */
2828 set_field_width(&spec, width);
2831 case FORMAT_TYPE_CHAR:
2835 case FORMAT_TYPE_STR: {
2836 const char *save_str = va_arg(args, char *);
2837 const char *err_msg;
2840 err_msg = check_pointer_msg(save_str);
2844 len = strlen(save_str) + 1;
2845 if (str + len < end)
2846 memcpy(str, save_str, len);
2851 case FORMAT_TYPE_PTR:
2852 /* Dereferenced pointers must be done now */
2854 /* Dereference of functions is still OK */
2864 if (!isalnum(*fmt)) {
2868 str = pointer(fmt, str, end, va_arg(args, void *),
2873 end[-1] = '\0'; /* Must be nul terminated */
2875 /* skip all alphanumeric pointer suffixes */
2876 while (isalnum(*fmt))
2881 switch (spec.type) {
2883 case FORMAT_TYPE_LONG_LONG:
2884 save_arg(long long);
2886 case FORMAT_TYPE_ULONG:
2887 case FORMAT_TYPE_LONG:
2888 save_arg(unsigned long);
2890 case FORMAT_TYPE_SIZE_T:
2893 case FORMAT_TYPE_PTRDIFF:
2894 save_arg(ptrdiff_t);
2896 case FORMAT_TYPE_UBYTE:
2897 case FORMAT_TYPE_BYTE:
2900 case FORMAT_TYPE_USHORT:
2901 case FORMAT_TYPE_SHORT:
2911 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2914 EXPORT_SYMBOL_GPL(vbin_printf);
2917 * bstr_printf - Format a string from binary arguments and place it in a buffer
2918 * @buf: The buffer to place the result into
2919 * @size: The size of the buffer, including the trailing null space
2920 * @fmt: The format string to use
2921 * @bin_buf: Binary arguments for the format string
2923 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2924 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2925 * a binary buffer that generated by vbin_printf.
2927 * The format follows C99 vsnprintf, but has some extensions:
2928 * see vsnprintf comment for details.
2930 * The return value is the number of characters which would
2931 * be generated for the given input, excluding the trailing
2932 * '\0', as per ISO C99. If you want to have the exact
2933 * number of characters written into @buf as return value
2934 * (not including the trailing '\0'), use vscnprintf(). If the
2935 * return is greater than or equal to @size, the resulting
2936 * string is truncated.
2938 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2940 struct printf_spec spec = {0};
2942 const char *args = (const char *)bin_buf;
2944 if (WARN_ON_ONCE(size > INT_MAX))
2950 #define get_arg(type) \
2952 typeof(type) value; \
2953 if (sizeof(type) == 8) { \
2954 args = PTR_ALIGN(args, sizeof(u32)); \
2955 *(u32 *)&value = *(u32 *)args; \
2956 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2958 args = PTR_ALIGN(args, sizeof(type)); \
2959 value = *(typeof(type) *)args; \
2961 args += sizeof(type); \
2965 /* Make sure end is always >= buf */
2972 const char *old_fmt = fmt;
2973 int read = format_decode(fmt, &spec);
2977 switch (spec.type) {
2978 case FORMAT_TYPE_NONE: {
2981 if (copy > end - str)
2983 memcpy(str, old_fmt, copy);
2989 case FORMAT_TYPE_WIDTH:
2990 set_field_width(&spec, get_arg(int));
2993 case FORMAT_TYPE_PRECISION:
2994 set_precision(&spec, get_arg(int));
2997 case FORMAT_TYPE_CHAR: {
3000 if (!(spec.flags & LEFT)) {
3001 while (--spec.field_width > 0) {
3007 c = (unsigned char) get_arg(char);
3011 while (--spec.field_width > 0) {
3019 case FORMAT_TYPE_STR: {
3020 const char *str_arg = args;
3021 args += strlen(str_arg) + 1;
3022 str = string(str, end, (char *)str_arg, spec);
3026 case FORMAT_TYPE_PTR: {
3027 bool process = false;
3029 /* Non function dereferences were already done */
3040 if (!isalnum(*fmt)) {
3044 /* Pointer dereference was already processed */
3046 len = copy = strlen(args);
3047 if (copy > end - str)
3049 memcpy(str, args, copy);
3055 str = pointer(fmt, str, end, get_arg(void *), spec);
3057 while (isalnum(*fmt))
3062 case FORMAT_TYPE_PERCENT_CHAR:
3068 case FORMAT_TYPE_INVALID:
3072 unsigned long long num;
3074 switch (spec.type) {
3076 case FORMAT_TYPE_LONG_LONG:
3077 num = get_arg(long long);
3079 case FORMAT_TYPE_ULONG:
3080 case FORMAT_TYPE_LONG:
3081 num = get_arg(unsigned long);
3083 case FORMAT_TYPE_SIZE_T:
3084 num = get_arg(size_t);
3086 case FORMAT_TYPE_PTRDIFF:
3087 num = get_arg(ptrdiff_t);
3089 case FORMAT_TYPE_UBYTE:
3090 num = get_arg(unsigned char);
3092 case FORMAT_TYPE_BYTE:
3093 num = get_arg(signed char);
3095 case FORMAT_TYPE_USHORT:
3096 num = get_arg(unsigned short);
3098 case FORMAT_TYPE_SHORT:
3099 num = get_arg(short);
3101 case FORMAT_TYPE_UINT:
3102 num = get_arg(unsigned int);
3108 str = number(str, end, num, spec);
3110 } /* switch(spec.type) */
3123 /* the trailing null byte doesn't count towards the total */
3126 EXPORT_SYMBOL_GPL(bstr_printf);
3129 * bprintf - Parse a format string and place args' binary value in a buffer
3130 * @bin_buf: The buffer to place args' binary value
3131 * @size: The size of the buffer(by words(32bits), not characters)
3132 * @fmt: The format string to use
3133 * @...: Arguments for the format string
3135 * The function returns the number of words(u32) written
3138 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3143 va_start(args, fmt);
3144 ret = vbin_printf(bin_buf, size, fmt, args);
3149 EXPORT_SYMBOL_GPL(bprintf);
3151 #endif /* CONFIG_BINARY_PRINTF */
3154 * vsscanf - Unformat a buffer into a list of arguments
3155 * @buf: input buffer
3156 * @fmt: format of buffer
3159 int vsscanf(const char *buf, const char *fmt, va_list args)
3161 const char *str = buf;
3169 unsigned long long u;
3175 /* skip any white space in format */
3176 /* white space in format matchs any amount of
3177 * white space, including none, in the input.
3179 if (isspace(*fmt)) {
3180 fmt = skip_spaces(++fmt);
3181 str = skip_spaces(str);
3184 /* anything that is not a conversion must match exactly */
3185 if (*fmt != '%' && *fmt) {
3186 if (*fmt++ != *str++)
3195 /* skip this conversion.
3196 * advance both strings to next white space
3201 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3202 /* '%*[' not yet supported, invalid format */
3207 while (!isspace(*str) && *str)
3212 /* get field width */
3214 if (isdigit(*fmt)) {
3215 field_width = skip_atoi(&fmt);
3216 if (field_width <= 0)
3220 /* get conversion qualifier */
3222 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
3225 if (unlikely(qualifier == *fmt)) {
3226 if (qualifier == 'h') {
3229 } else if (qualifier == 'l') {
3240 /* return number of characters read so far */
3241 *va_arg(args, int *) = str - buf;
3255 char *s = (char *)va_arg(args, char*);
3256 if (field_width == -1)
3260 } while (--field_width > 0 && *str);
3266 char *s = (char *)va_arg(args, char *);
3267 if (field_width == -1)
3268 field_width = SHRT_MAX;
3269 /* first, skip leading white space in buffer */
3270 str = skip_spaces(str);
3272 /* now copy until next white space */
3273 while (*str && !isspace(*str) && field_width--)
3280 * Warning: This implementation of the '[' conversion specifier
3281 * deviates from its glibc counterpart in the following ways:
3282 * (1) It does NOT support ranges i.e. '-' is NOT a special
3284 * (2) It cannot match the closing bracket ']' itself
3285 * (3) A field width is required
3286 * (4) '%*[' (discard matching input) is currently not supported
3289 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3290 * buf1, buf2, buf3);
3296 char *s = (char *)va_arg(args, char *);
3297 DECLARE_BITMAP(set, 256) = {0};
3298 unsigned int len = 0;
3299 bool negate = (*fmt == '^');
3301 /* field width is required */
3302 if (field_width == -1)
3308 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3309 set_bit((u8)*fmt, set);
3311 /* no ']' or no character set found */
3317 bitmap_complement(set, set, 256);
3318 /* exclude null '\0' byte */
3322 /* match must be non-empty */
3323 if (!test_bit((u8)*str, set))
3326 while (test_bit((u8)*str, set) && field_width--)
3348 /* looking for '%' in str */
3353 /* invalid format; stop here */
3357 /* have some sort of integer conversion.
3358 * first, skip white space in buffer.
3360 str = skip_spaces(str);
3363 if (is_sign && digit == '-')
3367 || (base == 16 && !isxdigit(digit))
3368 || (base == 10 && !isdigit(digit))
3369 || (base == 8 && (!isdigit(digit) || digit > '7'))
3370 || (base == 0 && !isdigit(digit)))
3374 val.s = simple_strntoll(str,
3375 field_width >= 0 ? field_width : INT_MAX,
3378 val.u = simple_strntoull(str,
3379 field_width >= 0 ? field_width : INT_MAX,
3382 switch (qualifier) {
3383 case 'H': /* that's 'hh' in format */
3385 *va_arg(args, signed char *) = val.s;
3387 *va_arg(args, unsigned char *) = val.u;
3391 *va_arg(args, short *) = val.s;
3393 *va_arg(args, unsigned short *) = val.u;
3397 *va_arg(args, long *) = val.s;
3399 *va_arg(args, unsigned long *) = val.u;
3403 *va_arg(args, long long *) = val.s;
3405 *va_arg(args, unsigned long long *) = val.u;
3408 *va_arg(args, size_t *) = val.u;
3412 *va_arg(args, int *) = val.s;
3414 *va_arg(args, unsigned int *) = val.u;
3426 EXPORT_SYMBOL(vsscanf);
3429 * sscanf - Unformat a buffer into a list of arguments
3430 * @buf: input buffer
3431 * @fmt: formatting of buffer
3432 * @...: resulting arguments
3434 int sscanf(const char *buf, const char *fmt, ...)
3439 va_start(args, fmt);
3440 i = vsscanf(buf, fmt, args);
3445 EXPORT_SYMBOL(sscanf);