xfrm4: Fix header checks in _decode_session4.
[linux/fpc-iii.git] / lib / vsprintf.c
blob95cd63b43b99fa83798fb68dadfbd95a8c0bc57c
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 <net/addrconf.h>
35 #include <asm/page.h> /* for PAGE_SIZE */
36 #include <asm/sections.h> /* for dereference_function_descriptor() */
37 #include <asm/byteorder.h> /* cpu_to_le16 */
39 #include <linux/string_helpers.h>
40 #include "kstrtox.h"
42 /**
43 * simple_strtoull - convert a string to an unsigned long long
44 * @cp: The start of the string
45 * @endp: A pointer to the end of the parsed string will be placed here
46 * @base: The number base to use
48 * This function is obsolete. Please use kstrtoull instead.
50 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
52 unsigned long long result;
53 unsigned int rv;
55 cp = _parse_integer_fixup_radix(cp, &base);
56 rv = _parse_integer(cp, base, &result);
57 /* FIXME */
58 cp += (rv & ~KSTRTOX_OVERFLOW);
60 if (endp)
61 *endp = (char *)cp;
63 return result;
65 EXPORT_SYMBOL(simple_strtoull);
67 /**
68 * simple_strtoul - convert a string to an unsigned long
69 * @cp: The start of the string
70 * @endp: A pointer to the end of the parsed string will be placed here
71 * @base: The number base to use
73 * This function is obsolete. Please use kstrtoul instead.
75 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
77 return simple_strtoull(cp, endp, base);
79 EXPORT_SYMBOL(simple_strtoul);
81 /**
82 * simple_strtol - convert a string to a signed 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 is obsolete. Please use kstrtol instead.
89 long simple_strtol(const char *cp, char **endp, unsigned int base)
91 if (*cp == '-')
92 return -simple_strtoul(cp + 1, endp, base);
94 return simple_strtoul(cp, endp, base);
96 EXPORT_SYMBOL(simple_strtol);
98 /**
99 * simple_strtoll - convert a string to a signed long long
100 * @cp: The start of the string
101 * @endp: A pointer to the end of the parsed string will be placed here
102 * @base: The number base to use
104 * This function is obsolete. Please use kstrtoll instead.
106 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
108 if (*cp == '-')
109 return -simple_strtoull(cp + 1, endp, base);
111 return simple_strtoull(cp, endp, base);
113 EXPORT_SYMBOL(simple_strtoll);
115 static noinline_for_stack
116 int skip_atoi(const char **s)
118 int i = 0;
120 do {
121 i = i*10 + *((*s)++) - '0';
122 } while (isdigit(**s));
124 return i;
128 * Decimal conversion is by far the most typical, and is used for
129 * /proc and /sys data. This directly impacts e.g. top performance
130 * with many processes running. We optimize it for speed by emitting
131 * two characters at a time, using a 200 byte lookup table. This
132 * roughly halves the number of multiplications compared to computing
133 * the digits one at a time. Implementation strongly inspired by the
134 * previous version, which in turn used ideas described at
135 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
136 * from the author, Douglas W. Jones).
138 * It turns out there is precisely one 26 bit fixed-point
139 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
140 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
141 * range happens to be somewhat larger (x <= 1073741898), but that's
142 * irrelevant for our purpose.
144 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
145 * need a 32x32->64 bit multiply, so we simply use the same constant.
147 * For dividing a number in the range [100, 10^4-1] by 100, there are
148 * several options. The simplest is (x * 0x147b) >> 19, which is valid
149 * for all x <= 43698.
152 static const u16 decpair[100] = {
153 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
154 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
155 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
156 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
157 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
158 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
159 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
160 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
161 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
162 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
163 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
164 #undef _
168 * This will print a single '0' even if r == 0, since we would
169 * immediately jump to out_r where two 0s would be written but only
170 * one of them accounted for in buf. This is needed by ip4_string
171 * below. All other callers pass a non-zero value of r.
173 static noinline_for_stack
174 char *put_dec_trunc8(char *buf, unsigned r)
176 unsigned q;
178 /* 1 <= r < 10^8 */
179 if (r < 100)
180 goto out_r;
182 /* 100 <= r < 10^8 */
183 q = (r * (u64)0x28f5c29) >> 32;
184 *((u16 *)buf) = decpair[r - 100*q];
185 buf += 2;
187 /* 1 <= q < 10^6 */
188 if (q < 100)
189 goto out_q;
191 /* 100 <= q < 10^6 */
192 r = (q * (u64)0x28f5c29) >> 32;
193 *((u16 *)buf) = decpair[q - 100*r];
194 buf += 2;
196 /* 1 <= r < 10^4 */
197 if (r < 100)
198 goto out_r;
200 /* 100 <= r < 10^4 */
201 q = (r * 0x147b) >> 19;
202 *((u16 *)buf) = decpair[r - 100*q];
203 buf += 2;
204 out_q:
205 /* 1 <= q < 100 */
206 r = q;
207 out_r:
208 /* 1 <= r < 100 */
209 *((u16 *)buf) = decpair[r];
210 buf += r < 10 ? 1 : 2;
211 return buf;
214 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
215 static noinline_for_stack
216 char *put_dec_full8(char *buf, unsigned r)
218 unsigned q;
220 /* 0 <= r < 10^8 */
221 q = (r * (u64)0x28f5c29) >> 32;
222 *((u16 *)buf) = decpair[r - 100*q];
223 buf += 2;
225 /* 0 <= q < 10^6 */
226 r = (q * (u64)0x28f5c29) >> 32;
227 *((u16 *)buf) = decpair[q - 100*r];
228 buf += 2;
230 /* 0 <= r < 10^4 */
231 q = (r * 0x147b) >> 19;
232 *((u16 *)buf) = decpair[r - 100*q];
233 buf += 2;
235 /* 0 <= q < 100 */
236 *((u16 *)buf) = decpair[q];
237 buf += 2;
238 return buf;
241 static noinline_for_stack
242 char *put_dec(char *buf, unsigned long long n)
244 if (n >= 100*1000*1000)
245 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
246 /* 1 <= n <= 1.6e11 */
247 if (n >= 100*1000*1000)
248 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
249 /* 1 <= n < 1e8 */
250 return put_dec_trunc8(buf, n);
253 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
255 static void
256 put_dec_full4(char *buf, unsigned r)
258 unsigned q;
260 /* 0 <= r < 10^4 */
261 q = (r * 0x147b) >> 19;
262 *((u16 *)buf) = decpair[r - 100*q];
263 buf += 2;
264 /* 0 <= q < 100 */
265 *((u16 *)buf) = decpair[q];
269 * Call put_dec_full4 on x % 10000, return x / 10000.
270 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
271 * holds for all x < 1,128,869,999. The largest value this
272 * helper will ever be asked to convert is 1,125,520,955.
273 * (second call in the put_dec code, assuming n is all-ones).
275 static noinline_for_stack
276 unsigned put_dec_helper4(char *buf, unsigned x)
278 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
280 put_dec_full4(buf, x - q * 10000);
281 return q;
284 /* Based on code by Douglas W. Jones found at
285 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
286 * (with permission from the author).
287 * Performs no 64-bit division and hence should be fast on 32-bit machines.
289 static
290 char *put_dec(char *buf, unsigned long long n)
292 uint32_t d3, d2, d1, q, h;
294 if (n < 100*1000*1000)
295 return put_dec_trunc8(buf, n);
297 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
298 h = (n >> 32);
299 d2 = (h ) & 0xffff;
300 d3 = (h >> 16); /* implicit "& 0xffff" */
302 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
303 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
304 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
305 q = put_dec_helper4(buf, q);
307 q += 7671 * d3 + 9496 * d2 + 6 * d1;
308 q = put_dec_helper4(buf+4, q);
310 q += 4749 * d3 + 42 * d2;
311 q = put_dec_helper4(buf+8, q);
313 q += 281 * d3;
314 buf += 12;
315 if (q)
316 buf = put_dec_trunc8(buf, q);
317 else while (buf[-1] == '0')
318 --buf;
320 return buf;
323 #endif
326 * Convert passed number to decimal string.
327 * Returns the length of string. On buffer overflow, returns 0.
329 * If speed is not important, use snprintf(). It's easy to read the code.
331 int num_to_str(char *buf, int size, unsigned long long num)
333 /* put_dec requires 2-byte alignment of the buffer. */
334 char tmp[sizeof(num) * 3] __aligned(2);
335 int idx, len;
337 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
338 if (num <= 9) {
339 tmp[0] = '0' + num;
340 len = 1;
341 } else {
342 len = put_dec(tmp, num) - tmp;
345 if (len > size)
346 return 0;
347 for (idx = 0; idx < len; ++idx)
348 buf[idx] = tmp[len - idx - 1];
349 return len;
352 #define SIGN 1 /* unsigned/signed, must be 1 */
353 #define LEFT 2 /* left justified */
354 #define PLUS 4 /* show plus */
355 #define SPACE 8 /* space if plus */
356 #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
357 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
358 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
360 enum format_type {
361 FORMAT_TYPE_NONE, /* Just a string part */
362 FORMAT_TYPE_WIDTH,
363 FORMAT_TYPE_PRECISION,
364 FORMAT_TYPE_CHAR,
365 FORMAT_TYPE_STR,
366 FORMAT_TYPE_PTR,
367 FORMAT_TYPE_PERCENT_CHAR,
368 FORMAT_TYPE_INVALID,
369 FORMAT_TYPE_LONG_LONG,
370 FORMAT_TYPE_ULONG,
371 FORMAT_TYPE_LONG,
372 FORMAT_TYPE_UBYTE,
373 FORMAT_TYPE_BYTE,
374 FORMAT_TYPE_USHORT,
375 FORMAT_TYPE_SHORT,
376 FORMAT_TYPE_UINT,
377 FORMAT_TYPE_INT,
378 FORMAT_TYPE_SIZE_T,
379 FORMAT_TYPE_PTRDIFF
382 struct printf_spec {
383 u8 type; /* format_type enum */
384 u8 flags; /* flags to number() */
385 u8 base; /* number base, 8, 10 or 16 only */
386 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
387 s16 field_width; /* width of output field */
388 s16 precision; /* # of digits/chars */
391 static noinline_for_stack
392 char *number(char *buf, char *end, unsigned long long num,
393 struct printf_spec spec)
395 /* put_dec requires 2-byte alignment of the buffer. */
396 char tmp[3 * sizeof(num)] __aligned(2);
397 char sign;
398 char locase;
399 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
400 int i;
401 bool is_zero = num == 0LL;
403 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
404 * produces same digits or (maybe lowercased) letters */
405 locase = (spec.flags & SMALL);
406 if (spec.flags & LEFT)
407 spec.flags &= ~ZEROPAD;
408 sign = 0;
409 if (spec.flags & SIGN) {
410 if ((signed long long)num < 0) {
411 sign = '-';
412 num = -(signed long long)num;
413 spec.field_width--;
414 } else if (spec.flags & PLUS) {
415 sign = '+';
416 spec.field_width--;
417 } else if (spec.flags & SPACE) {
418 sign = ' ';
419 spec.field_width--;
422 if (need_pfx) {
423 if (spec.base == 16)
424 spec.field_width -= 2;
425 else if (!is_zero)
426 spec.field_width--;
429 /* generate full string in tmp[], in reverse order */
430 i = 0;
431 if (num < spec.base)
432 tmp[i++] = hex_asc_upper[num] | locase;
433 else if (spec.base != 10) { /* 8 or 16 */
434 int mask = spec.base - 1;
435 int shift = 3;
437 if (spec.base == 16)
438 shift = 4;
439 do {
440 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
441 num >>= shift;
442 } while (num);
443 } else { /* base 10 */
444 i = put_dec(tmp, num) - tmp;
447 /* printing 100 using %2d gives "100", not "00" */
448 if (i > spec.precision)
449 spec.precision = i;
450 /* leading space padding */
451 spec.field_width -= spec.precision;
452 if (!(spec.flags & (ZEROPAD | LEFT))) {
453 while (--spec.field_width >= 0) {
454 if (buf < end)
455 *buf = ' ';
456 ++buf;
459 /* sign */
460 if (sign) {
461 if (buf < end)
462 *buf = sign;
463 ++buf;
465 /* "0x" / "0" prefix */
466 if (need_pfx) {
467 if (spec.base == 16 || !is_zero) {
468 if (buf < end)
469 *buf = '0';
470 ++buf;
472 if (spec.base == 16) {
473 if (buf < end)
474 *buf = ('X' | locase);
475 ++buf;
478 /* zero or space padding */
479 if (!(spec.flags & LEFT)) {
480 char c = ' ' + (spec.flags & ZEROPAD);
481 BUILD_BUG_ON(' ' + ZEROPAD != '0');
482 while (--spec.field_width >= 0) {
483 if (buf < end)
484 *buf = c;
485 ++buf;
488 /* hmm even more zero padding? */
489 while (i <= --spec.precision) {
490 if (buf < end)
491 *buf = '0';
492 ++buf;
494 /* actual digits of result */
495 while (--i >= 0) {
496 if (buf < end)
497 *buf = tmp[i];
498 ++buf;
500 /* trailing space padding */
501 while (--spec.field_width >= 0) {
502 if (buf < end)
503 *buf = ' ';
504 ++buf;
507 return buf;
510 static noinline_for_stack
511 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
513 int len, i;
515 if ((unsigned long)s < PAGE_SIZE)
516 s = "(null)";
518 len = strnlen(s, spec.precision);
520 if (!(spec.flags & LEFT)) {
521 while (len < spec.field_width--) {
522 if (buf < end)
523 *buf = ' ';
524 ++buf;
527 for (i = 0; i < len; ++i) {
528 if (buf < end)
529 *buf = *s;
530 ++buf; ++s;
532 while (len < spec.field_width--) {
533 if (buf < end)
534 *buf = ' ';
535 ++buf;
538 return buf;
541 static void widen(char *buf, char *end, unsigned len, unsigned spaces)
543 size_t size;
544 if (buf >= end) /* nowhere to put anything */
545 return;
546 size = end - buf;
547 if (size <= spaces) {
548 memset(buf, ' ', size);
549 return;
551 if (len) {
552 if (len > size - spaces)
553 len = size - spaces;
554 memmove(buf + spaces, buf, len);
556 memset(buf, ' ', spaces);
559 static noinline_for_stack
560 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
561 const char *fmt)
563 const char *array[4], *s;
564 const struct dentry *p;
565 int depth;
566 int i, n;
568 switch (fmt[1]) {
569 case '2': case '3': case '4':
570 depth = fmt[1] - '0';
571 break;
572 default:
573 depth = 1;
576 rcu_read_lock();
577 for (i = 0; i < depth; i++, d = p) {
578 p = ACCESS_ONCE(d->d_parent);
579 array[i] = ACCESS_ONCE(d->d_name.name);
580 if (p == d) {
581 if (i)
582 array[i] = "";
583 i++;
584 break;
587 s = array[--i];
588 for (n = 0; n != spec.precision; n++, buf++) {
589 char c = *s++;
590 if (!c) {
591 if (!i)
592 break;
593 c = '/';
594 s = array[--i];
596 if (buf < end)
597 *buf = c;
599 rcu_read_unlock();
600 if (n < spec.field_width) {
601 /* we want to pad the sucker */
602 unsigned spaces = spec.field_width - n;
603 if (!(spec.flags & LEFT)) {
604 widen(buf - n, end, n, spaces);
605 return buf + spaces;
607 while (spaces--) {
608 if (buf < end)
609 *buf = ' ';
610 ++buf;
613 return buf;
616 static noinline_for_stack
617 char *symbol_string(char *buf, char *end, void *ptr,
618 struct printf_spec spec, const char *fmt)
620 unsigned long value;
621 #ifdef CONFIG_KALLSYMS
622 char sym[KSYM_SYMBOL_LEN];
623 #endif
625 if (fmt[1] == 'R')
626 ptr = __builtin_extract_return_addr(ptr);
627 value = (unsigned long)ptr;
629 #ifdef CONFIG_KALLSYMS
630 if (*fmt == 'B')
631 sprint_backtrace(sym, value);
632 else if (*fmt != 'f' && *fmt != 's')
633 sprint_symbol(sym, value);
634 else
635 sprint_symbol_no_offset(sym, value);
637 return string(buf, end, sym, spec);
638 #else
639 spec.field_width = 2 * sizeof(void *);
640 spec.flags |= SPECIAL | SMALL | ZEROPAD;
641 spec.base = 16;
643 return number(buf, end, value, spec);
644 #endif
647 static noinline_for_stack
648 char *resource_string(char *buf, char *end, struct resource *res,
649 struct printf_spec spec, const char *fmt)
651 #ifndef IO_RSRC_PRINTK_SIZE
652 #define IO_RSRC_PRINTK_SIZE 6
653 #endif
655 #ifndef MEM_RSRC_PRINTK_SIZE
656 #define MEM_RSRC_PRINTK_SIZE 10
657 #endif
658 static const struct printf_spec io_spec = {
659 .base = 16,
660 .field_width = IO_RSRC_PRINTK_SIZE,
661 .precision = -1,
662 .flags = SPECIAL | SMALL | ZEROPAD,
664 static const struct printf_spec mem_spec = {
665 .base = 16,
666 .field_width = MEM_RSRC_PRINTK_SIZE,
667 .precision = -1,
668 .flags = SPECIAL | SMALL | ZEROPAD,
670 static const struct printf_spec bus_spec = {
671 .base = 16,
672 .field_width = 2,
673 .precision = -1,
674 .flags = SMALL | ZEROPAD,
676 static const struct printf_spec dec_spec = {
677 .base = 10,
678 .precision = -1,
679 .flags = 0,
681 static const struct printf_spec str_spec = {
682 .field_width = -1,
683 .precision = 10,
684 .flags = LEFT,
686 static const struct printf_spec flag_spec = {
687 .base = 16,
688 .precision = -1,
689 .flags = SPECIAL | SMALL,
692 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
693 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
694 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
695 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
696 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
697 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
698 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
699 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
701 char *p = sym, *pend = sym + sizeof(sym);
702 int decode = (fmt[0] == 'R') ? 1 : 0;
703 const struct printf_spec *specp;
705 *p++ = '[';
706 if (res->flags & IORESOURCE_IO) {
707 p = string(p, pend, "io ", str_spec);
708 specp = &io_spec;
709 } else if (res->flags & IORESOURCE_MEM) {
710 p = string(p, pend, "mem ", str_spec);
711 specp = &mem_spec;
712 } else if (res->flags & IORESOURCE_IRQ) {
713 p = string(p, pend, "irq ", str_spec);
714 specp = &dec_spec;
715 } else if (res->flags & IORESOURCE_DMA) {
716 p = string(p, pend, "dma ", str_spec);
717 specp = &dec_spec;
718 } else if (res->flags & IORESOURCE_BUS) {
719 p = string(p, pend, "bus ", str_spec);
720 specp = &bus_spec;
721 } else {
722 p = string(p, pend, "??? ", str_spec);
723 specp = &mem_spec;
724 decode = 0;
726 if (decode && res->flags & IORESOURCE_UNSET) {
727 p = string(p, pend, "size ", str_spec);
728 p = number(p, pend, resource_size(res), *specp);
729 } else {
730 p = number(p, pend, res->start, *specp);
731 if (res->start != res->end) {
732 *p++ = '-';
733 p = number(p, pend, res->end, *specp);
736 if (decode) {
737 if (res->flags & IORESOURCE_MEM_64)
738 p = string(p, pend, " 64bit", str_spec);
739 if (res->flags & IORESOURCE_PREFETCH)
740 p = string(p, pend, " pref", str_spec);
741 if (res->flags & IORESOURCE_WINDOW)
742 p = string(p, pend, " window", str_spec);
743 if (res->flags & IORESOURCE_DISABLED)
744 p = string(p, pend, " disabled", str_spec);
745 } else {
746 p = string(p, pend, " flags ", str_spec);
747 p = number(p, pend, res->flags, flag_spec);
749 *p++ = ']';
750 *p = '\0';
752 return string(buf, end, sym, spec);
755 static noinline_for_stack
756 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
757 const char *fmt)
759 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
760 negative value, fallback to the default */
761 char separator;
763 if (spec.field_width == 0)
764 /* nothing to print */
765 return buf;
767 if (ZERO_OR_NULL_PTR(addr))
768 /* NULL pointer */
769 return string(buf, end, NULL, spec);
771 switch (fmt[1]) {
772 case 'C':
773 separator = ':';
774 break;
775 case 'D':
776 separator = '-';
777 break;
778 case 'N':
779 separator = 0;
780 break;
781 default:
782 separator = ' ';
783 break;
786 if (spec.field_width > 0)
787 len = min_t(int, spec.field_width, 64);
789 for (i = 0; i < len; ++i) {
790 if (buf < end)
791 *buf = hex_asc_hi(addr[i]);
792 ++buf;
793 if (buf < end)
794 *buf = hex_asc_lo(addr[i]);
795 ++buf;
797 if (separator && i != len - 1) {
798 if (buf < end)
799 *buf = separator;
800 ++buf;
804 return buf;
807 static noinline_for_stack
808 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
809 struct printf_spec spec, const char *fmt)
811 const int CHUNKSZ = 32;
812 int nr_bits = max_t(int, spec.field_width, 0);
813 int i, chunksz;
814 bool first = true;
816 /* reused to print numbers */
817 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
819 chunksz = nr_bits & (CHUNKSZ - 1);
820 if (chunksz == 0)
821 chunksz = CHUNKSZ;
823 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
824 for (; i >= 0; i -= CHUNKSZ) {
825 u32 chunkmask, val;
826 int word, bit;
828 chunkmask = ((1ULL << chunksz) - 1);
829 word = i / BITS_PER_LONG;
830 bit = i % BITS_PER_LONG;
831 val = (bitmap[word] >> bit) & chunkmask;
833 if (!first) {
834 if (buf < end)
835 *buf = ',';
836 buf++;
838 first = false;
840 spec.field_width = DIV_ROUND_UP(chunksz, 4);
841 buf = number(buf, end, val, spec);
843 chunksz = CHUNKSZ;
845 return buf;
848 static noinline_for_stack
849 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
850 struct printf_spec spec, const char *fmt)
852 int nr_bits = max_t(int, spec.field_width, 0);
853 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
854 int cur, rbot, rtop;
855 bool first = true;
857 /* reused to print numbers */
858 spec = (struct printf_spec){ .base = 10 };
860 rbot = cur = find_first_bit(bitmap, nr_bits);
861 while (cur < nr_bits) {
862 rtop = cur;
863 cur = find_next_bit(bitmap, nr_bits, cur + 1);
864 if (cur < nr_bits && cur <= rtop + 1)
865 continue;
867 if (!first) {
868 if (buf < end)
869 *buf = ',';
870 buf++;
872 first = false;
874 buf = number(buf, end, rbot, spec);
875 if (rbot < rtop) {
876 if (buf < end)
877 *buf = '-';
878 buf++;
880 buf = number(buf, end, rtop, spec);
883 rbot = cur;
885 return buf;
888 static noinline_for_stack
889 char *mac_address_string(char *buf, char *end, u8 *addr,
890 struct printf_spec spec, const char *fmt)
892 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
893 char *p = mac_addr;
894 int i;
895 char separator;
896 bool reversed = false;
898 switch (fmt[1]) {
899 case 'F':
900 separator = '-';
901 break;
903 case 'R':
904 reversed = true;
905 /* fall through */
907 default:
908 separator = ':';
909 break;
912 for (i = 0; i < 6; i++) {
913 if (reversed)
914 p = hex_byte_pack(p, addr[5 - i]);
915 else
916 p = hex_byte_pack(p, addr[i]);
918 if (fmt[0] == 'M' && i != 5)
919 *p++ = separator;
921 *p = '\0';
923 return string(buf, end, mac_addr, spec);
926 static noinline_for_stack
927 char *ip4_string(char *p, const u8 *addr, const char *fmt)
929 int i;
930 bool leading_zeros = (fmt[0] == 'i');
931 int index;
932 int step;
934 switch (fmt[2]) {
935 case 'h':
936 #ifdef __BIG_ENDIAN
937 index = 0;
938 step = 1;
939 #else
940 index = 3;
941 step = -1;
942 #endif
943 break;
944 case 'l':
945 index = 3;
946 step = -1;
947 break;
948 case 'n':
949 case 'b':
950 default:
951 index = 0;
952 step = 1;
953 break;
955 for (i = 0; i < 4; i++) {
956 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
957 int digits = put_dec_trunc8(temp, addr[index]) - temp;
958 if (leading_zeros) {
959 if (digits < 3)
960 *p++ = '0';
961 if (digits < 2)
962 *p++ = '0';
964 /* reverse the digits in the quad */
965 while (digits--)
966 *p++ = temp[digits];
967 if (i < 3)
968 *p++ = '.';
969 index += step;
971 *p = '\0';
973 return p;
976 static noinline_for_stack
977 char *ip6_compressed_string(char *p, const char *addr)
979 int i, j, range;
980 unsigned char zerolength[8];
981 int longest = 1;
982 int colonpos = -1;
983 u16 word;
984 u8 hi, lo;
985 bool needcolon = false;
986 bool useIPv4;
987 struct in6_addr in6;
989 memcpy(&in6, addr, sizeof(struct in6_addr));
991 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
993 memset(zerolength, 0, sizeof(zerolength));
995 if (useIPv4)
996 range = 6;
997 else
998 range = 8;
1000 /* find position of longest 0 run */
1001 for (i = 0; i < range; i++) {
1002 for (j = i; j < range; j++) {
1003 if (in6.s6_addr16[j] != 0)
1004 break;
1005 zerolength[i]++;
1008 for (i = 0; i < range; i++) {
1009 if (zerolength[i] > longest) {
1010 longest = zerolength[i];
1011 colonpos = i;
1014 if (longest == 1) /* don't compress a single 0 */
1015 colonpos = -1;
1017 /* emit address */
1018 for (i = 0; i < range; i++) {
1019 if (i == colonpos) {
1020 if (needcolon || i == 0)
1021 *p++ = ':';
1022 *p++ = ':';
1023 needcolon = false;
1024 i += longest - 1;
1025 continue;
1027 if (needcolon) {
1028 *p++ = ':';
1029 needcolon = false;
1031 /* hex u16 without leading 0s */
1032 word = ntohs(in6.s6_addr16[i]);
1033 hi = word >> 8;
1034 lo = word & 0xff;
1035 if (hi) {
1036 if (hi > 0x0f)
1037 p = hex_byte_pack(p, hi);
1038 else
1039 *p++ = hex_asc_lo(hi);
1040 p = hex_byte_pack(p, lo);
1042 else if (lo > 0x0f)
1043 p = hex_byte_pack(p, lo);
1044 else
1045 *p++ = hex_asc_lo(lo);
1046 needcolon = true;
1049 if (useIPv4) {
1050 if (needcolon)
1051 *p++ = ':';
1052 p = ip4_string(p, &in6.s6_addr[12], "I4");
1054 *p = '\0';
1056 return p;
1059 static noinline_for_stack
1060 char *ip6_string(char *p, const char *addr, const char *fmt)
1062 int i;
1064 for (i = 0; i < 8; i++) {
1065 p = hex_byte_pack(p, *addr++);
1066 p = hex_byte_pack(p, *addr++);
1067 if (fmt[0] == 'I' && i != 7)
1068 *p++ = ':';
1070 *p = '\0';
1072 return p;
1075 static noinline_for_stack
1076 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1077 struct printf_spec spec, const char *fmt)
1079 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1081 if (fmt[0] == 'I' && fmt[2] == 'c')
1082 ip6_compressed_string(ip6_addr, addr);
1083 else
1084 ip6_string(ip6_addr, addr, fmt);
1086 return string(buf, end, ip6_addr, spec);
1089 static noinline_for_stack
1090 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1091 struct printf_spec spec, const char *fmt)
1093 char ip4_addr[sizeof("255.255.255.255")];
1095 ip4_string(ip4_addr, addr, fmt);
1097 return string(buf, end, ip4_addr, spec);
1100 static noinline_for_stack
1101 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1102 struct printf_spec spec, const char *fmt)
1104 bool have_p = false, have_s = false, have_f = false, have_c = false;
1105 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1106 sizeof(":12345") + sizeof("/123456789") +
1107 sizeof("%1234567890")];
1108 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1109 const u8 *addr = (const u8 *) &sa->sin6_addr;
1110 char fmt6[2] = { fmt[0], '6' };
1111 u8 off = 0;
1113 fmt++;
1114 while (isalpha(*++fmt)) {
1115 switch (*fmt) {
1116 case 'p':
1117 have_p = true;
1118 break;
1119 case 'f':
1120 have_f = true;
1121 break;
1122 case 's':
1123 have_s = true;
1124 break;
1125 case 'c':
1126 have_c = true;
1127 break;
1131 if (have_p || have_s || have_f) {
1132 *p = '[';
1133 off = 1;
1136 if (fmt6[0] == 'I' && have_c)
1137 p = ip6_compressed_string(ip6_addr + off, addr);
1138 else
1139 p = ip6_string(ip6_addr + off, addr, fmt6);
1141 if (have_p || have_s || have_f)
1142 *p++ = ']';
1144 if (have_p) {
1145 *p++ = ':';
1146 p = number(p, pend, ntohs(sa->sin6_port), spec);
1148 if (have_f) {
1149 *p++ = '/';
1150 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1151 IPV6_FLOWINFO_MASK), spec);
1153 if (have_s) {
1154 *p++ = '%';
1155 p = number(p, pend, sa->sin6_scope_id, spec);
1157 *p = '\0';
1159 return string(buf, end, ip6_addr, spec);
1162 static noinline_for_stack
1163 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1164 struct printf_spec spec, const char *fmt)
1166 bool have_p = false;
1167 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1168 char *pend = ip4_addr + sizeof(ip4_addr);
1169 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1170 char fmt4[3] = { fmt[0], '4', 0 };
1172 fmt++;
1173 while (isalpha(*++fmt)) {
1174 switch (*fmt) {
1175 case 'p':
1176 have_p = true;
1177 break;
1178 case 'h':
1179 case 'l':
1180 case 'n':
1181 case 'b':
1182 fmt4[2] = *fmt;
1183 break;
1187 p = ip4_string(ip4_addr, addr, fmt4);
1188 if (have_p) {
1189 *p++ = ':';
1190 p = number(p, pend, ntohs(sa->sin_port), spec);
1192 *p = '\0';
1194 return string(buf, end, ip4_addr, spec);
1197 static noinline_for_stack
1198 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1199 const char *fmt)
1201 bool found = true;
1202 int count = 1;
1203 unsigned int flags = 0;
1204 int len;
1206 if (spec.field_width == 0)
1207 return buf; /* nothing to print */
1209 if (ZERO_OR_NULL_PTR(addr))
1210 return string(buf, end, NULL, spec); /* NULL pointer */
1213 do {
1214 switch (fmt[count++]) {
1215 case 'a':
1216 flags |= ESCAPE_ANY;
1217 break;
1218 case 'c':
1219 flags |= ESCAPE_SPECIAL;
1220 break;
1221 case 'h':
1222 flags |= ESCAPE_HEX;
1223 break;
1224 case 'n':
1225 flags |= ESCAPE_NULL;
1226 break;
1227 case 'o':
1228 flags |= ESCAPE_OCTAL;
1229 break;
1230 case 'p':
1231 flags |= ESCAPE_NP;
1232 break;
1233 case 's':
1234 flags |= ESCAPE_SPACE;
1235 break;
1236 default:
1237 found = false;
1238 break;
1240 } while (found);
1242 if (!flags)
1243 flags = ESCAPE_ANY_NP;
1245 len = spec.field_width < 0 ? 1 : spec.field_width;
1248 * string_escape_mem() writes as many characters as it can to
1249 * the given buffer, and returns the total size of the output
1250 * had the buffer been big enough.
1252 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1254 return buf;
1257 static noinline_for_stack
1258 char *uuid_string(char *buf, char *end, const u8 *addr,
1259 struct printf_spec spec, const char *fmt)
1261 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1262 char *p = uuid;
1263 int i;
1264 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1265 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1266 const u8 *index = be;
1267 bool uc = false;
1269 switch (*(++fmt)) {
1270 case 'L':
1271 uc = true; /* fall-through */
1272 case 'l':
1273 index = le;
1274 break;
1275 case 'B':
1276 uc = true;
1277 break;
1280 for (i = 0; i < 16; i++) {
1281 p = hex_byte_pack(p, addr[index[i]]);
1282 switch (i) {
1283 case 3:
1284 case 5:
1285 case 7:
1286 case 9:
1287 *p++ = '-';
1288 break;
1292 *p = 0;
1294 if (uc) {
1295 p = uuid;
1296 do {
1297 *p = toupper(*p);
1298 } while (*(++p));
1301 return string(buf, end, uuid, spec);
1304 static
1305 char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1306 struct printf_spec spec)
1308 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1309 if (spec.field_width == -1)
1310 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1311 spec.base = 16;
1313 return number(buf, end, *(const netdev_features_t *)addr, spec);
1316 static noinline_for_stack
1317 char *address_val(char *buf, char *end, const void *addr,
1318 struct printf_spec spec, const char *fmt)
1320 unsigned long long num;
1322 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1323 spec.base = 16;
1325 switch (fmt[1]) {
1326 case 'd':
1327 num = *(const dma_addr_t *)addr;
1328 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1329 break;
1330 case 'p':
1331 default:
1332 num = *(const phys_addr_t *)addr;
1333 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1334 break;
1337 return number(buf, end, num, spec);
1340 static noinline_for_stack
1341 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1342 const char *fmt)
1344 if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1345 return string(buf, end, NULL, spec);
1347 switch (fmt[1]) {
1348 case 'r':
1349 return number(buf, end, clk_get_rate(clk), spec);
1351 case 'n':
1352 default:
1353 #ifdef CONFIG_COMMON_CLK
1354 return string(buf, end, __clk_get_name(clk), spec);
1355 #else
1356 spec.base = 16;
1357 spec.field_width = sizeof(unsigned long) * 2 + 2;
1358 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1359 return number(buf, end, (unsigned long)clk, spec);
1360 #endif
1364 int kptr_restrict __read_mostly;
1367 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1368 * by an extra set of alphanumeric characters that are extended format
1369 * specifiers.
1371 * Right now we handle:
1373 * - 'F' For symbolic function descriptor pointers with offset
1374 * - 'f' For simple symbolic function names without offset
1375 * - 'S' For symbolic direct pointers with offset
1376 * - 's' For symbolic direct pointers without offset
1377 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1378 * - 'B' For backtraced symbolic direct pointers with offset
1379 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1380 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1381 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1382 * width which must be explicitly specified either as part of the
1383 * format string '%32b[l]' or through '%*b[l]', [l] selects
1384 * range-list format instead of hex format
1385 * - 'M' For a 6-byte MAC address, it prints the address in the
1386 * usual colon-separated hex notation
1387 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1388 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1389 * with a dash-separated hex notation
1390 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1391 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1392 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1393 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1394 * [S][pfs]
1395 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1396 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1397 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1398 * IPv6 omits the colons (01020304...0f)
1399 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1400 * [S][pfs]
1401 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1402 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1403 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1404 * - 'I[6S]c' for IPv6 addresses printed as specified by
1405 * http://tools.ietf.org/html/rfc5952
1406 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1407 * of the following flags (see string_escape_mem() for the
1408 * details):
1409 * a - ESCAPE_ANY
1410 * c - ESCAPE_SPECIAL
1411 * h - ESCAPE_HEX
1412 * n - ESCAPE_NULL
1413 * o - ESCAPE_OCTAL
1414 * p - ESCAPE_NP
1415 * s - ESCAPE_SPACE
1416 * By default ESCAPE_ANY_NP is used.
1417 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1418 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1419 * Options for %pU are:
1420 * b big endian lower case hex (default)
1421 * B big endian UPPER case hex
1422 * l little endian lower case hex
1423 * L little endian UPPER case hex
1424 * big endian output byte order is:
1425 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1426 * little endian output byte order is:
1427 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1428 * - 'V' For a struct va_format which contains a format string * and va_list *,
1429 * call vsnprintf(->format, *->va_list).
1430 * Implements a "recursive vsnprintf".
1431 * Do not use this feature without some mechanism to verify the
1432 * correctness of the format string and va_list arguments.
1433 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1434 * - 'NF' For a netdev_features_t
1435 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1436 * a certain separator (' ' by default):
1437 * C colon
1438 * D dash
1439 * N no separator
1440 * The maximum supported length is 64 bytes of the input. Consider
1441 * to use print_hex_dump() for the larger input.
1442 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1443 * (default assumed to be phys_addr_t, passed by reference)
1444 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1445 * - 'D[234]' Same as 'd' but for a struct file
1446 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1447 * (legacy clock framework) of the clock
1448 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1449 * (legacy clock framework) of the clock
1450 * - 'Cr' For a clock, it prints the current rate of the clock
1452 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1453 * function pointers are really function descriptors, which contain a
1454 * pointer to the real address.
1456 static noinline_for_stack
1457 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1458 struct printf_spec spec)
1460 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1462 if (!ptr && *fmt != 'K') {
1464 * Print (null) with the same width as a pointer so it makes
1465 * tabular output look nice.
1467 if (spec.field_width == -1)
1468 spec.field_width = default_width;
1469 return string(buf, end, "(null)", spec);
1472 switch (*fmt) {
1473 case 'F':
1474 case 'f':
1475 ptr = dereference_function_descriptor(ptr);
1476 /* Fallthrough */
1477 case 'S':
1478 case 's':
1479 case 'B':
1480 return symbol_string(buf, end, ptr, spec, fmt);
1481 case 'R':
1482 case 'r':
1483 return resource_string(buf, end, ptr, spec, fmt);
1484 case 'h':
1485 return hex_string(buf, end, ptr, spec, fmt);
1486 case 'b':
1487 switch (fmt[1]) {
1488 case 'l':
1489 return bitmap_list_string(buf, end, ptr, spec, fmt);
1490 default:
1491 return bitmap_string(buf, end, ptr, spec, fmt);
1493 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1494 case 'm': /* Contiguous: 000102030405 */
1495 /* [mM]F (FDDI) */
1496 /* [mM]R (Reverse order; Bluetooth) */
1497 return mac_address_string(buf, end, ptr, spec, fmt);
1498 case 'I': /* Formatted IP supported
1499 * 4: 1.2.3.4
1500 * 6: 0001:0203:...:0708
1501 * 6c: 1::708 or 1::1.2.3.4
1503 case 'i': /* Contiguous:
1504 * 4: 001.002.003.004
1505 * 6: 000102...0f
1507 switch (fmt[1]) {
1508 case '6':
1509 return ip6_addr_string(buf, end, ptr, spec, fmt);
1510 case '4':
1511 return ip4_addr_string(buf, end, ptr, spec, fmt);
1512 case 'S': {
1513 const union {
1514 struct sockaddr raw;
1515 struct sockaddr_in v4;
1516 struct sockaddr_in6 v6;
1517 } *sa = ptr;
1519 switch (sa->raw.sa_family) {
1520 case AF_INET:
1521 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1522 case AF_INET6:
1523 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1524 default:
1525 return string(buf, end, "(invalid address)", spec);
1528 break;
1529 case 'E':
1530 return escaped_string(buf, end, ptr, spec, fmt);
1531 case 'U':
1532 return uuid_string(buf, end, ptr, spec, fmt);
1533 case 'V':
1535 va_list va;
1537 va_copy(va, *((struct va_format *)ptr)->va);
1538 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1539 ((struct va_format *)ptr)->fmt, va);
1540 va_end(va);
1541 return buf;
1543 case 'K':
1545 * %pK cannot be used in IRQ context because its test
1546 * for CAP_SYSLOG would be meaningless.
1548 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1549 in_nmi())) {
1550 if (spec.field_width == -1)
1551 spec.field_width = default_width;
1552 return string(buf, end, "pK-error", spec);
1555 switch (kptr_restrict) {
1556 case 0:
1557 /* Always print %pK values */
1558 break;
1559 case 1: {
1561 * Only print the real pointer value if the current
1562 * process has CAP_SYSLOG and is running with the
1563 * same credentials it started with. This is because
1564 * access to files is checked at open() time, but %pK
1565 * checks permission at read() time. We don't want to
1566 * leak pointer values if a binary opens a file using
1567 * %pK and then elevates privileges before reading it.
1569 const struct cred *cred = current_cred();
1571 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1572 !uid_eq(cred->euid, cred->uid) ||
1573 !gid_eq(cred->egid, cred->gid))
1574 ptr = NULL;
1575 break;
1577 case 2:
1578 default:
1579 /* Always print 0's for %pK */
1580 ptr = NULL;
1581 break;
1583 break;
1585 case 'N':
1586 switch (fmt[1]) {
1587 case 'F':
1588 return netdev_feature_string(buf, end, ptr, spec);
1590 break;
1591 case 'a':
1592 return address_val(buf, end, ptr, spec, fmt);
1593 case 'd':
1594 return dentry_name(buf, end, ptr, spec, fmt);
1595 case 'C':
1596 return clock(buf, end, ptr, spec, fmt);
1597 case 'D':
1598 return dentry_name(buf, end,
1599 ((const struct file *)ptr)->f_path.dentry,
1600 spec, fmt);
1602 spec.flags |= SMALL;
1603 if (spec.field_width == -1) {
1604 spec.field_width = default_width;
1605 spec.flags |= ZEROPAD;
1607 spec.base = 16;
1609 return number(buf, end, (unsigned long) ptr, spec);
1613 * Helper function to decode printf style format.
1614 * Each call decode a token from the format and return the
1615 * number of characters read (or likely the delta where it wants
1616 * to go on the next call).
1617 * The decoded token is returned through the parameters
1619 * 'h', 'l', or 'L' for integer fields
1620 * 'z' support added 23/7/1999 S.H.
1621 * 'z' changed to 'Z' --davidm 1/25/99
1622 * 't' added for ptrdiff_t
1624 * @fmt: the format string
1625 * @type of the token returned
1626 * @flags: various flags such as +, -, # tokens..
1627 * @field_width: overwritten width
1628 * @base: base of the number (octal, hex, ...)
1629 * @precision: precision of a number
1630 * @qualifier: qualifier of a number (long, size_t, ...)
1632 static noinline_for_stack
1633 int format_decode(const char *fmt, struct printf_spec *spec)
1635 const char *start = fmt;
1637 /* we finished early by reading the field width */
1638 if (spec->type == FORMAT_TYPE_WIDTH) {
1639 if (spec->field_width < 0) {
1640 spec->field_width = -spec->field_width;
1641 spec->flags |= LEFT;
1643 spec->type = FORMAT_TYPE_NONE;
1644 goto precision;
1647 /* we finished early by reading the precision */
1648 if (spec->type == FORMAT_TYPE_PRECISION) {
1649 if (spec->precision < 0)
1650 spec->precision = 0;
1652 spec->type = FORMAT_TYPE_NONE;
1653 goto qualifier;
1656 /* By default */
1657 spec->type = FORMAT_TYPE_NONE;
1659 for (; *fmt ; ++fmt) {
1660 if (*fmt == '%')
1661 break;
1664 /* Return the current non-format string */
1665 if (fmt != start || !*fmt)
1666 return fmt - start;
1668 /* Process flags */
1669 spec->flags = 0;
1671 while (1) { /* this also skips first '%' */
1672 bool found = true;
1674 ++fmt;
1676 switch (*fmt) {
1677 case '-': spec->flags |= LEFT; break;
1678 case '+': spec->flags |= PLUS; break;
1679 case ' ': spec->flags |= SPACE; break;
1680 case '#': spec->flags |= SPECIAL; break;
1681 case '0': spec->flags |= ZEROPAD; break;
1682 default: found = false;
1685 if (!found)
1686 break;
1689 /* get field width */
1690 spec->field_width = -1;
1692 if (isdigit(*fmt))
1693 spec->field_width = skip_atoi(&fmt);
1694 else if (*fmt == '*') {
1695 /* it's the next argument */
1696 spec->type = FORMAT_TYPE_WIDTH;
1697 return ++fmt - start;
1700 precision:
1701 /* get the precision */
1702 spec->precision = -1;
1703 if (*fmt == '.') {
1704 ++fmt;
1705 if (isdigit(*fmt)) {
1706 spec->precision = skip_atoi(&fmt);
1707 if (spec->precision < 0)
1708 spec->precision = 0;
1709 } else if (*fmt == '*') {
1710 /* it's the next argument */
1711 spec->type = FORMAT_TYPE_PRECISION;
1712 return ++fmt - start;
1716 qualifier:
1717 /* get the conversion qualifier */
1718 spec->qualifier = -1;
1719 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1720 _tolower(*fmt) == 'z' || *fmt == 't') {
1721 spec->qualifier = *fmt++;
1722 if (unlikely(spec->qualifier == *fmt)) {
1723 if (spec->qualifier == 'l') {
1724 spec->qualifier = 'L';
1725 ++fmt;
1726 } else if (spec->qualifier == 'h') {
1727 spec->qualifier = 'H';
1728 ++fmt;
1733 /* default base */
1734 spec->base = 10;
1735 switch (*fmt) {
1736 case 'c':
1737 spec->type = FORMAT_TYPE_CHAR;
1738 return ++fmt - start;
1740 case 's':
1741 spec->type = FORMAT_TYPE_STR;
1742 return ++fmt - start;
1744 case 'p':
1745 spec->type = FORMAT_TYPE_PTR;
1746 return ++fmt - start;
1748 case '%':
1749 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1750 return ++fmt - start;
1752 /* integer number formats - set up the flags and "break" */
1753 case 'o':
1754 spec->base = 8;
1755 break;
1757 case 'x':
1758 spec->flags |= SMALL;
1760 case 'X':
1761 spec->base = 16;
1762 break;
1764 case 'd':
1765 case 'i':
1766 spec->flags |= SIGN;
1767 case 'u':
1768 break;
1770 case 'n':
1772 * Since %n poses a greater security risk than utility, treat
1773 * it as an invalid format specifier. Warn about its use so
1774 * that new instances don't get added.
1776 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1777 /* Fall-through */
1779 default:
1780 spec->type = FORMAT_TYPE_INVALID;
1781 return fmt - start;
1784 if (spec->qualifier == 'L')
1785 spec->type = FORMAT_TYPE_LONG_LONG;
1786 else if (spec->qualifier == 'l') {
1787 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1788 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1789 } else if (_tolower(spec->qualifier) == 'z') {
1790 spec->type = FORMAT_TYPE_SIZE_T;
1791 } else if (spec->qualifier == 't') {
1792 spec->type = FORMAT_TYPE_PTRDIFF;
1793 } else if (spec->qualifier == 'H') {
1794 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1795 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1796 } else if (spec->qualifier == 'h') {
1797 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1798 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1799 } else {
1800 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1801 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1804 return ++fmt - start;
1808 * vsnprintf - Format a string and place it in a buffer
1809 * @buf: The buffer to place the result into
1810 * @size: The size of the buffer, including the trailing null space
1811 * @fmt: The format string to use
1812 * @args: Arguments for the format string
1814 * This function follows C99 vsnprintf, but has some extensions:
1815 * %pS output the name of a text symbol with offset
1816 * %ps output the name of a text symbol without offset
1817 * %pF output the name of a function pointer with its offset
1818 * %pf output the name of a function pointer without its offset
1819 * %pB output the name of a backtrace symbol with its offset
1820 * %pR output the address range in a struct resource with decoded flags
1821 * %pr output the address range in a struct resource with raw flags
1822 * %pb output the bitmap with field width as the number of bits
1823 * %pbl output the bitmap as range list with field width as the number of bits
1824 * %pM output a 6-byte MAC address with colons
1825 * %pMR output a 6-byte MAC address with colons in reversed order
1826 * %pMF output a 6-byte MAC address with dashes
1827 * %pm output a 6-byte MAC address without colons
1828 * %pmR output a 6-byte MAC address without colons in reversed order
1829 * %pI4 print an IPv4 address without leading zeros
1830 * %pi4 print an IPv4 address with leading zeros
1831 * %pI6 print an IPv6 address with colons
1832 * %pi6 print an IPv6 address without colons
1833 * %pI6c print an IPv6 address as specified by RFC 5952
1834 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1835 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1836 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1837 * case.
1838 * %*pE[achnops] print an escaped buffer
1839 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1840 * bytes of the input)
1841 * %pC output the name (Common Clock Framework) or address (legacy clock
1842 * framework) of a clock
1843 * %pCn output the name (Common Clock Framework) or address (legacy clock
1844 * framework) of a clock
1845 * %pCr output the current rate of a clock
1846 * %n is ignored
1848 * ** Please update Documentation/printk-formats.txt when making changes **
1850 * The return value is the number of characters which would
1851 * be generated for the given input, excluding the trailing
1852 * '\0', as per ISO C99. If you want to have the exact
1853 * number of characters written into @buf as return value
1854 * (not including the trailing '\0'), use vscnprintf(). If the
1855 * return is greater than or equal to @size, the resulting
1856 * string is truncated.
1858 * If you're not already dealing with a va_list consider using snprintf().
1860 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1862 unsigned long long num;
1863 char *str, *end;
1864 struct printf_spec spec = {0};
1866 /* Reject out-of-range values early. Large positive sizes are
1867 used for unknown buffer sizes. */
1868 if (WARN_ON_ONCE(size > INT_MAX))
1869 return 0;
1871 str = buf;
1872 end = buf + size;
1874 /* Make sure end is always >= buf */
1875 if (end < buf) {
1876 end = ((void *)-1);
1877 size = end - buf;
1880 while (*fmt) {
1881 const char *old_fmt = fmt;
1882 int read = format_decode(fmt, &spec);
1884 fmt += read;
1886 switch (spec.type) {
1887 case FORMAT_TYPE_NONE: {
1888 int copy = read;
1889 if (str < end) {
1890 if (copy > end - str)
1891 copy = end - str;
1892 memcpy(str, old_fmt, copy);
1894 str += read;
1895 break;
1898 case FORMAT_TYPE_WIDTH:
1899 spec.field_width = va_arg(args, int);
1900 break;
1902 case FORMAT_TYPE_PRECISION:
1903 spec.precision = va_arg(args, int);
1904 break;
1906 case FORMAT_TYPE_CHAR: {
1907 char c;
1909 if (!(spec.flags & LEFT)) {
1910 while (--spec.field_width > 0) {
1911 if (str < end)
1912 *str = ' ';
1913 ++str;
1917 c = (unsigned char) va_arg(args, int);
1918 if (str < end)
1919 *str = c;
1920 ++str;
1921 while (--spec.field_width > 0) {
1922 if (str < end)
1923 *str = ' ';
1924 ++str;
1926 break;
1929 case FORMAT_TYPE_STR:
1930 str = string(str, end, va_arg(args, char *), spec);
1931 break;
1933 case FORMAT_TYPE_PTR:
1934 str = pointer(fmt, str, end, va_arg(args, void *),
1935 spec);
1936 while (isalnum(*fmt))
1937 fmt++;
1938 break;
1940 case FORMAT_TYPE_PERCENT_CHAR:
1941 if (str < end)
1942 *str = '%';
1943 ++str;
1944 break;
1946 case FORMAT_TYPE_INVALID:
1947 if (str < end)
1948 *str = '%';
1949 ++str;
1950 break;
1952 default:
1953 switch (spec.type) {
1954 case FORMAT_TYPE_LONG_LONG:
1955 num = va_arg(args, long long);
1956 break;
1957 case FORMAT_TYPE_ULONG:
1958 num = va_arg(args, unsigned long);
1959 break;
1960 case FORMAT_TYPE_LONG:
1961 num = va_arg(args, long);
1962 break;
1963 case FORMAT_TYPE_SIZE_T:
1964 if (spec.flags & SIGN)
1965 num = va_arg(args, ssize_t);
1966 else
1967 num = va_arg(args, size_t);
1968 break;
1969 case FORMAT_TYPE_PTRDIFF:
1970 num = va_arg(args, ptrdiff_t);
1971 break;
1972 case FORMAT_TYPE_UBYTE:
1973 num = (unsigned char) va_arg(args, int);
1974 break;
1975 case FORMAT_TYPE_BYTE:
1976 num = (signed char) va_arg(args, int);
1977 break;
1978 case FORMAT_TYPE_USHORT:
1979 num = (unsigned short) va_arg(args, int);
1980 break;
1981 case FORMAT_TYPE_SHORT:
1982 num = (short) va_arg(args, int);
1983 break;
1984 case FORMAT_TYPE_INT:
1985 num = (int) va_arg(args, int);
1986 break;
1987 default:
1988 num = va_arg(args, unsigned int);
1991 str = number(str, end, num, spec);
1995 if (size > 0) {
1996 if (str < end)
1997 *str = '\0';
1998 else
1999 end[-1] = '\0';
2002 /* the trailing null byte doesn't count towards the total */
2003 return str-buf;
2006 EXPORT_SYMBOL(vsnprintf);
2009 * vscnprintf - Format a string and place it in a buffer
2010 * @buf: The buffer to place the result into
2011 * @size: The size of the buffer, including the trailing null space
2012 * @fmt: The format string to use
2013 * @args: Arguments for the format string
2015 * The return value is the number of characters which have been written into
2016 * the @buf not including the trailing '\0'. If @size is == 0 the function
2017 * returns 0.
2019 * If you're not already dealing with a va_list consider using scnprintf().
2021 * See the vsnprintf() documentation for format string extensions over C99.
2023 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2025 int i;
2027 i = vsnprintf(buf, size, fmt, args);
2029 if (likely(i < size))
2030 return i;
2031 if (size != 0)
2032 return size - 1;
2033 return 0;
2035 EXPORT_SYMBOL(vscnprintf);
2038 * snprintf - Format a string and place it in a buffer
2039 * @buf: The buffer to place the result into
2040 * @size: The size of the buffer, including the trailing null space
2041 * @fmt: The format string to use
2042 * @...: Arguments for the format string
2044 * The return value is the number of characters which would be
2045 * generated for the given input, excluding the trailing null,
2046 * as per ISO C99. If the return is greater than or equal to
2047 * @size, the resulting string is truncated.
2049 * See the vsnprintf() documentation for format string extensions over C99.
2051 int snprintf(char *buf, size_t size, const char *fmt, ...)
2053 va_list args;
2054 int i;
2056 va_start(args, fmt);
2057 i = vsnprintf(buf, size, fmt, args);
2058 va_end(args);
2060 return i;
2062 EXPORT_SYMBOL(snprintf);
2065 * scnprintf - Format a string and place it in a buffer
2066 * @buf: The buffer to place the result into
2067 * @size: The size of the buffer, including the trailing null space
2068 * @fmt: The format string to use
2069 * @...: Arguments for the format string
2071 * The return value is the number of characters written into @buf not including
2072 * the trailing '\0'. If @size is == 0 the function returns 0.
2075 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2077 va_list args;
2078 int i;
2080 va_start(args, fmt);
2081 i = vscnprintf(buf, size, fmt, args);
2082 va_end(args);
2084 return i;
2086 EXPORT_SYMBOL(scnprintf);
2089 * vsprintf - Format a string and place it in a buffer
2090 * @buf: The buffer to place the result into
2091 * @fmt: The format string to use
2092 * @args: Arguments for the format string
2094 * The function returns the number of characters written
2095 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2096 * buffer overflows.
2098 * If you're not already dealing with a va_list consider using sprintf().
2100 * See the vsnprintf() documentation for format string extensions over C99.
2102 int vsprintf(char *buf, const char *fmt, va_list args)
2104 return vsnprintf(buf, INT_MAX, fmt, args);
2106 EXPORT_SYMBOL(vsprintf);
2109 * sprintf - Format a string and place it in a buffer
2110 * @buf: The buffer to place the result into
2111 * @fmt: The format string to use
2112 * @...: Arguments for the format string
2114 * The function returns the number of characters written
2115 * into @buf. Use snprintf() or scnprintf() in order to avoid
2116 * buffer overflows.
2118 * See the vsnprintf() documentation for format string extensions over C99.
2120 int sprintf(char *buf, const char *fmt, ...)
2122 va_list args;
2123 int i;
2125 va_start(args, fmt);
2126 i = vsnprintf(buf, INT_MAX, fmt, args);
2127 va_end(args);
2129 return i;
2131 EXPORT_SYMBOL(sprintf);
2133 #ifdef CONFIG_BINARY_PRINTF
2135 * bprintf service:
2136 * vbin_printf() - VA arguments to binary data
2137 * bstr_printf() - Binary data to text string
2141 * vbin_printf - Parse a format string and place args' binary value in a buffer
2142 * @bin_buf: The buffer to place args' binary value
2143 * @size: The size of the buffer(by words(32bits), not characters)
2144 * @fmt: The format string to use
2145 * @args: Arguments for the format string
2147 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2148 * is skipped.
2150 * The return value is the number of words(32bits) which would be generated for
2151 * the given input.
2153 * NOTE:
2154 * If the return value is greater than @size, the resulting bin_buf is NOT
2155 * valid for bstr_printf().
2157 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2159 struct printf_spec spec = {0};
2160 char *str, *end;
2162 str = (char *)bin_buf;
2163 end = (char *)(bin_buf + size);
2165 #define save_arg(type) \
2166 do { \
2167 if (sizeof(type) == 8) { \
2168 unsigned long long value; \
2169 str = PTR_ALIGN(str, sizeof(u32)); \
2170 value = va_arg(args, unsigned long long); \
2171 if (str + sizeof(type) <= end) { \
2172 *(u32 *)str = *(u32 *)&value; \
2173 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2175 } else { \
2176 unsigned long value; \
2177 str = PTR_ALIGN(str, sizeof(type)); \
2178 value = va_arg(args, int); \
2179 if (str + sizeof(type) <= end) \
2180 *(typeof(type) *)str = (type)value; \
2182 str += sizeof(type); \
2183 } while (0)
2185 while (*fmt) {
2186 int read = format_decode(fmt, &spec);
2188 fmt += read;
2190 switch (spec.type) {
2191 case FORMAT_TYPE_NONE:
2192 case FORMAT_TYPE_INVALID:
2193 case FORMAT_TYPE_PERCENT_CHAR:
2194 break;
2196 case FORMAT_TYPE_WIDTH:
2197 case FORMAT_TYPE_PRECISION:
2198 save_arg(int);
2199 break;
2201 case FORMAT_TYPE_CHAR:
2202 save_arg(char);
2203 break;
2205 case FORMAT_TYPE_STR: {
2206 const char *save_str = va_arg(args, char *);
2207 size_t len;
2209 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2210 || (unsigned long)save_str < PAGE_SIZE)
2211 save_str = "(null)";
2212 len = strlen(save_str) + 1;
2213 if (str + len < end)
2214 memcpy(str, save_str, len);
2215 str += len;
2216 break;
2219 case FORMAT_TYPE_PTR:
2220 save_arg(void *);
2221 /* skip all alphanumeric pointer suffixes */
2222 while (isalnum(*fmt))
2223 fmt++;
2224 break;
2226 default:
2227 switch (spec.type) {
2229 case FORMAT_TYPE_LONG_LONG:
2230 save_arg(long long);
2231 break;
2232 case FORMAT_TYPE_ULONG:
2233 case FORMAT_TYPE_LONG:
2234 save_arg(unsigned long);
2235 break;
2236 case FORMAT_TYPE_SIZE_T:
2237 save_arg(size_t);
2238 break;
2239 case FORMAT_TYPE_PTRDIFF:
2240 save_arg(ptrdiff_t);
2241 break;
2242 case FORMAT_TYPE_UBYTE:
2243 case FORMAT_TYPE_BYTE:
2244 save_arg(char);
2245 break;
2246 case FORMAT_TYPE_USHORT:
2247 case FORMAT_TYPE_SHORT:
2248 save_arg(short);
2249 break;
2250 default:
2251 save_arg(int);
2256 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2257 #undef save_arg
2259 EXPORT_SYMBOL_GPL(vbin_printf);
2262 * bstr_printf - Format a string from binary arguments and place it in a buffer
2263 * @buf: The buffer to place the result into
2264 * @size: The size of the buffer, including the trailing null space
2265 * @fmt: The format string to use
2266 * @bin_buf: Binary arguments for the format string
2268 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2269 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2270 * a binary buffer that generated by vbin_printf.
2272 * The format follows C99 vsnprintf, but has some extensions:
2273 * see vsnprintf comment for details.
2275 * The return value is the number of characters which would
2276 * be generated for the given input, excluding the trailing
2277 * '\0', as per ISO C99. If you want to have the exact
2278 * number of characters written into @buf as return value
2279 * (not including the trailing '\0'), use vscnprintf(). If the
2280 * return is greater than or equal to @size, the resulting
2281 * string is truncated.
2283 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2285 struct printf_spec spec = {0};
2286 char *str, *end;
2287 const char *args = (const char *)bin_buf;
2289 if (WARN_ON_ONCE((int) size < 0))
2290 return 0;
2292 str = buf;
2293 end = buf + size;
2295 #define get_arg(type) \
2296 ({ \
2297 typeof(type) value; \
2298 if (sizeof(type) == 8) { \
2299 args = PTR_ALIGN(args, sizeof(u32)); \
2300 *(u32 *)&value = *(u32 *)args; \
2301 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2302 } else { \
2303 args = PTR_ALIGN(args, sizeof(type)); \
2304 value = *(typeof(type) *)args; \
2306 args += sizeof(type); \
2307 value; \
2310 /* Make sure end is always >= buf */
2311 if (end < buf) {
2312 end = ((void *)-1);
2313 size = end - buf;
2316 while (*fmt) {
2317 const char *old_fmt = fmt;
2318 int read = format_decode(fmt, &spec);
2320 fmt += read;
2322 switch (spec.type) {
2323 case FORMAT_TYPE_NONE: {
2324 int copy = read;
2325 if (str < end) {
2326 if (copy > end - str)
2327 copy = end - str;
2328 memcpy(str, old_fmt, copy);
2330 str += read;
2331 break;
2334 case FORMAT_TYPE_WIDTH:
2335 spec.field_width = get_arg(int);
2336 break;
2338 case FORMAT_TYPE_PRECISION:
2339 spec.precision = get_arg(int);
2340 break;
2342 case FORMAT_TYPE_CHAR: {
2343 char c;
2345 if (!(spec.flags & LEFT)) {
2346 while (--spec.field_width > 0) {
2347 if (str < end)
2348 *str = ' ';
2349 ++str;
2352 c = (unsigned char) get_arg(char);
2353 if (str < end)
2354 *str = c;
2355 ++str;
2356 while (--spec.field_width > 0) {
2357 if (str < end)
2358 *str = ' ';
2359 ++str;
2361 break;
2364 case FORMAT_TYPE_STR: {
2365 const char *str_arg = args;
2366 args += strlen(str_arg) + 1;
2367 str = string(str, end, (char *)str_arg, spec);
2368 break;
2371 case FORMAT_TYPE_PTR:
2372 str = pointer(fmt, str, end, get_arg(void *), spec);
2373 while (isalnum(*fmt))
2374 fmt++;
2375 break;
2377 case FORMAT_TYPE_PERCENT_CHAR:
2378 case FORMAT_TYPE_INVALID:
2379 if (str < end)
2380 *str = '%';
2381 ++str;
2382 break;
2384 default: {
2385 unsigned long long num;
2387 switch (spec.type) {
2389 case FORMAT_TYPE_LONG_LONG:
2390 num = get_arg(long long);
2391 break;
2392 case FORMAT_TYPE_ULONG:
2393 case FORMAT_TYPE_LONG:
2394 num = get_arg(unsigned long);
2395 break;
2396 case FORMAT_TYPE_SIZE_T:
2397 num = get_arg(size_t);
2398 break;
2399 case FORMAT_TYPE_PTRDIFF:
2400 num = get_arg(ptrdiff_t);
2401 break;
2402 case FORMAT_TYPE_UBYTE:
2403 num = get_arg(unsigned char);
2404 break;
2405 case FORMAT_TYPE_BYTE:
2406 num = get_arg(signed char);
2407 break;
2408 case FORMAT_TYPE_USHORT:
2409 num = get_arg(unsigned short);
2410 break;
2411 case FORMAT_TYPE_SHORT:
2412 num = get_arg(short);
2413 break;
2414 case FORMAT_TYPE_UINT:
2415 num = get_arg(unsigned int);
2416 break;
2417 default:
2418 num = get_arg(int);
2421 str = number(str, end, num, spec);
2422 } /* default: */
2423 } /* switch(spec.type) */
2424 } /* while(*fmt) */
2426 if (size > 0) {
2427 if (str < end)
2428 *str = '\0';
2429 else
2430 end[-1] = '\0';
2433 #undef get_arg
2435 /* the trailing null byte doesn't count towards the total */
2436 return str - buf;
2438 EXPORT_SYMBOL_GPL(bstr_printf);
2441 * bprintf - Parse a format string and place args' binary value in a buffer
2442 * @bin_buf: The buffer to place args' binary value
2443 * @size: The size of the buffer(by words(32bits), not characters)
2444 * @fmt: The format string to use
2445 * @...: Arguments for the format string
2447 * The function returns the number of words(u32) written
2448 * into @bin_buf.
2450 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2452 va_list args;
2453 int ret;
2455 va_start(args, fmt);
2456 ret = vbin_printf(bin_buf, size, fmt, args);
2457 va_end(args);
2459 return ret;
2461 EXPORT_SYMBOL_GPL(bprintf);
2463 #endif /* CONFIG_BINARY_PRINTF */
2466 * vsscanf - Unformat a buffer into a list of arguments
2467 * @buf: input buffer
2468 * @fmt: format of buffer
2469 * @args: arguments
2471 int vsscanf(const char *buf, const char *fmt, va_list args)
2473 const char *str = buf;
2474 char *next;
2475 char digit;
2476 int num = 0;
2477 u8 qualifier;
2478 unsigned int base;
2479 union {
2480 long long s;
2481 unsigned long long u;
2482 } val;
2483 s16 field_width;
2484 bool is_sign;
2486 while (*fmt) {
2487 /* skip any white space in format */
2488 /* white space in format matchs any amount of
2489 * white space, including none, in the input.
2491 if (isspace(*fmt)) {
2492 fmt = skip_spaces(++fmt);
2493 str = skip_spaces(str);
2496 /* anything that is not a conversion must match exactly */
2497 if (*fmt != '%' && *fmt) {
2498 if (*fmt++ != *str++)
2499 break;
2500 continue;
2503 if (!*fmt)
2504 break;
2505 ++fmt;
2507 /* skip this conversion.
2508 * advance both strings to next white space
2510 if (*fmt == '*') {
2511 if (!*str)
2512 break;
2513 while (!isspace(*fmt) && *fmt != '%' && *fmt)
2514 fmt++;
2515 while (!isspace(*str) && *str)
2516 str++;
2517 continue;
2520 /* get field width */
2521 field_width = -1;
2522 if (isdigit(*fmt)) {
2523 field_width = skip_atoi(&fmt);
2524 if (field_width <= 0)
2525 break;
2528 /* get conversion qualifier */
2529 qualifier = -1;
2530 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2531 _tolower(*fmt) == 'z') {
2532 qualifier = *fmt++;
2533 if (unlikely(qualifier == *fmt)) {
2534 if (qualifier == 'h') {
2535 qualifier = 'H';
2536 fmt++;
2537 } else if (qualifier == 'l') {
2538 qualifier = 'L';
2539 fmt++;
2544 if (!*fmt)
2545 break;
2547 if (*fmt == 'n') {
2548 /* return number of characters read so far */
2549 *va_arg(args, int *) = str - buf;
2550 ++fmt;
2551 continue;
2554 if (!*str)
2555 break;
2557 base = 10;
2558 is_sign = false;
2560 switch (*fmt++) {
2561 case 'c':
2563 char *s = (char *)va_arg(args, char*);
2564 if (field_width == -1)
2565 field_width = 1;
2566 do {
2567 *s++ = *str++;
2568 } while (--field_width > 0 && *str);
2569 num++;
2571 continue;
2572 case 's':
2574 char *s = (char *)va_arg(args, char *);
2575 if (field_width == -1)
2576 field_width = SHRT_MAX;
2577 /* first, skip leading white space in buffer */
2578 str = skip_spaces(str);
2580 /* now copy until next white space */
2581 while (*str && !isspace(*str) && field_width--)
2582 *s++ = *str++;
2583 *s = '\0';
2584 num++;
2586 continue;
2587 case 'o':
2588 base = 8;
2589 break;
2590 case 'x':
2591 case 'X':
2592 base = 16;
2593 break;
2594 case 'i':
2595 base = 0;
2596 case 'd':
2597 is_sign = true;
2598 case 'u':
2599 break;
2600 case '%':
2601 /* looking for '%' in str */
2602 if (*str++ != '%')
2603 return num;
2604 continue;
2605 default:
2606 /* invalid format; stop here */
2607 return num;
2610 /* have some sort of integer conversion.
2611 * first, skip white space in buffer.
2613 str = skip_spaces(str);
2615 digit = *str;
2616 if (is_sign && digit == '-')
2617 digit = *(str + 1);
2619 if (!digit
2620 || (base == 16 && !isxdigit(digit))
2621 || (base == 10 && !isdigit(digit))
2622 || (base == 8 && (!isdigit(digit) || digit > '7'))
2623 || (base == 0 && !isdigit(digit)))
2624 break;
2626 if (is_sign)
2627 val.s = qualifier != 'L' ?
2628 simple_strtol(str, &next, base) :
2629 simple_strtoll(str, &next, base);
2630 else
2631 val.u = qualifier != 'L' ?
2632 simple_strtoul(str, &next, base) :
2633 simple_strtoull(str, &next, base);
2635 if (field_width > 0 && next - str > field_width) {
2636 if (base == 0)
2637 _parse_integer_fixup_radix(str, &base);
2638 while (next - str > field_width) {
2639 if (is_sign)
2640 val.s = div_s64(val.s, base);
2641 else
2642 val.u = div_u64(val.u, base);
2643 --next;
2647 switch (qualifier) {
2648 case 'H': /* that's 'hh' in format */
2649 if (is_sign)
2650 *va_arg(args, signed char *) = val.s;
2651 else
2652 *va_arg(args, unsigned char *) = val.u;
2653 break;
2654 case 'h':
2655 if (is_sign)
2656 *va_arg(args, short *) = val.s;
2657 else
2658 *va_arg(args, unsigned short *) = val.u;
2659 break;
2660 case 'l':
2661 if (is_sign)
2662 *va_arg(args, long *) = val.s;
2663 else
2664 *va_arg(args, unsigned long *) = val.u;
2665 break;
2666 case 'L':
2667 if (is_sign)
2668 *va_arg(args, long long *) = val.s;
2669 else
2670 *va_arg(args, unsigned long long *) = val.u;
2671 break;
2672 case 'Z':
2673 case 'z':
2674 *va_arg(args, size_t *) = val.u;
2675 break;
2676 default:
2677 if (is_sign)
2678 *va_arg(args, int *) = val.s;
2679 else
2680 *va_arg(args, unsigned int *) = val.u;
2681 break;
2683 num++;
2685 if (!next)
2686 break;
2687 str = next;
2690 return num;
2692 EXPORT_SYMBOL(vsscanf);
2695 * sscanf - Unformat a buffer into a list of arguments
2696 * @buf: input buffer
2697 * @fmt: formatting of buffer
2698 * @...: resulting arguments
2700 int sscanf(const char *buf, const char *fmt, ...)
2702 va_list args;
2703 int i;
2705 va_start(args, fmt);
2706 i = vsscanf(buf, fmt, args);
2707 va_end(args);
2709 return i;
2711 EXPORT_SYMBOL(sscanf);