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