printk: remove %p6 format specifier, fix up comments
[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
29 #include <asm/page.h>           /* for PAGE_SIZE */
30 #include <asm/div64.h>
31 #include <asm/sections.h>       /* for dereference_function_descriptor() */
32
33 /* Works only for digits and letters, but small and fast */
34 #define TOLOWER(x) ((x) | 0x20)
35
36 static unsigned int simple_guess_base(const char *cp)
37 {
38         if (cp[0] == '0') {
39                 if (TOLOWER(cp[1]) == 'x' && isxdigit(cp[2]))
40                         return 16;
41                 else
42                         return 8;
43         } else {
44                 return 10;
45         }
46 }
47
48 /**
49  * simple_strtoul - convert a string to an unsigned long
50  * @cp: The start of the string
51  * @endp: A pointer to the end of the parsed string will be placed here
52  * @base: The number base to use
53  */
54 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
55 {
56         unsigned long result = 0;
57
58         if (!base)
59                 base = simple_guess_base(cp);
60
61         if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
62                 cp += 2;
63
64         while (isxdigit(*cp)) {
65                 unsigned int value;
66
67                 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
68                 if (value >= base)
69                         break;
70                 result = result * base + value;
71                 cp++;
72         }
73
74         if (endp)
75                 *endp = (char *)cp;
76         return result;
77 }
78 EXPORT_SYMBOL(simple_strtoul);
79
80 /**
81  * simple_strtol - convert a string to a signed long
82  * @cp: The start of the string
83  * @endp: A pointer to the end of the parsed string will be placed here
84  * @base: The number base to use
85  */
86 long simple_strtol(const char *cp, char **endp, unsigned int base)
87 {
88         if(*cp == '-')
89                 return -simple_strtoul(cp + 1, endp, base);
90         return simple_strtoul(cp, endp, base);
91 }
92 EXPORT_SYMBOL(simple_strtol);
93
94 /**
95  * simple_strtoull - convert a string to an unsigned long long
96  * @cp: The start of the string
97  * @endp: A pointer to the end of the parsed string will be placed here
98  * @base: The number base to use
99  */
100 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
101 {
102         unsigned long long result = 0;
103
104         if (!base)
105                 base = simple_guess_base(cp);
106
107         if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
108                 cp += 2;
109
110         while (isxdigit(*cp)) {
111                 unsigned int value;
112
113                 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
114                 if (value >= base)
115                         break;
116                 result = result * base + value;
117                 cp++;
118         }
119
120         if (endp)
121                 *endp = (char *)cp;
122         return result;
123 }
124 EXPORT_SYMBOL(simple_strtoull);
125
126 /**
127  * simple_strtoll - convert a string to a signed long long
128  * @cp: The start of the string
129  * @endp: A pointer to the end of the parsed string will be placed here
130  * @base: The number base to use
131  */
132 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
133 {
134         if(*cp=='-')
135                 return -simple_strtoull(cp + 1, endp, base);
136         return simple_strtoull(cp, endp, base);
137 }
138
139 /**
140  * strict_strtoul - convert a string to an unsigned long strictly
141  * @cp: The string to be converted
142  * @base: The number base to use
143  * @res: The converted result value
144  *
145  * strict_strtoul converts a string to an unsigned long only if the
146  * string is really an unsigned long string, any string containing
147  * any invalid char at the tail will be rejected and -EINVAL is returned,
148  * only a newline char at the tail is acceptible because people generally
149  * change a module parameter in the following way:
150  *
151  *      echo 1024 > /sys/module/e1000/parameters/copybreak
152  *
153  * echo will append a newline to the tail.
154  *
155  * It returns 0 if conversion is successful and *res is set to the converted
156  * value, otherwise it returns -EINVAL and *res is set to 0.
157  *
158  * simple_strtoul just ignores the successive invalid characters and
159  * return the converted value of prefix part of the string.
160  */
161 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
162 {
163         char *tail;
164         unsigned long val;
165         size_t len;
166
167         *res = 0;
168         len = strlen(cp);
169         if (len == 0)
170                 return -EINVAL;
171
172         val = simple_strtoul(cp, &tail, base);
173         if ((*tail == '\0') ||
174                 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
175                 *res = val;
176                 return 0;
177         }
178
179         return -EINVAL;
180 }
181 EXPORT_SYMBOL(strict_strtoul);
182
183 /**
184  * strict_strtol - convert a string to a long strictly
185  * @cp: The string to be converted
186  * @base: The number base to use
187  * @res: The converted result value
188  *
189  * strict_strtol is similiar to strict_strtoul, but it allows the first
190  * character of a string is '-'.
191  *
192  * It returns 0 if conversion is successful and *res is set to the converted
193  * value, otherwise it returns -EINVAL and *res is set to 0.
194  */
195 int strict_strtol(const char *cp, unsigned int base, long *res)
196 {
197         int ret;
198         if (*cp == '-') {
199                 ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
200                 if (!ret)
201                         *res = -(*res);
202         } else {
203                 ret = strict_strtoul(cp, base, (unsigned long *)res);
204         }
205
206         return ret;
207 }
208 EXPORT_SYMBOL(strict_strtol);
209
210 /**
211  * strict_strtoull - convert a string to an unsigned long long strictly
212  * @cp: The string to be converted
213  * @base: The number base to use
214  * @res: The converted result value
215  *
216  * strict_strtoull converts a string to an unsigned long long only if the
217  * string is really an unsigned long long string, any string containing
218  * any invalid char at the tail will be rejected and -EINVAL is returned,
219  * only a newline char at the tail is acceptible because people generally
220  * change a module parameter in the following way:
221  *
222  *      echo 1024 > /sys/module/e1000/parameters/copybreak
223  *
224  * echo will append a newline to the tail of the string.
225  *
226  * It returns 0 if conversion is successful and *res is set to the converted
227  * value, otherwise it returns -EINVAL and *res is set to 0.
228  *
229  * simple_strtoull just ignores the successive invalid characters and
230  * return the converted value of prefix part of the string.
231  */
232 int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
233 {
234         char *tail;
235         unsigned long long val;
236         size_t len;
237
238         *res = 0;
239         len = strlen(cp);
240         if (len == 0)
241                 return -EINVAL;
242
243         val = simple_strtoull(cp, &tail, base);
244         if ((*tail == '\0') ||
245                 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
246                 *res = val;
247                 return 0;
248         }
249
250         return -EINVAL;
251 }
252 EXPORT_SYMBOL(strict_strtoull);
253
254 /**
255  * strict_strtoll - convert a string to a long long strictly
256  * @cp: The string to be converted
257  * @base: The number base to use
258  * @res: The converted result value
259  *
260  * strict_strtoll is similiar to strict_strtoull, but it allows the first
261  * character of a string is '-'.
262  *
263  * It returns 0 if conversion is successful and *res is set to the converted
264  * value, otherwise it returns -EINVAL and *res is set to 0.
265  */
266 int strict_strtoll(const char *cp, unsigned int base, long long *res)
267 {
268         int ret;
269         if (*cp == '-') {
270                 ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
271                 if (!ret)
272                         *res = -(*res);
273         } else {
274                 ret = strict_strtoull(cp, base, (unsigned long long *)res);
275         }
276
277         return ret;
278 }
279 EXPORT_SYMBOL(strict_strtoll);
280
281 static int skip_atoi(const char **s)
282 {
283         int i=0;
284
285         while (isdigit(**s))
286                 i = i*10 + *((*s)++) - '0';
287         return i;
288 }
289
290 /* Decimal conversion is by far the most typical, and is used
291  * for /proc and /sys data. This directly impacts e.g. top performance
292  * with many processes running. We optimize it for speed
293  * using code from
294  * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
295  * (with permission from the author, Douglas W. Jones). */
296
297 /* Formats correctly any integer in [0,99999].
298  * Outputs from one to five digits depending on input.
299  * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
300 static char* put_dec_trunc(char *buf, unsigned q)
301 {
302         unsigned d3, d2, d1, d0;
303         d1 = (q>>4) & 0xf;
304         d2 = (q>>8) & 0xf;
305         d3 = (q>>12);
306
307         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
308         q = (d0 * 0xcd) >> 11;
309         d0 = d0 - 10*q;
310         *buf++ = d0 + '0'; /* least significant digit */
311         d1 = q + 9*d3 + 5*d2 + d1;
312         if (d1 != 0) {
313                 q = (d1 * 0xcd) >> 11;
314                 d1 = d1 - 10*q;
315                 *buf++ = d1 + '0'; /* next digit */
316
317                 d2 = q + 2*d2;
318                 if ((d2 != 0) || (d3 != 0)) {
319                         q = (d2 * 0xd) >> 7;
320                         d2 = d2 - 10*q;
321                         *buf++ = d2 + '0'; /* next digit */
322
323                         d3 = q + 4*d3;
324                         if (d3 != 0) {
325                                 q = (d3 * 0xcd) >> 11;
326                                 d3 = d3 - 10*q;
327                                 *buf++ = d3 + '0';  /* next digit */
328                                 if (q != 0)
329                                         *buf++ = q + '0';  /* most sign. digit */
330                         }
331                 }
332         }
333         return buf;
334 }
335 /* Same with if's removed. Always emits five digits */
336 static char* put_dec_full(char *buf, unsigned q)
337 {
338         /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
339         /* but anyway, gcc produces better code with full-sized ints */
340         unsigned d3, d2, d1, d0;
341         d1 = (q>>4) & 0xf;
342         d2 = (q>>8) & 0xf;
343         d3 = (q>>12);
344
345         /* Possible ways to approx. divide by 10 */
346         /* gcc -O2 replaces multiply with shifts and adds */
347         // (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
348         // (x * 0x67) >> 10:  1100111
349         // (x * 0x34) >> 9:    110100 - same
350         // (x * 0x1a) >> 8:     11010 - same
351         // (x * 0x0d) >> 7:      1101 - same, shortest code (on i386)
352
353         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
354         q = (d0 * 0xcd) >> 11;
355         d0 = d0 - 10*q;
356         *buf++ = d0 + '0';
357         d1 = q + 9*d3 + 5*d2 + d1;
358                 q = (d1 * 0xcd) >> 11;
359                 d1 = d1 - 10*q;
360                 *buf++ = d1 + '0';
361
362                 d2 = q + 2*d2;
363                         q = (d2 * 0xd) >> 7;
364                         d2 = d2 - 10*q;
365                         *buf++ = d2 + '0';
366
367                         d3 = q + 4*d3;
368                                 q = (d3 * 0xcd) >> 11; /* - shorter code */
369                                 /* q = (d3 * 0x67) >> 10; - would also work */
370                                 d3 = d3 - 10*q;
371                                 *buf++ = d3 + '0';
372                                         *buf++ = q + '0';
373         return buf;
374 }
375 /* No inlining helps gcc to use registers better */
376 static noinline char* put_dec(char *buf, unsigned long long num)
377 {
378         while (1) {
379                 unsigned rem;
380                 if (num < 100000)
381                         return put_dec_trunc(buf, num);
382                 rem = do_div(num, 100000);
383                 buf = put_dec_full(buf, rem);
384         }
385 }
386
387 #define ZEROPAD 1               /* pad with zero */
388 #define SIGN    2               /* unsigned/signed long */
389 #define PLUS    4               /* show plus */
390 #define SPACE   8               /* space if plus */
391 #define LEFT    16              /* left justified */
392 #define SMALL   32              /* Must be 32 == 0x20 */
393 #define SPECIAL 64              /* 0x */
394
395 static char *number(char *buf, char *end, unsigned long long num, int base, int size, int precision, int type)
396 {
397         /* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
398         static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
399
400         char tmp[66];
401         char sign;
402         char locase;
403         int need_pfx = ((type & SPECIAL) && base != 10);
404         int i;
405
406         /* locase = 0 or 0x20. ORing digits or letters with 'locase'
407          * produces same digits or (maybe lowercased) letters */
408         locase = (type & SMALL);
409         if (type & LEFT)
410                 type &= ~ZEROPAD;
411         sign = 0;
412         if (type & SIGN) {
413                 if ((signed long long) num < 0) {
414                         sign = '-';
415                         num = - (signed long long) num;
416                         size--;
417                 } else if (type & PLUS) {
418                         sign = '+';
419                         size--;
420                 } else if (type & SPACE) {
421                         sign = ' ';
422                         size--;
423                 }
424         }
425         if (need_pfx) {
426                 size--;
427                 if (base == 16)
428                         size--;
429         }
430
431         /* generate full string in tmp[], in reverse order */
432         i = 0;
433         if (num == 0)
434                 tmp[i++] = '0';
435         /* Generic code, for any base:
436         else do {
437                 tmp[i++] = (digits[do_div(num,base)] | locase);
438         } while (num != 0);
439         */
440         else if (base != 10) { /* 8 or 16 */
441                 int mask = base - 1;
442                 int shift = 3;
443                 if (base == 16) shift = 4;
444                 do {
445                         tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
446                         num >>= shift;
447                 } while (num);
448         } else { /* base 10 */
449                 i = put_dec(tmp, num) - tmp;
450         }
451
452         /* printing 100 using %2d gives "100", not "00" */
453         if (i > precision)
454                 precision = i;
455         /* leading space padding */
456         size -= precision;
457         if (!(type & (ZEROPAD+LEFT))) {
458                 while(--size >= 0) {
459                         if (buf < end)
460                                 *buf = ' ';
461                         ++buf;
462                 }
463         }
464         /* sign */
465         if (sign) {
466                 if (buf < end)
467                         *buf = sign;
468                 ++buf;
469         }
470         /* "0x" / "0" prefix */
471         if (need_pfx) {
472                 if (buf < end)
473                         *buf = '0';
474                 ++buf;
475                 if (base == 16) {
476                         if (buf < end)
477                                 *buf = ('X' | locase);
478                         ++buf;
479                 }
480         }
481         /* zero or space padding */
482         if (!(type & LEFT)) {
483                 char c = (type & ZEROPAD) ? '0' : ' ';
484                 while (--size >= 0) {
485                         if (buf < end)
486                                 *buf = c;
487                         ++buf;
488                 }
489         }
490         /* hmm even more zero padding? */
491         while (i <= --precision) {
492                 if (buf < end)
493                         *buf = '0';
494                 ++buf;
495         }
496         /* actual digits of result */
497         while (--i >= 0) {
498                 if (buf < end)
499                         *buf = tmp[i];
500                 ++buf;
501         }
502         /* trailing space padding */
503         while (--size >= 0) {
504                 if (buf < end)
505                         *buf = ' ';
506                 ++buf;
507         }
508         return buf;
509 }
510
511 static char *string(char *buf, char *end, char *s, int field_width, int precision, int flags)
512 {
513         int len, i;
514
515         if ((unsigned long)s < PAGE_SIZE)
516                 s = "<NULL>";
517
518         len = strnlen(s, precision);
519
520         if (!(flags & LEFT)) {
521                 while (len < field_width--) {
522                         if (buf < end)
523                                 *buf = ' ';
524                         ++buf;
525                 }
526         }
527         for (i = 0; i < len; ++i) {
528                 if (buf < end)
529                         *buf = *s;
530                 ++buf; ++s;
531         }
532         while (len < field_width--) {
533                 if (buf < end)
534                         *buf = ' ';
535                 ++buf;
536         }
537         return buf;
538 }
539
540 static char *symbol_string(char *buf, char *end, void *ptr, int field_width, int precision, int flags)
541 {
542         unsigned long value = (unsigned long) ptr;
543 #ifdef CONFIG_KALLSYMS
544         char sym[KSYM_SYMBOL_LEN];
545         sprint_symbol(sym, value);
546         return string(buf, end, sym, field_width, precision, flags);
547 #else
548         field_width = 2*sizeof(void *);
549         flags |= SPECIAL | SMALL | ZEROPAD;
550         return number(buf, end, value, 16, field_width, precision, flags);
551 #endif
552 }
553
554 static char *resource_string(char *buf, char *end, struct resource *res, int field_width, int precision, int flags)
555 {
556 #ifndef IO_RSRC_PRINTK_SIZE
557 #define IO_RSRC_PRINTK_SIZE     4
558 #endif
559
560 #ifndef MEM_RSRC_PRINTK_SIZE
561 #define MEM_RSRC_PRINTK_SIZE    8
562 #endif
563
564         /* room for the actual numbers, the two "0x", -, [, ] and the final zero */
565         char sym[4*sizeof(resource_size_t) + 8];
566         char *p = sym, *pend = sym + sizeof(sym);
567         int size = -1;
568
569         if (res->flags & IORESOURCE_IO)
570                 size = IO_RSRC_PRINTK_SIZE;
571         else if (res->flags & IORESOURCE_MEM)
572                 size = MEM_RSRC_PRINTK_SIZE;
573
574         *p++ = '[';
575         p = number(p, pend, res->start, 16, size, -1, SPECIAL | SMALL | ZEROPAD);
576         *p++ = '-';
577         p = number(p, pend, res->end, 16, size, -1, SPECIAL | SMALL | ZEROPAD);
578         *p++ = ']';
579         *p = 0;
580
581         return string(buf, end, sym, field_width, precision, flags);
582 }
583
584 static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
585                                 int precision, int flags)
586 {
587         char mac_addr[6 * 3]; /* (6 * 2 hex digits), 5 colons and trailing zero */
588         char *p = mac_addr;
589         int i;
590
591         for (i = 0; i < 6; i++) {
592                 p = pack_hex_byte(p, addr[i]);
593                 if (!(flags & SPECIAL) && i != 5)
594                         *p++ = ':';
595         }
596         *p = '\0';
597
598         return string(buf, end, mac_addr, field_width, precision, flags & ~SPECIAL);
599 }
600
601 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
602                          int precision, int flags)
603 {
604         char ip6_addr[8 * 5]; /* (8 * 4 hex digits), 7 colons and trailing zero */
605         char *p = ip6_addr;
606         int i;
607
608         for (i = 0; i < 8; i++) {
609                 p = pack_hex_byte(p, addr[2 * i]);
610                 p = pack_hex_byte(p, addr[2 * i + 1]);
611                 if (!(flags & SPECIAL) && i != 7)
612                         *p++ = ':';
613         }
614         *p = '\0';
615
616         return string(buf, end, ip6_addr, field_width, precision, flags & ~SPECIAL);
617 }
618
619 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
620                          int precision, int flags)
621 {
622         char ip4_addr[4 * 4]; /* (4 * 3 decimal digits), 3 dots and trailing zero */
623         char *p = ip4_addr;
624         int i;
625
626         for (i = 0; i < 4; i++) {
627                 p = put_dec_trunc(p, addr[i]);
628                 if (i != 3)
629                         *p++ = '.';
630         }
631         *p = '\0';
632
633         return string(buf, end, ip4_addr, field_width, precision, flags & ~SPECIAL);
634 }
635
636 /*
637  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
638  * by an extra set of alphanumeric characters that are extended format
639  * specifiers.
640  *
641  * Right now we handle:
642  *
643  * - 'F' For symbolic function descriptor pointers
644  * - 'S' For symbolic direct pointers
645  * - 'R' For a struct resource pointer, it prints the range of
646  *       addresses (not the name nor the flags)
647  * - 'M' For a 6-byte MAC address, it prints the address in the
648  *       usual colon-separated hex notation
649  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
650  *       decimal for v4 and colon separated network-order 16 bit hex for v6)
651  * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
652  *       currently the same
653  *
654  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
655  * function pointers are really function descriptors, which contain a
656  * pointer to the real address.
657  */
658 static char *pointer(const char *fmt, char *buf, char *end, void *ptr, int field_width, int precision, int flags)
659 {
660         switch (*fmt) {
661         case 'F':
662                 ptr = dereference_function_descriptor(ptr);
663                 /* Fallthrough */
664         case 'S':
665                 return symbol_string(buf, end, ptr, field_width, precision, flags);
666         case 'R':
667                 return resource_string(buf, end, ptr, field_width, precision, flags);
668         case 'M':
669                 return mac_address_string(buf, end, ptr, field_width, precision, flags);
670         case 'i':
671                 flags |= SPECIAL;
672                 /* Fallthrough */
673         case 'I':
674                 if (fmt[1] == '6')
675                         return ip6_addr_string(buf, end, ptr, field_width, precision, flags);
676                 if (fmt[1] == '4')
677                         return ip4_addr_string(buf, end, ptr, field_width, precision, flags);
678                 flags &= ~SPECIAL;
679                 break;
680         }
681         flags |= SMALL;
682         if (field_width == -1) {
683                 field_width = 2*sizeof(void *);
684                 flags |= ZEROPAD;
685         }
686         return number(buf, end, (unsigned long) ptr, 16, field_width, precision, flags);
687 }
688
689 /**
690  * vsnprintf - Format a string and place it in a buffer
691  * @buf: The buffer to place the result into
692  * @size: The size of the buffer, including the trailing null space
693  * @fmt: The format string to use
694  * @args: Arguments for the format string
695  *
696  * This function follows C99 vsnprintf, but has some extensions:
697  * %pS output the name of a text symbol
698  * %pF output the name of a function pointer
699  * %pR output the address range in a struct resource
700  *
701  * The return value is the number of characters which would
702  * be generated for the given input, excluding the trailing
703  * '\0', as per ISO C99. If you want to have the exact
704  * number of characters written into @buf as return value
705  * (not including the trailing '\0'), use vscnprintf(). If the
706  * return is greater than or equal to @size, the resulting
707  * string is truncated.
708  *
709  * Call this function if you are already dealing with a va_list.
710  * You probably want snprintf() instead.
711  */
712 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
713 {
714         unsigned long long num;
715         int base;
716         char *str, *end, c;
717
718         int flags;              /* flags to number() */
719
720         int field_width;        /* width of output field */
721         int precision;          /* min. # of digits for integers; max
722                                    number of chars for from string */
723         int qualifier;          /* 'h', 'l', or 'L' for integer fields */
724                                 /* 'z' support added 23/7/1999 S.H.    */
725                                 /* 'z' changed to 'Z' --davidm 1/25/99 */
726                                 /* 't' added for ptrdiff_t */
727
728         /* Reject out-of-range values early.  Large positive sizes are
729            used for unknown buffer sizes. */
730         if (unlikely((int) size < 0)) {
731                 /* There can be only one.. */
732                 static char warn = 1;
733                 WARN_ON(warn);
734                 warn = 0;
735                 return 0;
736         }
737
738         str = buf;
739         end = buf + size;
740
741         /* Make sure end is always >= buf */
742         if (end < buf) {
743                 end = ((void *)-1);
744                 size = end - buf;
745         }
746
747         for (; *fmt ; ++fmt) {
748                 if (*fmt != '%') {
749                         if (str < end)
750                                 *str = *fmt;
751                         ++str;
752                         continue;
753                 }
754
755                 /* process flags */
756                 flags = 0;
757                 repeat:
758                         ++fmt;          /* this also skips first '%' */
759                         switch (*fmt) {
760                                 case '-': flags |= LEFT; goto repeat;
761                                 case '+': flags |= PLUS; goto repeat;
762                                 case ' ': flags |= SPACE; goto repeat;
763                                 case '#': flags |= SPECIAL; goto repeat;
764                                 case '0': flags |= ZEROPAD; goto repeat;
765                         }
766
767                 /* get field width */
768                 field_width = -1;
769                 if (isdigit(*fmt))
770                         field_width = skip_atoi(&fmt);
771                 else if (*fmt == '*') {
772                         ++fmt;
773                         /* it's the next argument */
774                         field_width = va_arg(args, int);
775                         if (field_width < 0) {
776                                 field_width = -field_width;
777                                 flags |= LEFT;
778                         }
779                 }
780
781                 /* get the precision */
782                 precision = -1;
783                 if (*fmt == '.') {
784                         ++fmt;  
785                         if (isdigit(*fmt))
786                                 precision = skip_atoi(&fmt);
787                         else if (*fmt == '*') {
788                                 ++fmt;
789                                 /* it's the next argument */
790                                 precision = va_arg(args, int);
791                         }
792                         if (precision < 0)
793                                 precision = 0;
794                 }
795
796                 /* get the conversion qualifier */
797                 qualifier = -1;
798                 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
799                     *fmt =='Z' || *fmt == 'z' || *fmt == 't') {
800                         qualifier = *fmt;
801                         ++fmt;
802                         if (qualifier == 'l' && *fmt == 'l') {
803                                 qualifier = 'L';
804                                 ++fmt;
805                         }
806                 }
807
808                 /* default base */
809                 base = 10;
810
811                 switch (*fmt) {
812                         case 'c':
813                                 if (!(flags & LEFT)) {
814                                         while (--field_width > 0) {
815                                                 if (str < end)
816                                                         *str = ' ';
817                                                 ++str;
818                                         }
819                                 }
820                                 c = (unsigned char) va_arg(args, int);
821                                 if (str < end)
822                                         *str = c;
823                                 ++str;
824                                 while (--field_width > 0) {
825                                         if (str < end)
826                                                 *str = ' ';
827                                         ++str;
828                                 }
829                                 continue;
830
831                         case 's':
832                                 str = string(str, end, va_arg(args, char *), field_width, precision, flags);
833                                 continue;
834
835                         case 'p':
836                                 str = pointer(fmt+1, str, end,
837                                                 va_arg(args, void *),
838                                                 field_width, precision, flags);
839                                 /* Skip all alphanumeric pointer suffixes */
840                                 while (isalnum(fmt[1]))
841                                         fmt++;
842                                 continue;
843
844                         case 'n':
845                                 /* FIXME:
846                                 * What does C99 say about the overflow case here? */
847                                 if (qualifier == 'l') {
848                                         long * ip = va_arg(args, long *);
849                                         *ip = (str - buf);
850                                 } else if (qualifier == 'Z' || qualifier == 'z') {
851                                         size_t * ip = va_arg(args, size_t *);
852                                         *ip = (str - buf);
853                                 } else {
854                                         int * ip = va_arg(args, int *);
855                                         *ip = (str - buf);
856                                 }
857                                 continue;
858
859                         case '%':
860                                 if (str < end)
861                                         *str = '%';
862                                 ++str;
863                                 continue;
864
865                                 /* integer number formats - set up the flags and "break" */
866                         case 'o':
867                                 base = 8;
868                                 break;
869
870                         case 'x':
871                                 flags |= SMALL;
872                         case 'X':
873                                 base = 16;
874                                 break;
875
876                         case 'd':
877                         case 'i':
878                                 flags |= SIGN;
879                         case 'u':
880                                 break;
881
882                         default:
883                                 if (str < end)
884                                         *str = '%';
885                                 ++str;
886                                 if (*fmt) {
887                                         if (str < end)
888                                                 *str = *fmt;
889                                         ++str;
890                                 } else {
891                                         --fmt;
892                                 }
893                                 continue;
894                 }
895                 if (qualifier == 'L')
896                         num = va_arg(args, long long);
897                 else if (qualifier == 'l') {
898                         num = va_arg(args, unsigned long);
899                         if (flags & SIGN)
900                                 num = (signed long) num;
901                 } else if (qualifier == 'Z' || qualifier == 'z') {
902                         num = va_arg(args, size_t);
903                 } else if (qualifier == 't') {
904                         num = va_arg(args, ptrdiff_t);
905                 } else if (qualifier == 'h') {
906                         num = (unsigned short) va_arg(args, int);
907                         if (flags & SIGN)
908                                 num = (signed short) num;
909                 } else {
910                         num = va_arg(args, unsigned int);
911                         if (flags & SIGN)
912                                 num = (signed int) num;
913                 }
914                 str = number(str, end, num, base,
915                                 field_width, precision, flags);
916         }
917         if (size > 0) {
918                 if (str < end)
919                         *str = '\0';
920                 else
921                         end[-1] = '\0';
922         }
923         /* the trailing null byte doesn't count towards the total */
924         return str-buf;
925 }
926 EXPORT_SYMBOL(vsnprintf);
927
928 /**
929  * vscnprintf - Format a string and place it in a buffer
930  * @buf: The buffer to place the result into
931  * @size: The size of the buffer, including the trailing null space
932  * @fmt: The format string to use
933  * @args: Arguments for the format string
934  *
935  * The return value is the number of characters which have been written into
936  * the @buf not including the trailing '\0'. If @size is <= 0 the function
937  * returns 0.
938  *
939  * Call this function if you are already dealing with a va_list.
940  * You probably want scnprintf() instead.
941  *
942  * See the vsnprintf() documentation for format string extensions over C99.
943  */
944 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
945 {
946         int i;
947
948         i=vsnprintf(buf,size,fmt,args);
949         return (i >= size) ? (size - 1) : i;
950 }
951 EXPORT_SYMBOL(vscnprintf);
952
953 /**
954  * snprintf - Format a string and place it in a buffer
955  * @buf: The buffer to place the result into
956  * @size: The size of the buffer, including the trailing null space
957  * @fmt: The format string to use
958  * @...: Arguments for the format string
959  *
960  * The return value is the number of characters which would be
961  * generated for the given input, excluding the trailing null,
962  * as per ISO C99.  If the return is greater than or equal to
963  * @size, the resulting string is truncated.
964  *
965  * See the vsnprintf() documentation for format string extensions over C99.
966  */
967 int snprintf(char * buf, size_t size, const char *fmt, ...)
968 {
969         va_list args;
970         int i;
971
972         va_start(args, fmt);
973         i=vsnprintf(buf,size,fmt,args);
974         va_end(args);
975         return i;
976 }
977 EXPORT_SYMBOL(snprintf);
978
979 /**
980  * scnprintf - Format a string and place it in a buffer
981  * @buf: The buffer to place the result into
982  * @size: The size of the buffer, including the trailing null space
983  * @fmt: The format string to use
984  * @...: Arguments for the format string
985  *
986  * The return value is the number of characters written into @buf not including
987  * the trailing '\0'. If @size is <= 0 the function returns 0.
988  */
989
990 int scnprintf(char * buf, size_t size, const char *fmt, ...)
991 {
992         va_list args;
993         int i;
994
995         va_start(args, fmt);
996         i = vsnprintf(buf, size, fmt, args);
997         va_end(args);
998         return (i >= size) ? (size - 1) : i;
999 }
1000 EXPORT_SYMBOL(scnprintf);
1001
1002 /**
1003  * vsprintf - Format a string and place it in a buffer
1004  * @buf: The buffer to place the result into
1005  * @fmt: The format string to use
1006  * @args: Arguments for the format string
1007  *
1008  * The function returns the number of characters written
1009  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1010  * buffer overflows.
1011  *
1012  * Call this function if you are already dealing with a va_list.
1013  * You probably want sprintf() instead.
1014  *
1015  * See the vsnprintf() documentation for format string extensions over C99.
1016  */
1017 int vsprintf(char *buf, const char *fmt, va_list args)
1018 {
1019         return vsnprintf(buf, INT_MAX, fmt, args);
1020 }
1021 EXPORT_SYMBOL(vsprintf);
1022
1023 /**
1024  * sprintf - Format a string and place it in a buffer
1025  * @buf: The buffer to place the result into
1026  * @fmt: The format string to use
1027  * @...: Arguments for the format string
1028  *
1029  * The function returns the number of characters written
1030  * into @buf. Use snprintf() or scnprintf() in order to avoid
1031  * buffer overflows.
1032  *
1033  * See the vsnprintf() documentation for format string extensions over C99.
1034  */
1035 int sprintf(char * buf, const char *fmt, ...)
1036 {
1037         va_list args;
1038         int i;
1039
1040         va_start(args, fmt);
1041         i=vsnprintf(buf, INT_MAX, fmt, args);
1042         va_end(args);
1043         return i;
1044 }
1045 EXPORT_SYMBOL(sprintf);
1046
1047 /**
1048  * vsscanf - Unformat a buffer into a list of arguments
1049  * @buf:        input buffer
1050  * @fmt:        format of buffer
1051  * @args:       arguments
1052  */
1053 int vsscanf(const char * buf, const char * fmt, va_list args)
1054 {
1055         const char *str = buf;
1056         char *next;
1057         char digit;
1058         int num = 0;
1059         int qualifier;
1060         int base;
1061         int field_width;
1062         int is_sign = 0;
1063
1064         while(*fmt && *str) {
1065                 /* skip any white space in format */
1066                 /* white space in format matchs any amount of
1067                  * white space, including none, in the input.
1068                  */
1069                 if (isspace(*fmt)) {
1070                         while (isspace(*fmt))
1071                                 ++fmt;
1072                         while (isspace(*str))
1073                                 ++str;
1074                 }
1075
1076                 /* anything that is not a conversion must match exactly */
1077                 if (*fmt != '%' && *fmt) {
1078                         if (*fmt++ != *str++)
1079                                 break;
1080                         continue;
1081                 }
1082
1083                 if (!*fmt)
1084                         break;
1085                 ++fmt;
1086                 
1087                 /* skip this conversion.
1088                  * advance both strings to next white space
1089                  */
1090                 if (*fmt == '*') {
1091                         while (!isspace(*fmt) && *fmt)
1092                                 fmt++;
1093                         while (!isspace(*str) && *str)
1094                                 str++;
1095                         continue;
1096                 }
1097
1098                 /* get field width */
1099                 field_width = -1;
1100                 if (isdigit(*fmt))
1101                         field_width = skip_atoi(&fmt);
1102
1103                 /* get conversion qualifier */
1104                 qualifier = -1;
1105                 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
1106                     *fmt == 'Z' || *fmt == 'z') {
1107                         qualifier = *fmt++;
1108                         if (unlikely(qualifier == *fmt)) {
1109                                 if (qualifier == 'h') {
1110                                         qualifier = 'H';
1111                                         fmt++;
1112                                 } else if (qualifier == 'l') {
1113                                         qualifier = 'L';
1114                                         fmt++;
1115                                 }
1116                         }
1117                 }
1118                 base = 10;
1119                 is_sign = 0;
1120
1121                 if (!*fmt || !*str)
1122                         break;
1123
1124                 switch(*fmt++) {
1125                 case 'c':
1126                 {
1127                         char *s = (char *) va_arg(args,char*);
1128                         if (field_width == -1)
1129                                 field_width = 1;
1130                         do {
1131                                 *s++ = *str++;
1132                         } while (--field_width > 0 && *str);
1133                         num++;
1134                 }
1135                 continue;
1136                 case 's':
1137                 {
1138                         char *s = (char *) va_arg(args, char *);
1139                         if(field_width == -1)
1140                                 field_width = INT_MAX;
1141                         /* first, skip leading white space in buffer */
1142                         while (isspace(*str))
1143                                 str++;
1144
1145                         /* now copy until next white space */
1146                         while (*str && !isspace(*str) && field_width--) {
1147                                 *s++ = *str++;
1148                         }
1149                         *s = '\0';
1150                         num++;
1151                 }
1152                 continue;
1153                 case 'n':
1154                         /* return number of characters read so far */
1155                 {
1156                         int *i = (int *)va_arg(args,int*);
1157                         *i = str - buf;
1158                 }
1159                 continue;
1160                 case 'o':
1161                         base = 8;
1162                         break;
1163                 case 'x':
1164                 case 'X':
1165                         base = 16;
1166                         break;
1167                 case 'i':
1168                         base = 0;
1169                 case 'd':
1170                         is_sign = 1;
1171                 case 'u':
1172                         break;
1173                 case '%':
1174                         /* looking for '%' in str */
1175                         if (*str++ != '%') 
1176                                 return num;
1177                         continue;
1178                 default:
1179                         /* invalid format; stop here */
1180                         return num;
1181                 }
1182
1183                 /* have some sort of integer conversion.
1184                  * first, skip white space in buffer.
1185                  */
1186                 while (isspace(*str))
1187                         str++;
1188
1189                 digit = *str;
1190                 if (is_sign && digit == '-')
1191                         digit = *(str + 1);
1192
1193                 if (!digit
1194                     || (base == 16 && !isxdigit(digit))
1195                     || (base == 10 && !isdigit(digit))
1196                     || (base == 8 && (!isdigit(digit) || digit > '7'))
1197                     || (base == 0 && !isdigit(digit)))
1198                                 break;
1199
1200                 switch(qualifier) {
1201                 case 'H':       /* that's 'hh' in format */
1202                         if (is_sign) {
1203                                 signed char *s = (signed char *) va_arg(args,signed char *);
1204                                 *s = (signed char) simple_strtol(str,&next,base);
1205                         } else {
1206                                 unsigned char *s = (unsigned char *) va_arg(args, unsigned char *);
1207                                 *s = (unsigned char) simple_strtoul(str, &next, base);
1208                         }
1209                         break;
1210                 case 'h':
1211                         if (is_sign) {
1212                                 short *s = (short *) va_arg(args,short *);
1213                                 *s = (short) simple_strtol(str,&next,base);
1214                         } else {
1215                                 unsigned short *s = (unsigned short *) va_arg(args, unsigned short *);
1216                                 *s = (unsigned short) simple_strtoul(str, &next, base);
1217                         }
1218                         break;
1219                 case 'l':
1220                         if (is_sign) {
1221                                 long *l = (long *) va_arg(args,long *);
1222                                 *l = simple_strtol(str,&next,base);
1223                         } else {
1224                                 unsigned long *l = (unsigned long*) va_arg(args,unsigned long*);
1225                                 *l = simple_strtoul(str,&next,base);
1226                         }
1227                         break;
1228                 case 'L':
1229                         if (is_sign) {
1230                                 long long *l = (long long*) va_arg(args,long long *);
1231                                 *l = simple_strtoll(str,&next,base);
1232                         } else {
1233                                 unsigned long long *l = (unsigned long long*) va_arg(args,unsigned long long*);
1234                                 *l = simple_strtoull(str,&next,base);
1235                         }
1236                         break;
1237                 case 'Z':
1238                 case 'z':
1239                 {
1240                         size_t *s = (size_t*) va_arg(args,size_t*);
1241                         *s = (size_t) simple_strtoul(str,&next,base);
1242                 }
1243                 break;
1244                 default:
1245                         if (is_sign) {
1246                                 int *i = (int *) va_arg(args, int*);
1247                                 *i = (int) simple_strtol(str,&next,base);
1248                         } else {
1249                                 unsigned int *i = (unsigned int*) va_arg(args, unsigned int*);
1250                                 *i = (unsigned int) simple_strtoul(str,&next,base);
1251                         }
1252                         break;
1253                 }
1254                 num++;
1255
1256                 if (!next)
1257                         break;
1258                 str = next;
1259         }
1260
1261         /*
1262          * Now we've come all the way through so either the input string or the
1263          * format ended. In the former case, there can be a %n at the current
1264          * position in the format that needs to be filled.
1265          */
1266         if (*fmt == '%' && *(fmt + 1) == 'n') {
1267                 int *p = (int *)va_arg(args, int *);
1268                 *p = str - buf;
1269         }
1270
1271         return num;
1272 }
1273 EXPORT_SYMBOL(vsscanf);
1274
1275 /**
1276  * sscanf - Unformat a buffer into a list of arguments
1277  * @buf:        input buffer
1278  * @fmt:        formatting of buffer
1279  * @...:        resulting arguments
1280  */
1281 int sscanf(const char * buf, const char * fmt, ...)
1282 {
1283         va_list args;
1284         int i;
1285
1286         va_start(args,fmt);
1287         i = vsscanf(buf,fmt,args);
1288         va_end(args);
1289         return i;
1290 }
1291 EXPORT_SYMBOL(sscanf);