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>
57 * simple_strtoull - convert a string to an unsigned long long
58 * @cp: The start of the string
59 * @endp: A pointer to the end of the parsed string will be placed here
60 * @base: The number base to use
62 * This function has caveats. Please use kstrtoull instead.
64 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
66 unsigned long long result;
69 cp = _parse_integer_fixup_radix(cp, &base);
70 rv = _parse_integer(cp, base, &result);
72 cp += (rv & ~KSTRTOX_OVERFLOW);
79 EXPORT_SYMBOL(simple_strtoull);
82 * simple_strtoul - convert a string to an unsigned 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 kstrtoul instead.
89 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
91 return simple_strtoull(cp, endp, base);
93 EXPORT_SYMBOL(simple_strtoul);
96 * simple_strtol - convert a string to a signed 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 kstrtol instead.
103 long simple_strtol(const char *cp, char **endp, unsigned int base)
106 return -simple_strtoul(cp + 1, endp, base);
108 return simple_strtoul(cp, endp, base);
110 EXPORT_SYMBOL(simple_strtol);
113 * simple_strtoll - convert a string to a signed long long
114 * @cp: The start of the string
115 * @endp: A pointer to the end of the parsed string will be placed here
116 * @base: The number base to use
118 * This function has caveats. Please use kstrtoll instead.
120 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
123 return -simple_strtoull(cp + 1, endp, base);
125 return simple_strtoull(cp, endp, base);
127 EXPORT_SYMBOL(simple_strtoll);
129 static noinline_for_stack
130 int skip_atoi(const char **s)
135 i = i*10 + *((*s)++) - '0';
136 } while (isdigit(**s));
142 * Decimal conversion is by far the most typical, and is used for
143 * /proc and /sys data. This directly impacts e.g. top performance
144 * with many processes running. We optimize it for speed by emitting
145 * two characters at a time, using a 200 byte lookup table. This
146 * roughly halves the number of multiplications compared to computing
147 * the digits one at a time. Implementation strongly inspired by the
148 * previous version, which in turn used ideas described at
149 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
150 * from the author, Douglas W. Jones).
152 * It turns out there is precisely one 26 bit fixed-point
153 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
154 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
155 * range happens to be somewhat larger (x <= 1073741898), but that's
156 * irrelevant for our purpose.
158 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
159 * need a 32x32->64 bit multiply, so we simply use the same constant.
161 * For dividing a number in the range [100, 10^4-1] by 100, there are
162 * several options. The simplest is (x * 0x147b) >> 19, which is valid
163 * for all x <= 43698.
166 static const u16 decpair[100] = {
167 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
168 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
169 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
170 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
171 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
172 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
173 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
174 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
175 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
176 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
177 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
182 * This will print a single '0' even if r == 0, since we would
183 * immediately jump to out_r where two 0s would be written but only
184 * one of them accounted for in buf. This is needed by ip4_string
185 * below. All other callers pass a non-zero value of r.
187 static noinline_for_stack
188 char *put_dec_trunc8(char *buf, unsigned r)
196 /* 100 <= r < 10^8 */
197 q = (r * (u64)0x28f5c29) >> 32;
198 *((u16 *)buf) = decpair[r - 100*q];
205 /* 100 <= q < 10^6 */
206 r = (q * (u64)0x28f5c29) >> 32;
207 *((u16 *)buf) = decpair[q - 100*r];
214 /* 100 <= r < 10^4 */
215 q = (r * 0x147b) >> 19;
216 *((u16 *)buf) = decpair[r - 100*q];
223 *((u16 *)buf) = decpair[r];
224 buf += r < 10 ? 1 : 2;
228 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
229 static noinline_for_stack
230 char *put_dec_full8(char *buf, unsigned r)
235 q = (r * (u64)0x28f5c29) >> 32;
236 *((u16 *)buf) = decpair[r - 100*q];
240 r = (q * (u64)0x28f5c29) >> 32;
241 *((u16 *)buf) = decpair[q - 100*r];
245 q = (r * 0x147b) >> 19;
246 *((u16 *)buf) = decpair[r - 100*q];
250 *((u16 *)buf) = decpair[q];
255 static noinline_for_stack
256 char *put_dec(char *buf, unsigned long long n)
258 if (n >= 100*1000*1000)
259 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
260 /* 1 <= n <= 1.6e11 */
261 if (n >= 100*1000*1000)
262 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
264 return put_dec_trunc8(buf, n);
267 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
270 put_dec_full4(char *buf, unsigned r)
275 q = (r * 0x147b) >> 19;
276 *((u16 *)buf) = decpair[r - 100*q];
279 *((u16 *)buf) = decpair[q];
283 * Call put_dec_full4 on x % 10000, return x / 10000.
284 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
285 * holds for all x < 1,128,869,999. The largest value this
286 * helper will ever be asked to convert is 1,125,520,955.
287 * (second call in the put_dec code, assuming n is all-ones).
289 static noinline_for_stack
290 unsigned put_dec_helper4(char *buf, unsigned x)
292 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
294 put_dec_full4(buf, x - q * 10000);
298 /* Based on code by Douglas W. Jones found at
299 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
300 * (with permission from the author).
301 * Performs no 64-bit division and hence should be fast on 32-bit machines.
304 char *put_dec(char *buf, unsigned long long n)
306 uint32_t d3, d2, d1, q, h;
308 if (n < 100*1000*1000)
309 return put_dec_trunc8(buf, n);
311 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
314 d3 = (h >> 16); /* implicit "& 0xffff" */
316 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
317 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
318 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
319 q = put_dec_helper4(buf, q);
321 q += 7671 * d3 + 9496 * d2 + 6 * d1;
322 q = put_dec_helper4(buf+4, q);
324 q += 4749 * d3 + 42 * d2;
325 q = put_dec_helper4(buf+8, q);
330 buf = put_dec_trunc8(buf, q);
331 else while (buf[-1] == '0')
340 * Convert passed number to decimal string.
341 * Returns the length of string. On buffer overflow, returns 0.
343 * If speed is not important, use snprintf(). It's easy to read the code.
345 int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
347 /* put_dec requires 2-byte alignment of the buffer. */
348 char tmp[sizeof(num) * 3] __aligned(2);
351 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
356 len = put_dec(tmp, num) - tmp;
359 if (len > size || width > size)
364 for (idx = 0; idx < width; idx++)
370 for (idx = 0; idx < len; ++idx)
371 buf[idx + width] = tmp[len - idx - 1];
376 #define SIGN 1 /* unsigned/signed, must be 1 */
377 #define LEFT 2 /* left justified */
378 #define PLUS 4 /* show plus */
379 #define SPACE 8 /* space if plus */
380 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
381 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
382 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
384 static_assert(ZEROPAD == ('0' - ' '));
385 static_assert(SMALL == ' ');
388 FORMAT_TYPE_NONE, /* Just a string part */
390 FORMAT_TYPE_PRECISION,
394 FORMAT_TYPE_PERCENT_CHAR,
396 FORMAT_TYPE_LONG_LONG,
410 unsigned int type:8; /* format_type enum */
411 signed int field_width:24; /* width of output field */
412 unsigned int flags:8; /* flags to number() */
413 unsigned int base:8; /* number base, 8, 10 or 16 only */
414 signed int precision:16; /* # of digits/chars */
416 static_assert(sizeof(struct printf_spec) == 8);
418 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
419 #define PRECISION_MAX ((1 << 15) - 1)
421 static noinline_for_stack
422 char *number(char *buf, char *end, unsigned long long num,
423 struct printf_spec spec)
425 /* put_dec requires 2-byte alignment of the buffer. */
426 char tmp[3 * sizeof(num)] __aligned(2);
429 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
431 bool is_zero = num == 0LL;
432 int field_width = spec.field_width;
433 int precision = spec.precision;
435 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
436 * produces same digits or (maybe lowercased) letters */
437 locase = (spec.flags & SMALL);
438 if (spec.flags & LEFT)
439 spec.flags &= ~ZEROPAD;
441 if (spec.flags & SIGN) {
442 if ((signed long long)num < 0) {
444 num = -(signed long long)num;
446 } else if (spec.flags & PLUS) {
449 } else if (spec.flags & SPACE) {
461 /* generate full string in tmp[], in reverse order */
464 tmp[i++] = hex_asc_upper[num] | locase;
465 else if (spec.base != 10) { /* 8 or 16 */
466 int mask = spec.base - 1;
472 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
475 } else { /* base 10 */
476 i = put_dec(tmp, num) - tmp;
479 /* printing 100 using %2d gives "100", not "00" */
482 /* leading space padding */
483 field_width -= precision;
484 if (!(spec.flags & (ZEROPAD | LEFT))) {
485 while (--field_width >= 0) {
497 /* "0x" / "0" prefix */
499 if (spec.base == 16 || !is_zero) {
504 if (spec.base == 16) {
506 *buf = ('X' | locase);
510 /* zero or space padding */
511 if (!(spec.flags & LEFT)) {
512 char c = ' ' + (spec.flags & ZEROPAD);
514 while (--field_width >= 0) {
520 /* hmm even more zero padding? */
521 while (i <= --precision) {
526 /* actual digits of result */
532 /* trailing space padding */
533 while (--field_width >= 0) {
542 static noinline_for_stack
543 char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
545 struct printf_spec spec;
547 spec.type = FORMAT_TYPE_PTR;
548 spec.field_width = 2 + 2 * size; /* 0x + hex */
549 spec.flags = SPECIAL | SMALL | ZEROPAD;
553 return number(buf, end, num, spec);
556 static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
559 if (buf >= end) /* nowhere to put anything */
562 if (size <= spaces) {
563 memset(buf, ' ', size);
567 if (len > size - spaces)
569 memmove(buf + spaces, buf, len);
571 memset(buf, ' ', spaces);
575 * Handle field width padding for a string.
576 * @buf: current buffer position
577 * @n: length of string
578 * @end: end of output buffer
579 * @spec: for field width and flags
580 * Returns: new buffer position after padding.
582 static noinline_for_stack
583 char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
587 if (likely(n >= spec.field_width))
589 /* we want to pad the sucker */
590 spaces = spec.field_width - n;
591 if (!(spec.flags & LEFT)) {
592 move_right(buf - n, end, n, spaces);
603 /* Handle string from a well known address. */
604 static char *string_nocheck(char *buf, char *end, const char *s,
605 struct printf_spec spec)
608 int lim = spec.precision;
619 return widen_string(buf, len, end, spec);
622 static char *err_ptr(char *buf, char *end, void *ptr,
623 struct printf_spec spec)
625 int err = PTR_ERR(ptr);
626 const char *sym = errname(err);
629 return string_nocheck(buf, end, sym, spec);
632 * Somebody passed ERR_PTR(-1234) or some other non-existing
633 * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to
634 * printing it as its decimal representation.
638 return number(buf, end, err, spec);
641 /* Be careful: error messages must fit into the given buffer. */
642 static char *error_string(char *buf, char *end, const char *s,
643 struct printf_spec spec)
646 * Hard limit to avoid a completely insane messages. It actually
647 * works pretty well because most error messages are in
648 * the many pointer format modifiers.
650 if (spec.precision == -1)
651 spec.precision = 2 * sizeof(void *);
653 return string_nocheck(buf, end, s, spec);
657 * Do not call any complex external code here. Nested printk()/vsprintf()
658 * might cause infinite loops. Failures might break printk() and would
661 static const char *check_pointer_msg(const void *ptr)
666 if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
672 static int check_pointer(char **buf, char *end, const void *ptr,
673 struct printf_spec spec)
677 err_msg = check_pointer_msg(ptr);
679 *buf = error_string(*buf, end, err_msg, spec);
686 static noinline_for_stack
687 char *string(char *buf, char *end, const char *s,
688 struct printf_spec spec)
690 if (check_pointer(&buf, end, s, spec))
693 return string_nocheck(buf, end, s, spec);
696 static char *pointer_string(char *buf, char *end,
698 struct printf_spec spec)
702 if (spec.field_width == -1) {
703 spec.field_width = 2 * sizeof(ptr);
704 spec.flags |= ZEROPAD;
707 return number(buf, end, (unsigned long int)ptr, spec);
710 /* Make pointers available for printing early in the boot sequence. */
711 static int debug_boot_weak_hash __ro_after_init;
713 static int __init debug_boot_weak_hash_enable(char *str)
715 debug_boot_weak_hash = 1;
716 pr_info("debug_boot_weak_hash enabled\n");
719 early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable);
721 static DEFINE_STATIC_KEY_TRUE(not_filled_random_ptr_key);
722 static siphash_key_t ptr_key __read_mostly;
724 static void enable_ptr_key_workfn(struct work_struct *work)
726 get_random_bytes(&ptr_key, sizeof(ptr_key));
727 /* Needs to run from preemptible context */
728 static_branch_disable(¬_filled_random_ptr_key);
731 static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn);
733 static void fill_random_ptr_key(struct random_ready_callback *unused)
735 /* This may be in an interrupt handler. */
736 queue_work(system_unbound_wq, &enable_ptr_key_work);
739 static struct random_ready_callback random_ready = {
740 .func = fill_random_ptr_key
743 static int __init initialize_ptr_random(void)
745 int key_size = sizeof(ptr_key);
748 /* Use hw RNG if available. */
749 if (get_random_bytes_arch(&ptr_key, key_size) == key_size) {
750 static_branch_disable(¬_filled_random_ptr_key);
754 ret = add_random_ready_callback(&random_ready);
757 } else if (ret == -EALREADY) {
758 /* This is in preemptible context */
759 enable_ptr_key_workfn(&enable_ptr_key_work);
765 early_initcall(initialize_ptr_random);
767 /* Maps a pointer to a 32 bit unique identifier. */
768 static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
770 unsigned long hashval;
772 if (static_branch_unlikely(¬_filled_random_ptr_key))
776 hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
778 * Mask off the first 32 bits, this makes explicit that we have
779 * modified the address (and 32 bits is plenty for a unique ID).
781 hashval = hashval & 0xffffffff;
783 hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
785 *hashval_out = hashval;
789 int ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
791 return __ptr_to_hashval(ptr, hashval_out);
794 static char *ptr_to_id(char *buf, char *end, const void *ptr,
795 struct printf_spec spec)
797 const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
798 unsigned long hashval;
802 * Print the real pointer value for NULL and error pointers,
803 * as they are not actual addresses.
805 if (IS_ERR_OR_NULL(ptr))
806 return pointer_string(buf, end, ptr, spec);
808 /* When debugging early boot use non-cryptographically secure hash. */
809 if (unlikely(debug_boot_weak_hash)) {
810 hashval = hash_long((unsigned long)ptr, 32);
811 return pointer_string(buf, end, (const void *)hashval, spec);
814 ret = __ptr_to_hashval(ptr, &hashval);
816 spec.field_width = 2 * sizeof(ptr);
817 /* string length must be less than default_width */
818 return error_string(buf, end, str, spec);
821 return pointer_string(buf, end, (const void *)hashval, spec);
824 int kptr_restrict __read_mostly;
826 static noinline_for_stack
827 char *restricted_pointer(char *buf, char *end, const void *ptr,
828 struct printf_spec spec)
830 switch (kptr_restrict) {
832 /* Handle as %p, hash and do _not_ leak addresses. */
833 return ptr_to_id(buf, end, ptr, spec);
835 const struct cred *cred;
838 * kptr_restrict==1 cannot be used in IRQ context
839 * because its test for CAP_SYSLOG would be meaningless.
841 if (in_irq() || in_serving_softirq() || in_nmi()) {
842 if (spec.field_width == -1)
843 spec.field_width = 2 * sizeof(ptr);
844 return error_string(buf, end, "pK-error", spec);
848 * Only print the real pointer value if the current
849 * process has CAP_SYSLOG and is running with the
850 * same credentials it started with. This is because
851 * access to files is checked at open() time, but %pK
852 * checks permission at read() time. We don't want to
853 * leak pointer values if a binary opens a file using
854 * %pK and then elevates privileges before reading it.
856 cred = current_cred();
857 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
858 !uid_eq(cred->euid, cred->uid) ||
859 !gid_eq(cred->egid, cred->gid))
865 /* Always print 0's for %pK */
870 return pointer_string(buf, end, ptr, spec);
873 static noinline_for_stack
874 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
877 const char *array[4], *s;
878 const struct dentry *p;
883 case '2': case '3': case '4':
884 depth = fmt[1] - '0';
891 for (i = 0; i < depth; i++, d = p) {
892 if (check_pointer(&buf, end, d, spec)) {
897 p = READ_ONCE(d->d_parent);
898 array[i] = READ_ONCE(d->d_name.name);
907 for (n = 0; n != spec.precision; n++, buf++) {
919 return widen_string(buf, n, end, spec);
922 static noinline_for_stack
923 char *file_dentry_name(char *buf, char *end, const struct file *f,
924 struct printf_spec spec, const char *fmt)
926 if (check_pointer(&buf, end, f, spec))
929 return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
932 static noinline_for_stack
933 char *bdev_name(char *buf, char *end, struct block_device *bdev,
934 struct printf_spec spec, const char *fmt)
938 if (check_pointer(&buf, end, bdev, spec))
942 buf = string(buf, end, hd->disk_name, spec);
943 if (bdev->bd_partno) {
944 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
949 buf = number(buf, end, bdev->bd_partno, spec);
955 static noinline_for_stack
956 char *symbol_string(char *buf, char *end, void *ptr,
957 struct printf_spec spec, const char *fmt)
960 #ifdef CONFIG_KALLSYMS
961 char sym[KSYM_SYMBOL_LEN];
965 ptr = __builtin_extract_return_addr(ptr);
966 value = (unsigned long)ptr;
968 #ifdef CONFIG_KALLSYMS
970 sprint_backtrace(sym, value);
971 else if (*fmt != 's')
972 sprint_symbol(sym, value);
974 sprint_symbol_no_offset(sym, value);
976 return string_nocheck(buf, end, sym, spec);
978 return special_hex_number(buf, end, value, sizeof(void *));
982 static const struct printf_spec default_str_spec = {
987 static const struct printf_spec default_flag_spec = {
990 .flags = SPECIAL | SMALL,
993 static const struct printf_spec default_dec_spec = {
998 static const struct printf_spec default_dec02_spec = {
1005 static const struct printf_spec default_dec04_spec = {
1012 static noinline_for_stack
1013 char *resource_string(char *buf, char *end, struct resource *res,
1014 struct printf_spec spec, const char *fmt)
1016 #ifndef IO_RSRC_PRINTK_SIZE
1017 #define IO_RSRC_PRINTK_SIZE 6
1020 #ifndef MEM_RSRC_PRINTK_SIZE
1021 #define MEM_RSRC_PRINTK_SIZE 10
1023 static const struct printf_spec io_spec = {
1025 .field_width = IO_RSRC_PRINTK_SIZE,
1027 .flags = SPECIAL | SMALL | ZEROPAD,
1029 static const struct printf_spec mem_spec = {
1031 .field_width = MEM_RSRC_PRINTK_SIZE,
1033 .flags = SPECIAL | SMALL | ZEROPAD,
1035 static const struct printf_spec bus_spec = {
1039 .flags = SMALL | ZEROPAD,
1041 static const struct printf_spec str_spec = {
1047 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1048 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1049 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1050 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
1051 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
1052 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1053 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
1054 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
1056 char *p = sym, *pend = sym + sizeof(sym);
1057 int decode = (fmt[0] == 'R') ? 1 : 0;
1058 const struct printf_spec *specp;
1060 if (check_pointer(&buf, end, res, spec))
1064 if (res->flags & IORESOURCE_IO) {
1065 p = string_nocheck(p, pend, "io ", str_spec);
1067 } else if (res->flags & IORESOURCE_MEM) {
1068 p = string_nocheck(p, pend, "mem ", str_spec);
1070 } else if (res->flags & IORESOURCE_IRQ) {
1071 p = string_nocheck(p, pend, "irq ", str_spec);
1072 specp = &default_dec_spec;
1073 } else if (res->flags & IORESOURCE_DMA) {
1074 p = string_nocheck(p, pend, "dma ", str_spec);
1075 specp = &default_dec_spec;
1076 } else if (res->flags & IORESOURCE_BUS) {
1077 p = string_nocheck(p, pend, "bus ", str_spec);
1080 p = string_nocheck(p, pend, "??? ", str_spec);
1084 if (decode && res->flags & IORESOURCE_UNSET) {
1085 p = string_nocheck(p, pend, "size ", str_spec);
1086 p = number(p, pend, resource_size(res), *specp);
1088 p = number(p, pend, res->start, *specp);
1089 if (res->start != res->end) {
1091 p = number(p, pend, res->end, *specp);
1095 if (res->flags & IORESOURCE_MEM_64)
1096 p = string_nocheck(p, pend, " 64bit", str_spec);
1097 if (res->flags & IORESOURCE_PREFETCH)
1098 p = string_nocheck(p, pend, " pref", str_spec);
1099 if (res->flags & IORESOURCE_WINDOW)
1100 p = string_nocheck(p, pend, " window", str_spec);
1101 if (res->flags & IORESOURCE_DISABLED)
1102 p = string_nocheck(p, pend, " disabled", str_spec);
1104 p = string_nocheck(p, pend, " flags ", str_spec);
1105 p = number(p, pend, res->flags, default_flag_spec);
1110 return string_nocheck(buf, end, sym, spec);
1113 static noinline_for_stack
1114 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1117 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
1118 negative value, fallback to the default */
1121 if (spec.field_width == 0)
1122 /* nothing to print */
1125 if (check_pointer(&buf, end, addr, spec))
1143 if (spec.field_width > 0)
1144 len = min_t(int, spec.field_width, 64);
1146 for (i = 0; i < len; ++i) {
1148 *buf = hex_asc_hi(addr[i]);
1151 *buf = hex_asc_lo(addr[i]);
1154 if (separator && i != len - 1) {
1164 static noinline_for_stack
1165 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
1166 struct printf_spec spec, const char *fmt)
1168 const int CHUNKSZ = 32;
1169 int nr_bits = max_t(int, spec.field_width, 0);
1173 if (check_pointer(&buf, end, bitmap, spec))
1176 /* reused to print numbers */
1177 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
1179 chunksz = nr_bits & (CHUNKSZ - 1);
1183 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
1184 for (; i >= 0; i -= CHUNKSZ) {
1188 chunkmask = ((1ULL << chunksz) - 1);
1189 word = i / BITS_PER_LONG;
1190 bit = i % BITS_PER_LONG;
1191 val = (bitmap[word] >> bit) & chunkmask;
1200 spec.field_width = DIV_ROUND_UP(chunksz, 4);
1201 buf = number(buf, end, val, spec);
1208 static noinline_for_stack
1209 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
1210 struct printf_spec spec, const char *fmt)
1212 int nr_bits = max_t(int, spec.field_width, 0);
1213 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
1214 int cur, rbot, rtop;
1217 if (check_pointer(&buf, end, bitmap, spec))
1220 rbot = cur = find_first_bit(bitmap, nr_bits);
1221 while (cur < nr_bits) {
1223 cur = find_next_bit(bitmap, nr_bits, cur + 1);
1224 if (cur < nr_bits && cur <= rtop + 1)
1234 buf = number(buf, end, rbot, default_dec_spec);
1240 buf = number(buf, end, rtop, default_dec_spec);
1248 static noinline_for_stack
1249 char *mac_address_string(char *buf, char *end, u8 *addr,
1250 struct printf_spec spec, const char *fmt)
1252 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
1256 bool reversed = false;
1258 if (check_pointer(&buf, end, addr, spec))
1275 for (i = 0; i < 6; i++) {
1277 p = hex_byte_pack(p, addr[5 - i]);
1279 p = hex_byte_pack(p, addr[i]);
1281 if (fmt[0] == 'M' && i != 5)
1286 return string_nocheck(buf, end, mac_addr, spec);
1289 static noinline_for_stack
1290 char *ip4_string(char *p, const u8 *addr, const char *fmt)
1293 bool leading_zeros = (fmt[0] == 'i');
1318 for (i = 0; i < 4; i++) {
1319 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
1320 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1321 if (leading_zeros) {
1327 /* reverse the digits in the quad */
1329 *p++ = temp[digits];
1339 static noinline_for_stack
1340 char *ip6_compressed_string(char *p, const char *addr)
1343 unsigned char zerolength[8];
1348 bool needcolon = false;
1350 struct in6_addr in6;
1352 memcpy(&in6, addr, sizeof(struct in6_addr));
1354 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1356 memset(zerolength, 0, sizeof(zerolength));
1363 /* find position of longest 0 run */
1364 for (i = 0; i < range; i++) {
1365 for (j = i; j < range; j++) {
1366 if (in6.s6_addr16[j] != 0)
1371 for (i = 0; i < range; i++) {
1372 if (zerolength[i] > longest) {
1373 longest = zerolength[i];
1377 if (longest == 1) /* don't compress a single 0 */
1381 for (i = 0; i < range; i++) {
1382 if (i == colonpos) {
1383 if (needcolon || i == 0)
1394 /* hex u16 without leading 0s */
1395 word = ntohs(in6.s6_addr16[i]);
1400 p = hex_byte_pack(p, hi);
1402 *p++ = hex_asc_lo(hi);
1403 p = hex_byte_pack(p, lo);
1406 p = hex_byte_pack(p, lo);
1408 *p++ = hex_asc_lo(lo);
1415 p = ip4_string(p, &in6.s6_addr[12], "I4");
1422 static noinline_for_stack
1423 char *ip6_string(char *p, const char *addr, const char *fmt)
1427 for (i = 0; i < 8; i++) {
1428 p = hex_byte_pack(p, *addr++);
1429 p = hex_byte_pack(p, *addr++);
1430 if (fmt[0] == 'I' && i != 7)
1438 static noinline_for_stack
1439 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1440 struct printf_spec spec, const char *fmt)
1442 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1444 if (fmt[0] == 'I' && fmt[2] == 'c')
1445 ip6_compressed_string(ip6_addr, addr);
1447 ip6_string(ip6_addr, addr, fmt);
1449 return string_nocheck(buf, end, ip6_addr, spec);
1452 static noinline_for_stack
1453 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1454 struct printf_spec spec, const char *fmt)
1456 char ip4_addr[sizeof("255.255.255.255")];
1458 ip4_string(ip4_addr, addr, fmt);
1460 return string_nocheck(buf, end, ip4_addr, spec);
1463 static noinline_for_stack
1464 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1465 struct printf_spec spec, const char *fmt)
1467 bool have_p = false, have_s = false, have_f = false, have_c = false;
1468 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1469 sizeof(":12345") + sizeof("/123456789") +
1470 sizeof("%1234567890")];
1471 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1472 const u8 *addr = (const u8 *) &sa->sin6_addr;
1473 char fmt6[2] = { fmt[0], '6' };
1477 while (isalpha(*++fmt)) {
1494 if (have_p || have_s || have_f) {
1499 if (fmt6[0] == 'I' && have_c)
1500 p = ip6_compressed_string(ip6_addr + off, addr);
1502 p = ip6_string(ip6_addr + off, addr, fmt6);
1504 if (have_p || have_s || have_f)
1509 p = number(p, pend, ntohs(sa->sin6_port), spec);
1513 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1514 IPV6_FLOWINFO_MASK), spec);
1518 p = number(p, pend, sa->sin6_scope_id, spec);
1522 return string_nocheck(buf, end, ip6_addr, spec);
1525 static noinline_for_stack
1526 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1527 struct printf_spec spec, const char *fmt)
1529 bool have_p = false;
1530 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1531 char *pend = ip4_addr + sizeof(ip4_addr);
1532 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1533 char fmt4[3] = { fmt[0], '4', 0 };
1536 while (isalpha(*++fmt)) {
1550 p = ip4_string(ip4_addr, addr, fmt4);
1553 p = number(p, pend, ntohs(sa->sin_port), spec);
1557 return string_nocheck(buf, end, ip4_addr, spec);
1560 static noinline_for_stack
1561 char *ip_addr_string(char *buf, char *end, const void *ptr,
1562 struct printf_spec spec, const char *fmt)
1566 if (check_pointer(&buf, end, ptr, spec))
1571 return ip6_addr_string(buf, end, ptr, spec, fmt);
1573 return ip4_addr_string(buf, end, ptr, spec, fmt);
1576 struct sockaddr raw;
1577 struct sockaddr_in v4;
1578 struct sockaddr_in6 v6;
1581 switch (sa->raw.sa_family) {
1583 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1585 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1587 return error_string(buf, end, "(einval)", spec);
1591 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
1592 return error_string(buf, end, err_fmt_msg, spec);
1595 static noinline_for_stack
1596 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1601 unsigned int flags = 0;
1604 if (spec.field_width == 0)
1605 return buf; /* nothing to print */
1607 if (check_pointer(&buf, end, addr, spec))
1611 switch (fmt[count++]) {
1613 flags |= ESCAPE_ANY;
1616 flags |= ESCAPE_SPECIAL;
1619 flags |= ESCAPE_HEX;
1622 flags |= ESCAPE_NULL;
1625 flags |= ESCAPE_OCTAL;
1631 flags |= ESCAPE_SPACE;
1640 flags = ESCAPE_ANY_NP;
1642 len = spec.field_width < 0 ? 1 : spec.field_width;
1645 * string_escape_mem() writes as many characters as it can to
1646 * the given buffer, and returns the total size of the output
1647 * had the buffer been big enough.
1649 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1654 static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1655 struct printf_spec spec, const char *fmt)
1659 if (check_pointer(&buf, end, va_fmt, spec))
1662 va_copy(va, *va_fmt->va);
1663 buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
1669 static noinline_for_stack
1670 char *uuid_string(char *buf, char *end, const u8 *addr,
1671 struct printf_spec spec, const char *fmt)
1673 char uuid[UUID_STRING_LEN + 1];
1676 const u8 *index = uuid_index;
1679 if (check_pointer(&buf, end, addr, spec))
1694 for (i = 0; i < 16; i++) {
1696 p = hex_byte_pack_upper(p, addr[index[i]]);
1698 p = hex_byte_pack(p, addr[index[i]]);
1711 return string_nocheck(buf, end, uuid, spec);
1714 static noinline_for_stack
1715 char *netdev_bits(char *buf, char *end, const void *addr,
1716 struct printf_spec spec, const char *fmt)
1718 unsigned long long num;
1721 if (check_pointer(&buf, end, addr, spec))
1726 num = *(const netdev_features_t *)addr;
1727 size = sizeof(netdev_features_t);
1730 return error_string(buf, end, "(%pN?)", spec);
1733 return special_hex_number(buf, end, num, size);
1736 static noinline_for_stack
1737 char *address_val(char *buf, char *end, const void *addr,
1738 struct printf_spec spec, const char *fmt)
1740 unsigned long long num;
1743 if (check_pointer(&buf, end, addr, spec))
1748 num = *(const dma_addr_t *)addr;
1749 size = sizeof(dma_addr_t);
1753 num = *(const phys_addr_t *)addr;
1754 size = sizeof(phys_addr_t);
1758 return special_hex_number(buf, end, num, size);
1761 static noinline_for_stack
1762 char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1764 int year = tm->tm_year + (r ? 0 : 1900);
1765 int mon = tm->tm_mon + (r ? 0 : 1);
1767 buf = number(buf, end, year, default_dec04_spec);
1772 buf = number(buf, end, mon, default_dec02_spec);
1777 return number(buf, end, tm->tm_mday, default_dec02_spec);
1780 static noinline_for_stack
1781 char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1783 buf = number(buf, end, tm->tm_hour, default_dec02_spec);
1788 buf = number(buf, end, tm->tm_min, default_dec02_spec);
1793 return number(buf, end, tm->tm_sec, default_dec02_spec);
1796 static noinline_for_stack
1797 char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1798 struct printf_spec spec, const char *fmt)
1800 bool have_t = true, have_d = true;
1804 if (check_pointer(&buf, end, tm, spec))
1807 switch (fmt[count]) {
1818 raw = fmt[count] == 'r';
1821 buf = date_str(buf, end, tm, raw);
1822 if (have_d && have_t) {
1823 /* Respect ISO 8601 */
1829 buf = time_str(buf, end, tm, raw);
1834 static noinline_for_stack
1835 char *time64_str(char *buf, char *end, const time64_t time,
1836 struct printf_spec spec, const char *fmt)
1838 struct rtc_time rtc_time;
1841 time64_to_tm(time, 0, &tm);
1843 rtc_time.tm_sec = tm.tm_sec;
1844 rtc_time.tm_min = tm.tm_min;
1845 rtc_time.tm_hour = tm.tm_hour;
1846 rtc_time.tm_mday = tm.tm_mday;
1847 rtc_time.tm_mon = tm.tm_mon;
1848 rtc_time.tm_year = tm.tm_year;
1849 rtc_time.tm_wday = tm.tm_wday;
1850 rtc_time.tm_yday = tm.tm_yday;
1852 rtc_time.tm_isdst = 0;
1854 return rtc_str(buf, end, &rtc_time, spec, fmt);
1857 static noinline_for_stack
1858 char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
1863 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
1865 return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
1867 return error_string(buf, end, "(%pt?)", spec);
1871 static noinline_for_stack
1872 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1875 if (!IS_ENABLED(CONFIG_HAVE_CLK))
1876 return error_string(buf, end, "(%pC?)", spec);
1878 if (check_pointer(&buf, end, clk, spec))
1884 #ifdef CONFIG_COMMON_CLK
1885 return string(buf, end, __clk_get_name(clk), spec);
1887 return ptr_to_id(buf, end, clk, spec);
1893 char *format_flags(char *buf, char *end, unsigned long flags,
1894 const struct trace_print_flags *names)
1898 for ( ; flags && names->name; names++) {
1900 if ((flags & mask) != mask)
1903 buf = string(buf, end, names->name, default_str_spec);
1914 buf = number(buf, end, flags, default_flag_spec);
1919 static noinline_for_stack
1920 char *flags_string(char *buf, char *end, void *flags_ptr,
1921 struct printf_spec spec, const char *fmt)
1923 unsigned long flags;
1924 const struct trace_print_flags *names;
1926 if (check_pointer(&buf, end, flags_ptr, spec))
1931 flags = *(unsigned long *)flags_ptr;
1932 /* Remove zone id */
1933 flags &= (1UL << NR_PAGEFLAGS) - 1;
1934 names = pageflag_names;
1937 flags = *(unsigned long *)flags_ptr;
1938 names = vmaflag_names;
1941 flags = (__force unsigned long)(*(gfp_t *)flags_ptr);
1942 names = gfpflag_names;
1945 return error_string(buf, end, "(%pG?)", spec);
1948 return format_flags(buf, end, flags, names);
1951 static noinline_for_stack
1952 char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
1957 /* Loop starting from the root node to the current node. */
1958 for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
1959 struct fwnode_handle *__fwnode =
1960 fwnode_get_nth_parent(fwnode, depth);
1962 buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
1964 buf = string(buf, end, fwnode_get_name(__fwnode),
1967 fwnode_handle_put(__fwnode);
1973 static noinline_for_stack
1974 char *device_node_string(char *buf, char *end, struct device_node *dn,
1975 struct printf_spec spec, const char *fmt)
1977 char tbuf[sizeof("xxxx") + 1];
1980 char *buf_start = buf;
1981 struct property *prop;
1982 bool has_mult, pass;
1984 struct printf_spec str_spec = spec;
1985 str_spec.field_width = -1;
1988 return error_string(buf, end, "(%pO?)", spec);
1990 if (!IS_ENABLED(CONFIG_OF))
1991 return error_string(buf, end, "(%pOF?)", spec);
1993 if (check_pointer(&buf, end, dn, spec))
1996 /* simple case without anything any more format specifiers */
1998 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
2001 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
2010 case 'f': /* full_name */
2011 buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
2014 case 'n': /* name */
2015 p = fwnode_get_name(of_fwnode_handle(dn));
2016 precision = str_spec.precision;
2017 str_spec.precision = strchrnul(p, '@') - p;
2018 buf = string(buf, end, p, str_spec);
2019 str_spec.precision = precision;
2021 case 'p': /* phandle */
2022 buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec);
2024 case 'P': /* path-spec */
2025 p = fwnode_get_name(of_fwnode_handle(dn));
2028 buf = string(buf, end, p, str_spec);
2030 case 'F': /* flags */
2031 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2032 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2033 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2034 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2036 buf = string_nocheck(buf, end, tbuf, str_spec);
2038 case 'c': /* major compatible string */
2039 ret = of_property_read_string(dn, "compatible", &p);
2041 buf = string(buf, end, p, str_spec);
2043 case 'C': /* full compatible string */
2045 of_property_for_each_string(dn, "compatible", prop, p) {
2047 buf = string_nocheck(buf, end, ",", str_spec);
2048 buf = string_nocheck(buf, end, "\"", str_spec);
2049 buf = string(buf, end, p, str_spec);
2050 buf = string_nocheck(buf, end, "\"", str_spec);
2060 return widen_string(buf, buf - buf_start, end, spec);
2063 static noinline_for_stack
2064 char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
2065 struct printf_spec spec, const char *fmt)
2067 struct printf_spec str_spec = spec;
2068 char *buf_start = buf;
2070 str_spec.field_width = -1;
2073 return error_string(buf, end, "(%pf?)", spec);
2075 if (check_pointer(&buf, end, fwnode, spec))
2081 case 'P': /* name */
2082 buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
2084 case 'f': /* full_name */
2086 buf = fwnode_full_name_string(fwnode, buf, end);
2090 return widen_string(buf, buf - buf_start, end, spec);
2094 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2095 * by an extra set of alphanumeric characters that are extended format
2098 * Please update scripts/checkpatch.pl when adding/removing conversion
2099 * characters. (Search for "check for vsprintf extension").
2101 * Right now we handle:
2103 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2104 * - 's' For symbolic direct pointers (or function descriptors) without offset
2105 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
2106 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2107 * %ps and %pS. Be careful when re-using these specifiers.
2108 * - 'B' For backtraced symbolic direct pointers with offset
2109 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2110 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2111 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2112 * width which must be explicitly specified either as part of the
2113 * format string '%32b[l]' or through '%*b[l]', [l] selects
2114 * range-list format instead of hex format
2115 * - 'M' For a 6-byte MAC address, it prints the address in the
2116 * usual colon-separated hex notation
2117 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2118 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2119 * with a dash-separated hex notation
2120 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2121 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2122 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2123 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
2125 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2126 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2127 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2128 * IPv6 omits the colons (01020304...0f)
2129 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2131 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2132 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2133 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2134 * - 'I[6S]c' for IPv6 addresses printed as specified by
2135 * https://tools.ietf.org/html/rfc5952
2136 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2137 * of the following flags (see string_escape_mem() for the
2140 * c - ESCAPE_SPECIAL
2146 * By default ESCAPE_ANY_NP is used.
2147 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2148 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2149 * Options for %pU are:
2150 * b big endian lower case hex (default)
2151 * B big endian UPPER case hex
2152 * l little endian lower case hex
2153 * L little endian UPPER case hex
2154 * big endian output byte order is:
2155 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2156 * little endian output byte order is:
2157 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2158 * - 'V' For a struct va_format which contains a format string * and va_list *,
2159 * call vsnprintf(->format, *->va_list).
2160 * Implements a "recursive vsnprintf".
2161 * Do not use this feature without some mechanism to verify the
2162 * correctness of the format string and va_list arguments.
2163 * - 'K' For a kernel pointer that should be hidden from unprivileged users
2164 * - 'NF' For a netdev_features_t
2165 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2166 * a certain separator (' ' by default):
2170 * The maximum supported length is 64 bytes of the input. Consider
2171 * to use print_hex_dump() for the larger input.
2172 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2173 * (default assumed to be phys_addr_t, passed by reference)
2174 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2175 * - 'D[234]' Same as 'd' but for a struct file
2176 * - 'g' For block_device name (gendisk + partition number)
2177 * - 't[RT][dt][r]' For time and date as represented by:
2180 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2181 * (legacy clock framework) of the clock
2182 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2183 * (legacy clock framework) of the clock
2184 * - 'G' For flags to be printed as a collection of symbolic strings that would
2185 * construct the specific value. Supported flags given by option:
2186 * p page flags (see struct page) given as pointer to unsigned long
2187 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2188 * v vma flags (VM_*) given as pointer to unsigned long
2189 * - 'OF[fnpPcCF]' For a device tree object
2190 * Without any optional arguments prints the full_name
2191 * f device node full_name
2192 * n device node name
2193 * p device node phandle
2194 * P device node path spec (name + @unit)
2195 * F device node flags
2196 * c major compatible string
2197 * C full compatible string
2198 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2199 * Without an option prints the full name of the node
2201 * P node name, including a possible unit address
2202 * - 'x' For printing the address. Equivalent to "%lx".
2203 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
2204 * bpf_trace_printk() where [ku] prefix specifies either kernel (k)
2205 * or user (u) memory to probe, and:
2206 * s a string, equivalent to "%s" on direct vsnprintf() use
2208 * ** When making changes please also update:
2209 * Documentation/core-api/printk-formats.rst
2211 * Note: The default behaviour (unadorned %p) is to hash the address,
2212 * rendering it useful as a unique identifier.
2214 static noinline_for_stack
2215 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2216 struct printf_spec spec)
2221 ptr = dereference_symbol_descriptor(ptr);
2224 return symbol_string(buf, end, ptr, spec, fmt);
2227 return resource_string(buf, end, ptr, spec, fmt);
2229 return hex_string(buf, end, ptr, spec, fmt);
2233 return bitmap_list_string(buf, end, ptr, spec, fmt);
2235 return bitmap_string(buf, end, ptr, spec, fmt);
2237 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2238 case 'm': /* Contiguous: 000102030405 */
2240 /* [mM]R (Reverse order; Bluetooth) */
2241 return mac_address_string(buf, end, ptr, spec, fmt);
2242 case 'I': /* Formatted IP supported
2244 * 6: 0001:0203:...:0708
2245 * 6c: 1::708 or 1::1.2.3.4
2247 case 'i': /* Contiguous:
2248 * 4: 001.002.003.004
2251 return ip_addr_string(buf, end, ptr, spec, fmt);
2253 return escaped_string(buf, end, ptr, spec, fmt);
2255 return uuid_string(buf, end, ptr, spec, fmt);
2257 return va_format(buf, end, ptr, spec, fmt);
2259 return restricted_pointer(buf, end, ptr, spec);
2261 return netdev_bits(buf, end, ptr, spec, fmt);
2263 return address_val(buf, end, ptr, spec, fmt);
2265 return dentry_name(buf, end, ptr, spec, fmt);
2267 return time_and_date(buf, end, ptr, spec, fmt);
2269 return clock(buf, end, ptr, spec, fmt);
2271 return file_dentry_name(buf, end, ptr, spec, fmt);
2274 return bdev_name(buf, end, ptr, spec, fmt);
2278 return flags_string(buf, end, ptr, spec, fmt);
2280 return device_node_string(buf, end, ptr, spec, fmt + 1);
2282 return fwnode_string(buf, end, ptr, spec, fmt + 1);
2284 return pointer_string(buf, end, ptr, spec);
2286 /* %pe with a non-ERR_PTR gets treated as plain %p */
2289 return err_ptr(buf, end, ptr, spec);
2294 return string(buf, end, ptr, spec);
2296 return error_string(buf, end, "(einval)", spec);
2300 /* default is to _not_ leak addresses, hash before printing */
2301 return ptr_to_id(buf, end, ptr, spec);
2305 * Helper function to decode printf style format.
2306 * Each call decode a token from the format and return the
2307 * number of characters read (or likely the delta where it wants
2308 * to go on the next call).
2309 * The decoded token is returned through the parameters
2311 * 'h', 'l', or 'L' for integer fields
2312 * 'z' support added 23/7/1999 S.H.
2313 * 'z' changed to 'Z' --davidm 1/25/99
2314 * 'Z' changed to 'z' --adobriyan 2017-01-25
2315 * 't' added for ptrdiff_t
2317 * @fmt: the format string
2318 * @type of the token returned
2319 * @flags: various flags such as +, -, # tokens..
2320 * @field_width: overwritten width
2321 * @base: base of the number (octal, hex, ...)
2322 * @precision: precision of a number
2323 * @qualifier: qualifier of a number (long, size_t, ...)
2325 static noinline_for_stack
2326 int format_decode(const char *fmt, struct printf_spec *spec)
2328 const char *start = fmt;
2331 /* we finished early by reading the field width */
2332 if (spec->type == FORMAT_TYPE_WIDTH) {
2333 if (spec->field_width < 0) {
2334 spec->field_width = -spec->field_width;
2335 spec->flags |= LEFT;
2337 spec->type = FORMAT_TYPE_NONE;
2341 /* we finished early by reading the precision */
2342 if (spec->type == FORMAT_TYPE_PRECISION) {
2343 if (spec->precision < 0)
2344 spec->precision = 0;
2346 spec->type = FORMAT_TYPE_NONE;
2351 spec->type = FORMAT_TYPE_NONE;
2353 for (; *fmt ; ++fmt) {
2358 /* Return the current non-format string */
2359 if (fmt != start || !*fmt)
2365 while (1) { /* this also skips first '%' */
2371 case '-': spec->flags |= LEFT; break;
2372 case '+': spec->flags |= PLUS; break;
2373 case ' ': spec->flags |= SPACE; break;
2374 case '#': spec->flags |= SPECIAL; break;
2375 case '0': spec->flags |= ZEROPAD; break;
2376 default: found = false;
2383 /* get field width */
2384 spec->field_width = -1;
2387 spec->field_width = skip_atoi(&fmt);
2388 else if (*fmt == '*') {
2389 /* it's the next argument */
2390 spec->type = FORMAT_TYPE_WIDTH;
2391 return ++fmt - start;
2395 /* get the precision */
2396 spec->precision = -1;
2399 if (isdigit(*fmt)) {
2400 spec->precision = skip_atoi(&fmt);
2401 if (spec->precision < 0)
2402 spec->precision = 0;
2403 } else if (*fmt == '*') {
2404 /* it's the next argument */
2405 spec->type = FORMAT_TYPE_PRECISION;
2406 return ++fmt - start;
2411 /* get the conversion qualifier */
2413 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2414 *fmt == 'z' || *fmt == 't') {
2416 if (unlikely(qualifier == *fmt)) {
2417 if (qualifier == 'l') {
2420 } else if (qualifier == 'h') {
2431 spec->type = FORMAT_TYPE_CHAR;
2432 return ++fmt - start;
2435 spec->type = FORMAT_TYPE_STR;
2436 return ++fmt - start;
2439 spec->type = FORMAT_TYPE_PTR;
2440 return ++fmt - start;
2443 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2444 return ++fmt - start;
2446 /* integer number formats - set up the flags and "break" */
2452 spec->flags |= SMALL;
2461 spec->flags |= SIGN;
2467 * Since %n poses a greater security risk than
2468 * utility, treat it as any other invalid or
2469 * unsupported format specifier.
2474 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2475 spec->type = FORMAT_TYPE_INVALID;
2479 if (qualifier == 'L')
2480 spec->type = FORMAT_TYPE_LONG_LONG;
2481 else if (qualifier == 'l') {
2482 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2483 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2484 } else if (qualifier == 'z') {
2485 spec->type = FORMAT_TYPE_SIZE_T;
2486 } else if (qualifier == 't') {
2487 spec->type = FORMAT_TYPE_PTRDIFF;
2488 } else if (qualifier == 'H') {
2489 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2490 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2491 } else if (qualifier == 'h') {
2492 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2493 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2495 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2496 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2499 return ++fmt - start;
2503 set_field_width(struct printf_spec *spec, int width)
2505 spec->field_width = width;
2506 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2507 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2512 set_precision(struct printf_spec *spec, int prec)
2514 spec->precision = prec;
2515 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2516 spec->precision = clamp(prec, 0, PRECISION_MAX);
2521 * vsnprintf - Format a string and place it in a buffer
2522 * @buf: The buffer to place the result into
2523 * @size: The size of the buffer, including the trailing null space
2524 * @fmt: The format string to use
2525 * @args: Arguments for the format string
2527 * This function generally follows C99 vsnprintf, but has some
2528 * extensions and a few limitations:
2530 * - ``%n`` is unsupported
2531 * - ``%p*`` is handled by pointer()
2533 * See pointer() or Documentation/core-api/printk-formats.rst for more
2534 * extensive description.
2536 * **Please update the documentation in both places when making changes**
2538 * The return value is the number of characters which would
2539 * be generated for the given input, excluding the trailing
2540 * '\0', as per ISO C99. If you want to have the exact
2541 * number of characters written into @buf as return value
2542 * (not including the trailing '\0'), use vscnprintf(). If the
2543 * return is greater than or equal to @size, the resulting
2544 * string is truncated.
2546 * If you're not already dealing with a va_list consider using snprintf().
2548 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2550 unsigned long long num;
2552 struct printf_spec spec = {0};
2554 /* Reject out-of-range values early. Large positive sizes are
2555 used for unknown buffer sizes. */
2556 if (WARN_ON_ONCE(size > INT_MAX))
2562 /* Make sure end is always >= buf */
2569 const char *old_fmt = fmt;
2570 int read = format_decode(fmt, &spec);
2574 switch (spec.type) {
2575 case FORMAT_TYPE_NONE: {
2578 if (copy > end - str)
2580 memcpy(str, old_fmt, copy);
2586 case FORMAT_TYPE_WIDTH:
2587 set_field_width(&spec, va_arg(args, int));
2590 case FORMAT_TYPE_PRECISION:
2591 set_precision(&spec, va_arg(args, int));
2594 case FORMAT_TYPE_CHAR: {
2597 if (!(spec.flags & LEFT)) {
2598 while (--spec.field_width > 0) {
2605 c = (unsigned char) va_arg(args, int);
2609 while (--spec.field_width > 0) {
2617 case FORMAT_TYPE_STR:
2618 str = string(str, end, va_arg(args, char *), spec);
2621 case FORMAT_TYPE_PTR:
2622 str = pointer(fmt, str, end, va_arg(args, void *),
2624 while (isalnum(*fmt))
2628 case FORMAT_TYPE_PERCENT_CHAR:
2634 case FORMAT_TYPE_INVALID:
2636 * Presumably the arguments passed gcc's type
2637 * checking, but there is no safe or sane way
2638 * for us to continue parsing the format and
2639 * fetching from the va_list; the remaining
2640 * specifiers and arguments would be out of
2646 switch (spec.type) {
2647 case FORMAT_TYPE_LONG_LONG:
2648 num = va_arg(args, long long);
2650 case FORMAT_TYPE_ULONG:
2651 num = va_arg(args, unsigned long);
2653 case FORMAT_TYPE_LONG:
2654 num = va_arg(args, long);
2656 case FORMAT_TYPE_SIZE_T:
2657 if (spec.flags & SIGN)
2658 num = va_arg(args, ssize_t);
2660 num = va_arg(args, size_t);
2662 case FORMAT_TYPE_PTRDIFF:
2663 num = va_arg(args, ptrdiff_t);
2665 case FORMAT_TYPE_UBYTE:
2666 num = (unsigned char) va_arg(args, int);
2668 case FORMAT_TYPE_BYTE:
2669 num = (signed char) va_arg(args, int);
2671 case FORMAT_TYPE_USHORT:
2672 num = (unsigned short) va_arg(args, int);
2674 case FORMAT_TYPE_SHORT:
2675 num = (short) va_arg(args, int);
2677 case FORMAT_TYPE_INT:
2678 num = (int) va_arg(args, int);
2681 num = va_arg(args, unsigned int);
2684 str = number(str, end, num, spec);
2696 /* the trailing null byte doesn't count towards the total */
2700 EXPORT_SYMBOL(vsnprintf);
2703 * vscnprintf - Format a string and place it in a buffer
2704 * @buf: The buffer to place the result into
2705 * @size: The size of the buffer, including the trailing null space
2706 * @fmt: The format string to use
2707 * @args: Arguments for the format string
2709 * The return value is the number of characters which have been written into
2710 * the @buf not including the trailing '\0'. If @size is == 0 the function
2713 * If you're not already dealing with a va_list consider using scnprintf().
2715 * See the vsnprintf() documentation for format string extensions over C99.
2717 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2721 i = vsnprintf(buf, size, fmt, args);
2723 if (likely(i < size))
2729 EXPORT_SYMBOL(vscnprintf);
2732 * snprintf - Format a string and place it in a buffer
2733 * @buf: The buffer to place the result into
2734 * @size: The size of the buffer, including the trailing null space
2735 * @fmt: The format string to use
2736 * @...: Arguments for the format string
2738 * The return value is the number of characters which would be
2739 * generated for the given input, excluding the trailing null,
2740 * as per ISO C99. If the return is greater than or equal to
2741 * @size, the resulting string is truncated.
2743 * See the vsnprintf() documentation for format string extensions over C99.
2745 int snprintf(char *buf, size_t size, const char *fmt, ...)
2750 va_start(args, fmt);
2751 i = vsnprintf(buf, size, fmt, args);
2756 EXPORT_SYMBOL(snprintf);
2759 * scnprintf - Format a string and place it in a buffer
2760 * @buf: The buffer to place the result into
2761 * @size: The size of the buffer, including the trailing null space
2762 * @fmt: The format string to use
2763 * @...: Arguments for the format string
2765 * The return value is the number of characters written into @buf not including
2766 * the trailing '\0'. If @size is == 0 the function returns 0.
2769 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2774 va_start(args, fmt);
2775 i = vscnprintf(buf, size, fmt, args);
2780 EXPORT_SYMBOL(scnprintf);
2783 * vsprintf - Format a string and place it in a buffer
2784 * @buf: The buffer to place the result into
2785 * @fmt: The format string to use
2786 * @args: Arguments for the format string
2788 * The function returns the number of characters written
2789 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2792 * If you're not already dealing with a va_list consider using sprintf().
2794 * See the vsnprintf() documentation for format string extensions over C99.
2796 int vsprintf(char *buf, const char *fmt, va_list args)
2798 return vsnprintf(buf, INT_MAX, fmt, args);
2800 EXPORT_SYMBOL(vsprintf);
2803 * sprintf - Format a string and place it in a buffer
2804 * @buf: The buffer to place the result into
2805 * @fmt: The format string to use
2806 * @...: Arguments for the format string
2808 * The function returns the number of characters written
2809 * into @buf. Use snprintf() or scnprintf() in order to avoid
2812 * See the vsnprintf() documentation for format string extensions over C99.
2814 int sprintf(char *buf, const char *fmt, ...)
2819 va_start(args, fmt);
2820 i = vsnprintf(buf, INT_MAX, fmt, args);
2825 EXPORT_SYMBOL(sprintf);
2827 #ifdef CONFIG_BINARY_PRINTF
2830 * vbin_printf() - VA arguments to binary data
2831 * bstr_printf() - Binary data to text string
2835 * vbin_printf - Parse a format string and place args' binary value in a buffer
2836 * @bin_buf: The buffer to place args' binary value
2837 * @size: The size of the buffer(by words(32bits), not characters)
2838 * @fmt: The format string to use
2839 * @args: Arguments for the format string
2841 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2844 * The return value is the number of words(32bits) which would be generated for
2848 * If the return value is greater than @size, the resulting bin_buf is NOT
2849 * valid for bstr_printf().
2851 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2853 struct printf_spec spec = {0};
2857 str = (char *)bin_buf;
2858 end = (char *)(bin_buf + size);
2860 #define save_arg(type) \
2862 unsigned long long value; \
2863 if (sizeof(type) == 8) { \
2864 unsigned long long val8; \
2865 str = PTR_ALIGN(str, sizeof(u32)); \
2866 val8 = va_arg(args, unsigned long long); \
2867 if (str + sizeof(type) <= end) { \
2868 *(u32 *)str = *(u32 *)&val8; \
2869 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
2873 unsigned int val4; \
2874 str = PTR_ALIGN(str, sizeof(type)); \
2875 val4 = va_arg(args, int); \
2876 if (str + sizeof(type) <= end) \
2877 *(typeof(type) *)str = (type)(long)val4; \
2878 value = (unsigned long long)val4; \
2880 str += sizeof(type); \
2885 int read = format_decode(fmt, &spec);
2889 switch (spec.type) {
2890 case FORMAT_TYPE_NONE:
2891 case FORMAT_TYPE_PERCENT_CHAR:
2893 case FORMAT_TYPE_INVALID:
2896 case FORMAT_TYPE_WIDTH:
2897 case FORMAT_TYPE_PRECISION:
2898 width = (int)save_arg(int);
2899 /* Pointers may require the width */
2901 set_field_width(&spec, width);
2904 case FORMAT_TYPE_CHAR:
2908 case FORMAT_TYPE_STR: {
2909 const char *save_str = va_arg(args, char *);
2910 const char *err_msg;
2913 err_msg = check_pointer_msg(save_str);
2917 len = strlen(save_str) + 1;
2918 if (str + len < end)
2919 memcpy(str, save_str, len);
2924 case FORMAT_TYPE_PTR:
2925 /* Dereferenced pointers must be done now */
2927 /* Dereference of functions is still OK */
2936 if (!isalnum(*fmt)) {
2940 str = pointer(fmt, str, end, va_arg(args, void *),
2945 end[-1] = '\0'; /* Must be nul terminated */
2947 /* skip all alphanumeric pointer suffixes */
2948 while (isalnum(*fmt))
2953 switch (spec.type) {
2955 case FORMAT_TYPE_LONG_LONG:
2956 save_arg(long long);
2958 case FORMAT_TYPE_ULONG:
2959 case FORMAT_TYPE_LONG:
2960 save_arg(unsigned long);
2962 case FORMAT_TYPE_SIZE_T:
2965 case FORMAT_TYPE_PTRDIFF:
2966 save_arg(ptrdiff_t);
2968 case FORMAT_TYPE_UBYTE:
2969 case FORMAT_TYPE_BYTE:
2972 case FORMAT_TYPE_USHORT:
2973 case FORMAT_TYPE_SHORT:
2983 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2986 EXPORT_SYMBOL_GPL(vbin_printf);
2989 * bstr_printf - Format a string from binary arguments and place it in a buffer
2990 * @buf: The buffer to place the result into
2991 * @size: The size of the buffer, including the trailing null space
2992 * @fmt: The format string to use
2993 * @bin_buf: Binary arguments for the format string
2995 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2996 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2997 * a binary buffer that generated by vbin_printf.
2999 * The format follows C99 vsnprintf, but has some extensions:
3000 * see vsnprintf comment for details.
3002 * The return value is the number of characters which would
3003 * be generated for the given input, excluding the trailing
3004 * '\0', as per ISO C99. If you want to have the exact
3005 * number of characters written into @buf as return value
3006 * (not including the trailing '\0'), use vscnprintf(). If the
3007 * return is greater than or equal to @size, the resulting
3008 * string is truncated.
3010 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
3012 struct printf_spec spec = {0};
3014 const char *args = (const char *)bin_buf;
3016 if (WARN_ON_ONCE(size > INT_MAX))
3022 #define get_arg(type) \
3024 typeof(type) value; \
3025 if (sizeof(type) == 8) { \
3026 args = PTR_ALIGN(args, sizeof(u32)); \
3027 *(u32 *)&value = *(u32 *)args; \
3028 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3030 args = PTR_ALIGN(args, sizeof(type)); \
3031 value = *(typeof(type) *)args; \
3033 args += sizeof(type); \
3037 /* Make sure end is always >= buf */
3044 const char *old_fmt = fmt;
3045 int read = format_decode(fmt, &spec);
3049 switch (spec.type) {
3050 case FORMAT_TYPE_NONE: {
3053 if (copy > end - str)
3055 memcpy(str, old_fmt, copy);
3061 case FORMAT_TYPE_WIDTH:
3062 set_field_width(&spec, get_arg(int));
3065 case FORMAT_TYPE_PRECISION:
3066 set_precision(&spec, get_arg(int));
3069 case FORMAT_TYPE_CHAR: {
3072 if (!(spec.flags & LEFT)) {
3073 while (--spec.field_width > 0) {
3079 c = (unsigned char) get_arg(char);
3083 while (--spec.field_width > 0) {
3091 case FORMAT_TYPE_STR: {
3092 const char *str_arg = args;
3093 args += strlen(str_arg) + 1;
3094 str = string(str, end, (char *)str_arg, spec);
3098 case FORMAT_TYPE_PTR: {
3099 bool process = false;
3101 /* Non function dereferences were already done */
3113 if (!isalnum(*fmt)) {
3117 /* Pointer dereference was already processed */
3119 len = copy = strlen(args);
3120 if (copy > end - str)
3122 memcpy(str, args, copy);
3128 str = pointer(fmt, str, end, get_arg(void *), spec);
3130 while (isalnum(*fmt))
3135 case FORMAT_TYPE_PERCENT_CHAR:
3141 case FORMAT_TYPE_INVALID:
3145 unsigned long long num;
3147 switch (spec.type) {
3149 case FORMAT_TYPE_LONG_LONG:
3150 num = get_arg(long long);
3152 case FORMAT_TYPE_ULONG:
3153 case FORMAT_TYPE_LONG:
3154 num = get_arg(unsigned long);
3156 case FORMAT_TYPE_SIZE_T:
3157 num = get_arg(size_t);
3159 case FORMAT_TYPE_PTRDIFF:
3160 num = get_arg(ptrdiff_t);
3162 case FORMAT_TYPE_UBYTE:
3163 num = get_arg(unsigned char);
3165 case FORMAT_TYPE_BYTE:
3166 num = get_arg(signed char);
3168 case FORMAT_TYPE_USHORT:
3169 num = get_arg(unsigned short);
3171 case FORMAT_TYPE_SHORT:
3172 num = get_arg(short);
3174 case FORMAT_TYPE_UINT:
3175 num = get_arg(unsigned int);
3181 str = number(str, end, num, spec);
3183 } /* switch(spec.type) */
3196 /* the trailing null byte doesn't count towards the total */
3199 EXPORT_SYMBOL_GPL(bstr_printf);
3202 * bprintf - Parse a format string and place args' binary value in a buffer
3203 * @bin_buf: The buffer to place args' binary value
3204 * @size: The size of the buffer(by words(32bits), not characters)
3205 * @fmt: The format string to use
3206 * @...: Arguments for the format string
3208 * The function returns the number of words(u32) written
3211 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3216 va_start(args, fmt);
3217 ret = vbin_printf(bin_buf, size, fmt, args);
3222 EXPORT_SYMBOL_GPL(bprintf);
3224 #endif /* CONFIG_BINARY_PRINTF */
3227 * vsscanf - Unformat a buffer into a list of arguments
3228 * @buf: input buffer
3229 * @fmt: format of buffer
3232 int vsscanf(const char *buf, const char *fmt, va_list args)
3234 const char *str = buf;
3242 unsigned long long u;
3248 /* skip any white space in format */
3249 /* white space in format matchs any amount of
3250 * white space, including none, in the input.
3252 if (isspace(*fmt)) {
3253 fmt = skip_spaces(++fmt);
3254 str = skip_spaces(str);
3257 /* anything that is not a conversion must match exactly */
3258 if (*fmt != '%' && *fmt) {
3259 if (*fmt++ != *str++)
3268 /* skip this conversion.
3269 * advance both strings to next white space
3274 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3275 /* '%*[' not yet supported, invalid format */
3280 while (!isspace(*str) && *str)
3285 /* get field width */
3287 if (isdigit(*fmt)) {
3288 field_width = skip_atoi(&fmt);
3289 if (field_width <= 0)
3293 /* get conversion qualifier */
3295 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
3298 if (unlikely(qualifier == *fmt)) {
3299 if (qualifier == 'h') {
3302 } else if (qualifier == 'l') {
3313 /* return number of characters read so far */
3314 *va_arg(args, int *) = str - buf;
3328 char *s = (char *)va_arg(args, char*);
3329 if (field_width == -1)
3333 } while (--field_width > 0 && *str);
3339 char *s = (char *)va_arg(args, char *);
3340 if (field_width == -1)
3341 field_width = SHRT_MAX;
3342 /* first, skip leading white space in buffer */
3343 str = skip_spaces(str);
3345 /* now copy until next white space */
3346 while (*str && !isspace(*str) && field_width--)
3353 * Warning: This implementation of the '[' conversion specifier
3354 * deviates from its glibc counterpart in the following ways:
3355 * (1) It does NOT support ranges i.e. '-' is NOT a special
3357 * (2) It cannot match the closing bracket ']' itself
3358 * (3) A field width is required
3359 * (4) '%*[' (discard matching input) is currently not supported
3362 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3363 * buf1, buf2, buf3);
3369 char *s = (char *)va_arg(args, char *);
3370 DECLARE_BITMAP(set, 256) = {0};
3371 unsigned int len = 0;
3372 bool negate = (*fmt == '^');
3374 /* field width is required */
3375 if (field_width == -1)
3381 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3382 set_bit((u8)*fmt, set);
3384 /* no ']' or no character set found */
3390 bitmap_complement(set, set, 256);
3391 /* exclude null '\0' byte */
3395 /* match must be non-empty */
3396 if (!test_bit((u8)*str, set))
3399 while (test_bit((u8)*str, set) && field_width--)
3421 /* looking for '%' in str */
3426 /* invalid format; stop here */
3430 /* have some sort of integer conversion.
3431 * first, skip white space in buffer.
3433 str = skip_spaces(str);
3436 if (is_sign && digit == '-')
3440 || (base == 16 && !isxdigit(digit))
3441 || (base == 10 && !isdigit(digit))
3442 || (base == 8 && (!isdigit(digit) || digit > '7'))
3443 || (base == 0 && !isdigit(digit)))
3447 val.s = qualifier != 'L' ?
3448 simple_strtol(str, &next, base) :
3449 simple_strtoll(str, &next, base);
3451 val.u = qualifier != 'L' ?
3452 simple_strtoul(str, &next, base) :
3453 simple_strtoull(str, &next, base);
3455 if (field_width > 0 && next - str > field_width) {
3457 _parse_integer_fixup_radix(str, &base);
3458 while (next - str > field_width) {
3460 val.s = div_s64(val.s, base);
3462 val.u = div_u64(val.u, base);
3467 switch (qualifier) {
3468 case 'H': /* that's 'hh' in format */
3470 *va_arg(args, signed char *) = val.s;
3472 *va_arg(args, unsigned char *) = val.u;
3476 *va_arg(args, short *) = val.s;
3478 *va_arg(args, unsigned short *) = val.u;
3482 *va_arg(args, long *) = val.s;
3484 *va_arg(args, unsigned long *) = val.u;
3488 *va_arg(args, long long *) = val.s;
3490 *va_arg(args, unsigned long long *) = val.u;
3493 *va_arg(args, size_t *) = val.u;
3497 *va_arg(args, int *) = val.s;
3499 *va_arg(args, unsigned int *) = val.u;
3511 EXPORT_SYMBOL(vsscanf);
3514 * sscanf - Unformat a buffer into a list of arguments
3515 * @buf: input buffer
3516 * @fmt: formatting of buffer
3517 * @...: resulting arguments
3519 int sscanf(const char *buf, const char *fmt, ...)
3524 va_start(args, fmt);
3525 i = vsscanf(buf, fmt, args);
3530 EXPORT_SYMBOL(sscanf);