Linux 3.10.28
[linux/fpc-iii.git] / lib / vsprintf.c
blob620fae4c11f6f1d22ad5deab8f88843f1d957b1c
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/module.h> /* for KSYM_SYMBOL_LEN */
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/ctype.h>
24 #include <linux/kernel.h>
25 #include <linux/kallsyms.h>
26 #include <linux/math64.h>
27 #include <linux/uaccess.h>
28 #include <linux/ioport.h>
29 #include <linux/cred.h>
30 #include <net/addrconf.h>
32 #include <asm/page.h> /* for PAGE_SIZE */
33 #include <asm/sections.h> /* for dereference_function_descriptor() */
35 #include "kstrtox.h"
37 /**
38 * simple_strtoull - convert a string to an unsigned long long
39 * @cp: The start of the string
40 * @endp: A pointer to the end of the parsed string will be placed here
41 * @base: The number base to use
43 * This function is obsolete. Please use kstrtoull instead.
45 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
47 unsigned long long result;
48 unsigned int rv;
50 cp = _parse_integer_fixup_radix(cp, &base);
51 rv = _parse_integer(cp, base, &result);
52 /* FIXME */
53 cp += (rv & ~KSTRTOX_OVERFLOW);
55 if (endp)
56 *endp = (char *)cp;
58 return result;
60 EXPORT_SYMBOL(simple_strtoull);
62 /**
63 * simple_strtoul - convert a string to an unsigned long
64 * @cp: The start of the string
65 * @endp: A pointer to the end of the parsed string will be placed here
66 * @base: The number base to use
68 * This function is obsolete. Please use kstrtoul instead.
70 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
72 return simple_strtoull(cp, endp, base);
74 EXPORT_SYMBOL(simple_strtoul);
76 /**
77 * simple_strtol - convert a string to a signed long
78 * @cp: The start of the string
79 * @endp: A pointer to the end of the parsed string will be placed here
80 * @base: The number base to use
82 * This function is obsolete. Please use kstrtol instead.
84 long simple_strtol(const char *cp, char **endp, unsigned int base)
86 if (*cp == '-')
87 return -simple_strtoul(cp + 1, endp, base);
89 return simple_strtoul(cp, endp, base);
91 EXPORT_SYMBOL(simple_strtol);
93 /**
94 * simple_strtoll - convert a string to a signed long long
95 * @cp: The start of the string
96 * @endp: A pointer to the end of the parsed string will be placed here
97 * @base: The number base to use
99 * This function is obsolete. Please use kstrtoll instead.
101 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
103 if (*cp == '-')
104 return -simple_strtoull(cp + 1, endp, base);
106 return simple_strtoull(cp, endp, base);
108 EXPORT_SYMBOL(simple_strtoll);
110 static noinline_for_stack
111 int skip_atoi(const char **s)
113 int i = 0;
115 while (isdigit(**s))
116 i = i*10 + *((*s)++) - '0';
118 return i;
121 /* Decimal conversion is by far the most typical, and is used
122 * for /proc and /sys data. This directly impacts e.g. top performance
123 * with many processes running. We optimize it for speed
124 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
125 * (with permission from the author, Douglas W. Jones).
128 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
129 /* Formats correctly any integer in [0, 999999999] */
130 static noinline_for_stack
131 char *put_dec_full9(char *buf, unsigned q)
133 unsigned r;
136 * Possible ways to approx. divide by 10
137 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
138 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
139 * (x * 0x6667) >> 18 x < 43699
140 * (x * 0x3334) >> 17 x < 16389
141 * (x * 0x199a) >> 16 x < 16389
142 * (x * 0x0ccd) >> 15 x < 16389
143 * (x * 0x0667) >> 14 x < 2739
144 * (x * 0x0334) >> 13 x < 1029
145 * (x * 0x019a) >> 12 x < 1029
146 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
147 * (x * 0x0067) >> 10 x < 179
148 * (x * 0x0034) >> 9 x < 69 same
149 * (x * 0x001a) >> 8 x < 69 same
150 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
151 * (x * 0x0007) >> 6 x < 19
152 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
154 r = (q * (uint64_t)0x1999999a) >> 32;
155 *buf++ = (q - 10 * r) + '0'; /* 1 */
156 q = (r * (uint64_t)0x1999999a) >> 32;
157 *buf++ = (r - 10 * q) + '0'; /* 2 */
158 r = (q * (uint64_t)0x1999999a) >> 32;
159 *buf++ = (q - 10 * r) + '0'; /* 3 */
160 q = (r * (uint64_t)0x1999999a) >> 32;
161 *buf++ = (r - 10 * q) + '0'; /* 4 */
162 r = (q * (uint64_t)0x1999999a) >> 32;
163 *buf++ = (q - 10 * r) + '0'; /* 5 */
164 /* Now value is under 10000, can avoid 64-bit multiply */
165 q = (r * 0x199a) >> 16;
166 *buf++ = (r - 10 * q) + '0'; /* 6 */
167 r = (q * 0xcd) >> 11;
168 *buf++ = (q - 10 * r) + '0'; /* 7 */
169 q = (r * 0xcd) >> 11;
170 *buf++ = (r - 10 * q) + '0'; /* 8 */
171 *buf++ = q + '0'; /* 9 */
172 return buf;
174 #endif
176 /* Similar to above but do not pad with zeros.
177 * Code can be easily arranged to print 9 digits too, but our callers
178 * always call put_dec_full9() instead when the number has 9 decimal digits.
180 static noinline_for_stack
181 char *put_dec_trunc8(char *buf, unsigned r)
183 unsigned q;
185 /* Copy of previous function's body with added early returns */
186 while (r >= 10000) {
187 q = r + '0';
188 r = (r * (uint64_t)0x1999999a) >> 32;
189 *buf++ = q - 10*r;
192 q = (r * 0x199a) >> 16; /* r <= 9999 */
193 *buf++ = (r - 10 * q) + '0';
194 if (q == 0)
195 return buf;
196 r = (q * 0xcd) >> 11; /* q <= 999 */
197 *buf++ = (q - 10 * r) + '0';
198 if (r == 0)
199 return buf;
200 q = (r * 0xcd) >> 11; /* r <= 99 */
201 *buf++ = (r - 10 * q) + '0';
202 if (q == 0)
203 return buf;
204 *buf++ = q + '0'; /* q <= 9 */
205 return buf;
208 /* There are two algorithms to print larger numbers.
209 * One is generic: divide by 1000000000 and repeatedly print
210 * groups of (up to) 9 digits. It's conceptually simple,
211 * but requires a (unsigned long long) / 1000000000 division.
213 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
214 * manipulates them cleverly and generates groups of 4 decimal digits.
215 * It so happens that it does NOT require long long division.
217 * If long is > 32 bits, division of 64-bit values is relatively easy,
218 * and we will use the first algorithm.
219 * If long long is > 64 bits (strange architecture with VERY large long long),
220 * second algorithm can't be used, and we again use the first one.
222 * Else (if long is 32 bits and long long is 64 bits) we use second one.
225 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
227 /* First algorithm: generic */
229 static
230 char *put_dec(char *buf, unsigned long long n)
232 if (n >= 100*1000*1000) {
233 while (n >= 1000*1000*1000)
234 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
235 if (n >= 100*1000*1000)
236 return put_dec_full9(buf, n);
238 return put_dec_trunc8(buf, n);
241 #else
243 /* Second algorithm: valid only for 64-bit long longs */
245 /* See comment in put_dec_full9 for choice of constants */
246 static noinline_for_stack
247 void put_dec_full4(char *buf, unsigned q)
249 unsigned r;
250 r = (q * 0xccd) >> 15;
251 buf[0] = (q - 10 * r) + '0';
252 q = (r * 0xcd) >> 11;
253 buf[1] = (r - 10 * q) + '0';
254 r = (q * 0xcd) >> 11;
255 buf[2] = (q - 10 * r) + '0';
256 buf[3] = r + '0';
260 * Call put_dec_full4 on x % 10000, return x / 10000.
261 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
262 * holds for all x < 1,128,869,999. The largest value this
263 * helper will ever be asked to convert is 1,125,520,955.
264 * (d1 in the put_dec code, assuming n is all-ones).
266 static
267 unsigned put_dec_helper4(char *buf, unsigned x)
269 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
271 put_dec_full4(buf, x - q * 10000);
272 return q;
275 /* Based on code by Douglas W. Jones found at
276 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
277 * (with permission from the author).
278 * Performs no 64-bit division and hence should be fast on 32-bit machines.
280 static
281 char *put_dec(char *buf, unsigned long long n)
283 uint32_t d3, d2, d1, q, h;
285 if (n < 100*1000*1000)
286 return put_dec_trunc8(buf, n);
288 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
289 h = (n >> 32);
290 d2 = (h ) & 0xffff;
291 d3 = (h >> 16); /* implicit "& 0xffff" */
293 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
294 q = put_dec_helper4(buf, q);
296 q += 7671 * d3 + 9496 * d2 + 6 * d1;
297 q = put_dec_helper4(buf+4, q);
299 q += 4749 * d3 + 42 * d2;
300 q = put_dec_helper4(buf+8, q);
302 q += 281 * d3;
303 buf += 12;
304 if (q)
305 buf = put_dec_trunc8(buf, q);
306 else while (buf[-1] == '0')
307 --buf;
309 return buf;
312 #endif
315 * Convert passed number to decimal string.
316 * Returns the length of string. On buffer overflow, returns 0.
318 * If speed is not important, use snprintf(). It's easy to read the code.
320 int num_to_str(char *buf, int size, unsigned long long num)
322 char tmp[sizeof(num) * 3];
323 int idx, len;
325 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
326 if (num <= 9) {
327 tmp[0] = '0' + num;
328 len = 1;
329 } else {
330 len = put_dec(tmp, num) - tmp;
333 if (len > size)
334 return 0;
335 for (idx = 0; idx < len; ++idx)
336 buf[idx] = tmp[len - idx - 1];
337 return len;
340 #define ZEROPAD 1 /* pad with zero */
341 #define SIGN 2 /* unsigned/signed long */
342 #define PLUS 4 /* show plus */
343 #define SPACE 8 /* space if plus */
344 #define LEFT 16 /* left justified */
345 #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
346 #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
348 enum format_type {
349 FORMAT_TYPE_NONE, /* Just a string part */
350 FORMAT_TYPE_WIDTH,
351 FORMAT_TYPE_PRECISION,
352 FORMAT_TYPE_CHAR,
353 FORMAT_TYPE_STR,
354 FORMAT_TYPE_PTR,
355 FORMAT_TYPE_PERCENT_CHAR,
356 FORMAT_TYPE_INVALID,
357 FORMAT_TYPE_LONG_LONG,
358 FORMAT_TYPE_ULONG,
359 FORMAT_TYPE_LONG,
360 FORMAT_TYPE_UBYTE,
361 FORMAT_TYPE_BYTE,
362 FORMAT_TYPE_USHORT,
363 FORMAT_TYPE_SHORT,
364 FORMAT_TYPE_UINT,
365 FORMAT_TYPE_INT,
366 FORMAT_TYPE_NRCHARS,
367 FORMAT_TYPE_SIZE_T,
368 FORMAT_TYPE_PTRDIFF
371 struct printf_spec {
372 u8 type; /* format_type enum */
373 u8 flags; /* flags to number() */
374 u8 base; /* number base, 8, 10 or 16 only */
375 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
376 s16 field_width; /* width of output field */
377 s16 precision; /* # of digits/chars */
380 static noinline_for_stack
381 char *number(char *buf, char *end, unsigned long long num,
382 struct printf_spec spec)
384 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
385 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
387 char tmp[66];
388 char sign;
389 char locase;
390 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
391 int i;
392 bool is_zero = num == 0LL;
394 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
395 * produces same digits or (maybe lowercased) letters */
396 locase = (spec.flags & SMALL);
397 if (spec.flags & LEFT)
398 spec.flags &= ~ZEROPAD;
399 sign = 0;
400 if (spec.flags & SIGN) {
401 if ((signed long long)num < 0) {
402 sign = '-';
403 num = -(signed long long)num;
404 spec.field_width--;
405 } else if (spec.flags & PLUS) {
406 sign = '+';
407 spec.field_width--;
408 } else if (spec.flags & SPACE) {
409 sign = ' ';
410 spec.field_width--;
413 if (need_pfx) {
414 if (spec.base == 16)
415 spec.field_width -= 2;
416 else if (!is_zero)
417 spec.field_width--;
420 /* generate full string in tmp[], in reverse order */
421 i = 0;
422 if (num < spec.base)
423 tmp[i++] = digits[num] | locase;
424 /* Generic code, for any base:
425 else do {
426 tmp[i++] = (digits[do_div(num,base)] | locase);
427 } while (num != 0);
429 else if (spec.base != 10) { /* 8 or 16 */
430 int mask = spec.base - 1;
431 int shift = 3;
433 if (spec.base == 16)
434 shift = 4;
435 do {
436 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
437 num >>= shift;
438 } while (num);
439 } else { /* base 10 */
440 i = put_dec(tmp, num) - tmp;
443 /* printing 100 using %2d gives "100", not "00" */
444 if (i > spec.precision)
445 spec.precision = i;
446 /* leading space padding */
447 spec.field_width -= spec.precision;
448 if (!(spec.flags & (ZEROPAD+LEFT))) {
449 while (--spec.field_width >= 0) {
450 if (buf < end)
451 *buf = ' ';
452 ++buf;
455 /* sign */
456 if (sign) {
457 if (buf < end)
458 *buf = sign;
459 ++buf;
461 /* "0x" / "0" prefix */
462 if (need_pfx) {
463 if (spec.base == 16 || !is_zero) {
464 if (buf < end)
465 *buf = '0';
466 ++buf;
468 if (spec.base == 16) {
469 if (buf < end)
470 *buf = ('X' | locase);
471 ++buf;
474 /* zero or space padding */
475 if (!(spec.flags & LEFT)) {
476 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
477 while (--spec.field_width >= 0) {
478 if (buf < end)
479 *buf = c;
480 ++buf;
483 /* hmm even more zero padding? */
484 while (i <= --spec.precision) {
485 if (buf < end)
486 *buf = '0';
487 ++buf;
489 /* actual digits of result */
490 while (--i >= 0) {
491 if (buf < end)
492 *buf = tmp[i];
493 ++buf;
495 /* trailing space padding */
496 while (--spec.field_width >= 0) {
497 if (buf < end)
498 *buf = ' ';
499 ++buf;
502 return buf;
505 static noinline_for_stack
506 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
508 int len, i;
510 if ((unsigned long)s < PAGE_SIZE)
511 s = "(null)";
513 len = strnlen(s, spec.precision);
515 if (!(spec.flags & LEFT)) {
516 while (len < spec.field_width--) {
517 if (buf < end)
518 *buf = ' ';
519 ++buf;
522 for (i = 0; i < len; ++i) {
523 if (buf < end)
524 *buf = *s;
525 ++buf; ++s;
527 while (len < spec.field_width--) {
528 if (buf < end)
529 *buf = ' ';
530 ++buf;
533 return buf;
536 static noinline_for_stack
537 char *symbol_string(char *buf, char *end, void *ptr,
538 struct printf_spec spec, const char *fmt)
540 unsigned long value;
541 #ifdef CONFIG_KALLSYMS
542 char sym[KSYM_SYMBOL_LEN];
543 #endif
545 if (fmt[1] == 'R')
546 ptr = __builtin_extract_return_addr(ptr);
547 value = (unsigned long)ptr;
549 #ifdef CONFIG_KALLSYMS
550 if (*fmt == 'B')
551 sprint_backtrace(sym, value);
552 else if (*fmt != 'f' && *fmt != 's')
553 sprint_symbol(sym, value);
554 else
555 sprint_symbol_no_offset(sym, value);
557 return string(buf, end, sym, spec);
558 #else
559 spec.field_width = 2 * sizeof(void *);
560 spec.flags |= SPECIAL | SMALL | ZEROPAD;
561 spec.base = 16;
563 return number(buf, end, value, spec);
564 #endif
567 static noinline_for_stack
568 char *resource_string(char *buf, char *end, struct resource *res,
569 struct printf_spec spec, const char *fmt)
571 #ifndef IO_RSRC_PRINTK_SIZE
572 #define IO_RSRC_PRINTK_SIZE 6
573 #endif
575 #ifndef MEM_RSRC_PRINTK_SIZE
576 #define MEM_RSRC_PRINTK_SIZE 10
577 #endif
578 static const struct printf_spec io_spec = {
579 .base = 16,
580 .field_width = IO_RSRC_PRINTK_SIZE,
581 .precision = -1,
582 .flags = SPECIAL | SMALL | ZEROPAD,
584 static const struct printf_spec mem_spec = {
585 .base = 16,
586 .field_width = MEM_RSRC_PRINTK_SIZE,
587 .precision = -1,
588 .flags = SPECIAL | SMALL | ZEROPAD,
590 static const struct printf_spec bus_spec = {
591 .base = 16,
592 .field_width = 2,
593 .precision = -1,
594 .flags = SMALL | ZEROPAD,
596 static const struct printf_spec dec_spec = {
597 .base = 10,
598 .precision = -1,
599 .flags = 0,
601 static const struct printf_spec str_spec = {
602 .field_width = -1,
603 .precision = 10,
604 .flags = LEFT,
606 static const struct printf_spec flag_spec = {
607 .base = 16,
608 .precision = -1,
609 .flags = SPECIAL | SMALL,
612 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
613 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
614 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
615 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
616 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
617 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
618 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
619 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
621 char *p = sym, *pend = sym + sizeof(sym);
622 int decode = (fmt[0] == 'R') ? 1 : 0;
623 const struct printf_spec *specp;
625 *p++ = '[';
626 if (res->flags & IORESOURCE_IO) {
627 p = string(p, pend, "io ", str_spec);
628 specp = &io_spec;
629 } else if (res->flags & IORESOURCE_MEM) {
630 p = string(p, pend, "mem ", str_spec);
631 specp = &mem_spec;
632 } else if (res->flags & IORESOURCE_IRQ) {
633 p = string(p, pend, "irq ", str_spec);
634 specp = &dec_spec;
635 } else if (res->flags & IORESOURCE_DMA) {
636 p = string(p, pend, "dma ", str_spec);
637 specp = &dec_spec;
638 } else if (res->flags & IORESOURCE_BUS) {
639 p = string(p, pend, "bus ", str_spec);
640 specp = &bus_spec;
641 } else {
642 p = string(p, pend, "??? ", str_spec);
643 specp = &mem_spec;
644 decode = 0;
646 p = number(p, pend, res->start, *specp);
647 if (res->start != res->end) {
648 *p++ = '-';
649 p = number(p, pend, res->end, *specp);
651 if (decode) {
652 if (res->flags & IORESOURCE_MEM_64)
653 p = string(p, pend, " 64bit", str_spec);
654 if (res->flags & IORESOURCE_PREFETCH)
655 p = string(p, pend, " pref", str_spec);
656 if (res->flags & IORESOURCE_WINDOW)
657 p = string(p, pend, " window", str_spec);
658 if (res->flags & IORESOURCE_DISABLED)
659 p = string(p, pend, " disabled", str_spec);
660 } else {
661 p = string(p, pend, " flags ", str_spec);
662 p = number(p, pend, res->flags, flag_spec);
664 *p++ = ']';
665 *p = '\0';
667 return string(buf, end, sym, spec);
670 static noinline_for_stack
671 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
672 const char *fmt)
674 int i, len = 1; /* if we pass '%ph[CDN]', field witdh remains
675 negative value, fallback to the default */
676 char separator;
678 if (spec.field_width == 0)
679 /* nothing to print */
680 return buf;
682 if (ZERO_OR_NULL_PTR(addr))
683 /* NULL pointer */
684 return string(buf, end, NULL, spec);
686 switch (fmt[1]) {
687 case 'C':
688 separator = ':';
689 break;
690 case 'D':
691 separator = '-';
692 break;
693 case 'N':
694 separator = 0;
695 break;
696 default:
697 separator = ' ';
698 break;
701 if (spec.field_width > 0)
702 len = min_t(int, spec.field_width, 64);
704 for (i = 0; i < len && buf < end - 1; i++) {
705 buf = hex_byte_pack(buf, addr[i]);
707 if (buf < end && separator && i != len - 1)
708 *buf++ = separator;
711 return buf;
714 static noinline_for_stack
715 char *mac_address_string(char *buf, char *end, u8 *addr,
716 struct printf_spec spec, const char *fmt)
718 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
719 char *p = mac_addr;
720 int i;
721 char separator;
722 bool reversed = false;
724 switch (fmt[1]) {
725 case 'F':
726 separator = '-';
727 break;
729 case 'R':
730 reversed = true;
731 /* fall through */
733 default:
734 separator = ':';
735 break;
738 for (i = 0; i < 6; i++) {
739 if (reversed)
740 p = hex_byte_pack(p, addr[5 - i]);
741 else
742 p = hex_byte_pack(p, addr[i]);
744 if (fmt[0] == 'M' && i != 5)
745 *p++ = separator;
747 *p = '\0';
749 return string(buf, end, mac_addr, spec);
752 static noinline_for_stack
753 char *ip4_string(char *p, const u8 *addr, const char *fmt)
755 int i;
756 bool leading_zeros = (fmt[0] == 'i');
757 int index;
758 int step;
760 switch (fmt[2]) {
761 case 'h':
762 #ifdef __BIG_ENDIAN
763 index = 0;
764 step = 1;
765 #else
766 index = 3;
767 step = -1;
768 #endif
769 break;
770 case 'l':
771 index = 3;
772 step = -1;
773 break;
774 case 'n':
775 case 'b':
776 default:
777 index = 0;
778 step = 1;
779 break;
781 for (i = 0; i < 4; i++) {
782 char temp[3]; /* hold each IP quad in reverse order */
783 int digits = put_dec_trunc8(temp, addr[index]) - temp;
784 if (leading_zeros) {
785 if (digits < 3)
786 *p++ = '0';
787 if (digits < 2)
788 *p++ = '0';
790 /* reverse the digits in the quad */
791 while (digits--)
792 *p++ = temp[digits];
793 if (i < 3)
794 *p++ = '.';
795 index += step;
797 *p = '\0';
799 return p;
802 static noinline_for_stack
803 char *ip6_compressed_string(char *p, const char *addr)
805 int i, j, range;
806 unsigned char zerolength[8];
807 int longest = 1;
808 int colonpos = -1;
809 u16 word;
810 u8 hi, lo;
811 bool needcolon = false;
812 bool useIPv4;
813 struct in6_addr in6;
815 memcpy(&in6, addr, sizeof(struct in6_addr));
817 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
819 memset(zerolength, 0, sizeof(zerolength));
821 if (useIPv4)
822 range = 6;
823 else
824 range = 8;
826 /* find position of longest 0 run */
827 for (i = 0; i < range; i++) {
828 for (j = i; j < range; j++) {
829 if (in6.s6_addr16[j] != 0)
830 break;
831 zerolength[i]++;
834 for (i = 0; i < range; i++) {
835 if (zerolength[i] > longest) {
836 longest = zerolength[i];
837 colonpos = i;
840 if (longest == 1) /* don't compress a single 0 */
841 colonpos = -1;
843 /* emit address */
844 for (i = 0; i < range; i++) {
845 if (i == colonpos) {
846 if (needcolon || i == 0)
847 *p++ = ':';
848 *p++ = ':';
849 needcolon = false;
850 i += longest - 1;
851 continue;
853 if (needcolon) {
854 *p++ = ':';
855 needcolon = false;
857 /* hex u16 without leading 0s */
858 word = ntohs(in6.s6_addr16[i]);
859 hi = word >> 8;
860 lo = word & 0xff;
861 if (hi) {
862 if (hi > 0x0f)
863 p = hex_byte_pack(p, hi);
864 else
865 *p++ = hex_asc_lo(hi);
866 p = hex_byte_pack(p, lo);
868 else if (lo > 0x0f)
869 p = hex_byte_pack(p, lo);
870 else
871 *p++ = hex_asc_lo(lo);
872 needcolon = true;
875 if (useIPv4) {
876 if (needcolon)
877 *p++ = ':';
878 p = ip4_string(p, &in6.s6_addr[12], "I4");
880 *p = '\0';
882 return p;
885 static noinline_for_stack
886 char *ip6_string(char *p, const char *addr, const char *fmt)
888 int i;
890 for (i = 0; i < 8; i++) {
891 p = hex_byte_pack(p, *addr++);
892 p = hex_byte_pack(p, *addr++);
893 if (fmt[0] == 'I' && i != 7)
894 *p++ = ':';
896 *p = '\0';
898 return p;
901 static noinline_for_stack
902 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
903 struct printf_spec spec, const char *fmt)
905 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
907 if (fmt[0] == 'I' && fmt[2] == 'c')
908 ip6_compressed_string(ip6_addr, addr);
909 else
910 ip6_string(ip6_addr, addr, fmt);
912 return string(buf, end, ip6_addr, spec);
915 static noinline_for_stack
916 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
917 struct printf_spec spec, const char *fmt)
919 char ip4_addr[sizeof("255.255.255.255")];
921 ip4_string(ip4_addr, addr, fmt);
923 return string(buf, end, ip4_addr, spec);
926 static noinline_for_stack
927 char *uuid_string(char *buf, char *end, const u8 *addr,
928 struct printf_spec spec, const char *fmt)
930 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
931 char *p = uuid;
932 int i;
933 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
934 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
935 const u8 *index = be;
936 bool uc = false;
938 switch (*(++fmt)) {
939 case 'L':
940 uc = true; /* fall-through */
941 case 'l':
942 index = le;
943 break;
944 case 'B':
945 uc = true;
946 break;
949 for (i = 0; i < 16; i++) {
950 p = hex_byte_pack(p, addr[index[i]]);
951 switch (i) {
952 case 3:
953 case 5:
954 case 7:
955 case 9:
956 *p++ = '-';
957 break;
961 *p = 0;
963 if (uc) {
964 p = uuid;
965 do {
966 *p = toupper(*p);
967 } while (*(++p));
970 return string(buf, end, uuid, spec);
973 static
974 char *netdev_feature_string(char *buf, char *end, const u8 *addr,
975 struct printf_spec spec)
977 spec.flags |= SPECIAL | SMALL | ZEROPAD;
978 if (spec.field_width == -1)
979 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
980 spec.base = 16;
982 return number(buf, end, *(const netdev_features_t *)addr, spec);
985 int kptr_restrict __read_mostly;
988 * Show a '%p' thing. A kernel extension is that the '%p' is followed
989 * by an extra set of alphanumeric characters that are extended format
990 * specifiers.
992 * Right now we handle:
994 * - 'F' For symbolic function descriptor pointers with offset
995 * - 'f' For simple symbolic function names without offset
996 * - 'S' For symbolic direct pointers with offset
997 * - 's' For symbolic direct pointers without offset
998 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
999 * - 'B' For backtraced symbolic direct pointers with offset
1000 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1001 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1002 * - 'M' For a 6-byte MAC address, it prints the address in the
1003 * usual colon-separated hex notation
1004 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1005 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1006 * with a dash-separated hex notation
1007 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1008 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1009 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1010 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1011 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1012 * IPv6 omits the colons (01020304...0f)
1013 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1014 * - '[Ii]4[hnbl]' IPv4 addresses in host, network, big or little endian order
1015 * - 'I6c' for IPv6 addresses printed as specified by
1016 * http://tools.ietf.org/html/rfc5952
1017 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1018 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1019 * Options for %pU are:
1020 * b big endian lower case hex (default)
1021 * B big endian UPPER case hex
1022 * l little endian lower case hex
1023 * L little endian UPPER case hex
1024 * big endian output byte order is:
1025 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1026 * little endian output byte order is:
1027 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1028 * - 'V' For a struct va_format which contains a format string * and va_list *,
1029 * call vsnprintf(->format, *->va_list).
1030 * Implements a "recursive vsnprintf".
1031 * Do not use this feature without some mechanism to verify the
1032 * correctness of the format string and va_list arguments.
1033 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1034 * - 'NF' For a netdev_features_t
1035 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1036 * a certain separator (' ' by default):
1037 * C colon
1038 * D dash
1039 * N no separator
1040 * The maximum supported length is 64 bytes of the input. Consider
1041 * to use print_hex_dump() for the larger input.
1042 * - 'a' For a phys_addr_t type and its derivative types (passed by reference)
1044 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1045 * function pointers are really function descriptors, which contain a
1046 * pointer to the real address.
1048 static noinline_for_stack
1049 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1050 struct printf_spec spec)
1052 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1054 if (!ptr && *fmt != 'K') {
1056 * Print (null) with the same width as a pointer so it makes
1057 * tabular output look nice.
1059 if (spec.field_width == -1)
1060 spec.field_width = default_width;
1061 return string(buf, end, "(null)", spec);
1064 switch (*fmt) {
1065 case 'F':
1066 case 'f':
1067 ptr = dereference_function_descriptor(ptr);
1068 /* Fallthrough */
1069 case 'S':
1070 case 's':
1071 case 'B':
1072 return symbol_string(buf, end, ptr, spec, fmt);
1073 case 'R':
1074 case 'r':
1075 return resource_string(buf, end, ptr, spec, fmt);
1076 case 'h':
1077 return hex_string(buf, end, ptr, spec, fmt);
1078 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1079 case 'm': /* Contiguous: 000102030405 */
1080 /* [mM]F (FDDI) */
1081 /* [mM]R (Reverse order; Bluetooth) */
1082 return mac_address_string(buf, end, ptr, spec, fmt);
1083 case 'I': /* Formatted IP supported
1084 * 4: 1.2.3.4
1085 * 6: 0001:0203:...:0708
1086 * 6c: 1::708 or 1::1.2.3.4
1088 case 'i': /* Contiguous:
1089 * 4: 001.002.003.004
1090 * 6: 000102...0f
1092 switch (fmt[1]) {
1093 case '6':
1094 return ip6_addr_string(buf, end, ptr, spec, fmt);
1095 case '4':
1096 return ip4_addr_string(buf, end, ptr, spec, fmt);
1098 break;
1099 case 'U':
1100 return uuid_string(buf, end, ptr, spec, fmt);
1101 case 'V':
1103 va_list va;
1105 va_copy(va, *((struct va_format *)ptr)->va);
1106 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1107 ((struct va_format *)ptr)->fmt, va);
1108 va_end(va);
1109 return buf;
1111 case 'K':
1113 * %pK cannot be used in IRQ context because its test
1114 * for CAP_SYSLOG would be meaningless.
1116 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1117 in_nmi())) {
1118 if (spec.field_width == -1)
1119 spec.field_width = default_width;
1120 return string(buf, end, "pK-error", spec);
1123 switch (kptr_restrict) {
1124 case 0:
1125 /* Always print %pK values */
1126 break;
1127 case 1: {
1129 * Only print the real pointer value if the current
1130 * process has CAP_SYSLOG and is running with the
1131 * same credentials it started with. This is because
1132 * access to files is checked at open() time, but %pK
1133 * checks permission at read() time. We don't want to
1134 * leak pointer values if a binary opens a file using
1135 * %pK and then elevates privileges before reading it.
1137 const struct cred *cred = current_cred();
1139 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1140 !uid_eq(cred->euid, cred->uid) ||
1141 !gid_eq(cred->egid, cred->gid))
1142 ptr = NULL;
1143 break;
1145 case 2:
1146 default:
1147 /* Always print 0's for %pK */
1148 ptr = NULL;
1149 break;
1151 break;
1153 case 'N':
1154 switch (fmt[1]) {
1155 case 'F':
1156 return netdev_feature_string(buf, end, ptr, spec);
1158 break;
1159 case 'a':
1160 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1161 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1162 spec.base = 16;
1163 return number(buf, end,
1164 (unsigned long long) *((phys_addr_t *)ptr), spec);
1166 spec.flags |= SMALL;
1167 if (spec.field_width == -1) {
1168 spec.field_width = default_width;
1169 spec.flags |= ZEROPAD;
1171 spec.base = 16;
1173 return number(buf, end, (unsigned long) ptr, spec);
1177 * Helper function to decode printf style format.
1178 * Each call decode a token from the format and return the
1179 * number of characters read (or likely the delta where it wants
1180 * to go on the next call).
1181 * The decoded token is returned through the parameters
1183 * 'h', 'l', or 'L' for integer fields
1184 * 'z' support added 23/7/1999 S.H.
1185 * 'z' changed to 'Z' --davidm 1/25/99
1186 * 't' added for ptrdiff_t
1188 * @fmt: the format string
1189 * @type of the token returned
1190 * @flags: various flags such as +, -, # tokens..
1191 * @field_width: overwritten width
1192 * @base: base of the number (octal, hex, ...)
1193 * @precision: precision of a number
1194 * @qualifier: qualifier of a number (long, size_t, ...)
1196 static noinline_for_stack
1197 int format_decode(const char *fmt, struct printf_spec *spec)
1199 const char *start = fmt;
1201 /* we finished early by reading the field width */
1202 if (spec->type == FORMAT_TYPE_WIDTH) {
1203 if (spec->field_width < 0) {
1204 spec->field_width = -spec->field_width;
1205 spec->flags |= LEFT;
1207 spec->type = FORMAT_TYPE_NONE;
1208 goto precision;
1211 /* we finished early by reading the precision */
1212 if (spec->type == FORMAT_TYPE_PRECISION) {
1213 if (spec->precision < 0)
1214 spec->precision = 0;
1216 spec->type = FORMAT_TYPE_NONE;
1217 goto qualifier;
1220 /* By default */
1221 spec->type = FORMAT_TYPE_NONE;
1223 for (; *fmt ; ++fmt) {
1224 if (*fmt == '%')
1225 break;
1228 /* Return the current non-format string */
1229 if (fmt != start || !*fmt)
1230 return fmt - start;
1232 /* Process flags */
1233 spec->flags = 0;
1235 while (1) { /* this also skips first '%' */
1236 bool found = true;
1238 ++fmt;
1240 switch (*fmt) {
1241 case '-': spec->flags |= LEFT; break;
1242 case '+': spec->flags |= PLUS; break;
1243 case ' ': spec->flags |= SPACE; break;
1244 case '#': spec->flags |= SPECIAL; break;
1245 case '0': spec->flags |= ZEROPAD; break;
1246 default: found = false;
1249 if (!found)
1250 break;
1253 /* get field width */
1254 spec->field_width = -1;
1256 if (isdigit(*fmt))
1257 spec->field_width = skip_atoi(&fmt);
1258 else if (*fmt == '*') {
1259 /* it's the next argument */
1260 spec->type = FORMAT_TYPE_WIDTH;
1261 return ++fmt - start;
1264 precision:
1265 /* get the precision */
1266 spec->precision = -1;
1267 if (*fmt == '.') {
1268 ++fmt;
1269 if (isdigit(*fmt)) {
1270 spec->precision = skip_atoi(&fmt);
1271 if (spec->precision < 0)
1272 spec->precision = 0;
1273 } else if (*fmt == '*') {
1274 /* it's the next argument */
1275 spec->type = FORMAT_TYPE_PRECISION;
1276 return ++fmt - start;
1280 qualifier:
1281 /* get the conversion qualifier */
1282 spec->qualifier = -1;
1283 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1284 _tolower(*fmt) == 'z' || *fmt == 't') {
1285 spec->qualifier = *fmt++;
1286 if (unlikely(spec->qualifier == *fmt)) {
1287 if (spec->qualifier == 'l') {
1288 spec->qualifier = 'L';
1289 ++fmt;
1290 } else if (spec->qualifier == 'h') {
1291 spec->qualifier = 'H';
1292 ++fmt;
1297 /* default base */
1298 spec->base = 10;
1299 switch (*fmt) {
1300 case 'c':
1301 spec->type = FORMAT_TYPE_CHAR;
1302 return ++fmt - start;
1304 case 's':
1305 spec->type = FORMAT_TYPE_STR;
1306 return ++fmt - start;
1308 case 'p':
1309 spec->type = FORMAT_TYPE_PTR;
1310 return fmt - start;
1311 /* skip alnum */
1313 case 'n':
1314 spec->type = FORMAT_TYPE_NRCHARS;
1315 return ++fmt - start;
1317 case '%':
1318 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1319 return ++fmt - start;
1321 /* integer number formats - set up the flags and "break" */
1322 case 'o':
1323 spec->base = 8;
1324 break;
1326 case 'x':
1327 spec->flags |= SMALL;
1329 case 'X':
1330 spec->base = 16;
1331 break;
1333 case 'd':
1334 case 'i':
1335 spec->flags |= SIGN;
1336 case 'u':
1337 break;
1339 default:
1340 spec->type = FORMAT_TYPE_INVALID;
1341 return fmt - start;
1344 if (spec->qualifier == 'L')
1345 spec->type = FORMAT_TYPE_LONG_LONG;
1346 else if (spec->qualifier == 'l') {
1347 if (spec->flags & SIGN)
1348 spec->type = FORMAT_TYPE_LONG;
1349 else
1350 spec->type = FORMAT_TYPE_ULONG;
1351 } else if (_tolower(spec->qualifier) == 'z') {
1352 spec->type = FORMAT_TYPE_SIZE_T;
1353 } else if (spec->qualifier == 't') {
1354 spec->type = FORMAT_TYPE_PTRDIFF;
1355 } else if (spec->qualifier == 'H') {
1356 if (spec->flags & SIGN)
1357 spec->type = FORMAT_TYPE_BYTE;
1358 else
1359 spec->type = FORMAT_TYPE_UBYTE;
1360 } else if (spec->qualifier == 'h') {
1361 if (spec->flags & SIGN)
1362 spec->type = FORMAT_TYPE_SHORT;
1363 else
1364 spec->type = FORMAT_TYPE_USHORT;
1365 } else {
1366 if (spec->flags & SIGN)
1367 spec->type = FORMAT_TYPE_INT;
1368 else
1369 spec->type = FORMAT_TYPE_UINT;
1372 return ++fmt - start;
1376 * vsnprintf - Format a string and place it in a buffer
1377 * @buf: The buffer to place the result into
1378 * @size: The size of the buffer, including the trailing null space
1379 * @fmt: The format string to use
1380 * @args: Arguments for the format string
1382 * This function follows C99 vsnprintf, but has some extensions:
1383 * %pS output the name of a text symbol with offset
1384 * %ps output the name of a text symbol without offset
1385 * %pF output the name of a function pointer with its offset
1386 * %pf output the name of a function pointer without its offset
1387 * %pB output the name of a backtrace symbol with its offset
1388 * %pR output the address range in a struct resource with decoded flags
1389 * %pr output the address range in a struct resource with raw flags
1390 * %pM output a 6-byte MAC address with colons
1391 * %pMR output a 6-byte MAC address with colons in reversed order
1392 * %pMF output a 6-byte MAC address with dashes
1393 * %pm output a 6-byte MAC address without colons
1394 * %pmR output a 6-byte MAC address without colons in reversed order
1395 * %pI4 print an IPv4 address without leading zeros
1396 * %pi4 print an IPv4 address with leading zeros
1397 * %pI6 print an IPv6 address with colons
1398 * %pi6 print an IPv6 address without colons
1399 * %pI6c print an IPv6 address as specified by RFC 5952
1400 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1401 * case.
1402 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1403 * bytes of the input)
1404 * %n is ignored
1406 * ** Please update Documentation/printk-formats.txt when making changes **
1408 * The return value is the number of characters which would
1409 * be generated for the given input, excluding the trailing
1410 * '\0', as per ISO C99. If you want to have the exact
1411 * number of characters written into @buf as return value
1412 * (not including the trailing '\0'), use vscnprintf(). If the
1413 * return is greater than or equal to @size, the resulting
1414 * string is truncated.
1416 * If you're not already dealing with a va_list consider using snprintf().
1418 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1420 unsigned long long num;
1421 char *str, *end;
1422 struct printf_spec spec = {0};
1424 /* Reject out-of-range values early. Large positive sizes are
1425 used for unknown buffer sizes. */
1426 if (WARN_ON_ONCE((int) size < 0))
1427 return 0;
1429 str = buf;
1430 end = buf + size;
1432 /* Make sure end is always >= buf */
1433 if (end < buf) {
1434 end = ((void *)-1);
1435 size = end - buf;
1438 while (*fmt) {
1439 const char *old_fmt = fmt;
1440 int read = format_decode(fmt, &spec);
1442 fmt += read;
1444 switch (spec.type) {
1445 case FORMAT_TYPE_NONE: {
1446 int copy = read;
1447 if (str < end) {
1448 if (copy > end - str)
1449 copy = end - str;
1450 memcpy(str, old_fmt, copy);
1452 str += read;
1453 break;
1456 case FORMAT_TYPE_WIDTH:
1457 spec.field_width = va_arg(args, int);
1458 break;
1460 case FORMAT_TYPE_PRECISION:
1461 spec.precision = va_arg(args, int);
1462 break;
1464 case FORMAT_TYPE_CHAR: {
1465 char c;
1467 if (!(spec.flags & LEFT)) {
1468 while (--spec.field_width > 0) {
1469 if (str < end)
1470 *str = ' ';
1471 ++str;
1475 c = (unsigned char) va_arg(args, int);
1476 if (str < end)
1477 *str = c;
1478 ++str;
1479 while (--spec.field_width > 0) {
1480 if (str < end)
1481 *str = ' ';
1482 ++str;
1484 break;
1487 case FORMAT_TYPE_STR:
1488 str = string(str, end, va_arg(args, char *), spec);
1489 break;
1491 case FORMAT_TYPE_PTR:
1492 str = pointer(fmt+1, str, end, va_arg(args, void *),
1493 spec);
1494 while (isalnum(*fmt))
1495 fmt++;
1496 break;
1498 case FORMAT_TYPE_PERCENT_CHAR:
1499 if (str < end)
1500 *str = '%';
1501 ++str;
1502 break;
1504 case FORMAT_TYPE_INVALID:
1505 if (str < end)
1506 *str = '%';
1507 ++str;
1508 break;
1510 case FORMAT_TYPE_NRCHARS: {
1511 u8 qualifier = spec.qualifier;
1513 if (qualifier == 'l') {
1514 long *ip = va_arg(args, long *);
1515 *ip = (str - buf);
1516 } else if (_tolower(qualifier) == 'z') {
1517 size_t *ip = va_arg(args, size_t *);
1518 *ip = (str - buf);
1519 } else {
1520 int *ip = va_arg(args, int *);
1521 *ip = (str - buf);
1523 break;
1526 default:
1527 switch (spec.type) {
1528 case FORMAT_TYPE_LONG_LONG:
1529 num = va_arg(args, long long);
1530 break;
1531 case FORMAT_TYPE_ULONG:
1532 num = va_arg(args, unsigned long);
1533 break;
1534 case FORMAT_TYPE_LONG:
1535 num = va_arg(args, long);
1536 break;
1537 case FORMAT_TYPE_SIZE_T:
1538 if (spec.flags & SIGN)
1539 num = va_arg(args, ssize_t);
1540 else
1541 num = va_arg(args, size_t);
1542 break;
1543 case FORMAT_TYPE_PTRDIFF:
1544 num = va_arg(args, ptrdiff_t);
1545 break;
1546 case FORMAT_TYPE_UBYTE:
1547 num = (unsigned char) va_arg(args, int);
1548 break;
1549 case FORMAT_TYPE_BYTE:
1550 num = (signed char) va_arg(args, int);
1551 break;
1552 case FORMAT_TYPE_USHORT:
1553 num = (unsigned short) va_arg(args, int);
1554 break;
1555 case FORMAT_TYPE_SHORT:
1556 num = (short) va_arg(args, int);
1557 break;
1558 case FORMAT_TYPE_INT:
1559 num = (int) va_arg(args, int);
1560 break;
1561 default:
1562 num = va_arg(args, unsigned int);
1565 str = number(str, end, num, spec);
1569 if (size > 0) {
1570 if (str < end)
1571 *str = '\0';
1572 else
1573 end[-1] = '\0';
1576 /* the trailing null byte doesn't count towards the total */
1577 return str-buf;
1580 EXPORT_SYMBOL(vsnprintf);
1583 * vscnprintf - Format a string and place it in a buffer
1584 * @buf: The buffer to place the result into
1585 * @size: The size of the buffer, including the trailing null space
1586 * @fmt: The format string to use
1587 * @args: Arguments for the format string
1589 * The return value is the number of characters which have been written into
1590 * the @buf not including the trailing '\0'. If @size is == 0 the function
1591 * returns 0.
1593 * If you're not already dealing with a va_list consider using scnprintf().
1595 * See the vsnprintf() documentation for format string extensions over C99.
1597 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1599 int i;
1601 i = vsnprintf(buf, size, fmt, args);
1603 if (likely(i < size))
1604 return i;
1605 if (size != 0)
1606 return size - 1;
1607 return 0;
1609 EXPORT_SYMBOL(vscnprintf);
1612 * snprintf - Format a string and place it in a buffer
1613 * @buf: The buffer to place the result into
1614 * @size: The size of the buffer, including the trailing null space
1615 * @fmt: The format string to use
1616 * @...: Arguments for the format string
1618 * The return value is the number of characters which would be
1619 * generated for the given input, excluding the trailing null,
1620 * as per ISO C99. If the return is greater than or equal to
1621 * @size, the resulting string is truncated.
1623 * See the vsnprintf() documentation for format string extensions over C99.
1625 int snprintf(char *buf, size_t size, const char *fmt, ...)
1627 va_list args;
1628 int i;
1630 va_start(args, fmt);
1631 i = vsnprintf(buf, size, fmt, args);
1632 va_end(args);
1634 return i;
1636 EXPORT_SYMBOL(snprintf);
1639 * scnprintf - Format a string and place it in a buffer
1640 * @buf: The buffer to place the result into
1641 * @size: The size of the buffer, including the trailing null space
1642 * @fmt: The format string to use
1643 * @...: Arguments for the format string
1645 * The return value is the number of characters written into @buf not including
1646 * the trailing '\0'. If @size is == 0 the function returns 0.
1649 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1651 va_list args;
1652 int i;
1654 va_start(args, fmt);
1655 i = vscnprintf(buf, size, fmt, args);
1656 va_end(args);
1658 return i;
1660 EXPORT_SYMBOL(scnprintf);
1663 * vsprintf - Format a string and place it in a buffer
1664 * @buf: The buffer to place the result into
1665 * @fmt: The format string to use
1666 * @args: Arguments for the format string
1668 * The function returns the number of characters written
1669 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1670 * buffer overflows.
1672 * If you're not already dealing with a va_list consider using sprintf().
1674 * See the vsnprintf() documentation for format string extensions over C99.
1676 int vsprintf(char *buf, const char *fmt, va_list args)
1678 return vsnprintf(buf, INT_MAX, fmt, args);
1680 EXPORT_SYMBOL(vsprintf);
1683 * sprintf - Format a string and place it in a buffer
1684 * @buf: The buffer to place the result into
1685 * @fmt: The format string to use
1686 * @...: Arguments for the format string
1688 * The function returns the number of characters written
1689 * into @buf. Use snprintf() or scnprintf() in order to avoid
1690 * buffer overflows.
1692 * See the vsnprintf() documentation for format string extensions over C99.
1694 int sprintf(char *buf, const char *fmt, ...)
1696 va_list args;
1697 int i;
1699 va_start(args, fmt);
1700 i = vsnprintf(buf, INT_MAX, fmt, args);
1701 va_end(args);
1703 return i;
1705 EXPORT_SYMBOL(sprintf);
1707 #ifdef CONFIG_BINARY_PRINTF
1709 * bprintf service:
1710 * vbin_printf() - VA arguments to binary data
1711 * bstr_printf() - Binary data to text string
1715 * vbin_printf - Parse a format string and place args' binary value in a buffer
1716 * @bin_buf: The buffer to place args' binary value
1717 * @size: The size of the buffer(by words(32bits), not characters)
1718 * @fmt: The format string to use
1719 * @args: Arguments for the format string
1721 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1722 * is skiped.
1724 * The return value is the number of words(32bits) which would be generated for
1725 * the given input.
1727 * NOTE:
1728 * If the return value is greater than @size, the resulting bin_buf is NOT
1729 * valid for bstr_printf().
1731 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1733 struct printf_spec spec = {0};
1734 char *str, *end;
1736 str = (char *)bin_buf;
1737 end = (char *)(bin_buf + size);
1739 #define save_arg(type) \
1740 do { \
1741 if (sizeof(type) == 8) { \
1742 unsigned long long value; \
1743 str = PTR_ALIGN(str, sizeof(u32)); \
1744 value = va_arg(args, unsigned long long); \
1745 if (str + sizeof(type) <= end) { \
1746 *(u32 *)str = *(u32 *)&value; \
1747 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1749 } else { \
1750 unsigned long value; \
1751 str = PTR_ALIGN(str, sizeof(type)); \
1752 value = va_arg(args, int); \
1753 if (str + sizeof(type) <= end) \
1754 *(typeof(type) *)str = (type)value; \
1756 str += sizeof(type); \
1757 } while (0)
1759 while (*fmt) {
1760 int read = format_decode(fmt, &spec);
1762 fmt += read;
1764 switch (spec.type) {
1765 case FORMAT_TYPE_NONE:
1766 case FORMAT_TYPE_INVALID:
1767 case FORMAT_TYPE_PERCENT_CHAR:
1768 break;
1770 case FORMAT_TYPE_WIDTH:
1771 case FORMAT_TYPE_PRECISION:
1772 save_arg(int);
1773 break;
1775 case FORMAT_TYPE_CHAR:
1776 save_arg(char);
1777 break;
1779 case FORMAT_TYPE_STR: {
1780 const char *save_str = va_arg(args, char *);
1781 size_t len;
1783 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1784 || (unsigned long)save_str < PAGE_SIZE)
1785 save_str = "(null)";
1786 len = strlen(save_str) + 1;
1787 if (str + len < end)
1788 memcpy(str, save_str, len);
1789 str += len;
1790 break;
1793 case FORMAT_TYPE_PTR:
1794 save_arg(void *);
1795 /* skip all alphanumeric pointer suffixes */
1796 while (isalnum(*fmt))
1797 fmt++;
1798 break;
1800 case FORMAT_TYPE_NRCHARS: {
1801 /* skip %n 's argument */
1802 u8 qualifier = spec.qualifier;
1803 void *skip_arg;
1804 if (qualifier == 'l')
1805 skip_arg = va_arg(args, long *);
1806 else if (_tolower(qualifier) == 'z')
1807 skip_arg = va_arg(args, size_t *);
1808 else
1809 skip_arg = va_arg(args, int *);
1810 break;
1813 default:
1814 switch (spec.type) {
1816 case FORMAT_TYPE_LONG_LONG:
1817 save_arg(long long);
1818 break;
1819 case FORMAT_TYPE_ULONG:
1820 case FORMAT_TYPE_LONG:
1821 save_arg(unsigned long);
1822 break;
1823 case FORMAT_TYPE_SIZE_T:
1824 save_arg(size_t);
1825 break;
1826 case FORMAT_TYPE_PTRDIFF:
1827 save_arg(ptrdiff_t);
1828 break;
1829 case FORMAT_TYPE_UBYTE:
1830 case FORMAT_TYPE_BYTE:
1831 save_arg(char);
1832 break;
1833 case FORMAT_TYPE_USHORT:
1834 case FORMAT_TYPE_SHORT:
1835 save_arg(short);
1836 break;
1837 default:
1838 save_arg(int);
1843 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1844 #undef save_arg
1846 EXPORT_SYMBOL_GPL(vbin_printf);
1849 * bstr_printf - Format a string from binary arguments and place it in a buffer
1850 * @buf: The buffer to place the result into
1851 * @size: The size of the buffer, including the trailing null space
1852 * @fmt: The format string to use
1853 * @bin_buf: Binary arguments for the format string
1855 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1856 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1857 * a binary buffer that generated by vbin_printf.
1859 * The format follows C99 vsnprintf, but has some extensions:
1860 * see vsnprintf comment for details.
1862 * The return value is the number of characters which would
1863 * be generated for the given input, excluding the trailing
1864 * '\0', as per ISO C99. If you want to have the exact
1865 * number of characters written into @buf as return value
1866 * (not including the trailing '\0'), use vscnprintf(). If the
1867 * return is greater than or equal to @size, the resulting
1868 * string is truncated.
1870 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1872 struct printf_spec spec = {0};
1873 char *str, *end;
1874 const char *args = (const char *)bin_buf;
1876 if (WARN_ON_ONCE((int) size < 0))
1877 return 0;
1879 str = buf;
1880 end = buf + size;
1882 #define get_arg(type) \
1883 ({ \
1884 typeof(type) value; \
1885 if (sizeof(type) == 8) { \
1886 args = PTR_ALIGN(args, sizeof(u32)); \
1887 *(u32 *)&value = *(u32 *)args; \
1888 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1889 } else { \
1890 args = PTR_ALIGN(args, sizeof(type)); \
1891 value = *(typeof(type) *)args; \
1893 args += sizeof(type); \
1894 value; \
1897 /* Make sure end is always >= buf */
1898 if (end < buf) {
1899 end = ((void *)-1);
1900 size = end - buf;
1903 while (*fmt) {
1904 const char *old_fmt = fmt;
1905 int read = format_decode(fmt, &spec);
1907 fmt += read;
1909 switch (spec.type) {
1910 case FORMAT_TYPE_NONE: {
1911 int copy = read;
1912 if (str < end) {
1913 if (copy > end - str)
1914 copy = end - str;
1915 memcpy(str, old_fmt, copy);
1917 str += read;
1918 break;
1921 case FORMAT_TYPE_WIDTH:
1922 spec.field_width = get_arg(int);
1923 break;
1925 case FORMAT_TYPE_PRECISION:
1926 spec.precision = get_arg(int);
1927 break;
1929 case FORMAT_TYPE_CHAR: {
1930 char c;
1932 if (!(spec.flags & LEFT)) {
1933 while (--spec.field_width > 0) {
1934 if (str < end)
1935 *str = ' ';
1936 ++str;
1939 c = (unsigned char) get_arg(char);
1940 if (str < end)
1941 *str = c;
1942 ++str;
1943 while (--spec.field_width > 0) {
1944 if (str < end)
1945 *str = ' ';
1946 ++str;
1948 break;
1951 case FORMAT_TYPE_STR: {
1952 const char *str_arg = args;
1953 args += strlen(str_arg) + 1;
1954 str = string(str, end, (char *)str_arg, spec);
1955 break;
1958 case FORMAT_TYPE_PTR:
1959 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1960 while (isalnum(*fmt))
1961 fmt++;
1962 break;
1964 case FORMAT_TYPE_PERCENT_CHAR:
1965 case FORMAT_TYPE_INVALID:
1966 if (str < end)
1967 *str = '%';
1968 ++str;
1969 break;
1971 case FORMAT_TYPE_NRCHARS:
1972 /* skip */
1973 break;
1975 default: {
1976 unsigned long long num;
1978 switch (spec.type) {
1980 case FORMAT_TYPE_LONG_LONG:
1981 num = get_arg(long long);
1982 break;
1983 case FORMAT_TYPE_ULONG:
1984 case FORMAT_TYPE_LONG:
1985 num = get_arg(unsigned long);
1986 break;
1987 case FORMAT_TYPE_SIZE_T:
1988 num = get_arg(size_t);
1989 break;
1990 case FORMAT_TYPE_PTRDIFF:
1991 num = get_arg(ptrdiff_t);
1992 break;
1993 case FORMAT_TYPE_UBYTE:
1994 num = get_arg(unsigned char);
1995 break;
1996 case FORMAT_TYPE_BYTE:
1997 num = get_arg(signed char);
1998 break;
1999 case FORMAT_TYPE_USHORT:
2000 num = get_arg(unsigned short);
2001 break;
2002 case FORMAT_TYPE_SHORT:
2003 num = get_arg(short);
2004 break;
2005 case FORMAT_TYPE_UINT:
2006 num = get_arg(unsigned int);
2007 break;
2008 default:
2009 num = get_arg(int);
2012 str = number(str, end, num, spec);
2013 } /* default: */
2014 } /* switch(spec.type) */
2015 } /* while(*fmt) */
2017 if (size > 0) {
2018 if (str < end)
2019 *str = '\0';
2020 else
2021 end[-1] = '\0';
2024 #undef get_arg
2026 /* the trailing null byte doesn't count towards the total */
2027 return str - buf;
2029 EXPORT_SYMBOL_GPL(bstr_printf);
2032 * bprintf - Parse a format string and place args' binary value in a buffer
2033 * @bin_buf: The buffer to place args' binary value
2034 * @size: The size of the buffer(by words(32bits), not characters)
2035 * @fmt: The format string to use
2036 * @...: Arguments for the format string
2038 * The function returns the number of words(u32) written
2039 * into @bin_buf.
2041 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2043 va_list args;
2044 int ret;
2046 va_start(args, fmt);
2047 ret = vbin_printf(bin_buf, size, fmt, args);
2048 va_end(args);
2050 return ret;
2052 EXPORT_SYMBOL_GPL(bprintf);
2054 #endif /* CONFIG_BINARY_PRINTF */
2057 * vsscanf - Unformat a buffer into a list of arguments
2058 * @buf: input buffer
2059 * @fmt: format of buffer
2060 * @args: arguments
2062 int vsscanf(const char *buf, const char *fmt, va_list args)
2064 const char *str = buf;
2065 char *next;
2066 char digit;
2067 int num = 0;
2068 u8 qualifier;
2069 unsigned int base;
2070 union {
2071 long long s;
2072 unsigned long long u;
2073 } val;
2074 s16 field_width;
2075 bool is_sign;
2077 while (*fmt) {
2078 /* skip any white space in format */
2079 /* white space in format matchs any amount of
2080 * white space, including none, in the input.
2082 if (isspace(*fmt)) {
2083 fmt = skip_spaces(++fmt);
2084 str = skip_spaces(str);
2087 /* anything that is not a conversion must match exactly */
2088 if (*fmt != '%' && *fmt) {
2089 if (*fmt++ != *str++)
2090 break;
2091 continue;
2094 if (!*fmt)
2095 break;
2096 ++fmt;
2098 /* skip this conversion.
2099 * advance both strings to next white space
2101 if (*fmt == '*') {
2102 if (!*str)
2103 break;
2104 while (!isspace(*fmt) && *fmt != '%' && *fmt)
2105 fmt++;
2106 while (!isspace(*str) && *str)
2107 str++;
2108 continue;
2111 /* get field width */
2112 field_width = -1;
2113 if (isdigit(*fmt)) {
2114 field_width = skip_atoi(&fmt);
2115 if (field_width <= 0)
2116 break;
2119 /* get conversion qualifier */
2120 qualifier = -1;
2121 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2122 _tolower(*fmt) == 'z') {
2123 qualifier = *fmt++;
2124 if (unlikely(qualifier == *fmt)) {
2125 if (qualifier == 'h') {
2126 qualifier = 'H';
2127 fmt++;
2128 } else if (qualifier == 'l') {
2129 qualifier = 'L';
2130 fmt++;
2135 if (!*fmt)
2136 break;
2138 if (*fmt == 'n') {
2139 /* return number of characters read so far */
2140 *va_arg(args, int *) = str - buf;
2141 ++fmt;
2142 continue;
2145 if (!*str)
2146 break;
2148 base = 10;
2149 is_sign = 0;
2151 switch (*fmt++) {
2152 case 'c':
2154 char *s = (char *)va_arg(args, char*);
2155 if (field_width == -1)
2156 field_width = 1;
2157 do {
2158 *s++ = *str++;
2159 } while (--field_width > 0 && *str);
2160 num++;
2162 continue;
2163 case 's':
2165 char *s = (char *)va_arg(args, char *);
2166 if (field_width == -1)
2167 field_width = SHRT_MAX;
2168 /* first, skip leading white space in buffer */
2169 str = skip_spaces(str);
2171 /* now copy until next white space */
2172 while (*str && !isspace(*str) && field_width--)
2173 *s++ = *str++;
2174 *s = '\0';
2175 num++;
2177 continue;
2178 case 'o':
2179 base = 8;
2180 break;
2181 case 'x':
2182 case 'X':
2183 base = 16;
2184 break;
2185 case 'i':
2186 base = 0;
2187 case 'd':
2188 is_sign = 1;
2189 case 'u':
2190 break;
2191 case '%':
2192 /* looking for '%' in str */
2193 if (*str++ != '%')
2194 return num;
2195 continue;
2196 default:
2197 /* invalid format; stop here */
2198 return num;
2201 /* have some sort of integer conversion.
2202 * first, skip white space in buffer.
2204 str = skip_spaces(str);
2206 digit = *str;
2207 if (is_sign && digit == '-')
2208 digit = *(str + 1);
2210 if (!digit
2211 || (base == 16 && !isxdigit(digit))
2212 || (base == 10 && !isdigit(digit))
2213 || (base == 8 && (!isdigit(digit) || digit > '7'))
2214 || (base == 0 && !isdigit(digit)))
2215 break;
2217 if (is_sign)
2218 val.s = qualifier != 'L' ?
2219 simple_strtol(str, &next, base) :
2220 simple_strtoll(str, &next, base);
2221 else
2222 val.u = qualifier != 'L' ?
2223 simple_strtoul(str, &next, base) :
2224 simple_strtoull(str, &next, base);
2226 if (field_width > 0 && next - str > field_width) {
2227 if (base == 0)
2228 _parse_integer_fixup_radix(str, &base);
2229 while (next - str > field_width) {
2230 if (is_sign)
2231 val.s = div_s64(val.s, base);
2232 else
2233 val.u = div_u64(val.u, base);
2234 --next;
2238 switch (qualifier) {
2239 case 'H': /* that's 'hh' in format */
2240 if (is_sign)
2241 *va_arg(args, signed char *) = val.s;
2242 else
2243 *va_arg(args, unsigned char *) = val.u;
2244 break;
2245 case 'h':
2246 if (is_sign)
2247 *va_arg(args, short *) = val.s;
2248 else
2249 *va_arg(args, unsigned short *) = val.u;
2250 break;
2251 case 'l':
2252 if (is_sign)
2253 *va_arg(args, long *) = val.s;
2254 else
2255 *va_arg(args, unsigned long *) = val.u;
2256 break;
2257 case 'L':
2258 if (is_sign)
2259 *va_arg(args, long long *) = val.s;
2260 else
2261 *va_arg(args, unsigned long long *) = val.u;
2262 break;
2263 case 'Z':
2264 case 'z':
2265 *va_arg(args, size_t *) = val.u;
2266 break;
2267 default:
2268 if (is_sign)
2269 *va_arg(args, int *) = val.s;
2270 else
2271 *va_arg(args, unsigned int *) = val.u;
2272 break;
2274 num++;
2276 if (!next)
2277 break;
2278 str = next;
2281 return num;
2283 EXPORT_SYMBOL(vsscanf);
2286 * sscanf - Unformat a buffer into a list of arguments
2287 * @buf: input buffer
2288 * @fmt: formatting of buffer
2289 * @...: resulting arguments
2291 int sscanf(const char *buf, const char *fmt, ...)
2293 va_list args;
2294 int i;
2296 va_start(args, fmt);
2297 i = vsscanf(buf, fmt, args);
2298 va_end(args);
2300 return i;
2302 EXPORT_SYMBOL(sscanf);