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