xen/xenbus: Add 'will_handle' callback support in xenbus_watch_path()
[linux/fpc-iii.git] / lib / vsprintf.c
blob79ba3cc07026c1c01a3b9d465088632c5b3c22ba
1 /*
2 * linux/lib/vsprintf.c
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
7 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
8 /*
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
13 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
14 * - changed to provide snprintf and vsnprintf functions
15 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
16 * - scnprintf and vscnprintf
19 #include <stdarg.h>
20 #include <linux/clk.h>
21 #include <linux/clk-provider.h>
22 #include <linux/module.h> /* for KSYM_SYMBOL_LEN */
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/ctype.h>
26 #include <linux/kernel.h>
27 #include <linux/kallsyms.h>
28 #include <linux/math64.h>
29 #include <linux/uaccess.h>
30 #include <linux/ioport.h>
31 #include <linux/dcache.h>
32 #include <linux/cred.h>
33 #include <linux/uuid.h>
34 #include <net/addrconf.h>
35 #ifdef CONFIG_BLOCK
36 #include <linux/blkdev.h>
37 #endif
39 #include "../mm/internal.h" /* For the trace_print_flags arrays */
41 #include <asm/page.h> /* for PAGE_SIZE */
42 #include <asm/sections.h> /* for dereference_function_descriptor() */
43 #include <asm/byteorder.h> /* cpu_to_le16 */
45 #include <linux/string_helpers.h>
46 #include "kstrtox.h"
48 /**
49 * simple_strtoull - convert a string to an unsigned long long
50 * @cp: The start of the string
51 * @endp: A pointer to the end of the parsed string will be placed here
52 * @base: The number base to use
54 * This function is obsolete. Please use kstrtoull instead.
56 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
58 unsigned long long result;
59 unsigned int rv;
61 cp = _parse_integer_fixup_radix(cp, &base);
62 rv = _parse_integer(cp, base, &result);
63 /* FIXME */
64 cp += (rv & ~KSTRTOX_OVERFLOW);
66 if (endp)
67 *endp = (char *)cp;
69 return result;
71 EXPORT_SYMBOL(simple_strtoull);
73 /**
74 * simple_strtoul - convert a string to an unsigned long
75 * @cp: The start of the string
76 * @endp: A pointer to the end of the parsed string will be placed here
77 * @base: The number base to use
79 * This function is obsolete. Please use kstrtoul instead.
81 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
83 return simple_strtoull(cp, endp, base);
85 EXPORT_SYMBOL(simple_strtoul);
87 /**
88 * simple_strtol - convert a string to a signed long
89 * @cp: The start of the string
90 * @endp: A pointer to the end of the parsed string will be placed here
91 * @base: The number base to use
93 * This function is obsolete. Please use kstrtol instead.
95 long simple_strtol(const char *cp, char **endp, unsigned int base)
97 if (*cp == '-')
98 return -simple_strtoul(cp + 1, endp, base);
100 return simple_strtoul(cp, endp, base);
102 EXPORT_SYMBOL(simple_strtol);
105 * simple_strtoll - convert a string to a signed long long
106 * @cp: The start of the string
107 * @endp: A pointer to the end of the parsed string will be placed here
108 * @base: The number base to use
110 * This function is obsolete. Please use kstrtoll instead.
112 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
114 if (*cp == '-')
115 return -simple_strtoull(cp + 1, endp, base);
117 return simple_strtoull(cp, endp, base);
119 EXPORT_SYMBOL(simple_strtoll);
121 static noinline_for_stack
122 int skip_atoi(const char **s)
124 int i = 0;
126 do {
127 i = i*10 + *((*s)++) - '0';
128 } while (isdigit(**s));
130 return i;
134 * Decimal conversion is by far the most typical, and is used for
135 * /proc and /sys data. This directly impacts e.g. top performance
136 * with many processes running. We optimize it for speed by emitting
137 * two characters at a time, using a 200 byte lookup table. This
138 * roughly halves the number of multiplications compared to computing
139 * the digits one at a time. Implementation strongly inspired by the
140 * previous version, which in turn used ideas described at
141 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
142 * from the author, Douglas W. Jones).
144 * It turns out there is precisely one 26 bit fixed-point
145 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
146 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
147 * range happens to be somewhat larger (x <= 1073741898), but that's
148 * irrelevant for our purpose.
150 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
151 * need a 32x32->64 bit multiply, so we simply use the same constant.
153 * For dividing a number in the range [100, 10^4-1] by 100, there are
154 * several options. The simplest is (x * 0x147b) >> 19, which is valid
155 * for all x <= 43698.
158 static const u16 decpair[100] = {
159 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
160 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
161 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
162 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
163 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
164 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
165 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
166 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
167 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
168 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
169 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
170 #undef _
174 * This will print a single '0' even if r == 0, since we would
175 * immediately jump to out_r where two 0s would be written but only
176 * one of them accounted for in buf. This is needed by ip4_string
177 * below. All other callers pass a non-zero value of r.
179 static noinline_for_stack
180 char *put_dec_trunc8(char *buf, unsigned r)
182 unsigned q;
184 /* 1 <= r < 10^8 */
185 if (r < 100)
186 goto out_r;
188 /* 100 <= r < 10^8 */
189 q = (r * (u64)0x28f5c29) >> 32;
190 *((u16 *)buf) = decpair[r - 100*q];
191 buf += 2;
193 /* 1 <= q < 10^6 */
194 if (q < 100)
195 goto out_q;
197 /* 100 <= q < 10^6 */
198 r = (q * (u64)0x28f5c29) >> 32;
199 *((u16 *)buf) = decpair[q - 100*r];
200 buf += 2;
202 /* 1 <= r < 10^4 */
203 if (r < 100)
204 goto out_r;
206 /* 100 <= r < 10^4 */
207 q = (r * 0x147b) >> 19;
208 *((u16 *)buf) = decpair[r - 100*q];
209 buf += 2;
210 out_q:
211 /* 1 <= q < 100 */
212 r = q;
213 out_r:
214 /* 1 <= r < 100 */
215 *((u16 *)buf) = decpair[r];
216 buf += r < 10 ? 1 : 2;
217 return buf;
220 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
221 static noinline_for_stack
222 char *put_dec_full8(char *buf, unsigned r)
224 unsigned q;
226 /* 0 <= r < 10^8 */
227 q = (r * (u64)0x28f5c29) >> 32;
228 *((u16 *)buf) = decpair[r - 100*q];
229 buf += 2;
231 /* 0 <= q < 10^6 */
232 r = (q * (u64)0x28f5c29) >> 32;
233 *((u16 *)buf) = decpair[q - 100*r];
234 buf += 2;
236 /* 0 <= r < 10^4 */
237 q = (r * 0x147b) >> 19;
238 *((u16 *)buf) = decpair[r - 100*q];
239 buf += 2;
241 /* 0 <= q < 100 */
242 *((u16 *)buf) = decpair[q];
243 buf += 2;
244 return buf;
247 static noinline_for_stack
248 char *put_dec(char *buf, unsigned long long n)
250 if (n >= 100*1000*1000)
251 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
252 /* 1 <= n <= 1.6e11 */
253 if (n >= 100*1000*1000)
254 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
255 /* 1 <= n < 1e8 */
256 return put_dec_trunc8(buf, n);
259 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
261 static void
262 put_dec_full4(char *buf, unsigned r)
264 unsigned q;
266 /* 0 <= r < 10^4 */
267 q = (r * 0x147b) >> 19;
268 *((u16 *)buf) = decpair[r - 100*q];
269 buf += 2;
270 /* 0 <= q < 100 */
271 *((u16 *)buf) = decpair[q];
275 * Call put_dec_full4 on x % 10000, return x / 10000.
276 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
277 * holds for all x < 1,128,869,999. The largest value this
278 * helper will ever be asked to convert is 1,125,520,955.
279 * (second call in the put_dec code, assuming n is all-ones).
281 static noinline_for_stack
282 unsigned put_dec_helper4(char *buf, unsigned x)
284 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
286 put_dec_full4(buf, x - q * 10000);
287 return q;
290 /* Based on code by Douglas W. Jones found at
291 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
292 * (with permission from the author).
293 * Performs no 64-bit division and hence should be fast on 32-bit machines.
295 static
296 char *put_dec(char *buf, unsigned long long n)
298 uint32_t d3, d2, d1, q, h;
300 if (n < 100*1000*1000)
301 return put_dec_trunc8(buf, n);
303 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
304 h = (n >> 32);
305 d2 = (h ) & 0xffff;
306 d3 = (h >> 16); /* implicit "& 0xffff" */
308 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
309 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
310 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
311 q = put_dec_helper4(buf, q);
313 q += 7671 * d3 + 9496 * d2 + 6 * d1;
314 q = put_dec_helper4(buf+4, q);
316 q += 4749 * d3 + 42 * d2;
317 q = put_dec_helper4(buf+8, q);
319 q += 281 * d3;
320 buf += 12;
321 if (q)
322 buf = put_dec_trunc8(buf, q);
323 else while (buf[-1] == '0')
324 --buf;
326 return buf;
329 #endif
332 * Convert passed number to decimal string.
333 * Returns the length of string. On buffer overflow, returns 0.
335 * If speed is not important, use snprintf(). It's easy to read the code.
337 int num_to_str(char *buf, int size, unsigned long long num)
339 /* put_dec requires 2-byte alignment of the buffer. */
340 char tmp[sizeof(num) * 3] __aligned(2);
341 int idx, len;
343 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
344 if (num <= 9) {
345 tmp[0] = '0' + num;
346 len = 1;
347 } else {
348 len = put_dec(tmp, num) - tmp;
351 if (len > size)
352 return 0;
353 for (idx = 0; idx < len; ++idx)
354 buf[idx] = tmp[len - idx - 1];
355 return len;
358 #define SIGN 1 /* unsigned/signed, must be 1 */
359 #define LEFT 2 /* left justified */
360 #define PLUS 4 /* show plus */
361 #define SPACE 8 /* space if plus */
362 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
363 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
364 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
366 enum format_type {
367 FORMAT_TYPE_NONE, /* Just a string part */
368 FORMAT_TYPE_WIDTH,
369 FORMAT_TYPE_PRECISION,
370 FORMAT_TYPE_CHAR,
371 FORMAT_TYPE_STR,
372 FORMAT_TYPE_PTR,
373 FORMAT_TYPE_PERCENT_CHAR,
374 FORMAT_TYPE_INVALID,
375 FORMAT_TYPE_LONG_LONG,
376 FORMAT_TYPE_ULONG,
377 FORMAT_TYPE_LONG,
378 FORMAT_TYPE_UBYTE,
379 FORMAT_TYPE_BYTE,
380 FORMAT_TYPE_USHORT,
381 FORMAT_TYPE_SHORT,
382 FORMAT_TYPE_UINT,
383 FORMAT_TYPE_INT,
384 FORMAT_TYPE_SIZE_T,
385 FORMAT_TYPE_PTRDIFF
388 struct printf_spec {
389 unsigned int type:8; /* format_type enum */
390 signed int field_width:24; /* width of output field */
391 unsigned int flags:8; /* flags to number() */
392 unsigned int base:8; /* number base, 8, 10 or 16 only */
393 signed int precision:16; /* # of digits/chars */
394 } __packed;
395 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
396 #define PRECISION_MAX ((1 << 15) - 1)
398 static noinline_for_stack
399 char *number(char *buf, char *end, unsigned long long num,
400 struct printf_spec spec)
402 /* put_dec requires 2-byte alignment of the buffer. */
403 char tmp[3 * sizeof(num)] __aligned(2);
404 char sign;
405 char locase;
406 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
407 int i;
408 bool is_zero = num == 0LL;
409 int field_width = spec.field_width;
410 int precision = spec.precision;
412 BUILD_BUG_ON(sizeof(struct printf_spec) != 8);
414 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
415 * produces same digits or (maybe lowercased) letters */
416 locase = (spec.flags & SMALL);
417 if (spec.flags & LEFT)
418 spec.flags &= ~ZEROPAD;
419 sign = 0;
420 if (spec.flags & SIGN) {
421 if ((signed long long)num < 0) {
422 sign = '-';
423 num = -(signed long long)num;
424 field_width--;
425 } else if (spec.flags & PLUS) {
426 sign = '+';
427 field_width--;
428 } else if (spec.flags & SPACE) {
429 sign = ' ';
430 field_width--;
433 if (need_pfx) {
434 if (spec.base == 16)
435 field_width -= 2;
436 else if (!is_zero)
437 field_width--;
440 /* generate full string in tmp[], in reverse order */
441 i = 0;
442 if (num < spec.base)
443 tmp[i++] = hex_asc_upper[num] | locase;
444 else if (spec.base != 10) { /* 8 or 16 */
445 int mask = spec.base - 1;
446 int shift = 3;
448 if (spec.base == 16)
449 shift = 4;
450 do {
451 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
452 num >>= shift;
453 } while (num);
454 } else { /* base 10 */
455 i = put_dec(tmp, num) - tmp;
458 /* printing 100 using %2d gives "100", not "00" */
459 if (i > precision)
460 precision = i;
461 /* leading space padding */
462 field_width -= precision;
463 if (!(spec.flags & (ZEROPAD | LEFT))) {
464 while (--field_width >= 0) {
465 if (buf < end)
466 *buf = ' ';
467 ++buf;
470 /* sign */
471 if (sign) {
472 if (buf < end)
473 *buf = sign;
474 ++buf;
476 /* "0x" / "0" prefix */
477 if (need_pfx) {
478 if (spec.base == 16 || !is_zero) {
479 if (buf < end)
480 *buf = '0';
481 ++buf;
483 if (spec.base == 16) {
484 if (buf < end)
485 *buf = ('X' | locase);
486 ++buf;
489 /* zero or space padding */
490 if (!(spec.flags & LEFT)) {
491 char c = ' ' + (spec.flags & ZEROPAD);
492 BUILD_BUG_ON(' ' + ZEROPAD != '0');
493 while (--field_width >= 0) {
494 if (buf < end)
495 *buf = c;
496 ++buf;
499 /* hmm even more zero padding? */
500 while (i <= --precision) {
501 if (buf < end)
502 *buf = '0';
503 ++buf;
505 /* actual digits of result */
506 while (--i >= 0) {
507 if (buf < end)
508 *buf = tmp[i];
509 ++buf;
511 /* trailing space padding */
512 while (--field_width >= 0) {
513 if (buf < end)
514 *buf = ' ';
515 ++buf;
518 return buf;
521 static noinline_for_stack
522 char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
524 struct printf_spec spec;
526 spec.type = FORMAT_TYPE_PTR;
527 spec.field_width = 2 + 2 * size; /* 0x + hex */
528 spec.flags = SPECIAL | SMALL | ZEROPAD;
529 spec.base = 16;
530 spec.precision = -1;
532 return number(buf, end, num, spec);
535 static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
537 size_t size;
538 if (buf >= end) /* nowhere to put anything */
539 return;
540 size = end - buf;
541 if (size <= spaces) {
542 memset(buf, ' ', size);
543 return;
545 if (len) {
546 if (len > size - spaces)
547 len = size - spaces;
548 memmove(buf + spaces, buf, len);
550 memset(buf, ' ', spaces);
554 * Handle field width padding for a string.
555 * @buf: current buffer position
556 * @n: length of string
557 * @end: end of output buffer
558 * @spec: for field width and flags
559 * Returns: new buffer position after padding.
561 static noinline_for_stack
562 char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
564 unsigned spaces;
566 if (likely(n >= spec.field_width))
567 return buf;
568 /* we want to pad the sucker */
569 spaces = spec.field_width - n;
570 if (!(spec.flags & LEFT)) {
571 move_right(buf - n, end, n, spaces);
572 return buf + spaces;
574 while (spaces--) {
575 if (buf < end)
576 *buf = ' ';
577 ++buf;
579 return buf;
582 static noinline_for_stack
583 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
585 int len = 0;
586 size_t lim = spec.precision;
588 if ((unsigned long)s < PAGE_SIZE)
589 s = "(null)";
591 while (lim--) {
592 char c = *s++;
593 if (!c)
594 break;
595 if (buf < end)
596 *buf = c;
597 ++buf;
598 ++len;
600 return widen_string(buf, len, end, spec);
603 static noinline_for_stack
604 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
605 const char *fmt)
607 const char *array[4], *s;
608 const struct dentry *p;
609 int depth;
610 int i, n;
612 switch (fmt[1]) {
613 case '2': case '3': case '4':
614 depth = fmt[1] - '0';
615 break;
616 default:
617 depth = 1;
620 rcu_read_lock();
621 for (i = 0; i < depth; i++, d = p) {
622 p = ACCESS_ONCE(d->d_parent);
623 array[i] = ACCESS_ONCE(d->d_name.name);
624 if (p == d) {
625 if (i)
626 array[i] = "";
627 i++;
628 break;
631 s = array[--i];
632 for (n = 0; n != spec.precision; n++, buf++) {
633 char c = *s++;
634 if (!c) {
635 if (!i)
636 break;
637 c = '/';
638 s = array[--i];
640 if (buf < end)
641 *buf = c;
643 rcu_read_unlock();
644 return widen_string(buf, n, end, spec);
647 #ifdef CONFIG_BLOCK
648 static noinline_for_stack
649 char *bdev_name(char *buf, char *end, struct block_device *bdev,
650 struct printf_spec spec, const char *fmt)
652 struct gendisk *hd = bdev->bd_disk;
654 buf = string(buf, end, hd->disk_name, spec);
655 if (bdev->bd_part->partno) {
656 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
657 if (buf < end)
658 *buf = 'p';
659 buf++;
661 buf = number(buf, end, bdev->bd_part->partno, spec);
663 return buf;
665 #endif
667 static noinline_for_stack
668 char *symbol_string(char *buf, char *end, void *ptr,
669 struct printf_spec spec, const char *fmt)
671 unsigned long value;
672 #ifdef CONFIG_KALLSYMS
673 char sym[KSYM_SYMBOL_LEN];
674 #endif
676 if (fmt[1] == 'R')
677 ptr = __builtin_extract_return_addr(ptr);
678 value = (unsigned long)ptr;
680 #ifdef CONFIG_KALLSYMS
681 if (*fmt == 'B')
682 sprint_backtrace(sym, value);
683 else if (*fmt != 'f' && *fmt != 's')
684 sprint_symbol(sym, value);
685 else
686 sprint_symbol_no_offset(sym, value);
688 return string(buf, end, sym, spec);
689 #else
690 return special_hex_number(buf, end, value, sizeof(void *));
691 #endif
694 static noinline_for_stack
695 char *resource_string(char *buf, char *end, struct resource *res,
696 struct printf_spec spec, const char *fmt)
698 #ifndef IO_RSRC_PRINTK_SIZE
699 #define IO_RSRC_PRINTK_SIZE 6
700 #endif
702 #ifndef MEM_RSRC_PRINTK_SIZE
703 #define MEM_RSRC_PRINTK_SIZE 10
704 #endif
705 static const struct printf_spec io_spec = {
706 .base = 16,
707 .field_width = IO_RSRC_PRINTK_SIZE,
708 .precision = -1,
709 .flags = SPECIAL | SMALL | ZEROPAD,
711 static const struct printf_spec mem_spec = {
712 .base = 16,
713 .field_width = MEM_RSRC_PRINTK_SIZE,
714 .precision = -1,
715 .flags = SPECIAL | SMALL | ZEROPAD,
717 static const struct printf_spec bus_spec = {
718 .base = 16,
719 .field_width = 2,
720 .precision = -1,
721 .flags = SMALL | ZEROPAD,
723 static const struct printf_spec dec_spec = {
724 .base = 10,
725 .precision = -1,
726 .flags = 0,
728 static const struct printf_spec str_spec = {
729 .field_width = -1,
730 .precision = 10,
731 .flags = LEFT,
733 static const struct printf_spec flag_spec = {
734 .base = 16,
735 .precision = -1,
736 .flags = SPECIAL | SMALL,
739 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
740 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
741 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
742 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
743 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
744 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
745 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
746 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
748 char *p = sym, *pend = sym + sizeof(sym);
749 int decode = (fmt[0] == 'R') ? 1 : 0;
750 const struct printf_spec *specp;
752 *p++ = '[';
753 if (res->flags & IORESOURCE_IO) {
754 p = string(p, pend, "io ", str_spec);
755 specp = &io_spec;
756 } else if (res->flags & IORESOURCE_MEM) {
757 p = string(p, pend, "mem ", str_spec);
758 specp = &mem_spec;
759 } else if (res->flags & IORESOURCE_IRQ) {
760 p = string(p, pend, "irq ", str_spec);
761 specp = &dec_spec;
762 } else if (res->flags & IORESOURCE_DMA) {
763 p = string(p, pend, "dma ", str_spec);
764 specp = &dec_spec;
765 } else if (res->flags & IORESOURCE_BUS) {
766 p = string(p, pend, "bus ", str_spec);
767 specp = &bus_spec;
768 } else {
769 p = string(p, pend, "??? ", str_spec);
770 specp = &mem_spec;
771 decode = 0;
773 if (decode && res->flags & IORESOURCE_UNSET) {
774 p = string(p, pend, "size ", str_spec);
775 p = number(p, pend, resource_size(res), *specp);
776 } else {
777 p = number(p, pend, res->start, *specp);
778 if (res->start != res->end) {
779 *p++ = '-';
780 p = number(p, pend, res->end, *specp);
783 if (decode) {
784 if (res->flags & IORESOURCE_MEM_64)
785 p = string(p, pend, " 64bit", str_spec);
786 if (res->flags & IORESOURCE_PREFETCH)
787 p = string(p, pend, " pref", str_spec);
788 if (res->flags & IORESOURCE_WINDOW)
789 p = string(p, pend, " window", str_spec);
790 if (res->flags & IORESOURCE_DISABLED)
791 p = string(p, pend, " disabled", str_spec);
792 } else {
793 p = string(p, pend, " flags ", str_spec);
794 p = number(p, pend, res->flags, flag_spec);
796 *p++ = ']';
797 *p = '\0';
799 return string(buf, end, sym, spec);
802 static noinline_for_stack
803 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
804 const char *fmt)
806 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
807 negative value, fallback to the default */
808 char separator;
810 if (spec.field_width == 0)
811 /* nothing to print */
812 return buf;
814 if (ZERO_OR_NULL_PTR(addr))
815 /* NULL pointer */
816 return string(buf, end, NULL, spec);
818 switch (fmt[1]) {
819 case 'C':
820 separator = ':';
821 break;
822 case 'D':
823 separator = '-';
824 break;
825 case 'N':
826 separator = 0;
827 break;
828 default:
829 separator = ' ';
830 break;
833 if (spec.field_width > 0)
834 len = min_t(int, spec.field_width, 64);
836 for (i = 0; i < len; ++i) {
837 if (buf < end)
838 *buf = hex_asc_hi(addr[i]);
839 ++buf;
840 if (buf < end)
841 *buf = hex_asc_lo(addr[i]);
842 ++buf;
844 if (separator && i != len - 1) {
845 if (buf < end)
846 *buf = separator;
847 ++buf;
851 return buf;
854 static noinline_for_stack
855 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
856 struct printf_spec spec, const char *fmt)
858 const int CHUNKSZ = 32;
859 int nr_bits = max_t(int, spec.field_width, 0);
860 int i, chunksz;
861 bool first = true;
863 /* reused to print numbers */
864 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
866 chunksz = nr_bits & (CHUNKSZ - 1);
867 if (chunksz == 0)
868 chunksz = CHUNKSZ;
870 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
871 for (; i >= 0; i -= CHUNKSZ) {
872 u32 chunkmask, val;
873 int word, bit;
875 chunkmask = ((1ULL << chunksz) - 1);
876 word = i / BITS_PER_LONG;
877 bit = i % BITS_PER_LONG;
878 val = (bitmap[word] >> bit) & chunkmask;
880 if (!first) {
881 if (buf < end)
882 *buf = ',';
883 buf++;
885 first = false;
887 spec.field_width = DIV_ROUND_UP(chunksz, 4);
888 buf = number(buf, end, val, spec);
890 chunksz = CHUNKSZ;
892 return buf;
895 static noinline_for_stack
896 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
897 struct printf_spec spec, const char *fmt)
899 int nr_bits = max_t(int, spec.field_width, 0);
900 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
901 int cur, rbot, rtop;
902 bool first = true;
904 /* reused to print numbers */
905 spec = (struct printf_spec){ .base = 10 };
907 rbot = cur = find_first_bit(bitmap, nr_bits);
908 while (cur < nr_bits) {
909 rtop = cur;
910 cur = find_next_bit(bitmap, nr_bits, cur + 1);
911 if (cur < nr_bits && cur <= rtop + 1)
912 continue;
914 if (!first) {
915 if (buf < end)
916 *buf = ',';
917 buf++;
919 first = false;
921 buf = number(buf, end, rbot, spec);
922 if (rbot < rtop) {
923 if (buf < end)
924 *buf = '-';
925 buf++;
927 buf = number(buf, end, rtop, spec);
930 rbot = cur;
932 return buf;
935 static noinline_for_stack
936 char *mac_address_string(char *buf, char *end, u8 *addr,
937 struct printf_spec spec, const char *fmt)
939 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
940 char *p = mac_addr;
941 int i;
942 char separator;
943 bool reversed = false;
945 switch (fmt[1]) {
946 case 'F':
947 separator = '-';
948 break;
950 case 'R':
951 reversed = true;
952 /* fall through */
954 default:
955 separator = ':';
956 break;
959 for (i = 0; i < 6; i++) {
960 if (reversed)
961 p = hex_byte_pack(p, addr[5 - i]);
962 else
963 p = hex_byte_pack(p, addr[i]);
965 if (fmt[0] == 'M' && i != 5)
966 *p++ = separator;
968 *p = '\0';
970 return string(buf, end, mac_addr, spec);
973 static noinline_for_stack
974 char *ip4_string(char *p, const u8 *addr, const char *fmt)
976 int i;
977 bool leading_zeros = (fmt[0] == 'i');
978 int index;
979 int step;
981 switch (fmt[2]) {
982 case 'h':
983 #ifdef __BIG_ENDIAN
984 index = 0;
985 step = 1;
986 #else
987 index = 3;
988 step = -1;
989 #endif
990 break;
991 case 'l':
992 index = 3;
993 step = -1;
994 break;
995 case 'n':
996 case 'b':
997 default:
998 index = 0;
999 step = 1;
1000 break;
1002 for (i = 0; i < 4; i++) {
1003 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
1004 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1005 if (leading_zeros) {
1006 if (digits < 3)
1007 *p++ = '0';
1008 if (digits < 2)
1009 *p++ = '0';
1011 /* reverse the digits in the quad */
1012 while (digits--)
1013 *p++ = temp[digits];
1014 if (i < 3)
1015 *p++ = '.';
1016 index += step;
1018 *p = '\0';
1020 return p;
1023 static noinline_for_stack
1024 char *ip6_compressed_string(char *p, const char *addr)
1026 int i, j, range;
1027 unsigned char zerolength[8];
1028 int longest = 1;
1029 int colonpos = -1;
1030 u16 word;
1031 u8 hi, lo;
1032 bool needcolon = false;
1033 bool useIPv4;
1034 struct in6_addr in6;
1036 memcpy(&in6, addr, sizeof(struct in6_addr));
1038 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1040 memset(zerolength, 0, sizeof(zerolength));
1042 if (useIPv4)
1043 range = 6;
1044 else
1045 range = 8;
1047 /* find position of longest 0 run */
1048 for (i = 0; i < range; i++) {
1049 for (j = i; j < range; j++) {
1050 if (in6.s6_addr16[j] != 0)
1051 break;
1052 zerolength[i]++;
1055 for (i = 0; i < range; i++) {
1056 if (zerolength[i] > longest) {
1057 longest = zerolength[i];
1058 colonpos = i;
1061 if (longest == 1) /* don't compress a single 0 */
1062 colonpos = -1;
1064 /* emit address */
1065 for (i = 0; i < range; i++) {
1066 if (i == colonpos) {
1067 if (needcolon || i == 0)
1068 *p++ = ':';
1069 *p++ = ':';
1070 needcolon = false;
1071 i += longest - 1;
1072 continue;
1074 if (needcolon) {
1075 *p++ = ':';
1076 needcolon = false;
1078 /* hex u16 without leading 0s */
1079 word = ntohs(in6.s6_addr16[i]);
1080 hi = word >> 8;
1081 lo = word & 0xff;
1082 if (hi) {
1083 if (hi > 0x0f)
1084 p = hex_byte_pack(p, hi);
1085 else
1086 *p++ = hex_asc_lo(hi);
1087 p = hex_byte_pack(p, lo);
1089 else if (lo > 0x0f)
1090 p = hex_byte_pack(p, lo);
1091 else
1092 *p++ = hex_asc_lo(lo);
1093 needcolon = true;
1096 if (useIPv4) {
1097 if (needcolon)
1098 *p++ = ':';
1099 p = ip4_string(p, &in6.s6_addr[12], "I4");
1101 *p = '\0';
1103 return p;
1106 static noinline_for_stack
1107 char *ip6_string(char *p, const char *addr, const char *fmt)
1109 int i;
1111 for (i = 0; i < 8; i++) {
1112 p = hex_byte_pack(p, *addr++);
1113 p = hex_byte_pack(p, *addr++);
1114 if (fmt[0] == 'I' && i != 7)
1115 *p++ = ':';
1117 *p = '\0';
1119 return p;
1122 static noinline_for_stack
1123 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1124 struct printf_spec spec, const char *fmt)
1126 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1128 if (fmt[0] == 'I' && fmt[2] == 'c')
1129 ip6_compressed_string(ip6_addr, addr);
1130 else
1131 ip6_string(ip6_addr, addr, fmt);
1133 return string(buf, end, ip6_addr, spec);
1136 static noinline_for_stack
1137 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1138 struct printf_spec spec, const char *fmt)
1140 char ip4_addr[sizeof("255.255.255.255")];
1142 ip4_string(ip4_addr, addr, fmt);
1144 return string(buf, end, ip4_addr, spec);
1147 static noinline_for_stack
1148 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1149 struct printf_spec spec, const char *fmt)
1151 bool have_p = false, have_s = false, have_f = false, have_c = false;
1152 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1153 sizeof(":12345") + sizeof("/123456789") +
1154 sizeof("%1234567890")];
1155 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1156 const u8 *addr = (const u8 *) &sa->sin6_addr;
1157 char fmt6[2] = { fmt[0], '6' };
1158 u8 off = 0;
1160 fmt++;
1161 while (isalpha(*++fmt)) {
1162 switch (*fmt) {
1163 case 'p':
1164 have_p = true;
1165 break;
1166 case 'f':
1167 have_f = true;
1168 break;
1169 case 's':
1170 have_s = true;
1171 break;
1172 case 'c':
1173 have_c = true;
1174 break;
1178 if (have_p || have_s || have_f) {
1179 *p = '[';
1180 off = 1;
1183 if (fmt6[0] == 'I' && have_c)
1184 p = ip6_compressed_string(ip6_addr + off, addr);
1185 else
1186 p = ip6_string(ip6_addr + off, addr, fmt6);
1188 if (have_p || have_s || have_f)
1189 *p++ = ']';
1191 if (have_p) {
1192 *p++ = ':';
1193 p = number(p, pend, ntohs(sa->sin6_port), spec);
1195 if (have_f) {
1196 *p++ = '/';
1197 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1198 IPV6_FLOWINFO_MASK), spec);
1200 if (have_s) {
1201 *p++ = '%';
1202 p = number(p, pend, sa->sin6_scope_id, spec);
1204 *p = '\0';
1206 return string(buf, end, ip6_addr, spec);
1209 static noinline_for_stack
1210 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1211 struct printf_spec spec, const char *fmt)
1213 bool have_p = false;
1214 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1215 char *pend = ip4_addr + sizeof(ip4_addr);
1216 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1217 char fmt4[3] = { fmt[0], '4', 0 };
1219 fmt++;
1220 while (isalpha(*++fmt)) {
1221 switch (*fmt) {
1222 case 'p':
1223 have_p = true;
1224 break;
1225 case 'h':
1226 case 'l':
1227 case 'n':
1228 case 'b':
1229 fmt4[2] = *fmt;
1230 break;
1234 p = ip4_string(ip4_addr, addr, fmt4);
1235 if (have_p) {
1236 *p++ = ':';
1237 p = number(p, pend, ntohs(sa->sin_port), spec);
1239 *p = '\0';
1241 return string(buf, end, ip4_addr, spec);
1244 static noinline_for_stack
1245 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1246 const char *fmt)
1248 bool found = true;
1249 int count = 1;
1250 unsigned int flags = 0;
1251 int len;
1253 if (spec.field_width == 0)
1254 return buf; /* nothing to print */
1256 if (ZERO_OR_NULL_PTR(addr))
1257 return string(buf, end, NULL, spec); /* NULL pointer */
1260 do {
1261 switch (fmt[count++]) {
1262 case 'a':
1263 flags |= ESCAPE_ANY;
1264 break;
1265 case 'c':
1266 flags |= ESCAPE_SPECIAL;
1267 break;
1268 case 'h':
1269 flags |= ESCAPE_HEX;
1270 break;
1271 case 'n':
1272 flags |= ESCAPE_NULL;
1273 break;
1274 case 'o':
1275 flags |= ESCAPE_OCTAL;
1276 break;
1277 case 'p':
1278 flags |= ESCAPE_NP;
1279 break;
1280 case 's':
1281 flags |= ESCAPE_SPACE;
1282 break;
1283 default:
1284 found = false;
1285 break;
1287 } while (found);
1289 if (!flags)
1290 flags = ESCAPE_ANY_NP;
1292 len = spec.field_width < 0 ? 1 : spec.field_width;
1295 * string_escape_mem() writes as many characters as it can to
1296 * the given buffer, and returns the total size of the output
1297 * had the buffer been big enough.
1299 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1301 return buf;
1304 static noinline_for_stack
1305 char *uuid_string(char *buf, char *end, const u8 *addr,
1306 struct printf_spec spec, const char *fmt)
1308 char uuid[UUID_STRING_LEN + 1];
1309 char *p = uuid;
1310 int i;
1311 const u8 *index = uuid_be_index;
1312 bool uc = false;
1314 switch (*(++fmt)) {
1315 case 'L':
1316 uc = true; /* fall-through */
1317 case 'l':
1318 index = uuid_le_index;
1319 break;
1320 case 'B':
1321 uc = true;
1322 break;
1325 for (i = 0; i < 16; i++) {
1326 if (uc)
1327 p = hex_byte_pack_upper(p, addr[index[i]]);
1328 else
1329 p = hex_byte_pack(p, addr[index[i]]);
1330 switch (i) {
1331 case 3:
1332 case 5:
1333 case 7:
1334 case 9:
1335 *p++ = '-';
1336 break;
1340 *p = 0;
1342 return string(buf, end, uuid, spec);
1345 static noinline_for_stack
1346 char *netdev_bits(char *buf, char *end, const void *addr, const char *fmt)
1348 unsigned long long num;
1349 int size;
1351 switch (fmt[1]) {
1352 case 'F':
1353 num = *(const netdev_features_t *)addr;
1354 size = sizeof(netdev_features_t);
1355 break;
1356 default:
1357 num = (unsigned long)addr;
1358 size = sizeof(unsigned long);
1359 break;
1362 return special_hex_number(buf, end, num, size);
1365 static noinline_for_stack
1366 char *address_val(char *buf, char *end, const void *addr, const char *fmt)
1368 unsigned long long num;
1369 int size;
1371 switch (fmt[1]) {
1372 case 'd':
1373 num = *(const dma_addr_t *)addr;
1374 size = sizeof(dma_addr_t);
1375 break;
1376 case 'p':
1377 default:
1378 num = *(const phys_addr_t *)addr;
1379 size = sizeof(phys_addr_t);
1380 break;
1383 return special_hex_number(buf, end, num, size);
1386 static noinline_for_stack
1387 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1388 const char *fmt)
1390 if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1391 return string(buf, end, NULL, spec);
1393 switch (fmt[1]) {
1394 case 'n':
1395 default:
1396 #ifdef CONFIG_COMMON_CLK
1397 return string(buf, end, __clk_get_name(clk), spec);
1398 #else
1399 return special_hex_number(buf, end, (unsigned long)clk, sizeof(unsigned long));
1400 #endif
1404 static
1405 char *format_flags(char *buf, char *end, unsigned long flags,
1406 const struct trace_print_flags *names)
1408 unsigned long mask;
1409 const struct printf_spec strspec = {
1410 .field_width = -1,
1411 .precision = -1,
1413 const struct printf_spec numspec = {
1414 .flags = SPECIAL|SMALL,
1415 .field_width = -1,
1416 .precision = -1,
1417 .base = 16,
1420 for ( ; flags && names->name; names++) {
1421 mask = names->mask;
1422 if ((flags & mask) != mask)
1423 continue;
1425 buf = string(buf, end, names->name, strspec);
1427 flags &= ~mask;
1428 if (flags) {
1429 if (buf < end)
1430 *buf = '|';
1431 buf++;
1435 if (flags)
1436 buf = number(buf, end, flags, numspec);
1438 return buf;
1441 static noinline_for_stack
1442 char *flags_string(char *buf, char *end, void *flags_ptr, const char *fmt)
1444 unsigned long flags;
1445 const struct trace_print_flags *names;
1447 switch (fmt[1]) {
1448 case 'p':
1449 flags = *(unsigned long *)flags_ptr;
1450 /* Remove zone id */
1451 flags &= (1UL << NR_PAGEFLAGS) - 1;
1452 names = pageflag_names;
1453 break;
1454 case 'v':
1455 flags = *(unsigned long *)flags_ptr;
1456 names = vmaflag_names;
1457 break;
1458 case 'g':
1459 flags = *(gfp_t *)flags_ptr;
1460 names = gfpflag_names;
1461 break;
1462 default:
1463 WARN_ONCE(1, "Unsupported flags modifier: %c\n", fmt[1]);
1464 return buf;
1467 return format_flags(buf, end, flags, names);
1470 int kptr_restrict __read_mostly;
1473 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1474 * by an extra set of alphanumeric characters that are extended format
1475 * specifiers.
1477 * Right now we handle:
1479 * - 'F' For symbolic function descriptor pointers with offset
1480 * - 'f' For simple symbolic function names without offset
1481 * - 'S' For symbolic direct pointers with offset
1482 * - 's' For symbolic direct pointers without offset
1483 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1484 * - 'B' For backtraced symbolic direct pointers with offset
1485 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1486 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1487 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1488 * width which must be explicitly specified either as part of the
1489 * format string '%32b[l]' or through '%*b[l]', [l] selects
1490 * range-list format instead of hex format
1491 * - 'M' For a 6-byte MAC address, it prints the address in the
1492 * usual colon-separated hex notation
1493 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1494 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1495 * with a dash-separated hex notation
1496 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1497 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1498 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1499 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1500 * [S][pfs]
1501 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1502 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1503 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1504 * IPv6 omits the colons (01020304...0f)
1505 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1506 * [S][pfs]
1507 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1508 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1509 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1510 * - 'I[6S]c' for IPv6 addresses printed as specified by
1511 * http://tools.ietf.org/html/rfc5952
1512 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1513 * of the following flags (see string_escape_mem() for the
1514 * details):
1515 * a - ESCAPE_ANY
1516 * c - ESCAPE_SPECIAL
1517 * h - ESCAPE_HEX
1518 * n - ESCAPE_NULL
1519 * o - ESCAPE_OCTAL
1520 * p - ESCAPE_NP
1521 * s - ESCAPE_SPACE
1522 * By default ESCAPE_ANY_NP is used.
1523 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1524 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1525 * Options for %pU are:
1526 * b big endian lower case hex (default)
1527 * B big endian UPPER case hex
1528 * l little endian lower case hex
1529 * L little endian UPPER case hex
1530 * big endian output byte order is:
1531 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1532 * little endian output byte order is:
1533 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1534 * - 'V' For a struct va_format which contains a format string * and va_list *,
1535 * call vsnprintf(->format, *->va_list).
1536 * Implements a "recursive vsnprintf".
1537 * Do not use this feature without some mechanism to verify the
1538 * correctness of the format string and va_list arguments.
1539 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1540 * - 'NF' For a netdev_features_t
1541 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1542 * a certain separator (' ' by default):
1543 * C colon
1544 * D dash
1545 * N no separator
1546 * The maximum supported length is 64 bytes of the input. Consider
1547 * to use print_hex_dump() for the larger input.
1548 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1549 * (default assumed to be phys_addr_t, passed by reference)
1550 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1551 * - 'D[234]' Same as 'd' but for a struct file
1552 * - 'g' For block_device name (gendisk + partition number)
1553 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1554 * (legacy clock framework) of the clock
1555 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1556 * (legacy clock framework) of the clock
1557 * - 'Cr' For a clock, it prints the current rate of the clock
1558 * - 'G' For flags to be printed as a collection of symbolic strings that would
1559 * construct the specific value. Supported flags given by option:
1560 * p page flags (see struct page) given as pointer to unsigned long
1561 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
1562 * v vma flags (VM_*) given as pointer to unsigned long
1564 * ** Please update also Documentation/printk-formats.txt when making changes **
1566 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1567 * function pointers are really function descriptors, which contain a
1568 * pointer to the real address.
1570 static noinline_for_stack
1571 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1572 struct printf_spec spec)
1574 const int default_width = 2 * sizeof(void *);
1576 if (!ptr && *fmt != 'K') {
1578 * Print (null) with the same width as a pointer so it makes
1579 * tabular output look nice.
1581 if (spec.field_width == -1)
1582 spec.field_width = default_width;
1583 return string(buf, end, "(null)", spec);
1586 switch (*fmt) {
1587 case 'F':
1588 case 'f':
1589 ptr = dereference_function_descriptor(ptr);
1590 /* Fallthrough */
1591 case 'S':
1592 case 's':
1593 case 'B':
1594 return symbol_string(buf, end, ptr, spec, fmt);
1595 case 'R':
1596 case 'r':
1597 return resource_string(buf, end, ptr, spec, fmt);
1598 case 'h':
1599 return hex_string(buf, end, ptr, spec, fmt);
1600 case 'b':
1601 switch (fmt[1]) {
1602 case 'l':
1603 return bitmap_list_string(buf, end, ptr, spec, fmt);
1604 default:
1605 return bitmap_string(buf, end, ptr, spec, fmt);
1607 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1608 case 'm': /* Contiguous: 000102030405 */
1609 /* [mM]F (FDDI) */
1610 /* [mM]R (Reverse order; Bluetooth) */
1611 return mac_address_string(buf, end, ptr, spec, fmt);
1612 case 'I': /* Formatted IP supported
1613 * 4: 1.2.3.4
1614 * 6: 0001:0203:...:0708
1615 * 6c: 1::708 or 1::1.2.3.4
1617 case 'i': /* Contiguous:
1618 * 4: 001.002.003.004
1619 * 6: 000102...0f
1621 switch (fmt[1]) {
1622 case '6':
1623 return ip6_addr_string(buf, end, ptr, spec, fmt);
1624 case '4':
1625 return ip4_addr_string(buf, end, ptr, spec, fmt);
1626 case 'S': {
1627 const union {
1628 struct sockaddr raw;
1629 struct sockaddr_in v4;
1630 struct sockaddr_in6 v6;
1631 } *sa = ptr;
1633 switch (sa->raw.sa_family) {
1634 case AF_INET:
1635 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1636 case AF_INET6:
1637 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1638 default:
1639 return string(buf, end, "(invalid address)", spec);
1642 break;
1643 case 'E':
1644 return escaped_string(buf, end, ptr, spec, fmt);
1645 case 'U':
1646 return uuid_string(buf, end, ptr, spec, fmt);
1647 case 'V':
1649 va_list va;
1651 va_copy(va, *((struct va_format *)ptr)->va);
1652 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1653 ((struct va_format *)ptr)->fmt, va);
1654 va_end(va);
1655 return buf;
1657 case 'K':
1658 switch (kptr_restrict) {
1659 case 0:
1660 /* Always print %pK values */
1661 break;
1662 case 1: {
1663 const struct cred *cred;
1666 * kptr_restrict==1 cannot be used in IRQ context
1667 * because its test for CAP_SYSLOG would be meaningless.
1669 if (in_irq() || in_serving_softirq() || in_nmi()) {
1670 if (spec.field_width == -1)
1671 spec.field_width = default_width;
1672 return string(buf, end, "pK-error", spec);
1676 * Only print the real pointer value if the current
1677 * process has CAP_SYSLOG and is running with the
1678 * same credentials it started with. This is because
1679 * access to files is checked at open() time, but %pK
1680 * checks permission at read() time. We don't want to
1681 * leak pointer values if a binary opens a file using
1682 * %pK and then elevates privileges before reading it.
1684 cred = current_cred();
1685 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1686 !uid_eq(cred->euid, cred->uid) ||
1687 !gid_eq(cred->egid, cred->gid))
1688 ptr = NULL;
1689 break;
1691 case 2:
1692 default:
1693 /* Always print 0's for %pK */
1694 ptr = NULL;
1695 break;
1697 break;
1699 case 'N':
1700 return netdev_bits(buf, end, ptr, fmt);
1701 case 'a':
1702 return address_val(buf, end, ptr, fmt);
1703 case 'd':
1704 return dentry_name(buf, end, ptr, spec, fmt);
1705 case 'C':
1706 return clock(buf, end, ptr, spec, fmt);
1707 case 'D':
1708 return dentry_name(buf, end,
1709 ((const struct file *)ptr)->f_path.dentry,
1710 spec, fmt);
1711 #ifdef CONFIG_BLOCK
1712 case 'g':
1713 return bdev_name(buf, end, ptr, spec, fmt);
1714 #endif
1716 case 'G':
1717 return flags_string(buf, end, ptr, fmt);
1719 spec.flags |= SMALL;
1720 if (spec.field_width == -1) {
1721 spec.field_width = default_width;
1722 spec.flags |= ZEROPAD;
1724 spec.base = 16;
1726 return number(buf, end, (unsigned long) ptr, spec);
1730 * Helper function to decode printf style format.
1731 * Each call decode a token from the format and return the
1732 * number of characters read (or likely the delta where it wants
1733 * to go on the next call).
1734 * The decoded token is returned through the parameters
1736 * 'h', 'l', or 'L' for integer fields
1737 * 'z' support added 23/7/1999 S.H.
1738 * 'z' changed to 'Z' --davidm 1/25/99
1739 * 't' added for ptrdiff_t
1741 * @fmt: the format string
1742 * @type of the token returned
1743 * @flags: various flags such as +, -, # tokens..
1744 * @field_width: overwritten width
1745 * @base: base of the number (octal, hex, ...)
1746 * @precision: precision of a number
1747 * @qualifier: qualifier of a number (long, size_t, ...)
1749 static noinline_for_stack
1750 int format_decode(const char *fmt, struct printf_spec *spec)
1752 const char *start = fmt;
1753 char qualifier;
1755 /* we finished early by reading the field width */
1756 if (spec->type == FORMAT_TYPE_WIDTH) {
1757 if (spec->field_width < 0) {
1758 spec->field_width = -spec->field_width;
1759 spec->flags |= LEFT;
1761 spec->type = FORMAT_TYPE_NONE;
1762 goto precision;
1765 /* we finished early by reading the precision */
1766 if (spec->type == FORMAT_TYPE_PRECISION) {
1767 if (spec->precision < 0)
1768 spec->precision = 0;
1770 spec->type = FORMAT_TYPE_NONE;
1771 goto qualifier;
1774 /* By default */
1775 spec->type = FORMAT_TYPE_NONE;
1777 for (; *fmt ; ++fmt) {
1778 if (*fmt == '%')
1779 break;
1782 /* Return the current non-format string */
1783 if (fmt != start || !*fmt)
1784 return fmt - start;
1786 /* Process flags */
1787 spec->flags = 0;
1789 while (1) { /* this also skips first '%' */
1790 bool found = true;
1792 ++fmt;
1794 switch (*fmt) {
1795 case '-': spec->flags |= LEFT; break;
1796 case '+': spec->flags |= PLUS; break;
1797 case ' ': spec->flags |= SPACE; break;
1798 case '#': spec->flags |= SPECIAL; break;
1799 case '0': spec->flags |= ZEROPAD; break;
1800 default: found = false;
1803 if (!found)
1804 break;
1807 /* get field width */
1808 spec->field_width = -1;
1810 if (isdigit(*fmt))
1811 spec->field_width = skip_atoi(&fmt);
1812 else if (*fmt == '*') {
1813 /* it's the next argument */
1814 spec->type = FORMAT_TYPE_WIDTH;
1815 return ++fmt - start;
1818 precision:
1819 /* get the precision */
1820 spec->precision = -1;
1821 if (*fmt == '.') {
1822 ++fmt;
1823 if (isdigit(*fmt)) {
1824 spec->precision = skip_atoi(&fmt);
1825 if (spec->precision < 0)
1826 spec->precision = 0;
1827 } else if (*fmt == '*') {
1828 /* it's the next argument */
1829 spec->type = FORMAT_TYPE_PRECISION;
1830 return ++fmt - start;
1834 qualifier:
1835 /* get the conversion qualifier */
1836 qualifier = 0;
1837 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1838 _tolower(*fmt) == 'z' || *fmt == 't') {
1839 qualifier = *fmt++;
1840 if (unlikely(qualifier == *fmt)) {
1841 if (qualifier == 'l') {
1842 qualifier = 'L';
1843 ++fmt;
1844 } else if (qualifier == 'h') {
1845 qualifier = 'H';
1846 ++fmt;
1851 /* default base */
1852 spec->base = 10;
1853 switch (*fmt) {
1854 case 'c':
1855 spec->type = FORMAT_TYPE_CHAR;
1856 return ++fmt - start;
1858 case 's':
1859 spec->type = FORMAT_TYPE_STR;
1860 return ++fmt - start;
1862 case 'p':
1863 spec->type = FORMAT_TYPE_PTR;
1864 return ++fmt - start;
1866 case '%':
1867 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1868 return ++fmt - start;
1870 /* integer number formats - set up the flags and "break" */
1871 case 'o':
1872 spec->base = 8;
1873 break;
1875 case 'x':
1876 spec->flags |= SMALL;
1878 case 'X':
1879 spec->base = 16;
1880 break;
1882 case 'd':
1883 case 'i':
1884 spec->flags |= SIGN;
1885 case 'u':
1886 break;
1888 case 'n':
1890 * Since %n poses a greater security risk than
1891 * utility, treat it as any other invalid or
1892 * unsupported format specifier.
1894 /* Fall-through */
1896 default:
1897 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
1898 spec->type = FORMAT_TYPE_INVALID;
1899 return fmt - start;
1902 if (qualifier == 'L')
1903 spec->type = FORMAT_TYPE_LONG_LONG;
1904 else if (qualifier == 'l') {
1905 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1906 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1907 } else if (_tolower(qualifier) == 'z') {
1908 spec->type = FORMAT_TYPE_SIZE_T;
1909 } else if (qualifier == 't') {
1910 spec->type = FORMAT_TYPE_PTRDIFF;
1911 } else if (qualifier == 'H') {
1912 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1913 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1914 } else if (qualifier == 'h') {
1915 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1916 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1917 } else {
1918 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1919 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1922 return ++fmt - start;
1925 static void
1926 set_field_width(struct printf_spec *spec, int width)
1928 spec->field_width = width;
1929 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
1930 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
1934 static void
1935 set_precision(struct printf_spec *spec, int prec)
1937 spec->precision = prec;
1938 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
1939 spec->precision = clamp(prec, 0, PRECISION_MAX);
1944 * vsnprintf - Format a string and place it in a buffer
1945 * @buf: The buffer to place the result into
1946 * @size: The size of the buffer, including the trailing null space
1947 * @fmt: The format string to use
1948 * @args: Arguments for the format string
1950 * This function generally follows C99 vsnprintf, but has some
1951 * extensions and a few limitations:
1953 * %n is unsupported
1954 * %p* is handled by pointer()
1956 * See pointer() or Documentation/printk-formats.txt for more
1957 * extensive description.
1959 * ** Please update the documentation in both places when making changes **
1961 * The return value is the number of characters which would
1962 * be generated for the given input, excluding the trailing
1963 * '\0', as per ISO C99. If you want to have the exact
1964 * number of characters written into @buf as return value
1965 * (not including the trailing '\0'), use vscnprintf(). If the
1966 * return is greater than or equal to @size, the resulting
1967 * string is truncated.
1969 * If you're not already dealing with a va_list consider using snprintf().
1971 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1973 unsigned long long num;
1974 char *str, *end;
1975 struct printf_spec spec = {0};
1977 /* Reject out-of-range values early. Large positive sizes are
1978 used for unknown buffer sizes. */
1979 if (WARN_ON_ONCE(size > INT_MAX))
1980 return 0;
1982 str = buf;
1983 end = buf + size;
1985 /* Make sure end is always >= buf */
1986 if (end < buf) {
1987 end = ((void *)-1);
1988 size = end - buf;
1991 while (*fmt) {
1992 const char *old_fmt = fmt;
1993 int read = format_decode(fmt, &spec);
1995 fmt += read;
1997 switch (spec.type) {
1998 case FORMAT_TYPE_NONE: {
1999 int copy = read;
2000 if (str < end) {
2001 if (copy > end - str)
2002 copy = end - str;
2003 memcpy(str, old_fmt, copy);
2005 str += read;
2006 break;
2009 case FORMAT_TYPE_WIDTH:
2010 set_field_width(&spec, va_arg(args, int));
2011 break;
2013 case FORMAT_TYPE_PRECISION:
2014 set_precision(&spec, va_arg(args, int));
2015 break;
2017 case FORMAT_TYPE_CHAR: {
2018 char c;
2020 if (!(spec.flags & LEFT)) {
2021 while (--spec.field_width > 0) {
2022 if (str < end)
2023 *str = ' ';
2024 ++str;
2028 c = (unsigned char) va_arg(args, int);
2029 if (str < end)
2030 *str = c;
2031 ++str;
2032 while (--spec.field_width > 0) {
2033 if (str < end)
2034 *str = ' ';
2035 ++str;
2037 break;
2040 case FORMAT_TYPE_STR:
2041 str = string(str, end, va_arg(args, char *), spec);
2042 break;
2044 case FORMAT_TYPE_PTR:
2045 str = pointer(fmt, str, end, va_arg(args, void *),
2046 spec);
2047 while (isalnum(*fmt))
2048 fmt++;
2049 break;
2051 case FORMAT_TYPE_PERCENT_CHAR:
2052 if (str < end)
2053 *str = '%';
2054 ++str;
2055 break;
2057 case FORMAT_TYPE_INVALID:
2059 * Presumably the arguments passed gcc's type
2060 * checking, but there is no safe or sane way
2061 * for us to continue parsing the format and
2062 * fetching from the va_list; the remaining
2063 * specifiers and arguments would be out of
2064 * sync.
2066 goto out;
2068 default:
2069 switch (spec.type) {
2070 case FORMAT_TYPE_LONG_LONG:
2071 num = va_arg(args, long long);
2072 break;
2073 case FORMAT_TYPE_ULONG:
2074 num = va_arg(args, unsigned long);
2075 break;
2076 case FORMAT_TYPE_LONG:
2077 num = va_arg(args, long);
2078 break;
2079 case FORMAT_TYPE_SIZE_T:
2080 if (spec.flags & SIGN)
2081 num = va_arg(args, ssize_t);
2082 else
2083 num = va_arg(args, size_t);
2084 break;
2085 case FORMAT_TYPE_PTRDIFF:
2086 num = va_arg(args, ptrdiff_t);
2087 break;
2088 case FORMAT_TYPE_UBYTE:
2089 num = (unsigned char) va_arg(args, int);
2090 break;
2091 case FORMAT_TYPE_BYTE:
2092 num = (signed char) va_arg(args, int);
2093 break;
2094 case FORMAT_TYPE_USHORT:
2095 num = (unsigned short) va_arg(args, int);
2096 break;
2097 case FORMAT_TYPE_SHORT:
2098 num = (short) va_arg(args, int);
2099 break;
2100 case FORMAT_TYPE_INT:
2101 num = (int) va_arg(args, int);
2102 break;
2103 default:
2104 num = va_arg(args, unsigned int);
2107 str = number(str, end, num, spec);
2111 out:
2112 if (size > 0) {
2113 if (str < end)
2114 *str = '\0';
2115 else
2116 end[-1] = '\0';
2119 /* the trailing null byte doesn't count towards the total */
2120 return str-buf;
2123 EXPORT_SYMBOL(vsnprintf);
2126 * vscnprintf - Format a string and place it in a buffer
2127 * @buf: The buffer to place the result into
2128 * @size: The size of the buffer, including the trailing null space
2129 * @fmt: The format string to use
2130 * @args: Arguments for the format string
2132 * The return value is the number of characters which have been written into
2133 * the @buf not including the trailing '\0'. If @size is == 0 the function
2134 * returns 0.
2136 * If you're not already dealing with a va_list consider using scnprintf().
2138 * See the vsnprintf() documentation for format string extensions over C99.
2140 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2142 int i;
2144 i = vsnprintf(buf, size, fmt, args);
2146 if (likely(i < size))
2147 return i;
2148 if (size != 0)
2149 return size - 1;
2150 return 0;
2152 EXPORT_SYMBOL(vscnprintf);
2155 * snprintf - Format a string and place it in a buffer
2156 * @buf: The buffer to place the result into
2157 * @size: The size of the buffer, including the trailing null space
2158 * @fmt: The format string to use
2159 * @...: Arguments for the format string
2161 * The return value is the number of characters which would be
2162 * generated for the given input, excluding the trailing null,
2163 * as per ISO C99. If the return is greater than or equal to
2164 * @size, the resulting string is truncated.
2166 * See the vsnprintf() documentation for format string extensions over C99.
2168 int snprintf(char *buf, size_t size, const char *fmt, ...)
2170 va_list args;
2171 int i;
2173 va_start(args, fmt);
2174 i = vsnprintf(buf, size, fmt, args);
2175 va_end(args);
2177 return i;
2179 EXPORT_SYMBOL(snprintf);
2182 * scnprintf - Format a string and place it in a buffer
2183 * @buf: The buffer to place the result into
2184 * @size: The size of the buffer, including the trailing null space
2185 * @fmt: The format string to use
2186 * @...: Arguments for the format string
2188 * The return value is the number of characters written into @buf not including
2189 * the trailing '\0'. If @size is == 0 the function returns 0.
2192 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2194 va_list args;
2195 int i;
2197 va_start(args, fmt);
2198 i = vscnprintf(buf, size, fmt, args);
2199 va_end(args);
2201 return i;
2203 EXPORT_SYMBOL(scnprintf);
2206 * vsprintf - Format a string and place it in a buffer
2207 * @buf: The buffer to place the result into
2208 * @fmt: The format string to use
2209 * @args: Arguments for the format string
2211 * The function returns the number of characters written
2212 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2213 * buffer overflows.
2215 * If you're not already dealing with a va_list consider using sprintf().
2217 * See the vsnprintf() documentation for format string extensions over C99.
2219 int vsprintf(char *buf, const char *fmt, va_list args)
2221 return vsnprintf(buf, INT_MAX, fmt, args);
2223 EXPORT_SYMBOL(vsprintf);
2226 * sprintf - Format a string and place it in a buffer
2227 * @buf: The buffer to place the result into
2228 * @fmt: The format string to use
2229 * @...: Arguments for the format string
2231 * The function returns the number of characters written
2232 * into @buf. Use snprintf() or scnprintf() in order to avoid
2233 * buffer overflows.
2235 * See the vsnprintf() documentation for format string extensions over C99.
2237 int sprintf(char *buf, const char *fmt, ...)
2239 va_list args;
2240 int i;
2242 va_start(args, fmt);
2243 i = vsnprintf(buf, INT_MAX, fmt, args);
2244 va_end(args);
2246 return i;
2248 EXPORT_SYMBOL(sprintf);
2250 #ifdef CONFIG_BINARY_PRINTF
2252 * bprintf service:
2253 * vbin_printf() - VA arguments to binary data
2254 * bstr_printf() - Binary data to text string
2258 * vbin_printf - Parse a format string and place args' binary value in a buffer
2259 * @bin_buf: The buffer to place args' binary value
2260 * @size: The size of the buffer(by words(32bits), not characters)
2261 * @fmt: The format string to use
2262 * @args: Arguments for the format string
2264 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2265 * is skipped.
2267 * The return value is the number of words(32bits) which would be generated for
2268 * the given input.
2270 * NOTE:
2271 * If the return value is greater than @size, the resulting bin_buf is NOT
2272 * valid for bstr_printf().
2274 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2276 struct printf_spec spec = {0};
2277 char *str, *end;
2279 str = (char *)bin_buf;
2280 end = (char *)(bin_buf + size);
2282 #define save_arg(type) \
2283 do { \
2284 if (sizeof(type) == 8) { \
2285 unsigned long long value; \
2286 str = PTR_ALIGN(str, sizeof(u32)); \
2287 value = va_arg(args, unsigned long long); \
2288 if (str + sizeof(type) <= end) { \
2289 *(u32 *)str = *(u32 *)&value; \
2290 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2292 } else { \
2293 unsigned long value; \
2294 str = PTR_ALIGN(str, sizeof(type)); \
2295 value = va_arg(args, int); \
2296 if (str + sizeof(type) <= end) \
2297 *(typeof(type) *)str = (type)value; \
2299 str += sizeof(type); \
2300 } while (0)
2302 while (*fmt) {
2303 int read = format_decode(fmt, &spec);
2305 fmt += read;
2307 switch (spec.type) {
2308 case FORMAT_TYPE_NONE:
2309 case FORMAT_TYPE_PERCENT_CHAR:
2310 break;
2311 case FORMAT_TYPE_INVALID:
2312 goto out;
2314 case FORMAT_TYPE_WIDTH:
2315 case FORMAT_TYPE_PRECISION:
2316 save_arg(int);
2317 break;
2319 case FORMAT_TYPE_CHAR:
2320 save_arg(char);
2321 break;
2323 case FORMAT_TYPE_STR: {
2324 const char *save_str = va_arg(args, char *);
2325 size_t len;
2327 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2328 || (unsigned long)save_str < PAGE_SIZE)
2329 save_str = "(null)";
2330 len = strlen(save_str) + 1;
2331 if (str + len < end)
2332 memcpy(str, save_str, len);
2333 str += len;
2334 break;
2337 case FORMAT_TYPE_PTR:
2338 save_arg(void *);
2339 /* skip all alphanumeric pointer suffixes */
2340 while (isalnum(*fmt))
2341 fmt++;
2342 break;
2344 default:
2345 switch (spec.type) {
2347 case FORMAT_TYPE_LONG_LONG:
2348 save_arg(long long);
2349 break;
2350 case FORMAT_TYPE_ULONG:
2351 case FORMAT_TYPE_LONG:
2352 save_arg(unsigned long);
2353 break;
2354 case FORMAT_TYPE_SIZE_T:
2355 save_arg(size_t);
2356 break;
2357 case FORMAT_TYPE_PTRDIFF:
2358 save_arg(ptrdiff_t);
2359 break;
2360 case FORMAT_TYPE_UBYTE:
2361 case FORMAT_TYPE_BYTE:
2362 save_arg(char);
2363 break;
2364 case FORMAT_TYPE_USHORT:
2365 case FORMAT_TYPE_SHORT:
2366 save_arg(short);
2367 break;
2368 default:
2369 save_arg(int);
2374 out:
2375 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2376 #undef save_arg
2378 EXPORT_SYMBOL_GPL(vbin_printf);
2381 * bstr_printf - Format a string from binary arguments and place it in a buffer
2382 * @buf: The buffer to place the result into
2383 * @size: The size of the buffer, including the trailing null space
2384 * @fmt: The format string to use
2385 * @bin_buf: Binary arguments for the format string
2387 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2388 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2389 * a binary buffer that generated by vbin_printf.
2391 * The format follows C99 vsnprintf, but has some extensions:
2392 * see vsnprintf comment for details.
2394 * The return value is the number of characters which would
2395 * be generated for the given input, excluding the trailing
2396 * '\0', as per ISO C99. If you want to have the exact
2397 * number of characters written into @buf as return value
2398 * (not including the trailing '\0'), use vscnprintf(). If the
2399 * return is greater than or equal to @size, the resulting
2400 * string is truncated.
2402 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2404 struct printf_spec spec = {0};
2405 char *str, *end;
2406 const char *args = (const char *)bin_buf;
2408 if (WARN_ON_ONCE(size > INT_MAX))
2409 return 0;
2411 str = buf;
2412 end = buf + size;
2414 #define get_arg(type) \
2415 ({ \
2416 typeof(type) value; \
2417 if (sizeof(type) == 8) { \
2418 args = PTR_ALIGN(args, sizeof(u32)); \
2419 *(u32 *)&value = *(u32 *)args; \
2420 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2421 } else { \
2422 args = PTR_ALIGN(args, sizeof(type)); \
2423 value = *(typeof(type) *)args; \
2425 args += sizeof(type); \
2426 value; \
2429 /* Make sure end is always >= buf */
2430 if (end < buf) {
2431 end = ((void *)-1);
2432 size = end - buf;
2435 while (*fmt) {
2436 const char *old_fmt = fmt;
2437 int read = format_decode(fmt, &spec);
2439 fmt += read;
2441 switch (spec.type) {
2442 case FORMAT_TYPE_NONE: {
2443 int copy = read;
2444 if (str < end) {
2445 if (copy > end - str)
2446 copy = end - str;
2447 memcpy(str, old_fmt, copy);
2449 str += read;
2450 break;
2453 case FORMAT_TYPE_WIDTH:
2454 set_field_width(&spec, get_arg(int));
2455 break;
2457 case FORMAT_TYPE_PRECISION:
2458 set_precision(&spec, get_arg(int));
2459 break;
2461 case FORMAT_TYPE_CHAR: {
2462 char c;
2464 if (!(spec.flags & LEFT)) {
2465 while (--spec.field_width > 0) {
2466 if (str < end)
2467 *str = ' ';
2468 ++str;
2471 c = (unsigned char) get_arg(char);
2472 if (str < end)
2473 *str = c;
2474 ++str;
2475 while (--spec.field_width > 0) {
2476 if (str < end)
2477 *str = ' ';
2478 ++str;
2480 break;
2483 case FORMAT_TYPE_STR: {
2484 const char *str_arg = args;
2485 args += strlen(str_arg) + 1;
2486 str = string(str, end, (char *)str_arg, spec);
2487 break;
2490 case FORMAT_TYPE_PTR:
2491 str = pointer(fmt, str, end, get_arg(void *), spec);
2492 while (isalnum(*fmt))
2493 fmt++;
2494 break;
2496 case FORMAT_TYPE_PERCENT_CHAR:
2497 if (str < end)
2498 *str = '%';
2499 ++str;
2500 break;
2502 case FORMAT_TYPE_INVALID:
2503 goto out;
2505 default: {
2506 unsigned long long num;
2508 switch (spec.type) {
2510 case FORMAT_TYPE_LONG_LONG:
2511 num = get_arg(long long);
2512 break;
2513 case FORMAT_TYPE_ULONG:
2514 case FORMAT_TYPE_LONG:
2515 num = get_arg(unsigned long);
2516 break;
2517 case FORMAT_TYPE_SIZE_T:
2518 num = get_arg(size_t);
2519 break;
2520 case FORMAT_TYPE_PTRDIFF:
2521 num = get_arg(ptrdiff_t);
2522 break;
2523 case FORMAT_TYPE_UBYTE:
2524 num = get_arg(unsigned char);
2525 break;
2526 case FORMAT_TYPE_BYTE:
2527 num = get_arg(signed char);
2528 break;
2529 case FORMAT_TYPE_USHORT:
2530 num = get_arg(unsigned short);
2531 break;
2532 case FORMAT_TYPE_SHORT:
2533 num = get_arg(short);
2534 break;
2535 case FORMAT_TYPE_UINT:
2536 num = get_arg(unsigned int);
2537 break;
2538 default:
2539 num = get_arg(int);
2542 str = number(str, end, num, spec);
2543 } /* default: */
2544 } /* switch(spec.type) */
2545 } /* while(*fmt) */
2547 out:
2548 if (size > 0) {
2549 if (str < end)
2550 *str = '\0';
2551 else
2552 end[-1] = '\0';
2555 #undef get_arg
2557 /* the trailing null byte doesn't count towards the total */
2558 return str - buf;
2560 EXPORT_SYMBOL_GPL(bstr_printf);
2563 * bprintf - Parse a format string and place args' binary value in a buffer
2564 * @bin_buf: The buffer to place args' binary value
2565 * @size: The size of the buffer(by words(32bits), not characters)
2566 * @fmt: The format string to use
2567 * @...: Arguments for the format string
2569 * The function returns the number of words(u32) written
2570 * into @bin_buf.
2572 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2574 va_list args;
2575 int ret;
2577 va_start(args, fmt);
2578 ret = vbin_printf(bin_buf, size, fmt, args);
2579 va_end(args);
2581 return ret;
2583 EXPORT_SYMBOL_GPL(bprintf);
2585 #endif /* CONFIG_BINARY_PRINTF */
2588 * vsscanf - Unformat a buffer into a list of arguments
2589 * @buf: input buffer
2590 * @fmt: format of buffer
2591 * @args: arguments
2593 int vsscanf(const char *buf, const char *fmt, va_list args)
2595 const char *str = buf;
2596 char *next;
2597 char digit;
2598 int num = 0;
2599 u8 qualifier;
2600 unsigned int base;
2601 union {
2602 long long s;
2603 unsigned long long u;
2604 } val;
2605 s16 field_width;
2606 bool is_sign;
2608 while (*fmt) {
2609 /* skip any white space in format */
2610 /* white space in format matchs any amount of
2611 * white space, including none, in the input.
2613 if (isspace(*fmt)) {
2614 fmt = skip_spaces(++fmt);
2615 str = skip_spaces(str);
2618 /* anything that is not a conversion must match exactly */
2619 if (*fmt != '%' && *fmt) {
2620 if (*fmt++ != *str++)
2621 break;
2622 continue;
2625 if (!*fmt)
2626 break;
2627 ++fmt;
2629 /* skip this conversion.
2630 * advance both strings to next white space
2632 if (*fmt == '*') {
2633 if (!*str)
2634 break;
2635 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
2636 /* '%*[' not yet supported, invalid format */
2637 if (*fmt == '[')
2638 return num;
2639 fmt++;
2641 while (!isspace(*str) && *str)
2642 str++;
2643 continue;
2646 /* get field width */
2647 field_width = -1;
2648 if (isdigit(*fmt)) {
2649 field_width = skip_atoi(&fmt);
2650 if (field_width <= 0)
2651 break;
2654 /* get conversion qualifier */
2655 qualifier = -1;
2656 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2657 _tolower(*fmt) == 'z') {
2658 qualifier = *fmt++;
2659 if (unlikely(qualifier == *fmt)) {
2660 if (qualifier == 'h') {
2661 qualifier = 'H';
2662 fmt++;
2663 } else if (qualifier == 'l') {
2664 qualifier = 'L';
2665 fmt++;
2670 if (!*fmt)
2671 break;
2673 if (*fmt == 'n') {
2674 /* return number of characters read so far */
2675 *va_arg(args, int *) = str - buf;
2676 ++fmt;
2677 continue;
2680 if (!*str)
2681 break;
2683 base = 10;
2684 is_sign = false;
2686 switch (*fmt++) {
2687 case 'c':
2689 char *s = (char *)va_arg(args, char*);
2690 if (field_width == -1)
2691 field_width = 1;
2692 do {
2693 *s++ = *str++;
2694 } while (--field_width > 0 && *str);
2695 num++;
2697 continue;
2698 case 's':
2700 char *s = (char *)va_arg(args, char *);
2701 if (field_width == -1)
2702 field_width = SHRT_MAX;
2703 /* first, skip leading white space in buffer */
2704 str = skip_spaces(str);
2706 /* now copy until next white space */
2707 while (*str && !isspace(*str) && field_width--)
2708 *s++ = *str++;
2709 *s = '\0';
2710 num++;
2712 continue;
2714 * Warning: This implementation of the '[' conversion specifier
2715 * deviates from its glibc counterpart in the following ways:
2716 * (1) It does NOT support ranges i.e. '-' is NOT a special
2717 * character
2718 * (2) It cannot match the closing bracket ']' itself
2719 * (3) A field width is required
2720 * (4) '%*[' (discard matching input) is currently not supported
2722 * Example usage:
2723 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
2724 * buf1, buf2, buf3);
2725 * if (ret < 3)
2726 * // etc..
2728 case '[':
2730 char *s = (char *)va_arg(args, char *);
2731 DECLARE_BITMAP(set, 256) = {0};
2732 unsigned int len = 0;
2733 bool negate = (*fmt == '^');
2735 /* field width is required */
2736 if (field_width == -1)
2737 return num;
2739 if (negate)
2740 ++fmt;
2742 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
2743 set_bit((u8)*fmt, set);
2745 /* no ']' or no character set found */
2746 if (!*fmt || !len)
2747 return num;
2748 ++fmt;
2750 if (negate) {
2751 bitmap_complement(set, set, 256);
2752 /* exclude null '\0' byte */
2753 clear_bit(0, set);
2756 /* match must be non-empty */
2757 if (!test_bit((u8)*str, set))
2758 return num;
2760 while (test_bit((u8)*str, set) && field_width--)
2761 *s++ = *str++;
2762 *s = '\0';
2763 ++num;
2765 continue;
2766 case 'o':
2767 base = 8;
2768 break;
2769 case 'x':
2770 case 'X':
2771 base = 16;
2772 break;
2773 case 'i':
2774 base = 0;
2775 case 'd':
2776 is_sign = true;
2777 case 'u':
2778 break;
2779 case '%':
2780 /* looking for '%' in str */
2781 if (*str++ != '%')
2782 return num;
2783 continue;
2784 default:
2785 /* invalid format; stop here */
2786 return num;
2789 /* have some sort of integer conversion.
2790 * first, skip white space in buffer.
2792 str = skip_spaces(str);
2794 digit = *str;
2795 if (is_sign && digit == '-')
2796 digit = *(str + 1);
2798 if (!digit
2799 || (base == 16 && !isxdigit(digit))
2800 || (base == 10 && !isdigit(digit))
2801 || (base == 8 && (!isdigit(digit) || digit > '7'))
2802 || (base == 0 && !isdigit(digit)))
2803 break;
2805 if (is_sign)
2806 val.s = qualifier != 'L' ?
2807 simple_strtol(str, &next, base) :
2808 simple_strtoll(str, &next, base);
2809 else
2810 val.u = qualifier != 'L' ?
2811 simple_strtoul(str, &next, base) :
2812 simple_strtoull(str, &next, base);
2814 if (field_width > 0 && next - str > field_width) {
2815 if (base == 0)
2816 _parse_integer_fixup_radix(str, &base);
2817 while (next - str > field_width) {
2818 if (is_sign)
2819 val.s = div_s64(val.s, base);
2820 else
2821 val.u = div_u64(val.u, base);
2822 --next;
2826 switch (qualifier) {
2827 case 'H': /* that's 'hh' in format */
2828 if (is_sign)
2829 *va_arg(args, signed char *) = val.s;
2830 else
2831 *va_arg(args, unsigned char *) = val.u;
2832 break;
2833 case 'h':
2834 if (is_sign)
2835 *va_arg(args, short *) = val.s;
2836 else
2837 *va_arg(args, unsigned short *) = val.u;
2838 break;
2839 case 'l':
2840 if (is_sign)
2841 *va_arg(args, long *) = val.s;
2842 else
2843 *va_arg(args, unsigned long *) = val.u;
2844 break;
2845 case 'L':
2846 if (is_sign)
2847 *va_arg(args, long long *) = val.s;
2848 else
2849 *va_arg(args, unsigned long long *) = val.u;
2850 break;
2851 case 'Z':
2852 case 'z':
2853 *va_arg(args, size_t *) = val.u;
2854 break;
2855 default:
2856 if (is_sign)
2857 *va_arg(args, int *) = val.s;
2858 else
2859 *va_arg(args, unsigned int *) = val.u;
2860 break;
2862 num++;
2864 if (!next)
2865 break;
2866 str = next;
2869 return num;
2871 EXPORT_SYMBOL(vsscanf);
2874 * sscanf - Unformat a buffer into a list of arguments
2875 * @buf: input buffer
2876 * @fmt: formatting of buffer
2877 * @...: resulting arguments
2879 int sscanf(const char *buf, const char *fmt, ...)
2881 va_list args;
2882 int i;
2884 va_start(args, fmt);
2885 i = vsscanf(buf, fmt, args);
2886 va_end(args);
2888 return i;
2890 EXPORT_SYMBOL(sscanf);