lib/vsprintf.c: Add %pMF to format FDDI bit reversed MAC addresses
[linux-2.6.git] / lib / vsprintf.c
1 /*
2  *  linux/lib/vsprintf.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  */
6
7 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
8 /*
9  * Wirzenius wrote this portably, Torvalds fucked it up :-)
10  */
11
12 /*
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
17  */
18
19 #include <stdarg.h>
20 #include <linux/module.h>
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/uaccess.h>
27 #include <linux/ioport.h>
28 #include <linux/bitrev.h>
29 #include <net/addrconf.h>
30
31 #include <asm/page.h>           /* for PAGE_SIZE */
32 #include <asm/div64.h>
33 #include <asm/sections.h>       /* for dereference_function_descriptor() */
34
35 /* Works only for digits and letters, but small and fast */
36 #define TOLOWER(x) ((x) | 0x20)
37
38 static unsigned int simple_guess_base(const char *cp)
39 {
40         if (cp[0] == '0') {
41                 if (TOLOWER(cp[1]) == 'x' && isxdigit(cp[2]))
42                         return 16;
43                 else
44                         return 8;
45         } else {
46                 return 10;
47         }
48 }
49
50 /**
51  * simple_strtoull - convert a string to an unsigned long long
52  * @cp: The start of the string
53  * @endp: A pointer to the end of the parsed string will be placed here
54  * @base: The number base to use
55  */
56 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
57 {
58         unsigned long long result = 0;
59
60         if (!base)
61                 base = simple_guess_base(cp);
62
63         if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
64                 cp += 2;
65
66         while (isxdigit(*cp)) {
67                 unsigned int value;
68
69                 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
70                 if (value >= base)
71                         break;
72                 result = result * base + value;
73                 cp++;
74         }
75         if (endp)
76                 *endp = (char *)cp;
77
78         return result;
79 }
80 EXPORT_SYMBOL(simple_strtoull);
81
82 /**
83  * simple_strtoul - convert a string to an unsigned long
84  * @cp: The start of the string
85  * @endp: A pointer to the end of the parsed string will be placed here
86  * @base: The number base to use
87  */
88 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
89 {
90         return simple_strtoull(cp, endp, base);
91 }
92 EXPORT_SYMBOL(simple_strtoul);
93
94 /**
95  * simple_strtol - convert a string to a signed long
96  * @cp: The start of the string
97  * @endp: A pointer to the end of the parsed string will be placed here
98  * @base: The number base to use
99  */
100 long simple_strtol(const char *cp, char **endp, unsigned int base)
101 {
102         if (*cp == '-')
103                 return -simple_strtoul(cp + 1, endp, base);
104
105         return simple_strtoul(cp, endp, base);
106 }
107 EXPORT_SYMBOL(simple_strtol);
108
109 /**
110  * simple_strtoll - convert a string to a signed long long
111  * @cp: The start of the string
112  * @endp: A pointer to the end of the parsed string will be placed here
113  * @base: The number base to use
114  */
115 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
116 {
117         if (*cp == '-')
118                 return -simple_strtoull(cp + 1, endp, base);
119
120         return simple_strtoull(cp, endp, base);
121 }
122
123 /**
124  * strict_strtoul - convert a string to an unsigned long strictly
125  * @cp: The string to be converted
126  * @base: The number base to use
127  * @res: The converted result value
128  *
129  * strict_strtoul converts a string to an unsigned long only if the
130  * string is really an unsigned long string, any string containing
131  * any invalid char at the tail will be rejected and -EINVAL is returned,
132  * only a newline char at the tail is acceptible because people generally
133  * change a module parameter in the following way:
134  *
135  *      echo 1024 > /sys/module/e1000/parameters/copybreak
136  *
137  * echo will append a newline to the tail.
138  *
139  * It returns 0 if conversion is successful and *res is set to the converted
140  * value, otherwise it returns -EINVAL and *res is set to 0.
141  *
142  * simple_strtoul just ignores the successive invalid characters and
143  * return the converted value of prefix part of the string.
144  */
145 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
146 {
147         char *tail;
148         unsigned long val;
149         size_t len;
150
151         *res = 0;
152         len = strlen(cp);
153         if (len == 0)
154                 return -EINVAL;
155
156         val = simple_strtoul(cp, &tail, base);
157         if (tail == cp)
158                 return -EINVAL;
159
160         if ((*tail == '\0') ||
161                 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
162                 *res = val;
163                 return 0;
164         }
165
166         return -EINVAL;
167 }
168 EXPORT_SYMBOL(strict_strtoul);
169
170 /**
171  * strict_strtol - convert a string to a long strictly
172  * @cp: The string to be converted
173  * @base: The number base to use
174  * @res: The converted result value
175  *
176  * strict_strtol is similiar to strict_strtoul, but it allows the first
177  * character of a string is '-'.
178  *
179  * It returns 0 if conversion is successful and *res is set to the converted
180  * value, otherwise it returns -EINVAL and *res is set to 0.
181  */
182 int strict_strtol(const char *cp, unsigned int base, long *res)
183 {
184         int ret;
185         if (*cp == '-') {
186                 ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
187                 if (!ret)
188                         *res = -(*res);
189         } else {
190                 ret = strict_strtoul(cp, base, (unsigned long *)res);
191         }
192
193         return ret;
194 }
195 EXPORT_SYMBOL(strict_strtol);
196
197 /**
198  * strict_strtoull - convert a string to an unsigned long long strictly
199  * @cp: The string to be converted
200  * @base: The number base to use
201  * @res: The converted result value
202  *
203  * strict_strtoull converts a string to an unsigned long long only if the
204  * string is really an unsigned long long string, any string containing
205  * any invalid char at the tail will be rejected and -EINVAL is returned,
206  * only a newline char at the tail is acceptible because people generally
207  * change a module parameter in the following way:
208  *
209  *      echo 1024 > /sys/module/e1000/parameters/copybreak
210  *
211  * echo will append a newline to the tail of the string.
212  *
213  * It returns 0 if conversion is successful and *res is set to the converted
214  * value, otherwise it returns -EINVAL and *res is set to 0.
215  *
216  * simple_strtoull just ignores the successive invalid characters and
217  * return the converted value of prefix part of the string.
218  */
219 int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
220 {
221         char *tail;
222         unsigned long long val;
223         size_t len;
224
225         *res = 0;
226         len = strlen(cp);
227         if (len == 0)
228                 return -EINVAL;
229
230         val = simple_strtoull(cp, &tail, base);
231         if (tail == cp)
232                 return -EINVAL;
233         if ((*tail == '\0') ||
234                 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
235                 *res = val;
236                 return 0;
237         }
238
239         return -EINVAL;
240 }
241 EXPORT_SYMBOL(strict_strtoull);
242
243 /**
244  * strict_strtoll - convert a string to a long long strictly
245  * @cp: The string to be converted
246  * @base: The number base to use
247  * @res: The converted result value
248  *
249  * strict_strtoll is similiar to strict_strtoull, but it allows the first
250  * character of a string is '-'.
251  *
252  * It returns 0 if conversion is successful and *res is set to the converted
253  * value, otherwise it returns -EINVAL and *res is set to 0.
254  */
255 int strict_strtoll(const char *cp, unsigned int base, long long *res)
256 {
257         int ret;
258         if (*cp == '-') {
259                 ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
260                 if (!ret)
261                         *res = -(*res);
262         } else {
263                 ret = strict_strtoull(cp, base, (unsigned long long *)res);
264         }
265
266         return ret;
267 }
268 EXPORT_SYMBOL(strict_strtoll);
269
270 static int skip_atoi(const char **s)
271 {
272         int i = 0;
273
274         while (isdigit(**s))
275                 i = i*10 + *((*s)++) - '0';
276
277         return i;
278 }
279
280 /* Decimal conversion is by far the most typical, and is used
281  * for /proc and /sys data. This directly impacts e.g. top performance
282  * with many processes running. We optimize it for speed
283  * using code from
284  * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
285  * (with permission from the author, Douglas W. Jones). */
286
287 /* Formats correctly any integer in [0,99999].
288  * Outputs from one to five digits depending on input.
289  * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
290 static char *put_dec_trunc(char *buf, unsigned q)
291 {
292         unsigned d3, d2, d1, d0;
293         d1 = (q>>4) & 0xf;
294         d2 = (q>>8) & 0xf;
295         d3 = (q>>12);
296
297         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
298         q = (d0 * 0xcd) >> 11;
299         d0 = d0 - 10*q;
300         *buf++ = d0 + '0'; /* least significant digit */
301         d1 = q + 9*d3 + 5*d2 + d1;
302         if (d1 != 0) {
303                 q = (d1 * 0xcd) >> 11;
304                 d1 = d1 - 10*q;
305                 *buf++ = d1 + '0'; /* next digit */
306
307                 d2 = q + 2*d2;
308                 if ((d2 != 0) || (d3 != 0)) {
309                         q = (d2 * 0xd) >> 7;
310                         d2 = d2 - 10*q;
311                         *buf++ = d2 + '0'; /* next digit */
312
313                         d3 = q + 4*d3;
314                         if (d3 != 0) {
315                                 q = (d3 * 0xcd) >> 11;
316                                 d3 = d3 - 10*q;
317                                 *buf++ = d3 + '0';  /* next digit */
318                                 if (q != 0)
319                                         *buf++ = q + '0'; /* most sign. digit */
320                         }
321                 }
322         }
323
324         return buf;
325 }
326 /* Same with if's removed. Always emits five digits */
327 static char *put_dec_full(char *buf, unsigned q)
328 {
329         /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
330         /* but anyway, gcc produces better code with full-sized ints */
331         unsigned d3, d2, d1, d0;
332         d1 = (q>>4) & 0xf;
333         d2 = (q>>8) & 0xf;
334         d3 = (q>>12);
335
336         /*
337          * Possible ways to approx. divide by 10
338          * gcc -O2 replaces multiply with shifts and adds
339          * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
340          * (x * 0x67) >> 10:  1100111
341          * (x * 0x34) >> 9:    110100 - same
342          * (x * 0x1a) >> 8:     11010 - same
343          * (x * 0x0d) >> 7:      1101 - same, shortest code (on i386)
344          */
345         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
346         q = (d0 * 0xcd) >> 11;
347         d0 = d0 - 10*q;
348         *buf++ = d0 + '0';
349         d1 = q + 9*d3 + 5*d2 + d1;
350                 q = (d1 * 0xcd) >> 11;
351                 d1 = d1 - 10*q;
352                 *buf++ = d1 + '0';
353
354                 d2 = q + 2*d2;
355                         q = (d2 * 0xd) >> 7;
356                         d2 = d2 - 10*q;
357                         *buf++ = d2 + '0';
358
359                         d3 = q + 4*d3;
360                                 q = (d3 * 0xcd) >> 11; /* - shorter code */
361                                 /* q = (d3 * 0x67) >> 10; - would also work */
362                                 d3 = d3 - 10*q;
363                                 *buf++ = d3 + '0';
364                                         *buf++ = q + '0';
365
366         return buf;
367 }
368 /* No inlining helps gcc to use registers better */
369 static noinline char *put_dec(char *buf, unsigned long long num)
370 {
371         while (1) {
372                 unsigned rem;
373                 if (num < 100000)
374                         return put_dec_trunc(buf, num);
375                 rem = do_div(num, 100000);
376                 buf = put_dec_full(buf, rem);
377         }
378 }
379
380 #define ZEROPAD 1               /* pad with zero */
381 #define SIGN    2               /* unsigned/signed long */
382 #define PLUS    4               /* show plus */
383 #define SPACE   8               /* space if plus */
384 #define LEFT    16              /* left justified */
385 #define SMALL   32              /* Must be 32 == 0x20 */
386 #define SPECIAL 64              /* 0x */
387
388 enum format_type {
389         FORMAT_TYPE_NONE, /* Just a string part */
390         FORMAT_TYPE_WIDTH,
391         FORMAT_TYPE_PRECISION,
392         FORMAT_TYPE_CHAR,
393         FORMAT_TYPE_STR,
394         FORMAT_TYPE_PTR,
395         FORMAT_TYPE_PERCENT_CHAR,
396         FORMAT_TYPE_INVALID,
397         FORMAT_TYPE_LONG_LONG,
398         FORMAT_TYPE_ULONG,
399         FORMAT_TYPE_LONG,
400         FORMAT_TYPE_UBYTE,
401         FORMAT_TYPE_BYTE,
402         FORMAT_TYPE_USHORT,
403         FORMAT_TYPE_SHORT,
404         FORMAT_TYPE_UINT,
405         FORMAT_TYPE_INT,
406         FORMAT_TYPE_NRCHARS,
407         FORMAT_TYPE_SIZE_T,
408         FORMAT_TYPE_PTRDIFF
409 };
410
411 struct printf_spec {
412         enum format_type        type;
413         int                     flags;          /* flags to number() */
414         int                     field_width;    /* width of output field */
415         int                     base;
416         int                     precision;      /* # of digits/chars */
417         int                     qualifier;
418 };
419
420 static char *number(char *buf, char *end, unsigned long long num,
421                         struct printf_spec spec)
422 {
423         /* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
424         static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
425
426         char tmp[66];
427         char sign;
428         char locase;
429         int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
430         int i;
431
432         /* locase = 0 or 0x20. ORing digits or letters with 'locase'
433          * produces same digits or (maybe lowercased) letters */
434         locase = (spec.flags & SMALL);
435         if (spec.flags & LEFT)
436                 spec.flags &= ~ZEROPAD;
437         sign = 0;
438         if (spec.flags & SIGN) {
439                 if ((signed long long)num < 0) {
440                         sign = '-';
441                         num = -(signed long long)num;
442                         spec.field_width--;
443                 } else if (spec.flags & PLUS) {
444                         sign = '+';
445                         spec.field_width--;
446                 } else if (spec.flags & SPACE) {
447                         sign = ' ';
448                         spec.field_width--;
449                 }
450         }
451         if (need_pfx) {
452                 spec.field_width--;
453                 if (spec.base == 16)
454                         spec.field_width--;
455         }
456
457         /* generate full string in tmp[], in reverse order */
458         i = 0;
459         if (num == 0)
460                 tmp[i++] = '0';
461         /* Generic code, for any base:
462         else do {
463                 tmp[i++] = (digits[do_div(num,base)] | locase);
464         } while (num != 0);
465         */
466         else if (spec.base != 10) { /* 8 or 16 */
467                 int mask = spec.base - 1;
468                 int shift = 3;
469
470                 if (spec.base == 16)
471                         shift = 4;
472                 do {
473                         tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
474                         num >>= shift;
475                 } while (num);
476         } else { /* base 10 */
477                 i = put_dec(tmp, num) - tmp;
478         }
479
480         /* printing 100 using %2d gives "100", not "00" */
481         if (i > spec.precision)
482                 spec.precision = i;
483         /* leading space padding */
484         spec.field_width -= spec.precision;
485         if (!(spec.flags & (ZEROPAD+LEFT))) {
486                 while (--spec.field_width >= 0) {
487                         if (buf < end)
488                                 *buf = ' ';
489                         ++buf;
490                 }
491         }
492         /* sign */
493         if (sign) {
494                 if (buf < end)
495                         *buf = sign;
496                 ++buf;
497         }
498         /* "0x" / "0" prefix */
499         if (need_pfx) {
500                 if (buf < end)
501                         *buf = '0';
502                 ++buf;
503                 if (spec.base == 16) {
504                         if (buf < end)
505                                 *buf = ('X' | locase);
506                         ++buf;
507                 }
508         }
509         /* zero or space padding */
510         if (!(spec.flags & LEFT)) {
511                 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
512                 while (--spec.field_width >= 0) {
513                         if (buf < end)
514                                 *buf = c;
515                         ++buf;
516                 }
517         }
518         /* hmm even more zero padding? */
519         while (i <= --spec.precision) {
520                 if (buf < end)
521                         *buf = '0';
522                 ++buf;
523         }
524         /* actual digits of result */
525         while (--i >= 0) {
526                 if (buf < end)
527                         *buf = tmp[i];
528                 ++buf;
529         }
530         /* trailing space padding */
531         while (--spec.field_width >= 0) {
532                 if (buf < end)
533                         *buf = ' ';
534                 ++buf;
535         }
536
537         return buf;
538 }
539
540 static char *string(char *buf, char *end, const char *s, struct printf_spec spec)
541 {
542         int len, i;
543
544         if ((unsigned long)s < PAGE_SIZE)
545                 s = "(null)";
546
547         len = strnlen(s, spec.precision);
548
549         if (!(spec.flags & LEFT)) {
550                 while (len < spec.field_width--) {
551                         if (buf < end)
552                                 *buf = ' ';
553                         ++buf;
554                 }
555         }
556         for (i = 0; i < len; ++i) {
557                 if (buf < end)
558                         *buf = *s;
559                 ++buf; ++s;
560         }
561         while (len < spec.field_width--) {
562                 if (buf < end)
563                         *buf = ' ';
564                 ++buf;
565         }
566
567         return buf;
568 }
569
570 static char *symbol_string(char *buf, char *end, void *ptr,
571                                 struct printf_spec spec, char ext)
572 {
573         unsigned long value = (unsigned long) ptr;
574 #ifdef CONFIG_KALLSYMS
575         char sym[KSYM_SYMBOL_LEN];
576         if (ext != 'f' && ext != 's')
577                 sprint_symbol(sym, value);
578         else
579                 kallsyms_lookup(value, NULL, NULL, NULL, sym);
580
581         return string(buf, end, sym, spec);
582 #else
583         spec.field_width = 2 * sizeof(void *);
584         spec.flags |= SPECIAL | SMALL | ZEROPAD;
585         spec.base = 16;
586
587         return number(buf, end, value, spec);
588 #endif
589 }
590
591 static char *resource_string(char *buf, char *end, struct resource *res,
592                                 struct printf_spec spec, const char *fmt)
593 {
594 #ifndef IO_RSRC_PRINTK_SIZE
595 #define IO_RSRC_PRINTK_SIZE     6
596 #endif
597
598 #ifndef MEM_RSRC_PRINTK_SIZE
599 #define MEM_RSRC_PRINTK_SIZE    10
600 #endif
601         struct printf_spec hex_spec = {
602                 .base = 16,
603                 .precision = -1,
604                 .flags = SPECIAL | SMALL | ZEROPAD,
605         };
606         struct printf_spec dec_spec = {
607                 .base = 10,
608                 .precision = -1,
609                 .flags = 0,
610         };
611         struct printf_spec str_spec = {
612                 .field_width = -1,
613                 .precision = 10,
614                 .flags = LEFT,
615         };
616         struct printf_spec flag_spec = {
617                 .base = 16,
618                 .precision = -1,
619                 .flags = SPECIAL | SMALL,
620         };
621
622         /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
623          * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
624 #define RSRC_BUF_SIZE           ((2 * sizeof(resource_size_t)) + 4)
625 #define FLAG_BUF_SIZE           (2 * sizeof(res->flags))
626 #define DECODED_BUF_SIZE        sizeof("[mem - 64bit pref disabled]")
627 #define RAW_BUF_SIZE            sizeof("[mem - flags 0x]")
628         char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
629                      2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
630
631         char *p = sym, *pend = sym + sizeof(sym);
632         int size = -1, addr = 0;
633         int decode = (fmt[0] == 'R') ? 1 : 0;
634
635         if (res->flags & IORESOURCE_IO) {
636                 size = IO_RSRC_PRINTK_SIZE;
637                 addr = 1;
638         } else if (res->flags & IORESOURCE_MEM) {
639                 size = MEM_RSRC_PRINTK_SIZE;
640                 addr = 1;
641         }
642
643         *p++ = '[';
644         if (res->flags & IORESOURCE_IO)
645                 p = string(p, pend, "io  ", str_spec);
646         else if (res->flags & IORESOURCE_MEM)
647                 p = string(p, pend, "mem ", str_spec);
648         else if (res->flags & IORESOURCE_IRQ)
649                 p = string(p, pend, "irq ", str_spec);
650         else if (res->flags & IORESOURCE_DMA)
651                 p = string(p, pend, "dma ", str_spec);
652         else {
653                 p = string(p, pend, "??? ", str_spec);
654                 decode = 0;
655         }
656         hex_spec.field_width = size;
657         p = number(p, pend, res->start, addr ? hex_spec : dec_spec);
658         if (res->start != res->end) {
659                 *p++ = '-';
660                 p = number(p, pend, res->end, addr ? hex_spec : dec_spec);
661         }
662         if (decode) {
663                 if (res->flags & IORESOURCE_MEM_64)
664                         p = string(p, pend, " 64bit", str_spec);
665                 if (res->flags & IORESOURCE_PREFETCH)
666                         p = string(p, pend, " pref", str_spec);
667                 if (res->flags & IORESOURCE_DISABLED)
668                         p = string(p, pend, " disabled", str_spec);
669         } else {
670                 p = string(p, pend, " flags ", str_spec);
671                 p = number(p, pend, res->flags, flag_spec);
672         }
673         *p++ = ']';
674         *p = '\0';
675
676         return string(buf, end, sym, spec);
677 }
678
679 static char *mac_address_string(char *buf, char *end, u8 *addr,
680                                 struct printf_spec spec, const char *fmt)
681 {
682         char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
683         char *p = mac_addr;
684         int i;
685         bool bitrev;
686         char separator;
687
688         if (fmt[1] == 'F') {            /* FDDI canonical format */
689                 bitrev = true;
690                 separator = '-';
691         } else {
692                 bitrev = false;
693                 separator = ':';
694         }
695
696         for (i = 0; i < 6; i++) {
697                 p = pack_hex_byte(p, bitrev ? bitrev8(addr[i]) : addr[i]);
698                 if (fmt[0] == 'M' && i != 5)
699                         *p++ = separator;
700         }
701         *p = '\0';
702
703         return string(buf, end, mac_addr, spec);
704 }
705
706 static char *ip4_string(char *p, const u8 *addr, bool leading_zeros)
707 {
708         int i;
709
710         for (i = 0; i < 4; i++) {
711                 char temp[3];   /* hold each IP quad in reverse order */
712                 int digits = put_dec_trunc(temp, addr[i]) - temp;
713                 if (leading_zeros) {
714                         if (digits < 3)
715                                 *p++ = '0';
716                         if (digits < 2)
717                                 *p++ = '0';
718                 }
719                 /* reverse the digits in the quad */
720                 while (digits--)
721                         *p++ = temp[digits];
722                 if (i < 3)
723                         *p++ = '.';
724         }
725         *p = '\0';
726
727         return p;
728 }
729
730 static char *ip6_compressed_string(char *p, const char *addr)
731 {
732         int i, j, range;
733         unsigned char zerolength[8];
734         int longest = 1;
735         int colonpos = -1;
736         u16 word;
737         u8 hi, lo;
738         bool needcolon = false;
739         bool useIPv4;
740         struct in6_addr in6;
741
742         memcpy(&in6, addr, sizeof(struct in6_addr));
743
744         useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
745
746         memset(zerolength, 0, sizeof(zerolength));
747
748         if (useIPv4)
749                 range = 6;
750         else
751                 range = 8;
752
753         /* find position of longest 0 run */
754         for (i = 0; i < range; i++) {
755                 for (j = i; j < range; j++) {
756                         if (in6.s6_addr16[j] != 0)
757                                 break;
758                         zerolength[i]++;
759                 }
760         }
761         for (i = 0; i < range; i++) {
762                 if (zerolength[i] > longest) {
763                         longest = zerolength[i];
764                         colonpos = i;
765                 }
766         }
767
768         /* emit address */
769         for (i = 0; i < range; i++) {
770                 if (i == colonpos) {
771                         if (needcolon || i == 0)
772                                 *p++ = ':';
773                         *p++ = ':';
774                         needcolon = false;
775                         i += longest - 1;
776                         continue;
777                 }
778                 if (needcolon) {
779                         *p++ = ':';
780                         needcolon = false;
781                 }
782                 /* hex u16 without leading 0s */
783                 word = ntohs(in6.s6_addr16[i]);
784                 hi = word >> 8;
785                 lo = word & 0xff;
786                 if (hi) {
787                         if (hi > 0x0f)
788                                 p = pack_hex_byte(p, hi);
789                         else
790                                 *p++ = hex_asc_lo(hi);
791                         p = pack_hex_byte(p, lo);
792                 }
793                 else if (lo > 0x0f)
794                         p = pack_hex_byte(p, lo);
795                 else
796                         *p++ = hex_asc_lo(lo);
797                 needcolon = true;
798         }
799
800         if (useIPv4) {
801                 if (needcolon)
802                         *p++ = ':';
803                 p = ip4_string(p, &in6.s6_addr[12], false);
804         }
805         *p = '\0';
806
807         return p;
808 }
809
810 static char *ip6_string(char *p, const char *addr, const char *fmt)
811 {
812         int i;
813
814         for (i = 0; i < 8; i++) {
815                 p = pack_hex_byte(p, *addr++);
816                 p = pack_hex_byte(p, *addr++);
817                 if (fmt[0] == 'I' && i != 7)
818                         *p++ = ':';
819         }
820         *p = '\0';
821
822         return p;
823 }
824
825 static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
826                              struct printf_spec spec, const char *fmt)
827 {
828         char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
829
830         if (fmt[0] == 'I' && fmt[2] == 'c')
831                 ip6_compressed_string(ip6_addr, addr);
832         else
833                 ip6_string(ip6_addr, addr, fmt);
834
835         return string(buf, end, ip6_addr, spec);
836 }
837
838 static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
839                              struct printf_spec spec, const char *fmt)
840 {
841         char ip4_addr[sizeof("255.255.255.255")];
842
843         ip4_string(ip4_addr, addr, fmt[0] == 'i');
844
845         return string(buf, end, ip4_addr, spec);
846 }
847
848 static char *uuid_string(char *buf, char *end, const u8 *addr,
849                          struct printf_spec spec, const char *fmt)
850 {
851         char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
852         char *p = uuid;
853         int i;
854         static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
855         static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
856         const u8 *index = be;
857         bool uc = false;
858
859         switch (*(++fmt)) {
860         case 'L':
861                 uc = true;              /* fall-through */
862         case 'l':
863                 index = le;
864                 break;
865         case 'B':
866                 uc = true;
867                 break;
868         }
869
870         for (i = 0; i < 16; i++) {
871                 p = pack_hex_byte(p, addr[index[i]]);
872                 switch (i) {
873                 case 3:
874                 case 5:
875                 case 7:
876                 case 9:
877                         *p++ = '-';
878                         break;
879                 }
880         }
881
882         *p = 0;
883
884         if (uc) {
885                 p = uuid;
886                 do {
887                         *p = toupper(*p);
888                 } while (*(++p));
889         }
890
891         return string(buf, end, uuid, spec);
892 }
893
894 /*
895  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
896  * by an extra set of alphanumeric characters that are extended format
897  * specifiers.
898  *
899  * Right now we handle:
900  *
901  * - 'F' For symbolic function descriptor pointers with offset
902  * - 'f' For simple symbolic function names without offset
903  * - 'S' For symbolic direct pointers with offset
904  * - 's' For symbolic direct pointers without offset
905  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
906  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
907  * - 'M' For a 6-byte MAC address, it prints the address in the
908  *       usual colon-separated hex notation
909  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
910  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
911  *       with a dash-separated hex notation with bit reversed bytes
912  * - 'mF' For a 6-byte MAC FDDI address, it prints the address
913  *       in hex notation without separators with bit reversed bytes
914  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
915  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
916  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
917  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
918  *       IPv6 omits the colons (01020304...0f)
919  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
920  * - 'I6c' for IPv6 addresses printed as specified by
921  *       http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
922  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
923  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
924  *       Options for %pU are:
925  *         b big endian lower case hex (default)
926  *         B big endian UPPER case hex
927  *         l little endian lower case hex
928  *         L little endian UPPER case hex
929  *           big endian output byte order is:
930  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
931  *           little endian output byte order is:
932  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
933  *
934  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
935  * function pointers are really function descriptors, which contain a
936  * pointer to the real address.
937  */
938 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
939                         struct printf_spec spec)
940 {
941         if (!ptr)
942                 return string(buf, end, "(null)", spec);
943
944         switch (*fmt) {
945         case 'F':
946         case 'f':
947                 ptr = dereference_function_descriptor(ptr);
948                 /* Fallthrough */
949         case 'S':
950         case 's':
951                 return symbol_string(buf, end, ptr, spec, *fmt);
952         case 'R':
953         case 'r':
954                 return resource_string(buf, end, ptr, spec, fmt);
955         case 'M':                       /* Colon separated: 00:01:02:03:04:05 */
956         case 'm':                       /* Contiguous: 000102030405 */
957                                         /* [mM]F (FDDI, bit reversed) */
958                 return mac_address_string(buf, end, ptr, spec, fmt);
959         case 'I':                       /* Formatted IP supported
960                                          * 4:   1.2.3.4
961                                          * 6:   0001:0203:...:0708
962                                          * 6c:  1::708 or 1::1.2.3.4
963                                          */
964         case 'i':                       /* Contiguous:
965                                          * 4:   001.002.003.004
966                                          * 6:   000102...0f
967                                          */
968                 switch (fmt[1]) {
969                 case '6':
970                         return ip6_addr_string(buf, end, ptr, spec, fmt);
971                 case '4':
972                         return ip4_addr_string(buf, end, ptr, spec, fmt);
973                 }
974                 break;
975         case 'U':
976                 return uuid_string(buf, end, ptr, spec, fmt);
977         }
978         spec.flags |= SMALL;
979         if (spec.field_width == -1) {
980                 spec.field_width = 2*sizeof(void *);
981                 spec.flags |= ZEROPAD;
982         }
983         spec.base = 16;
984
985         return number(buf, end, (unsigned long) ptr, spec);
986 }
987
988 /*
989  * Helper function to decode printf style format.
990  * Each call decode a token from the format and return the
991  * number of characters read (or likely the delta where it wants
992  * to go on the next call).
993  * The decoded token is returned through the parameters
994  *
995  * 'h', 'l', or 'L' for integer fields
996  * 'z' support added 23/7/1999 S.H.
997  * 'z' changed to 'Z' --davidm 1/25/99
998  * 't' added for ptrdiff_t
999  *
1000  * @fmt: the format string
1001  * @type of the token returned
1002  * @flags: various flags such as +, -, # tokens..
1003  * @field_width: overwritten width
1004  * @base: base of the number (octal, hex, ...)
1005  * @precision: precision of a number
1006  * @qualifier: qualifier of a number (long, size_t, ...)
1007  */
1008 static int format_decode(const char *fmt, struct printf_spec *spec)
1009 {
1010         const char *start = fmt;
1011
1012         /* we finished early by reading the field width */
1013         if (spec->type == FORMAT_TYPE_WIDTH) {
1014                 if (spec->field_width < 0) {
1015                         spec->field_width = -spec->field_width;
1016                         spec->flags |= LEFT;
1017                 }
1018                 spec->type = FORMAT_TYPE_NONE;
1019                 goto precision;
1020         }
1021
1022         /* we finished early by reading the precision */
1023         if (spec->type == FORMAT_TYPE_PRECISION) {
1024                 if (spec->precision < 0)
1025                         spec->precision = 0;
1026
1027                 spec->type = FORMAT_TYPE_NONE;
1028                 goto qualifier;
1029         }
1030
1031         /* By default */
1032         spec->type = FORMAT_TYPE_NONE;
1033
1034         for (; *fmt ; ++fmt) {
1035                 if (*fmt == '%')
1036                         break;
1037         }
1038
1039         /* Return the current non-format string */
1040         if (fmt != start || !*fmt)
1041                 return fmt - start;
1042
1043         /* Process flags */
1044         spec->flags = 0;
1045
1046         while (1) { /* this also skips first '%' */
1047                 bool found = true;
1048
1049                 ++fmt;
1050
1051                 switch (*fmt) {
1052                 case '-': spec->flags |= LEFT;    break;
1053                 case '+': spec->flags |= PLUS;    break;
1054                 case ' ': spec->flags |= SPACE;   break;
1055                 case '#': spec->flags |= SPECIAL; break;
1056                 case '0': spec->flags |= ZEROPAD; break;
1057                 default:  found = false;
1058                 }
1059
1060                 if (!found)
1061                         break;
1062         }
1063
1064         /* get field width */
1065         spec->field_width = -1;
1066
1067         if (isdigit(*fmt))
1068                 spec->field_width = skip_atoi(&fmt);
1069         else if (*fmt == '*') {
1070                 /* it's the next argument */
1071                 spec->type = FORMAT_TYPE_WIDTH;
1072                 return ++fmt - start;
1073         }
1074
1075 precision:
1076         /* get the precision */
1077         spec->precision = -1;
1078         if (*fmt == '.') {
1079                 ++fmt;
1080                 if (isdigit(*fmt)) {
1081                         spec->precision = skip_atoi(&fmt);
1082                         if (spec->precision < 0)
1083                                 spec->precision = 0;
1084                 } else if (*fmt == '*') {
1085                         /* it's the next argument */
1086                         spec->type = FORMAT_TYPE_PRECISION;
1087                         return ++fmt - start;
1088                 }
1089         }
1090
1091 qualifier:
1092         /* get the conversion qualifier */
1093         spec->qualifier = -1;
1094         if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1095             TOLOWER(*fmt) == 'z' || *fmt == 't') {
1096                 spec->qualifier = *fmt++;
1097                 if (unlikely(spec->qualifier == *fmt)) {
1098                         if (spec->qualifier == 'l') {
1099                                 spec->qualifier = 'L';
1100                                 ++fmt;
1101                         } else if (spec->qualifier == 'h') {
1102                                 spec->qualifier = 'H';
1103                                 ++fmt;
1104                         }
1105                 }
1106         }
1107
1108         /* default base */
1109         spec->base = 10;
1110         switch (*fmt) {
1111         case 'c':
1112                 spec->type = FORMAT_TYPE_CHAR;
1113                 return ++fmt - start;
1114
1115         case 's':
1116                 spec->type = FORMAT_TYPE_STR;
1117                 return ++fmt - start;
1118
1119         case 'p':
1120                 spec->type = FORMAT_TYPE_PTR;
1121                 return fmt - start;
1122                 /* skip alnum */
1123
1124         case 'n':
1125                 spec->type = FORMAT_TYPE_NRCHARS;
1126                 return ++fmt - start;
1127
1128         case '%':
1129                 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1130                 return ++fmt - start;
1131
1132         /* integer number formats - set up the flags and "break" */
1133         case 'o':
1134                 spec->base = 8;
1135                 break;
1136
1137         case 'x':
1138                 spec->flags |= SMALL;
1139
1140         case 'X':
1141                 spec->base = 16;
1142                 break;
1143
1144         case 'd':
1145         case 'i':
1146                 spec->flags |= SIGN;
1147         case 'u':
1148                 break;
1149
1150         default:
1151                 spec->type = FORMAT_TYPE_INVALID;
1152                 return fmt - start;
1153         }
1154
1155         if (spec->qualifier == 'L')
1156                 spec->type = FORMAT_TYPE_LONG_LONG;
1157         else if (spec->qualifier == 'l') {
1158                 if (spec->flags & SIGN)
1159                         spec->type = FORMAT_TYPE_LONG;
1160                 else
1161                         spec->type = FORMAT_TYPE_ULONG;
1162         } else if (TOLOWER(spec->qualifier) == 'z') {
1163                 spec->type = FORMAT_TYPE_SIZE_T;
1164         } else if (spec->qualifier == 't') {
1165                 spec->type = FORMAT_TYPE_PTRDIFF;
1166         } else if (spec->qualifier == 'H') {
1167                 if (spec->flags & SIGN)
1168                         spec->type = FORMAT_TYPE_BYTE;
1169                 else
1170                         spec->type = FORMAT_TYPE_UBYTE;
1171         } else if (spec->qualifier == 'h') {
1172                 if (spec->flags & SIGN)
1173                         spec->type = FORMAT_TYPE_SHORT;
1174                 else
1175                         spec->type = FORMAT_TYPE_USHORT;
1176         } else {
1177                 if (spec->flags & SIGN)
1178                         spec->type = FORMAT_TYPE_INT;
1179                 else
1180                         spec->type = FORMAT_TYPE_UINT;
1181         }
1182
1183         return ++fmt - start;
1184 }
1185
1186 /**
1187  * vsnprintf - Format a string and place it in a buffer
1188  * @buf: The buffer to place the result into
1189  * @size: The size of the buffer, including the trailing null space
1190  * @fmt: The format string to use
1191  * @args: Arguments for the format string
1192  *
1193  * This function follows C99 vsnprintf, but has some extensions:
1194  * %pS output the name of a text symbol with offset
1195  * %ps output the name of a text symbol without offset
1196  * %pF output the name of a function pointer with its offset
1197  * %pf output the name of a function pointer without its offset
1198  * %pR output the address range in a struct resource with decoded flags
1199  * %pr output the address range in a struct resource with raw flags
1200  * %pM output a 6-byte MAC address with colons
1201  * %pm output a 6-byte MAC address without colons
1202  * %pI4 print an IPv4 address without leading zeros
1203  * %pi4 print an IPv4 address with leading zeros
1204  * %pI6 print an IPv6 address with colons
1205  * %pi6 print an IPv6 address without colons
1206  * %pI6c print an IPv6 address as specified by
1207  *   http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
1208  * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1209  *   case.
1210  * %n is ignored
1211  *
1212  * The return value is the number of characters which would
1213  * be generated for the given input, excluding the trailing
1214  * '\0', as per ISO C99. If you want to have the exact
1215  * number of characters written into @buf as return value
1216  * (not including the trailing '\0'), use vscnprintf(). If the
1217  * return is greater than or equal to @size, the resulting
1218  * string is truncated.
1219  *
1220  * Call this function if you are already dealing with a va_list.
1221  * You probably want snprintf() instead.
1222  */
1223 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1224 {
1225         unsigned long long num;
1226         char *str, *end;
1227         struct printf_spec spec = {0};
1228
1229         /* Reject out-of-range values early.  Large positive sizes are
1230            used for unknown buffer sizes. */
1231         if (WARN_ON_ONCE((int) size < 0))
1232                 return 0;
1233
1234         str = buf;
1235         end = buf + size;
1236
1237         /* Make sure end is always >= buf */
1238         if (end < buf) {
1239                 end = ((void *)-1);
1240                 size = end - buf;
1241         }
1242
1243         while (*fmt) {
1244                 const char *old_fmt = fmt;
1245                 int read = format_decode(fmt, &spec);
1246
1247                 fmt += read;
1248
1249                 switch (spec.type) {
1250                 case FORMAT_TYPE_NONE: {
1251                         int copy = read;
1252                         if (str < end) {
1253                                 if (copy > end - str)
1254                                         copy = end - str;
1255                                 memcpy(str, old_fmt, copy);
1256                         }
1257                         str += read;
1258                         break;
1259                 }
1260
1261                 case FORMAT_TYPE_WIDTH:
1262                         spec.field_width = va_arg(args, int);
1263                         break;
1264
1265                 case FORMAT_TYPE_PRECISION:
1266                         spec.precision = va_arg(args, int);
1267                         break;
1268
1269                 case FORMAT_TYPE_CHAR: {
1270                         char c;
1271
1272                         if (!(spec.flags & LEFT)) {
1273                                 while (--spec.field_width > 0) {
1274                                         if (str < end)
1275                                                 *str = ' ';
1276                                         ++str;
1277
1278                                 }
1279                         }
1280                         c = (unsigned char) va_arg(args, int);
1281                         if (str < end)
1282                                 *str = c;
1283                         ++str;
1284                         while (--spec.field_width > 0) {
1285                                 if (str < end)
1286                                         *str = ' ';
1287                                 ++str;
1288                         }
1289                         break;
1290                 }
1291
1292                 case FORMAT_TYPE_STR:
1293                         str = string(str, end, va_arg(args, char *), spec);
1294                         break;
1295
1296                 case FORMAT_TYPE_PTR:
1297                         str = pointer(fmt+1, str, end, va_arg(args, void *),
1298                                       spec);
1299                         while (isalnum(*fmt))
1300                                 fmt++;
1301                         break;
1302
1303                 case FORMAT_TYPE_PERCENT_CHAR:
1304                         if (str < end)
1305                                 *str = '%';
1306                         ++str;
1307                         break;
1308
1309                 case FORMAT_TYPE_INVALID:
1310                         if (str < end)
1311                                 *str = '%';
1312                         ++str;
1313                         break;
1314
1315                 case FORMAT_TYPE_NRCHARS: {
1316                         int qualifier = spec.qualifier;
1317
1318                         if (qualifier == 'l') {
1319                                 long *ip = va_arg(args, long *);
1320                                 *ip = (str - buf);
1321                         } else if (TOLOWER(qualifier) == 'z') {
1322                                 size_t *ip = va_arg(args, size_t *);
1323                                 *ip = (str - buf);
1324                         } else {
1325                                 int *ip = va_arg(args, int *);
1326                                 *ip = (str - buf);
1327                         }
1328                         break;
1329                 }
1330
1331                 default:
1332                         switch (spec.type) {
1333                         case FORMAT_TYPE_LONG_LONG:
1334                                 num = va_arg(args, long long);
1335                                 break;
1336                         case FORMAT_TYPE_ULONG:
1337                                 num = va_arg(args, unsigned long);
1338                                 break;
1339                         case FORMAT_TYPE_LONG:
1340                                 num = va_arg(args, long);
1341                                 break;
1342                         case FORMAT_TYPE_SIZE_T:
1343                                 num = va_arg(args, size_t);
1344                                 break;
1345                         case FORMAT_TYPE_PTRDIFF:
1346                                 num = va_arg(args, ptrdiff_t);
1347                                 break;
1348                         case FORMAT_TYPE_UBYTE:
1349                                 num = (unsigned char) va_arg(args, int);
1350                                 break;
1351                         case FORMAT_TYPE_BYTE:
1352                                 num = (signed char) va_arg(args, int);
1353                                 break;
1354                         case FORMAT_TYPE_USHORT:
1355                                 num = (unsigned short) va_arg(args, int);
1356                                 break;
1357                         case FORMAT_TYPE_SHORT:
1358                                 num = (short) va_arg(args, int);
1359                                 break;
1360                         case FORMAT_TYPE_INT:
1361                                 num = (int) va_arg(args, int);
1362                                 break;
1363                         default:
1364                                 num = va_arg(args, unsigned int);
1365                         }
1366
1367                         str = number(str, end, num, spec);
1368                 }
1369         }
1370
1371         if (size > 0) {
1372                 if (str < end)
1373                         *str = '\0';
1374                 else
1375                         end[-1] = '\0';
1376         }
1377
1378         /* the trailing null byte doesn't count towards the total */
1379         return str-buf;
1380
1381 }
1382 EXPORT_SYMBOL(vsnprintf);
1383
1384 /**
1385  * vscnprintf - Format a string and place it in a buffer
1386  * @buf: The buffer to place the result into
1387  * @size: The size of the buffer, including the trailing null space
1388  * @fmt: The format string to use
1389  * @args: Arguments for the format string
1390  *
1391  * The return value is the number of characters which have been written into
1392  * the @buf not including the trailing '\0'. If @size is <= 0 the function
1393  * returns 0.
1394  *
1395  * Call this function if you are already dealing with a va_list.
1396  * You probably want scnprintf() instead.
1397  *
1398  * See the vsnprintf() documentation for format string extensions over C99.
1399  */
1400 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1401 {
1402         int i;
1403
1404         i = vsnprintf(buf, size, fmt, args);
1405
1406         return (i >= size) ? (size - 1) : i;
1407 }
1408 EXPORT_SYMBOL(vscnprintf);
1409
1410 /**
1411  * snprintf - Format a string and place it in a buffer
1412  * @buf: The buffer to place the result into
1413  * @size: The size of the buffer, including the trailing null space
1414  * @fmt: The format string to use
1415  * @...: Arguments for the format string
1416  *
1417  * The return value is the number of characters which would be
1418  * generated for the given input, excluding the trailing null,
1419  * as per ISO C99.  If the return is greater than or equal to
1420  * @size, the resulting string is truncated.
1421  *
1422  * See the vsnprintf() documentation for format string extensions over C99.
1423  */
1424 int snprintf(char *buf, size_t size, const char *fmt, ...)
1425 {
1426         va_list args;
1427         int i;
1428
1429         va_start(args, fmt);
1430         i = vsnprintf(buf, size, fmt, args);
1431         va_end(args);
1432
1433         return i;
1434 }
1435 EXPORT_SYMBOL(snprintf);
1436
1437 /**
1438  * scnprintf - Format a string and place it in a buffer
1439  * @buf: The buffer to place the result into
1440  * @size: The size of the buffer, including the trailing null space
1441  * @fmt: The format string to use
1442  * @...: Arguments for the format string
1443  *
1444  * The return value is the number of characters written into @buf not including
1445  * the trailing '\0'. If @size is <= 0 the function returns 0.
1446  */
1447
1448 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1449 {
1450         va_list args;
1451         int i;
1452
1453         va_start(args, fmt);
1454         i = vsnprintf(buf, size, fmt, args);
1455         va_end(args);
1456
1457         return (i >= size) ? (size - 1) : i;
1458 }
1459 EXPORT_SYMBOL(scnprintf);
1460
1461 /**
1462  * vsprintf - Format a string and place it in a buffer
1463  * @buf: The buffer to place the result into
1464  * @fmt: The format string to use
1465  * @args: Arguments for the format string
1466  *
1467  * The function returns the number of characters written
1468  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1469  * buffer overflows.
1470  *
1471  * Call this function if you are already dealing with a va_list.
1472  * You probably want sprintf() instead.
1473  *
1474  * See the vsnprintf() documentation for format string extensions over C99.
1475  */
1476 int vsprintf(char *buf, const char *fmt, va_list args)
1477 {
1478         return vsnprintf(buf, INT_MAX, fmt, args);
1479 }
1480 EXPORT_SYMBOL(vsprintf);
1481
1482 /**
1483  * sprintf - Format a string and place it in a buffer
1484  * @buf: The buffer to place the result into
1485  * @fmt: The format string to use
1486  * @...: Arguments for the format string
1487  *
1488  * The function returns the number of characters written
1489  * into @buf. Use snprintf() or scnprintf() in order to avoid
1490  * buffer overflows.
1491  *
1492  * See the vsnprintf() documentation for format string extensions over C99.
1493  */
1494 int sprintf(char *buf, const char *fmt, ...)
1495 {
1496         va_list args;
1497         int i;
1498
1499         va_start(args, fmt);
1500         i = vsnprintf(buf, INT_MAX, fmt, args);
1501         va_end(args);
1502
1503         return i;
1504 }
1505 EXPORT_SYMBOL(sprintf);
1506
1507 #ifdef CONFIG_BINARY_PRINTF
1508 /*
1509  * bprintf service:
1510  * vbin_printf() - VA arguments to binary data
1511  * bstr_printf() - Binary data to text string
1512  */
1513
1514 /**
1515  * vbin_printf - Parse a format string and place args' binary value in a buffer
1516  * @bin_buf: The buffer to place args' binary value
1517  * @size: The size of the buffer(by words(32bits), not characters)
1518  * @fmt: The format string to use
1519  * @args: Arguments for the format string
1520  *
1521  * The format follows C99 vsnprintf, except %n is ignored, and its argument
1522  * is skiped.
1523  *
1524  * The return value is the number of words(32bits) which would be generated for
1525  * the given input.
1526  *
1527  * NOTE:
1528  * If the return value is greater than @size, the resulting bin_buf is NOT
1529  * valid for bstr_printf().
1530  */
1531 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1532 {
1533         struct printf_spec spec = {0};
1534         char *str, *end;
1535
1536         str = (char *)bin_buf;
1537         end = (char *)(bin_buf + size);
1538
1539 #define save_arg(type)                                                  \
1540 do {                                                                    \
1541         if (sizeof(type) == 8) {                                        \
1542                 unsigned long long value;                               \
1543                 str = PTR_ALIGN(str, sizeof(u32));                      \
1544                 value = va_arg(args, unsigned long long);               \
1545                 if (str + sizeof(type) <= end) {                        \
1546                         *(u32 *)str = *(u32 *)&value;                   \
1547                         *(u32 *)(str + 4) = *((u32 *)&value + 1);       \
1548                 }                                                       \
1549         } else {                                                        \
1550                 unsigned long value;                                    \
1551                 str = PTR_ALIGN(str, sizeof(type));                     \
1552                 value = va_arg(args, int);                              \
1553                 if (str + sizeof(type) <= end)                          \
1554                         *(typeof(type) *)str = (type)value;             \
1555         }                                                               \
1556         str += sizeof(type);                                            \
1557 } while (0)
1558
1559         while (*fmt) {
1560                 int read = format_decode(fmt, &spec);
1561
1562                 fmt += read;
1563
1564                 switch (spec.type) {
1565                 case FORMAT_TYPE_NONE:
1566                 case FORMAT_TYPE_INVALID:
1567                 case FORMAT_TYPE_PERCENT_CHAR:
1568                         break;
1569
1570                 case FORMAT_TYPE_WIDTH:
1571                 case FORMAT_TYPE_PRECISION:
1572                         save_arg(int);
1573                         break;
1574
1575                 case FORMAT_TYPE_CHAR:
1576                         save_arg(char);
1577                         break;
1578
1579                 case FORMAT_TYPE_STR: {
1580                         const char *save_str = va_arg(args, char *);
1581                         size_t len;
1582
1583                         if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1584                                         || (unsigned long)save_str < PAGE_SIZE)
1585                                 save_str = "(null)";
1586                         len = strlen(save_str) + 1;
1587                         if (str + len < end)
1588                                 memcpy(str, save_str, len);
1589                         str += len;
1590                         break;
1591                 }
1592
1593                 case FORMAT_TYPE_PTR:
1594                         save_arg(void *);
1595                         /* skip all alphanumeric pointer suffixes */
1596                         while (isalnum(*fmt))
1597                                 fmt++;
1598                         break;
1599
1600                 case FORMAT_TYPE_NRCHARS: {
1601                         /* skip %n 's argument */
1602                         int qualifier = spec.qualifier;
1603                         void *skip_arg;
1604                         if (qualifier == 'l')
1605                                 skip_arg = va_arg(args, long *);
1606                         else if (TOLOWER(qualifier) == 'z')
1607                                 skip_arg = va_arg(args, size_t *);
1608                         else
1609                                 skip_arg = va_arg(args, int *);
1610                         break;
1611                 }
1612
1613                 default:
1614                         switch (spec.type) {
1615
1616                         case FORMAT_TYPE_LONG_LONG:
1617                                 save_arg(long long);
1618                                 break;
1619                         case FORMAT_TYPE_ULONG:
1620                         case FORMAT_TYPE_LONG:
1621                                 save_arg(unsigned long);
1622                                 break;
1623                         case FORMAT_TYPE_SIZE_T:
1624                                 save_arg(size_t);
1625                                 break;
1626                         case FORMAT_TYPE_PTRDIFF:
1627                                 save_arg(ptrdiff_t);
1628                                 break;
1629                         case FORMAT_TYPE_UBYTE:
1630                         case FORMAT_TYPE_BYTE:
1631                                 save_arg(char);
1632                                 break;
1633                         case FORMAT_TYPE_USHORT:
1634                         case FORMAT_TYPE_SHORT:
1635                                 save_arg(short);
1636                                 break;
1637                         default:
1638                                 save_arg(int);
1639                         }
1640                 }
1641         }
1642
1643         return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1644 #undef save_arg
1645 }
1646 EXPORT_SYMBOL_GPL(vbin_printf);
1647
1648 /**
1649  * bstr_printf - Format a string from binary arguments and place it in a buffer
1650  * @buf: The buffer to place the result into
1651  * @size: The size of the buffer, including the trailing null space
1652  * @fmt: The format string to use
1653  * @bin_buf: Binary arguments for the format string
1654  *
1655  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1656  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1657  * a binary buffer that generated by vbin_printf.
1658  *
1659  * The format follows C99 vsnprintf, but has some extensions:
1660  *  see vsnprintf comment for details.
1661  *
1662  * The return value is the number of characters which would
1663  * be generated for the given input, excluding the trailing
1664  * '\0', as per ISO C99. If you want to have the exact
1665  * number of characters written into @buf as return value
1666  * (not including the trailing '\0'), use vscnprintf(). If the
1667  * return is greater than or equal to @size, the resulting
1668  * string is truncated.
1669  */
1670 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1671 {
1672         struct printf_spec spec = {0};
1673         char *str, *end;
1674         const char *args = (const char *)bin_buf;
1675
1676         if (WARN_ON_ONCE((int) size < 0))
1677                 return 0;
1678
1679         str = buf;
1680         end = buf + size;
1681
1682 #define get_arg(type)                                                   \
1683 ({                                                                      \
1684         typeof(type) value;                                             \
1685         if (sizeof(type) == 8) {                                        \
1686                 args = PTR_ALIGN(args, sizeof(u32));                    \
1687                 *(u32 *)&value = *(u32 *)args;                          \
1688                 *((u32 *)&value + 1) = *(u32 *)(args + 4);              \
1689         } else {                                                        \
1690                 args = PTR_ALIGN(args, sizeof(type));                   \
1691                 value = *(typeof(type) *)args;                          \
1692         }                                                               \
1693         args += sizeof(type);                                           \
1694         value;                                                          \
1695 })
1696
1697         /* Make sure end is always >= buf */
1698         if (end < buf) {
1699                 end = ((void *)-1);
1700                 size = end - buf;
1701         }
1702
1703         while (*fmt) {
1704                 const char *old_fmt = fmt;
1705                 int read = format_decode(fmt, &spec);
1706
1707                 fmt += read;
1708
1709                 switch (spec.type) {
1710                 case FORMAT_TYPE_NONE: {
1711                         int copy = read;
1712                         if (str < end) {
1713                                 if (copy > end - str)
1714                                         copy = end - str;
1715                                 memcpy(str, old_fmt, copy);
1716                         }
1717                         str += read;
1718                         break;
1719                 }
1720
1721                 case FORMAT_TYPE_WIDTH:
1722                         spec.field_width = get_arg(int);
1723                         break;
1724
1725                 case FORMAT_TYPE_PRECISION:
1726                         spec.precision = get_arg(int);
1727                         break;
1728
1729                 case FORMAT_TYPE_CHAR: {
1730                         char c;
1731
1732                         if (!(spec.flags & LEFT)) {
1733                                 while (--spec.field_width > 0) {
1734                                         if (str < end)
1735                                                 *str = ' ';
1736                                         ++str;
1737                                 }
1738                         }
1739                         c = (unsigned char) get_arg(char);
1740                         if (str < end)
1741                                 *str = c;
1742                         ++str;
1743                         while (--spec.field_width > 0) {
1744                                 if (str < end)
1745                                         *str = ' ';
1746                                 ++str;
1747                         }
1748                         break;
1749                 }
1750
1751                 case FORMAT_TYPE_STR: {
1752                         const char *str_arg = args;
1753                         args += strlen(str_arg) + 1;
1754                         str = string(str, end, (char *)str_arg, spec);
1755                         break;
1756                 }
1757
1758                 case FORMAT_TYPE_PTR:
1759                         str = pointer(fmt+1, str, end, get_arg(void *), spec);
1760                         while (isalnum(*fmt))
1761                                 fmt++;
1762                         break;
1763
1764                 case FORMAT_TYPE_PERCENT_CHAR:
1765                 case FORMAT_TYPE_INVALID:
1766                         if (str < end)
1767                                 *str = '%';
1768                         ++str;
1769                         break;
1770
1771                 case FORMAT_TYPE_NRCHARS:
1772                         /* skip */
1773                         break;
1774
1775                 default: {
1776                         unsigned long long num;
1777
1778                         switch (spec.type) {
1779
1780                         case FORMAT_TYPE_LONG_LONG:
1781                                 num = get_arg(long long);
1782                                 break;
1783                         case FORMAT_TYPE_ULONG:
1784                         case FORMAT_TYPE_LONG:
1785                                 num = get_arg(unsigned long);
1786                                 break;
1787                         case FORMAT_TYPE_SIZE_T:
1788                                 num = get_arg(size_t);
1789                                 break;
1790                         case FORMAT_TYPE_PTRDIFF:
1791                                 num = get_arg(ptrdiff_t);
1792                                 break;
1793                         case FORMAT_TYPE_UBYTE:
1794                                 num = get_arg(unsigned char);
1795                                 break;
1796                         case FORMAT_TYPE_BYTE:
1797                                 num = get_arg(signed char);
1798                                 break;
1799                         case FORMAT_TYPE_USHORT:
1800                                 num = get_arg(unsigned short);
1801                                 break;
1802                         case FORMAT_TYPE_SHORT:
1803                                 num = get_arg(short);
1804                                 break;
1805                         case FORMAT_TYPE_UINT:
1806                                 num = get_arg(unsigned int);
1807                                 break;
1808                         default:
1809                                 num = get_arg(int);
1810                         }
1811
1812                         str = number(str, end, num, spec);
1813                 } /* default: */
1814                 } /* switch(spec.type) */
1815         } /* while(*fmt) */
1816
1817         if (size > 0) {
1818                 if (str < end)
1819                         *str = '\0';
1820                 else
1821                         end[-1] = '\0';
1822         }
1823
1824 #undef get_arg
1825
1826         /* the trailing null byte doesn't count towards the total */
1827         return str - buf;
1828 }
1829 EXPORT_SYMBOL_GPL(bstr_printf);
1830
1831 /**
1832  * bprintf - Parse a format string and place args' binary value in a buffer
1833  * @bin_buf: The buffer to place args' binary value
1834  * @size: The size of the buffer(by words(32bits), not characters)
1835  * @fmt: The format string to use
1836  * @...: Arguments for the format string
1837  *
1838  * The function returns the number of words(u32) written
1839  * into @bin_buf.
1840  */
1841 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1842 {
1843         va_list args;
1844         int ret;
1845
1846         va_start(args, fmt);
1847         ret = vbin_printf(bin_buf, size, fmt, args);
1848         va_end(args);
1849
1850         return ret;
1851 }
1852 EXPORT_SYMBOL_GPL(bprintf);
1853
1854 #endif /* CONFIG_BINARY_PRINTF */
1855
1856 /**
1857  * vsscanf - Unformat a buffer into a list of arguments
1858  * @buf:        input buffer
1859  * @fmt:        format of buffer
1860  * @args:       arguments
1861  */
1862 int vsscanf(const char *buf, const char *fmt, va_list args)
1863 {
1864         const char *str = buf;
1865         char *next;
1866         char digit;
1867         int num = 0;
1868         int qualifier, base, field_width;
1869         bool is_sign;
1870
1871         while (*fmt && *str) {
1872                 /* skip any white space in format */
1873                 /* white space in format matchs any amount of
1874                  * white space, including none, in the input.
1875                  */
1876                 if (isspace(*fmt)) {
1877                         fmt = skip_spaces(++fmt);
1878                         str = skip_spaces(str);
1879                 }
1880
1881                 /* anything that is not a conversion must match exactly */
1882                 if (*fmt != '%' && *fmt) {
1883                         if (*fmt++ != *str++)
1884                                 break;
1885                         continue;
1886                 }
1887
1888                 if (!*fmt)
1889                         break;
1890                 ++fmt;
1891
1892                 /* skip this conversion.
1893                  * advance both strings to next white space
1894                  */
1895                 if (*fmt == '*') {
1896                         while (!isspace(*fmt) && *fmt != '%' && *fmt)
1897                                 fmt++;
1898                         while (!isspace(*str) && *str)
1899                                 str++;
1900                         continue;
1901                 }
1902
1903                 /* get field width */
1904                 field_width = -1;
1905                 if (isdigit(*fmt))
1906                         field_width = skip_atoi(&fmt);
1907
1908                 /* get conversion qualifier */
1909                 qualifier = -1;
1910                 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1911                     TOLOWER(*fmt) == 'z') {
1912                         qualifier = *fmt++;
1913                         if (unlikely(qualifier == *fmt)) {
1914                                 if (qualifier == 'h') {
1915                                         qualifier = 'H';
1916                                         fmt++;
1917                                 } else if (qualifier == 'l') {
1918                                         qualifier = 'L';
1919                                         fmt++;
1920                                 }
1921                         }
1922                 }
1923
1924                 if (!*fmt || !*str)
1925                         break;
1926
1927                 base = 10;
1928                 is_sign = 0;
1929
1930                 switch (*fmt++) {
1931                 case 'c':
1932                 {
1933                         char *s = (char *)va_arg(args, char*);
1934                         if (field_width == -1)
1935                                 field_width = 1;
1936                         do {
1937                                 *s++ = *str++;
1938                         } while (--field_width > 0 && *str);
1939                         num++;
1940                 }
1941                 continue;
1942                 case 's':
1943                 {
1944                         char *s = (char *)va_arg(args, char *);
1945                         if (field_width == -1)
1946                                 field_width = INT_MAX;
1947                         /* first, skip leading white space in buffer */
1948                         str = skip_spaces(str);
1949
1950                         /* now copy until next white space */
1951                         while (*str && !isspace(*str) && field_width--)
1952                                 *s++ = *str++;
1953                         *s = '\0';
1954                         num++;
1955                 }
1956                 continue;
1957                 case 'n':
1958                         /* return number of characters read so far */
1959                 {
1960                         int *i = (int *)va_arg(args, int*);
1961                         *i = str - buf;
1962                 }
1963                 continue;
1964                 case 'o':
1965                         base = 8;
1966                         break;
1967                 case 'x':
1968                 case 'X':
1969                         base = 16;
1970                         break;
1971                 case 'i':
1972                         base = 0;
1973                 case 'd':
1974                         is_sign = 1;
1975                 case 'u':
1976                         break;
1977                 case '%':
1978                         /* looking for '%' in str */
1979                         if (*str++ != '%')
1980                                 return num;
1981                         continue;
1982                 default:
1983                         /* invalid format; stop here */
1984                         return num;
1985                 }
1986
1987                 /* have some sort of integer conversion.
1988                  * first, skip white space in buffer.
1989                  */
1990                 str = skip_spaces(str);
1991
1992                 digit = *str;
1993                 if (is_sign && digit == '-')
1994                         digit = *(str + 1);
1995
1996                 if (!digit
1997                     || (base == 16 && !isxdigit(digit))
1998                     || (base == 10 && !isdigit(digit))
1999                     || (base == 8 && (!isdigit(digit) || digit > '7'))
2000                     || (base == 0 && !isdigit(digit)))
2001                         break;
2002
2003                 switch (qualifier) {
2004                 case 'H':       /* that's 'hh' in format */
2005                         if (is_sign) {
2006                                 signed char *s = (signed char *)va_arg(args, signed char *);
2007                                 *s = (signed char)simple_strtol(str, &next, base);
2008                         } else {
2009                                 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
2010                                 *s = (unsigned char)simple_strtoul(str, &next, base);
2011                         }
2012                         break;
2013                 case 'h':
2014                         if (is_sign) {
2015                                 short *s = (short *)va_arg(args, short *);
2016                                 *s = (short)simple_strtol(str, &next, base);
2017                         } else {
2018                                 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
2019                                 *s = (unsigned short)simple_strtoul(str, &next, base);
2020                         }
2021                         break;
2022                 case 'l':
2023                         if (is_sign) {
2024                                 long *l = (long *)va_arg(args, long *);
2025                                 *l = simple_strtol(str, &next, base);
2026                         } else {
2027                                 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
2028                                 *l = simple_strtoul(str, &next, base);
2029                         }
2030                         break;
2031                 case 'L':
2032                         if (is_sign) {
2033                                 long long *l = (long long *)va_arg(args, long long *);
2034                                 *l = simple_strtoll(str, &next, base);
2035                         } else {
2036                                 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
2037                                 *l = simple_strtoull(str, &next, base);
2038                         }
2039                         break;
2040                 case 'Z':
2041                 case 'z':
2042                 {
2043                         size_t *s = (size_t *)va_arg(args, size_t *);
2044                         *s = (size_t)simple_strtoul(str, &next, base);
2045                 }
2046                 break;
2047                 default:
2048                         if (is_sign) {
2049                                 int *i = (int *)va_arg(args, int *);
2050                                 *i = (int)simple_strtol(str, &next, base);
2051                         } else {
2052                                 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
2053                                 *i = (unsigned int)simple_strtoul(str, &next, base);
2054                         }
2055                         break;
2056                 }
2057                 num++;
2058
2059                 if (!next)
2060                         break;
2061                 str = next;
2062         }
2063
2064         /*
2065          * Now we've come all the way through so either the input string or the
2066          * format ended. In the former case, there can be a %n at the current
2067          * position in the format that needs to be filled.
2068          */
2069         if (*fmt == '%' && *(fmt + 1) == 'n') {
2070                 int *p = (int *)va_arg(args, int *);
2071                 *p = str - buf;
2072         }
2073
2074         return num;
2075 }
2076 EXPORT_SYMBOL(vsscanf);
2077
2078 /**
2079  * sscanf - Unformat a buffer into a list of arguments
2080  * @buf:        input buffer
2081  * @fmt:        formatting of buffer
2082  * @...:        resulting arguments
2083  */
2084 int sscanf(const char *buf, const char *fmt, ...)
2085 {
2086         va_list args;
2087         int i;
2088
2089         va_start(args, fmt);
2090         i = vsscanf(buf, fmt, args);
2091         va_end(args);
2092
2093         return i;
2094 }
2095 EXPORT_SYMBOL(sscanf);