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