ebbecf90d5d7bb8ed5cd16af3d616c7c75cdcc5f
[safe/jmp/linux-2.6] / 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              /* use lowercase in hex (must be 32 == 0x20) */
385 #define SPECIAL 64              /* prefix hex with "0x", octal with "0" */
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         u16     type;
412         s16     field_width;    /* width of output field */
413         u8      flags;          /* flags to number() */
414         u8      base;
415         s8      precision;      /* # of digits/chars */
416         u8      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         static const struct printf_spec io_spec = {
601                 .base = 16,
602                 .field_width = IO_RSRC_PRINTK_SIZE,
603                 .precision = -1,
604                 .flags = SPECIAL | SMALL | ZEROPAD,
605         };
606         static const struct printf_spec mem_spec = {
607                 .base = 16,
608                 .field_width = MEM_RSRC_PRINTK_SIZE,
609                 .precision = -1,
610                 .flags = SPECIAL | SMALL | ZEROPAD,
611         };
612         static const struct printf_spec bus_spec = {
613                 .base = 16,
614                 .field_width = 2,
615                 .precision = -1,
616                 .flags = SMALL | ZEROPAD,
617         };
618         static const struct printf_spec dec_spec = {
619                 .base = 10,
620                 .precision = -1,
621                 .flags = 0,
622         };
623         static const struct printf_spec str_spec = {
624                 .field_width = -1,
625                 .precision = 10,
626                 .flags = LEFT,
627         };
628         static const struct printf_spec flag_spec = {
629                 .base = 16,
630                 .precision = -1,
631                 .flags = SPECIAL | SMALL,
632         };
633
634         /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
635          * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
636 #define RSRC_BUF_SIZE           ((2 * sizeof(resource_size_t)) + 4)
637 #define FLAG_BUF_SIZE           (2 * sizeof(res->flags))
638 #define DECODED_BUF_SIZE        sizeof("[mem - 64bit pref disabled]")
639 #define RAW_BUF_SIZE            sizeof("[mem - flags 0x]")
640         char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
641                      2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
642
643         char *p = sym, *pend = sym + sizeof(sym);
644         int decode = (fmt[0] == 'R') ? 1 : 0;
645         const struct printf_spec *specp;
646
647         *p++ = '[';
648         if (res->flags & IORESOURCE_IO) {
649                 p = string(p, pend, "io  ", str_spec);
650                 specp = &io_spec;
651         } else if (res->flags & IORESOURCE_MEM) {
652                 p = string(p, pend, "mem ", str_spec);
653                 specp = &mem_spec;
654         } else if (res->flags & IORESOURCE_IRQ) {
655                 p = string(p, pend, "irq ", str_spec);
656                 specp = &dec_spec;
657         } else if (res->flags & IORESOURCE_DMA) {
658                 p = string(p, pend, "dma ", str_spec);
659                 specp = &dec_spec;
660         } else if (res->flags & IORESOURCE_BUS) {
661                 p = string(p, pend, "bus ", str_spec);
662                 specp = &bus_spec;
663         } else {
664                 p = string(p, pend, "??? ", str_spec);
665                 specp = &mem_spec;
666                 decode = 0;
667         }
668         p = number(p, pend, res->start, *specp);
669         if (res->start != res->end) {
670                 *p++ = '-';
671                 p = number(p, pend, res->end, *specp);
672         }
673         if (decode) {
674                 if (res->flags & IORESOURCE_MEM_64)
675                         p = string(p, pend, " 64bit", str_spec);
676                 if (res->flags & IORESOURCE_PREFETCH)
677                         p = string(p, pend, " pref", str_spec);
678                 if (res->flags & IORESOURCE_DISABLED)
679                         p = string(p, pend, " disabled", str_spec);
680         } else {
681                 p = string(p, pend, " flags ", str_spec);
682                 p = number(p, pend, res->flags, flag_spec);
683         }
684         *p++ = ']';
685         *p = '\0';
686
687         return string(buf, end, sym, spec);
688 }
689
690 static char *mac_address_string(char *buf, char *end, u8 *addr,
691                                 struct printf_spec spec, const char *fmt)
692 {
693         char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
694         char *p = mac_addr;
695         int i;
696         char separator;
697
698         if (fmt[1] == 'F') {            /* FDDI canonical format */
699                 separator = '-';
700         } else {
701                 separator = ':';
702         }
703
704         for (i = 0; i < 6; i++) {
705                 p = pack_hex_byte(p, addr[i]);
706                 if (fmt[0] == 'M' && i != 5)
707                         *p++ = separator;
708         }
709         *p = '\0';
710
711         return string(buf, end, mac_addr, spec);
712 }
713
714 static char *ip4_string(char *p, const u8 *addr, const char *fmt)
715 {
716         int i;
717         bool leading_zeros = (fmt[0] == 'i');
718         int index;
719         int step;
720
721         switch (fmt[2]) {
722         case 'h':
723 #ifdef __BIG_ENDIAN
724                 index = 0;
725                 step = 1;
726 #else
727                 index = 3;
728                 step = -1;
729 #endif
730                 break;
731         case 'l':
732                 index = 3;
733                 step = -1;
734                 break;
735         case 'n':
736         case 'b':
737         default:
738                 index = 0;
739                 step = 1;
740                 break;
741         }
742         for (i = 0; i < 4; i++) {
743                 char temp[3];   /* hold each IP quad in reverse order */
744                 int digits = put_dec_trunc(temp, addr[index]) - temp;
745                 if (leading_zeros) {
746                         if (digits < 3)
747                                 *p++ = '0';
748                         if (digits < 2)
749                                 *p++ = '0';
750                 }
751                 /* reverse the digits in the quad */
752                 while (digits--)
753                         *p++ = temp[digits];
754                 if (i < 3)
755                         *p++ = '.';
756                 index += step;
757         }
758         *p = '\0';
759
760         return p;
761 }
762
763 static char *ip6_compressed_string(char *p, const char *addr)
764 {
765         int i, j, range;
766         unsigned char zerolength[8];
767         int longest = 1;
768         int colonpos = -1;
769         u16 word;
770         u8 hi, lo;
771         bool needcolon = false;
772         bool useIPv4;
773         struct in6_addr in6;
774
775         memcpy(&in6, addr, sizeof(struct in6_addr));
776
777         useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
778
779         memset(zerolength, 0, sizeof(zerolength));
780
781         if (useIPv4)
782                 range = 6;
783         else
784                 range = 8;
785
786         /* find position of longest 0 run */
787         for (i = 0; i < range; i++) {
788                 for (j = i; j < range; j++) {
789                         if (in6.s6_addr16[j] != 0)
790                                 break;
791                         zerolength[i]++;
792                 }
793         }
794         for (i = 0; i < range; i++) {
795                 if (zerolength[i] > longest) {
796                         longest = zerolength[i];
797                         colonpos = i;
798                 }
799         }
800
801         /* emit address */
802         for (i = 0; i < range; i++) {
803                 if (i == colonpos) {
804                         if (needcolon || i == 0)
805                                 *p++ = ':';
806                         *p++ = ':';
807                         needcolon = false;
808                         i += longest - 1;
809                         continue;
810                 }
811                 if (needcolon) {
812                         *p++ = ':';
813                         needcolon = false;
814                 }
815                 /* hex u16 without leading 0s */
816                 word = ntohs(in6.s6_addr16[i]);
817                 hi = word >> 8;
818                 lo = word & 0xff;
819                 if (hi) {
820                         if (hi > 0x0f)
821                                 p = pack_hex_byte(p, hi);
822                         else
823                                 *p++ = hex_asc_lo(hi);
824                         p = pack_hex_byte(p, lo);
825                 }
826                 else if (lo > 0x0f)
827                         p = pack_hex_byte(p, lo);
828                 else
829                         *p++ = hex_asc_lo(lo);
830                 needcolon = true;
831         }
832
833         if (useIPv4) {
834                 if (needcolon)
835                         *p++ = ':';
836                 p = ip4_string(p, &in6.s6_addr[12], "I4");
837         }
838         *p = '\0';
839
840         return p;
841 }
842
843 static char *ip6_string(char *p, const char *addr, const char *fmt)
844 {
845         int i;
846
847         for (i = 0; i < 8; i++) {
848                 p = pack_hex_byte(p, *addr++);
849                 p = pack_hex_byte(p, *addr++);
850                 if (fmt[0] == 'I' && i != 7)
851                         *p++ = ':';
852         }
853         *p = '\0';
854
855         return p;
856 }
857
858 static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
859                              struct printf_spec spec, const char *fmt)
860 {
861         char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
862
863         if (fmt[0] == 'I' && fmt[2] == 'c')
864                 ip6_compressed_string(ip6_addr, addr);
865         else
866                 ip6_string(ip6_addr, addr, fmt);
867
868         return string(buf, end, ip6_addr, spec);
869 }
870
871 static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
872                              struct printf_spec spec, const char *fmt)
873 {
874         char ip4_addr[sizeof("255.255.255.255")];
875
876         ip4_string(ip4_addr, addr, fmt);
877
878         return string(buf, end, ip4_addr, spec);
879 }
880
881 static char *uuid_string(char *buf, char *end, const u8 *addr,
882                          struct printf_spec spec, const char *fmt)
883 {
884         char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
885         char *p = uuid;
886         int i;
887         static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
888         static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
889         const u8 *index = be;
890         bool uc = false;
891
892         switch (*(++fmt)) {
893         case 'L':
894                 uc = true;              /* fall-through */
895         case 'l':
896                 index = le;
897                 break;
898         case 'B':
899                 uc = true;
900                 break;
901         }
902
903         for (i = 0; i < 16; i++) {
904                 p = pack_hex_byte(p, addr[index[i]]);
905                 switch (i) {
906                 case 3:
907                 case 5:
908                 case 7:
909                 case 9:
910                         *p++ = '-';
911                         break;
912                 }
913         }
914
915         *p = 0;
916
917         if (uc) {
918                 p = uuid;
919                 do {
920                         *p = toupper(*p);
921                 } while (*(++p));
922         }
923
924         return string(buf, end, uuid, spec);
925 }
926
927 /*
928  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
929  * by an extra set of alphanumeric characters that are extended format
930  * specifiers.
931  *
932  * Right now we handle:
933  *
934  * - 'F' For symbolic function descriptor pointers with offset
935  * - 'f' For simple symbolic function names without offset
936  * - 'S' For symbolic direct pointers with offset
937  * - 's' For symbolic direct pointers without offset
938  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
939  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
940  * - 'M' For a 6-byte MAC address, it prints the address in the
941  *       usual colon-separated hex notation
942  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
943  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
944  *       with a dash-separated hex notation
945  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
946  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
947  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
948  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
949  *       IPv6 omits the colons (01020304...0f)
950  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
951  * - '[Ii]4[hnbl]' IPv4 addresses in host, network, big or little endian order
952  * - 'I6c' for IPv6 addresses printed as specified by
953  *       http://tools.ietf.org/html/draft-ietf-6man-text-addr-representation-00
954  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
955  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
956  *       Options for %pU are:
957  *         b big endian lower case hex (default)
958  *         B big endian UPPER case hex
959  *         l little endian lower case hex
960  *         L little endian UPPER case hex
961  *           big endian output byte order is:
962  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
963  *           little endian output byte order is:
964  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
965  *
966  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
967  * function pointers are really function descriptors, which contain a
968  * pointer to the real address.
969  */
970 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
971                         struct printf_spec spec)
972 {
973         if (!ptr)
974                 return string(buf, end, "(null)", spec);
975
976         switch (*fmt) {
977         case 'F':
978         case 'f':
979                 ptr = dereference_function_descriptor(ptr);
980                 /* Fallthrough */
981         case 'S':
982         case 's':
983                 return symbol_string(buf, end, ptr, spec, *fmt);
984         case 'R':
985         case 'r':
986                 return resource_string(buf, end, ptr, spec, fmt);
987         case 'M':                       /* Colon separated: 00:01:02:03:04:05 */
988         case 'm':                       /* Contiguous: 000102030405 */
989                                         /* [mM]F (FDDI, bit reversed) */
990                 return mac_address_string(buf, end, ptr, spec, fmt);
991         case 'I':                       /* Formatted IP supported
992                                          * 4:   1.2.3.4
993                                          * 6:   0001:0203:...:0708
994                                          * 6c:  1::708 or 1::1.2.3.4
995                                          */
996         case 'i':                       /* Contiguous:
997                                          * 4:   001.002.003.004
998                                          * 6:   000102...0f
999                                          */
1000                 switch (fmt[1]) {
1001                 case '6':
1002                         return ip6_addr_string(buf, end, ptr, spec, fmt);
1003                 case '4':
1004                         return ip4_addr_string(buf, end, ptr, spec, fmt);
1005                 }
1006                 break;
1007         case 'U':
1008                 return uuid_string(buf, end, ptr, spec, fmt);
1009         }
1010         spec.flags |= SMALL;
1011         if (spec.field_width == -1) {
1012                 spec.field_width = 2*sizeof(void *);
1013                 spec.flags |= ZEROPAD;
1014         }
1015         spec.base = 16;
1016
1017         return number(buf, end, (unsigned long) ptr, spec);
1018 }
1019
1020 /*
1021  * Helper function to decode printf style format.
1022  * Each call decode a token from the format and return the
1023  * number of characters read (or likely the delta where it wants
1024  * to go on the next call).
1025  * The decoded token is returned through the parameters
1026  *
1027  * 'h', 'l', or 'L' for integer fields
1028  * 'z' support added 23/7/1999 S.H.
1029  * 'z' changed to 'Z' --davidm 1/25/99
1030  * 't' added for ptrdiff_t
1031  *
1032  * @fmt: the format string
1033  * @type of the token returned
1034  * @flags: various flags such as +, -, # tokens..
1035  * @field_width: overwritten width
1036  * @base: base of the number (octal, hex, ...)
1037  * @precision: precision of a number
1038  * @qualifier: qualifier of a number (long, size_t, ...)
1039  */
1040 static int format_decode(const char *fmt, struct printf_spec *spec)
1041 {
1042         const char *start = fmt;
1043
1044         /* we finished early by reading the field width */
1045         if (spec->type == FORMAT_TYPE_WIDTH) {
1046                 if (spec->field_width < 0) {
1047                         spec->field_width = -spec->field_width;
1048                         spec->flags |= LEFT;
1049                 }
1050                 spec->type = FORMAT_TYPE_NONE;
1051                 goto precision;
1052         }
1053
1054         /* we finished early by reading the precision */
1055         if (spec->type == FORMAT_TYPE_PRECISION) {
1056                 if (spec->precision < 0)
1057                         spec->precision = 0;
1058
1059                 spec->type = FORMAT_TYPE_NONE;
1060                 goto qualifier;
1061         }
1062
1063         /* By default */
1064         spec->type = FORMAT_TYPE_NONE;
1065
1066         for (; *fmt ; ++fmt) {
1067                 if (*fmt == '%')
1068                         break;
1069         }
1070
1071         /* Return the current non-format string */
1072         if (fmt != start || !*fmt)
1073                 return fmt - start;
1074
1075         /* Process flags */
1076         spec->flags = 0;
1077
1078         while (1) { /* this also skips first '%' */
1079                 bool found = true;
1080
1081                 ++fmt;
1082
1083                 switch (*fmt) {
1084                 case '-': spec->flags |= LEFT;    break;
1085                 case '+': spec->flags |= PLUS;    break;
1086                 case ' ': spec->flags |= SPACE;   break;
1087                 case '#': spec->flags |= SPECIAL; break;
1088                 case '0': spec->flags |= ZEROPAD; break;
1089                 default:  found = false;
1090                 }
1091
1092                 if (!found)
1093                         break;
1094         }
1095
1096         /* get field width */
1097         spec->field_width = -1;
1098
1099         if (isdigit(*fmt))
1100                 spec->field_width = skip_atoi(&fmt);
1101         else if (*fmt == '*') {
1102                 /* it's the next argument */
1103                 spec->type = FORMAT_TYPE_WIDTH;
1104                 return ++fmt - start;
1105         }
1106
1107 precision:
1108         /* get the precision */
1109         spec->precision = -1;
1110         if (*fmt == '.') {
1111                 ++fmt;
1112                 if (isdigit(*fmt)) {
1113                         spec->precision = skip_atoi(&fmt);
1114                         if (spec->precision < 0)
1115                                 spec->precision = 0;
1116                 } else if (*fmt == '*') {
1117                         /* it's the next argument */
1118                         spec->type = FORMAT_TYPE_PRECISION;
1119                         return ++fmt - start;
1120                 }
1121         }
1122
1123 qualifier:
1124         /* get the conversion qualifier */
1125         spec->qualifier = -1;
1126         if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1127             TOLOWER(*fmt) == 'z' || *fmt == 't') {
1128                 spec->qualifier = *fmt++;
1129                 if (unlikely(spec->qualifier == *fmt)) {
1130                         if (spec->qualifier == 'l') {
1131                                 spec->qualifier = 'L';
1132                                 ++fmt;
1133                         } else if (spec->qualifier == 'h') {
1134                                 spec->qualifier = 'H';
1135                                 ++fmt;
1136                         }
1137                 }
1138         }
1139
1140         /* default base */
1141         spec->base = 10;
1142         switch (*fmt) {
1143         case 'c':
1144                 spec->type = FORMAT_TYPE_CHAR;
1145                 return ++fmt - start;
1146
1147         case 's':
1148                 spec->type = FORMAT_TYPE_STR;
1149                 return ++fmt - start;
1150
1151         case 'p':
1152                 spec->type = FORMAT_TYPE_PTR;
1153                 return fmt - start;
1154                 /* skip alnum */
1155
1156         case 'n':
1157                 spec->type = FORMAT_TYPE_NRCHARS;
1158                 return ++fmt - start;
1159
1160         case '%':
1161                 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1162                 return ++fmt - start;
1163
1164         /* integer number formats - set up the flags and "break" */
1165         case 'o':
1166                 spec->base = 8;
1167                 break;
1168
1169         case 'x':
1170                 spec->flags |= SMALL;
1171
1172         case 'X':
1173                 spec->base = 16;
1174                 break;
1175
1176         case 'd':
1177         case 'i':
1178                 spec->flags |= SIGN;
1179         case 'u':
1180                 break;
1181
1182         default:
1183                 spec->type = FORMAT_TYPE_INVALID;
1184                 return fmt - start;
1185         }
1186
1187         if (spec->qualifier == 'L')
1188                 spec->type = FORMAT_TYPE_LONG_LONG;
1189         else if (spec->qualifier == 'l') {
1190                 if (spec->flags & SIGN)
1191                         spec->type = FORMAT_TYPE_LONG;
1192                 else
1193                         spec->type = FORMAT_TYPE_ULONG;
1194         } else if (TOLOWER(spec->qualifier) == 'z') {
1195                 spec->type = FORMAT_TYPE_SIZE_T;
1196         } else if (spec->qualifier == 't') {
1197                 spec->type = FORMAT_TYPE_PTRDIFF;
1198         } else if (spec->qualifier == 'H') {
1199                 if (spec->flags & SIGN)
1200                         spec->type = FORMAT_TYPE_BYTE;
1201                 else
1202                         spec->type = FORMAT_TYPE_UBYTE;
1203         } else if (spec->qualifier == 'h') {
1204                 if (spec->flags & SIGN)
1205                         spec->type = FORMAT_TYPE_SHORT;
1206                 else
1207                         spec->type = FORMAT_TYPE_USHORT;
1208         } else {
1209                 if (spec->flags & SIGN)
1210                         spec->type = FORMAT_TYPE_INT;
1211                 else
1212                         spec->type = FORMAT_TYPE_UINT;
1213         }
1214
1215         return ++fmt - start;
1216 }
1217
1218 /**
1219  * vsnprintf - Format a string and place it in a buffer
1220  * @buf: The buffer to place the result into
1221  * @size: The size of the buffer, including the trailing null space
1222  * @fmt: The format string to use
1223  * @args: Arguments for the format string
1224  *
1225  * This function follows C99 vsnprintf, but has some extensions:
1226  * %pS output the name of a text symbol with offset
1227  * %ps output the name of a text symbol without offset
1228  * %pF output the name of a function pointer with its offset
1229  * %pf output the name of a function pointer without its offset
1230  * %pR output the address range in a struct resource with decoded flags
1231  * %pr output the address range in a struct resource with raw flags
1232  * %pM output a 6-byte MAC address with colons
1233  * %pm output a 6-byte MAC address without colons
1234  * %pI4 print an IPv4 address without leading zeros
1235  * %pi4 print an IPv4 address with leading zeros
1236  * %pI6 print an IPv6 address with colons
1237  * %pi6 print an IPv6 address without colons
1238  * %pI6c print an IPv6 address as specified by
1239  *   http://tools.ietf.org/html/draft-ietf-6man-text-addr-representation-00
1240  * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1241  *   case.
1242  * %n is ignored
1243  *
1244  * The return value is the number of characters which would
1245  * be generated for the given input, excluding the trailing
1246  * '\0', as per ISO C99. If you want to have the exact
1247  * number of characters written into @buf as return value
1248  * (not including the trailing '\0'), use vscnprintf(). If the
1249  * return is greater than or equal to @size, the resulting
1250  * string is truncated.
1251  *
1252  * Call this function if you are already dealing with a va_list.
1253  * You probably want snprintf() instead.
1254  */
1255 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1256 {
1257         unsigned long long num;
1258         char *str, *end;
1259         struct printf_spec spec = {0};
1260
1261         /* Reject out-of-range values early.  Large positive sizes are
1262            used for unknown buffer sizes. */
1263         if (WARN_ON_ONCE((int) size < 0))
1264                 return 0;
1265
1266         str = buf;
1267         end = buf + size;
1268
1269         /* Make sure end is always >= buf */
1270         if (end < buf) {
1271                 end = ((void *)-1);
1272                 size = end - buf;
1273         }
1274
1275         while (*fmt) {
1276                 const char *old_fmt = fmt;
1277                 int read = format_decode(fmt, &spec);
1278
1279                 fmt += read;
1280
1281                 switch (spec.type) {
1282                 case FORMAT_TYPE_NONE: {
1283                         int copy = read;
1284                         if (str < end) {
1285                                 if (copy > end - str)
1286                                         copy = end - str;
1287                                 memcpy(str, old_fmt, copy);
1288                         }
1289                         str += read;
1290                         break;
1291                 }
1292
1293                 case FORMAT_TYPE_WIDTH:
1294                         spec.field_width = va_arg(args, int);
1295                         break;
1296
1297                 case FORMAT_TYPE_PRECISION:
1298                         spec.precision = va_arg(args, int);
1299                         break;
1300
1301                 case FORMAT_TYPE_CHAR: {
1302                         char c;
1303
1304                         if (!(spec.flags & LEFT)) {
1305                                 while (--spec.field_width > 0) {
1306                                         if (str < end)
1307                                                 *str = ' ';
1308                                         ++str;
1309
1310                                 }
1311                         }
1312                         c = (unsigned char) va_arg(args, int);
1313                         if (str < end)
1314                                 *str = c;
1315                         ++str;
1316                         while (--spec.field_width > 0) {
1317                                 if (str < end)
1318                                         *str = ' ';
1319                                 ++str;
1320                         }
1321                         break;
1322                 }
1323
1324                 case FORMAT_TYPE_STR:
1325                         str = string(str, end, va_arg(args, char *), spec);
1326                         break;
1327
1328                 case FORMAT_TYPE_PTR:
1329                         str = pointer(fmt+1, str, end, va_arg(args, void *),
1330                                       spec);
1331                         while (isalnum(*fmt))
1332                                 fmt++;
1333                         break;
1334
1335                 case FORMAT_TYPE_PERCENT_CHAR:
1336                         if (str < end)
1337                                 *str = '%';
1338                         ++str;
1339                         break;
1340
1341                 case FORMAT_TYPE_INVALID:
1342                         if (str < end)
1343                                 *str = '%';
1344                         ++str;
1345                         break;
1346
1347                 case FORMAT_TYPE_NRCHARS: {
1348                         u8 qualifier = spec.qualifier;
1349
1350                         if (qualifier == 'l') {
1351                                 long *ip = va_arg(args, long *);
1352                                 *ip = (str - buf);
1353                         } else if (TOLOWER(qualifier) == 'z') {
1354                                 size_t *ip = va_arg(args, size_t *);
1355                                 *ip = (str - buf);
1356                         } else {
1357                                 int *ip = va_arg(args, int *);
1358                                 *ip = (str - buf);
1359                         }
1360                         break;
1361                 }
1362
1363                 default:
1364                         switch (spec.type) {
1365                         case FORMAT_TYPE_LONG_LONG:
1366                                 num = va_arg(args, long long);
1367                                 break;
1368                         case FORMAT_TYPE_ULONG:
1369                                 num = va_arg(args, unsigned long);
1370                                 break;
1371                         case FORMAT_TYPE_LONG:
1372                                 num = va_arg(args, long);
1373                                 break;
1374                         case FORMAT_TYPE_SIZE_T:
1375                                 num = va_arg(args, size_t);
1376                                 break;
1377                         case FORMAT_TYPE_PTRDIFF:
1378                                 num = va_arg(args, ptrdiff_t);
1379                                 break;
1380                         case FORMAT_TYPE_UBYTE:
1381                                 num = (unsigned char) va_arg(args, int);
1382                                 break;
1383                         case FORMAT_TYPE_BYTE:
1384                                 num = (signed char) va_arg(args, int);
1385                                 break;
1386                         case FORMAT_TYPE_USHORT:
1387                                 num = (unsigned short) va_arg(args, int);
1388                                 break;
1389                         case FORMAT_TYPE_SHORT:
1390                                 num = (short) va_arg(args, int);
1391                                 break;
1392                         case FORMAT_TYPE_INT:
1393                                 num = (int) va_arg(args, int);
1394                                 break;
1395                         default:
1396                                 num = va_arg(args, unsigned int);
1397                         }
1398
1399                         str = number(str, end, num, spec);
1400                 }
1401         }
1402
1403         if (size > 0) {
1404                 if (str < end)
1405                         *str = '\0';
1406                 else
1407                         end[-1] = '\0';
1408         }
1409
1410         /* the trailing null byte doesn't count towards the total */
1411         return str-buf;
1412
1413 }
1414 EXPORT_SYMBOL(vsnprintf);
1415
1416 /**
1417  * vscnprintf - Format a string and place it in a buffer
1418  * @buf: The buffer to place the result into
1419  * @size: The size of the buffer, including the trailing null space
1420  * @fmt: The format string to use
1421  * @args: Arguments for the format string
1422  *
1423  * The return value is the number of characters which have been written into
1424  * the @buf not including the trailing '\0'. If @size is <= 0 the function
1425  * returns 0.
1426  *
1427  * Call this function if you are already dealing with a va_list.
1428  * You probably want scnprintf() instead.
1429  *
1430  * See the vsnprintf() documentation for format string extensions over C99.
1431  */
1432 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1433 {
1434         int i;
1435
1436         i = vsnprintf(buf, size, fmt, args);
1437
1438         return (i >= size) ? (size - 1) : i;
1439 }
1440 EXPORT_SYMBOL(vscnprintf);
1441
1442 /**
1443  * snprintf - Format a string and place it in a buffer
1444  * @buf: The buffer to place the result into
1445  * @size: The size of the buffer, including the trailing null space
1446  * @fmt: The format string to use
1447  * @...: Arguments for the format string
1448  *
1449  * The return value is the number of characters which would be
1450  * generated for the given input, excluding the trailing null,
1451  * as per ISO C99.  If the return is greater than or equal to
1452  * @size, the resulting string is truncated.
1453  *
1454  * See the vsnprintf() documentation for format string extensions over C99.
1455  */
1456 int snprintf(char *buf, size_t size, const char *fmt, ...)
1457 {
1458         va_list args;
1459         int i;
1460
1461         va_start(args, fmt);
1462         i = vsnprintf(buf, size, fmt, args);
1463         va_end(args);
1464
1465         return i;
1466 }
1467 EXPORT_SYMBOL(snprintf);
1468
1469 /**
1470  * scnprintf - Format a string and place it in a buffer
1471  * @buf: The buffer to place the result into
1472  * @size: The size of the buffer, including the trailing null space
1473  * @fmt: The format string to use
1474  * @...: Arguments for the format string
1475  *
1476  * The return value is the number of characters written into @buf not including
1477  * the trailing '\0'. If @size is <= 0 the function returns 0.
1478  */
1479
1480 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1481 {
1482         va_list args;
1483         int i;
1484
1485         va_start(args, fmt);
1486         i = vsnprintf(buf, size, fmt, args);
1487         va_end(args);
1488
1489         return (i >= size) ? (size - 1) : i;
1490 }
1491 EXPORT_SYMBOL(scnprintf);
1492
1493 /**
1494  * vsprintf - Format a string and place it in a buffer
1495  * @buf: The buffer to place the result into
1496  * @fmt: The format string to use
1497  * @args: Arguments for the format string
1498  *
1499  * The function returns the number of characters written
1500  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1501  * buffer overflows.
1502  *
1503  * Call this function if you are already dealing with a va_list.
1504  * You probably want sprintf() instead.
1505  *
1506  * See the vsnprintf() documentation for format string extensions over C99.
1507  */
1508 int vsprintf(char *buf, const char *fmt, va_list args)
1509 {
1510         return vsnprintf(buf, INT_MAX, fmt, args);
1511 }
1512 EXPORT_SYMBOL(vsprintf);
1513
1514 /**
1515  * sprintf - Format a string and place it in a buffer
1516  * @buf: The buffer to place the result into
1517  * @fmt: The format string to use
1518  * @...: Arguments for the format string
1519  *
1520  * The function returns the number of characters written
1521  * into @buf. Use snprintf() or scnprintf() in order to avoid
1522  * buffer overflows.
1523  *
1524  * See the vsnprintf() documentation for format string extensions over C99.
1525  */
1526 int sprintf(char *buf, const char *fmt, ...)
1527 {
1528         va_list args;
1529         int i;
1530
1531         va_start(args, fmt);
1532         i = vsnprintf(buf, INT_MAX, fmt, args);
1533         va_end(args);
1534
1535         return i;
1536 }
1537 EXPORT_SYMBOL(sprintf);
1538
1539 #ifdef CONFIG_BINARY_PRINTF
1540 /*
1541  * bprintf service:
1542  * vbin_printf() - VA arguments to binary data
1543  * bstr_printf() - Binary data to text string
1544  */
1545
1546 /**
1547  * vbin_printf - Parse a format string and place args' binary value in a buffer
1548  * @bin_buf: The buffer to place args' binary value
1549  * @size: The size of the buffer(by words(32bits), not characters)
1550  * @fmt: The format string to use
1551  * @args: Arguments for the format string
1552  *
1553  * The format follows C99 vsnprintf, except %n is ignored, and its argument
1554  * is skiped.
1555  *
1556  * The return value is the number of words(32bits) which would be generated for
1557  * the given input.
1558  *
1559  * NOTE:
1560  * If the return value is greater than @size, the resulting bin_buf is NOT
1561  * valid for bstr_printf().
1562  */
1563 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1564 {
1565         struct printf_spec spec = {0};
1566         char *str, *end;
1567
1568         str = (char *)bin_buf;
1569         end = (char *)(bin_buf + size);
1570
1571 #define save_arg(type)                                                  \
1572 do {                                                                    \
1573         if (sizeof(type) == 8) {                                        \
1574                 unsigned long long value;                               \
1575                 str = PTR_ALIGN(str, sizeof(u32));                      \
1576                 value = va_arg(args, unsigned long long);               \
1577                 if (str + sizeof(type) <= end) {                        \
1578                         *(u32 *)str = *(u32 *)&value;                   \
1579                         *(u32 *)(str + 4) = *((u32 *)&value + 1);       \
1580                 }                                                       \
1581         } else {                                                        \
1582                 unsigned long value;                                    \
1583                 str = PTR_ALIGN(str, sizeof(type));                     \
1584                 value = va_arg(args, int);                              \
1585                 if (str + sizeof(type) <= end)                          \
1586                         *(typeof(type) *)str = (type)value;             \
1587         }                                                               \
1588         str += sizeof(type);                                            \
1589 } while (0)
1590
1591         while (*fmt) {
1592                 int read = format_decode(fmt, &spec);
1593
1594                 fmt += read;
1595
1596                 switch (spec.type) {
1597                 case FORMAT_TYPE_NONE:
1598                 case FORMAT_TYPE_INVALID:
1599                 case FORMAT_TYPE_PERCENT_CHAR:
1600                         break;
1601
1602                 case FORMAT_TYPE_WIDTH:
1603                 case FORMAT_TYPE_PRECISION:
1604                         save_arg(int);
1605                         break;
1606
1607                 case FORMAT_TYPE_CHAR:
1608                         save_arg(char);
1609                         break;
1610
1611                 case FORMAT_TYPE_STR: {
1612                         const char *save_str = va_arg(args, char *);
1613                         size_t len;
1614
1615                         if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1616                                         || (unsigned long)save_str < PAGE_SIZE)
1617                                 save_str = "(null)";
1618                         len = strlen(save_str) + 1;
1619                         if (str + len < end)
1620                                 memcpy(str, save_str, len);
1621                         str += len;
1622                         break;
1623                 }
1624
1625                 case FORMAT_TYPE_PTR:
1626                         save_arg(void *);
1627                         /* skip all alphanumeric pointer suffixes */
1628                         while (isalnum(*fmt))
1629                                 fmt++;
1630                         break;
1631
1632                 case FORMAT_TYPE_NRCHARS: {
1633                         /* skip %n 's argument */
1634                         u8 qualifier = spec.qualifier;
1635                         void *skip_arg;
1636                         if (qualifier == 'l')
1637                                 skip_arg = va_arg(args, long *);
1638                         else if (TOLOWER(qualifier) == 'z')
1639                                 skip_arg = va_arg(args, size_t *);
1640                         else
1641                                 skip_arg = va_arg(args, int *);
1642                         break;
1643                 }
1644
1645                 default:
1646                         switch (spec.type) {
1647
1648                         case FORMAT_TYPE_LONG_LONG:
1649                                 save_arg(long long);
1650                                 break;
1651                         case FORMAT_TYPE_ULONG:
1652                         case FORMAT_TYPE_LONG:
1653                                 save_arg(unsigned long);
1654                                 break;
1655                         case FORMAT_TYPE_SIZE_T:
1656                                 save_arg(size_t);
1657                                 break;
1658                         case FORMAT_TYPE_PTRDIFF:
1659                                 save_arg(ptrdiff_t);
1660                                 break;
1661                         case FORMAT_TYPE_UBYTE:
1662                         case FORMAT_TYPE_BYTE:
1663                                 save_arg(char);
1664                                 break;
1665                         case FORMAT_TYPE_USHORT:
1666                         case FORMAT_TYPE_SHORT:
1667                                 save_arg(short);
1668                                 break;
1669                         default:
1670                                 save_arg(int);
1671                         }
1672                 }
1673         }
1674
1675         return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1676 #undef save_arg
1677 }
1678 EXPORT_SYMBOL_GPL(vbin_printf);
1679
1680 /**
1681  * bstr_printf - Format a string from binary arguments and place it in a buffer
1682  * @buf: The buffer to place the result into
1683  * @size: The size of the buffer, including the trailing null space
1684  * @fmt: The format string to use
1685  * @bin_buf: Binary arguments for the format string
1686  *
1687  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1688  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1689  * a binary buffer that generated by vbin_printf.
1690  *
1691  * The format follows C99 vsnprintf, but has some extensions:
1692  *  see vsnprintf comment for details.
1693  *
1694  * The return value is the number of characters which would
1695  * be generated for the given input, excluding the trailing
1696  * '\0', as per ISO C99. If you want to have the exact
1697  * number of characters written into @buf as return value
1698  * (not including the trailing '\0'), use vscnprintf(). If the
1699  * return is greater than or equal to @size, the resulting
1700  * string is truncated.
1701  */
1702 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1703 {
1704         struct printf_spec spec = {0};
1705         char *str, *end;
1706         const char *args = (const char *)bin_buf;
1707
1708         if (WARN_ON_ONCE((int) size < 0))
1709                 return 0;
1710
1711         str = buf;
1712         end = buf + size;
1713
1714 #define get_arg(type)                                                   \
1715 ({                                                                      \
1716         typeof(type) value;                                             \
1717         if (sizeof(type) == 8) {                                        \
1718                 args = PTR_ALIGN(args, sizeof(u32));                    \
1719                 *(u32 *)&value = *(u32 *)args;                          \
1720                 *((u32 *)&value + 1) = *(u32 *)(args + 4);              \
1721         } else {                                                        \
1722                 args = PTR_ALIGN(args, sizeof(type));                   \
1723                 value = *(typeof(type) *)args;                          \
1724         }                                                               \
1725         args += sizeof(type);                                           \
1726         value;                                                          \
1727 })
1728
1729         /* Make sure end is always >= buf */
1730         if (end < buf) {
1731                 end = ((void *)-1);
1732                 size = end - buf;
1733         }
1734
1735         while (*fmt) {
1736                 const char *old_fmt = fmt;
1737                 int read = format_decode(fmt, &spec);
1738
1739                 fmt += read;
1740
1741                 switch (spec.type) {
1742                 case FORMAT_TYPE_NONE: {
1743                         int copy = read;
1744                         if (str < end) {
1745                                 if (copy > end - str)
1746                                         copy = end - str;
1747                                 memcpy(str, old_fmt, copy);
1748                         }
1749                         str += read;
1750                         break;
1751                 }
1752
1753                 case FORMAT_TYPE_WIDTH:
1754                         spec.field_width = get_arg(int);
1755                         break;
1756
1757                 case FORMAT_TYPE_PRECISION:
1758                         spec.precision = get_arg(int);
1759                         break;
1760
1761                 case FORMAT_TYPE_CHAR: {
1762                         char c;
1763
1764                         if (!(spec.flags & LEFT)) {
1765                                 while (--spec.field_width > 0) {
1766                                         if (str < end)
1767                                                 *str = ' ';
1768                                         ++str;
1769                                 }
1770                         }
1771                         c = (unsigned char) get_arg(char);
1772                         if (str < end)
1773                                 *str = c;
1774                         ++str;
1775                         while (--spec.field_width > 0) {
1776                                 if (str < end)
1777                                         *str = ' ';
1778                                 ++str;
1779                         }
1780                         break;
1781                 }
1782
1783                 case FORMAT_TYPE_STR: {
1784                         const char *str_arg = args;
1785                         args += strlen(str_arg) + 1;
1786                         str = string(str, end, (char *)str_arg, spec);
1787                         break;
1788                 }
1789
1790                 case FORMAT_TYPE_PTR:
1791                         str = pointer(fmt+1, str, end, get_arg(void *), spec);
1792                         while (isalnum(*fmt))
1793                                 fmt++;
1794                         break;
1795
1796                 case FORMAT_TYPE_PERCENT_CHAR:
1797                 case FORMAT_TYPE_INVALID:
1798                         if (str < end)
1799                                 *str = '%';
1800                         ++str;
1801                         break;
1802
1803                 case FORMAT_TYPE_NRCHARS:
1804                         /* skip */
1805                         break;
1806
1807                 default: {
1808                         unsigned long long num;
1809
1810                         switch (spec.type) {
1811
1812                         case FORMAT_TYPE_LONG_LONG:
1813                                 num = get_arg(long long);
1814                                 break;
1815                         case FORMAT_TYPE_ULONG:
1816                         case FORMAT_TYPE_LONG:
1817                                 num = get_arg(unsigned long);
1818                                 break;
1819                         case FORMAT_TYPE_SIZE_T:
1820                                 num = get_arg(size_t);
1821                                 break;
1822                         case FORMAT_TYPE_PTRDIFF:
1823                                 num = get_arg(ptrdiff_t);
1824                                 break;
1825                         case FORMAT_TYPE_UBYTE:
1826                                 num = get_arg(unsigned char);
1827                                 break;
1828                         case FORMAT_TYPE_BYTE:
1829                                 num = get_arg(signed char);
1830                                 break;
1831                         case FORMAT_TYPE_USHORT:
1832                                 num = get_arg(unsigned short);
1833                                 break;
1834                         case FORMAT_TYPE_SHORT:
1835                                 num = get_arg(short);
1836                                 break;
1837                         case FORMAT_TYPE_UINT:
1838                                 num = get_arg(unsigned int);
1839                                 break;
1840                         default:
1841                                 num = get_arg(int);
1842                         }
1843
1844                         str = number(str, end, num, spec);
1845                 } /* default: */
1846                 } /* switch(spec.type) */
1847         } /* while(*fmt) */
1848
1849         if (size > 0) {
1850                 if (str < end)
1851                         *str = '\0';
1852                 else
1853                         end[-1] = '\0';
1854         }
1855
1856 #undef get_arg
1857
1858         /* the trailing null byte doesn't count towards the total */
1859         return str - buf;
1860 }
1861 EXPORT_SYMBOL_GPL(bstr_printf);
1862
1863 /**
1864  * bprintf - Parse a format string and place args' binary value in a buffer
1865  * @bin_buf: The buffer to place args' binary value
1866  * @size: The size of the buffer(by words(32bits), not characters)
1867  * @fmt: The format string to use
1868  * @...: Arguments for the format string
1869  *
1870  * The function returns the number of words(u32) written
1871  * into @bin_buf.
1872  */
1873 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1874 {
1875         va_list args;
1876         int ret;
1877
1878         va_start(args, fmt);
1879         ret = vbin_printf(bin_buf, size, fmt, args);
1880         va_end(args);
1881
1882         return ret;
1883 }
1884 EXPORT_SYMBOL_GPL(bprintf);
1885
1886 #endif /* CONFIG_BINARY_PRINTF */
1887
1888 /**
1889  * vsscanf - Unformat a buffer into a list of arguments
1890  * @buf:        input buffer
1891  * @fmt:        format of buffer
1892  * @args:       arguments
1893  */
1894 int vsscanf(const char *buf, const char *fmt, va_list args)
1895 {
1896         const char *str = buf;
1897         char *next;
1898         char digit;
1899         int num = 0;
1900         u8 qualifier;
1901         u8 base;
1902         s16 field_width;
1903         bool is_sign;
1904
1905         while (*fmt && *str) {
1906                 /* skip any white space in format */
1907                 /* white space in format matchs any amount of
1908                  * white space, including none, in the input.
1909                  */
1910                 if (isspace(*fmt)) {
1911                         fmt = skip_spaces(++fmt);
1912                         str = skip_spaces(str);
1913                 }
1914
1915                 /* anything that is not a conversion must match exactly */
1916                 if (*fmt != '%' && *fmt) {
1917                         if (*fmt++ != *str++)
1918                                 break;
1919                         continue;
1920                 }
1921
1922                 if (!*fmt)
1923                         break;
1924                 ++fmt;
1925
1926                 /* skip this conversion.
1927                  * advance both strings to next white space
1928                  */
1929                 if (*fmt == '*') {
1930                         while (!isspace(*fmt) && *fmt != '%' && *fmt)
1931                                 fmt++;
1932                         while (!isspace(*str) && *str)
1933                                 str++;
1934                         continue;
1935                 }
1936
1937                 /* get field width */
1938                 field_width = -1;
1939                 if (isdigit(*fmt))
1940                         field_width = skip_atoi(&fmt);
1941
1942                 /* get conversion qualifier */
1943                 qualifier = -1;
1944                 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1945                     TOLOWER(*fmt) == 'z') {
1946                         qualifier = *fmt++;
1947                         if (unlikely(qualifier == *fmt)) {
1948                                 if (qualifier == 'h') {
1949                                         qualifier = 'H';
1950                                         fmt++;
1951                                 } else if (qualifier == 'l') {
1952                                         qualifier = 'L';
1953                                         fmt++;
1954                                 }
1955                         }
1956                 }
1957
1958                 if (!*fmt || !*str)
1959                         break;
1960
1961                 base = 10;
1962                 is_sign = 0;
1963
1964                 switch (*fmt++) {
1965                 case 'c':
1966                 {
1967                         char *s = (char *)va_arg(args, char*);
1968                         if (field_width == -1)
1969                                 field_width = 1;
1970                         do {
1971                                 *s++ = *str++;
1972                         } while (--field_width > 0 && *str);
1973                         num++;
1974                 }
1975                 continue;
1976                 case 's':
1977                 {
1978                         char *s = (char *)va_arg(args, char *);
1979                         if (field_width == -1)
1980                                 field_width = SHORT_MAX;
1981                         /* first, skip leading white space in buffer */
1982                         str = skip_spaces(str);
1983
1984                         /* now copy until next white space */
1985                         while (*str && !isspace(*str) && field_width--)
1986                                 *s++ = *str++;
1987                         *s = '\0';
1988                         num++;
1989                 }
1990                 continue;
1991                 case 'n':
1992                         /* return number of characters read so far */
1993                 {
1994                         int *i = (int *)va_arg(args, int*);
1995                         *i = str - buf;
1996                 }
1997                 continue;
1998                 case 'o':
1999                         base = 8;
2000                         break;
2001                 case 'x':
2002                 case 'X':
2003                         base = 16;
2004                         break;
2005                 case 'i':
2006                         base = 0;
2007                 case 'd':
2008                         is_sign = 1;
2009                 case 'u':
2010                         break;
2011                 case '%':
2012                         /* looking for '%' in str */
2013                         if (*str++ != '%')
2014                                 return num;
2015                         continue;
2016                 default:
2017                         /* invalid format; stop here */
2018                         return num;
2019                 }
2020
2021                 /* have some sort of integer conversion.
2022                  * first, skip white space in buffer.
2023                  */
2024                 str = skip_spaces(str);
2025
2026                 digit = *str;
2027                 if (is_sign && digit == '-')
2028                         digit = *(str + 1);
2029
2030                 if (!digit
2031                     || (base == 16 && !isxdigit(digit))
2032                     || (base == 10 && !isdigit(digit))
2033                     || (base == 8 && (!isdigit(digit) || digit > '7'))
2034                     || (base == 0 && !isdigit(digit)))
2035                         break;
2036
2037                 switch (qualifier) {
2038                 case 'H':       /* that's 'hh' in format */
2039                         if (is_sign) {
2040                                 signed char *s = (signed char *)va_arg(args, signed char *);
2041                                 *s = (signed char)simple_strtol(str, &next, base);
2042                         } else {
2043                                 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
2044                                 *s = (unsigned char)simple_strtoul(str, &next, base);
2045                         }
2046                         break;
2047                 case 'h':
2048                         if (is_sign) {
2049                                 short *s = (short *)va_arg(args, short *);
2050                                 *s = (short)simple_strtol(str, &next, base);
2051                         } else {
2052                                 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
2053                                 *s = (unsigned short)simple_strtoul(str, &next, base);
2054                         }
2055                         break;
2056                 case 'l':
2057                         if (is_sign) {
2058                                 long *l = (long *)va_arg(args, long *);
2059                                 *l = simple_strtol(str, &next, base);
2060                         } else {
2061                                 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
2062                                 *l = simple_strtoul(str, &next, base);
2063                         }
2064                         break;
2065                 case 'L':
2066                         if (is_sign) {
2067                                 long long *l = (long long *)va_arg(args, long long *);
2068                                 *l = simple_strtoll(str, &next, base);
2069                         } else {
2070                                 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
2071                                 *l = simple_strtoull(str, &next, base);
2072                         }
2073                         break;
2074                 case 'Z':
2075                 case 'z':
2076                 {
2077                         size_t *s = (size_t *)va_arg(args, size_t *);
2078                         *s = (size_t)simple_strtoul(str, &next, base);
2079                 }
2080                 break;
2081                 default:
2082                         if (is_sign) {
2083                                 int *i = (int *)va_arg(args, int *);
2084                                 *i = (int)simple_strtol(str, &next, base);
2085                         } else {
2086                                 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
2087                                 *i = (unsigned int)simple_strtoul(str, &next, base);
2088                         }
2089                         break;
2090                 }
2091                 num++;
2092
2093                 if (!next)
2094                         break;
2095                 str = next;
2096         }
2097
2098         /*
2099          * Now we've come all the way through so either the input string or the
2100          * format ended. In the former case, there can be a %n at the current
2101          * position in the format that needs to be filled.
2102          */
2103         if (*fmt == '%' && *(fmt + 1) == 'n') {
2104                 int *p = (int *)va_arg(args, int *);
2105                 *p = str - buf;
2106         }
2107
2108         return num;
2109 }
2110 EXPORT_SYMBOL(vsscanf);
2111
2112 /**
2113  * sscanf - Unformat a buffer into a list of arguments
2114  * @buf:        input buffer
2115  * @fmt:        formatting of buffer
2116  * @...:        resulting arguments
2117  */
2118 int sscanf(const char *buf, const char *fmt, ...)
2119 {
2120         va_list args;
2121         int i;
2122
2123         va_start(args, fmt);
2124         i = vsscanf(buf, fmt, args);
2125         va_end(args);
2126
2127         return i;
2128 }
2129 EXPORT_SYMBOL(sscanf);