d960aead03368e70503936b55d8d42ba82649518
[muen/linux.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/clk.h>
21 #include <linux/clk-provider.h>
22 #include <linux/module.h>       /* for KSYM_SYMBOL_LEN */
23 #include <linux/types.h>
24 #include <linux/string.h>
25 #include <linux/ctype.h>
26 #include <linux/kernel.h>
27 #include <linux/kallsyms.h>
28 #include <linux/math64.h>
29 #include <linux/uaccess.h>
30 #include <linux/ioport.h>
31 #include <linux/dcache.h>
32 #include <linux/cred.h>
33 #include <linux/uuid.h>
34 #include <linux/of.h>
35 #include <net/addrconf.h>
36 #include <linux/siphash.h>
37 #include <linux/compiler.h>
38 #ifdef CONFIG_BLOCK
39 #include <linux/blkdev.h>
40 #endif
41
42 #include "../mm/internal.h"     /* For the trace_print_flags arrays */
43
44 #include <asm/page.h>           /* for PAGE_SIZE */
45 #include <asm/sections.h>       /* for dereference_function_descriptor() */
46 #include <asm/byteorder.h>      /* cpu_to_le16 */
47
48 #include <linux/string_helpers.h>
49 #include "kstrtox.h"
50
51 /**
52  * simple_strtoull - convert a string to an unsigned long long
53  * @cp: The start of the string
54  * @endp: A pointer to the end of the parsed string will be placed here
55  * @base: The number base to use
56  *
57  * This function is obsolete. Please use kstrtoull instead.
58  */
59 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
60 {
61         unsigned long long result;
62         unsigned int rv;
63
64         cp = _parse_integer_fixup_radix(cp, &base);
65         rv = _parse_integer(cp, base, &result);
66         /* FIXME */
67         cp += (rv & ~KSTRTOX_OVERFLOW);
68
69         if (endp)
70                 *endp = (char *)cp;
71
72         return result;
73 }
74 EXPORT_SYMBOL(simple_strtoull);
75
76 /**
77  * simple_strtoul - convert a string to an unsigned long
78  * @cp: The start of the string
79  * @endp: A pointer to the end of the parsed string will be placed here
80  * @base: The number base to use
81  *
82  * This function is obsolete. Please use kstrtoul instead.
83  */
84 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
85 {
86         return simple_strtoull(cp, endp, base);
87 }
88 EXPORT_SYMBOL(simple_strtoul);
89
90 /**
91  * simple_strtol - convert a string to a signed long
92  * @cp: The start of the string
93  * @endp: A pointer to the end of the parsed string will be placed here
94  * @base: The number base to use
95  *
96  * This function is obsolete. Please use kstrtol instead.
97  */
98 long simple_strtol(const char *cp, char **endp, unsigned int base)
99 {
100         if (*cp == '-')
101                 return -simple_strtoul(cp + 1, endp, base);
102
103         return simple_strtoul(cp, endp, base);
104 }
105 EXPORT_SYMBOL(simple_strtol);
106
107 /**
108  * simple_strtoll - convert a string to a signed long long
109  * @cp: The start of the string
110  * @endp: A pointer to the end of the parsed string will be placed here
111  * @base: The number base to use
112  *
113  * This function is obsolete. Please use kstrtoll instead.
114  */
115 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
116 {
117         if (*cp == '-')
118                 return -simple_strtoull(cp + 1, endp, base);
119
120         return simple_strtoull(cp, endp, base);
121 }
122 EXPORT_SYMBOL(simple_strtoll);
123
124 static noinline_for_stack
125 int skip_atoi(const char **s)
126 {
127         int i = 0;
128
129         do {
130                 i = i*10 + *((*s)++) - '0';
131         } while (isdigit(**s));
132
133         return i;
134 }
135
136 /*
137  * Decimal conversion is by far the most typical, and is used for
138  * /proc and /sys data. This directly impacts e.g. top performance
139  * with many processes running. We optimize it for speed by emitting
140  * two characters at a time, using a 200 byte lookup table. This
141  * roughly halves the number of multiplications compared to computing
142  * the digits one at a time. Implementation strongly inspired by the
143  * previous version, which in turn used ideas described at
144  * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
145  * from the author, Douglas W. Jones).
146  *
147  * It turns out there is precisely one 26 bit fixed-point
148  * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
149  * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
150  * range happens to be somewhat larger (x <= 1073741898), but that's
151  * irrelevant for our purpose.
152  *
153  * For dividing a number in the range [10^4, 10^6-1] by 100, we still
154  * need a 32x32->64 bit multiply, so we simply use the same constant.
155  *
156  * For dividing a number in the range [100, 10^4-1] by 100, there are
157  * several options. The simplest is (x * 0x147b) >> 19, which is valid
158  * for all x <= 43698.
159  */
160
161 static const u16 decpair[100] = {
162 #define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
163         _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
164         _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
165         _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
166         _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
167         _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
168         _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
169         _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
170         _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
171         _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
172         _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
173 #undef _
174 };
175
176 /*
177  * This will print a single '0' even if r == 0, since we would
178  * immediately jump to out_r where two 0s would be written but only
179  * one of them accounted for in buf. This is needed by ip4_string
180  * below. All other callers pass a non-zero value of r.
181 */
182 static noinline_for_stack
183 char *put_dec_trunc8(char *buf, unsigned r)
184 {
185         unsigned q;
186
187         /* 1 <= r < 10^8 */
188         if (r < 100)
189                 goto out_r;
190
191         /* 100 <= r < 10^8 */
192         q = (r * (u64)0x28f5c29) >> 32;
193         *((u16 *)buf) = decpair[r - 100*q];
194         buf += 2;
195
196         /* 1 <= q < 10^6 */
197         if (q < 100)
198                 goto out_q;
199
200         /*  100 <= q < 10^6 */
201         r = (q * (u64)0x28f5c29) >> 32;
202         *((u16 *)buf) = decpair[q - 100*r];
203         buf += 2;
204
205         /* 1 <= r < 10^4 */
206         if (r < 100)
207                 goto out_r;
208
209         /* 100 <= r < 10^4 */
210         q = (r * 0x147b) >> 19;
211         *((u16 *)buf) = decpair[r - 100*q];
212         buf += 2;
213 out_q:
214         /* 1 <= q < 100 */
215         r = q;
216 out_r:
217         /* 1 <= r < 100 */
218         *((u16 *)buf) = decpair[r];
219         buf += r < 10 ? 1 : 2;
220         return buf;
221 }
222
223 #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
224 static noinline_for_stack
225 char *put_dec_full8(char *buf, unsigned r)
226 {
227         unsigned q;
228
229         /* 0 <= r < 10^8 */
230         q = (r * (u64)0x28f5c29) >> 32;
231         *((u16 *)buf) = decpair[r - 100*q];
232         buf += 2;
233
234         /* 0 <= q < 10^6 */
235         r = (q * (u64)0x28f5c29) >> 32;
236         *((u16 *)buf) = decpair[q - 100*r];
237         buf += 2;
238
239         /* 0 <= r < 10^4 */
240         q = (r * 0x147b) >> 19;
241         *((u16 *)buf) = decpair[r - 100*q];
242         buf += 2;
243
244         /* 0 <= q < 100 */
245         *((u16 *)buf) = decpair[q];
246         buf += 2;
247         return buf;
248 }
249
250 static noinline_for_stack
251 char *put_dec(char *buf, unsigned long long n)
252 {
253         if (n >= 100*1000*1000)
254                 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
255         /* 1 <= n <= 1.6e11 */
256         if (n >= 100*1000*1000)
257                 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
258         /* 1 <= n < 1e8 */
259         return put_dec_trunc8(buf, n);
260 }
261
262 #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
263
264 static void
265 put_dec_full4(char *buf, unsigned r)
266 {
267         unsigned q;
268
269         /* 0 <= r < 10^4 */
270         q = (r * 0x147b) >> 19;
271         *((u16 *)buf) = decpair[r - 100*q];
272         buf += 2;
273         /* 0 <= q < 100 */
274         *((u16 *)buf) = decpair[q];
275 }
276
277 /*
278  * Call put_dec_full4 on x % 10000, return x / 10000.
279  * The approximation x/10000 == (x * 0x346DC5D7) >> 43
280  * holds for all x < 1,128,869,999.  The largest value this
281  * helper will ever be asked to convert is 1,125,520,955.
282  * (second call in the put_dec code, assuming n is all-ones).
283  */
284 static noinline_for_stack
285 unsigned put_dec_helper4(char *buf, unsigned x)
286 {
287         uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
288
289         put_dec_full4(buf, x - q * 10000);
290         return q;
291 }
292
293 /* Based on code by Douglas W. Jones found at
294  * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
295  * (with permission from the author).
296  * Performs no 64-bit division and hence should be fast on 32-bit machines.
297  */
298 static
299 char *put_dec(char *buf, unsigned long long n)
300 {
301         uint32_t d3, d2, d1, q, h;
302
303         if (n < 100*1000*1000)
304                 return put_dec_trunc8(buf, n);
305
306         d1  = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
307         h   = (n >> 32);
308         d2  = (h      ) & 0xffff;
309         d3  = (h >> 16); /* implicit "& 0xffff" */
310
311         /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
312              = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
313         q   = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
314         q = put_dec_helper4(buf, q);
315
316         q += 7671 * d3 + 9496 * d2 + 6 * d1;
317         q = put_dec_helper4(buf+4, q);
318
319         q += 4749 * d3 + 42 * d2;
320         q = put_dec_helper4(buf+8, q);
321
322         q += 281 * d3;
323         buf += 12;
324         if (q)
325                 buf = put_dec_trunc8(buf, q);
326         else while (buf[-1] == '0')
327                 --buf;
328
329         return buf;
330 }
331
332 #endif
333
334 /*
335  * Convert passed number to decimal string.
336  * Returns the length of string.  On buffer overflow, returns 0.
337  *
338  * If speed is not important, use snprintf(). It's easy to read the code.
339  */
340 int num_to_str(char *buf, int size, unsigned long long num)
341 {
342         /* put_dec requires 2-byte alignment of the buffer. */
343         char tmp[sizeof(num) * 3] __aligned(2);
344         int idx, len;
345
346         /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
347         if (num <= 9) {
348                 tmp[0] = '0' + num;
349                 len = 1;
350         } else {
351                 len = put_dec(tmp, num) - tmp;
352         }
353
354         if (len > size)
355                 return 0;
356         for (idx = 0; idx < len; ++idx)
357                 buf[idx] = tmp[len - idx - 1];
358         return len;
359 }
360
361 #define SIGN    1               /* unsigned/signed, must be 1 */
362 #define LEFT    2               /* left justified */
363 #define PLUS    4               /* show plus */
364 #define SPACE   8               /* space if plus */
365 #define ZEROPAD 16              /* pad with zero, must be 16 == '0' - ' ' */
366 #define SMALL   32              /* use lowercase in hex (must be 32 == 0x20) */
367 #define SPECIAL 64              /* prefix hex with "0x", octal with "0" */
368
369 enum format_type {
370         FORMAT_TYPE_NONE, /* Just a string part */
371         FORMAT_TYPE_WIDTH,
372         FORMAT_TYPE_PRECISION,
373         FORMAT_TYPE_CHAR,
374         FORMAT_TYPE_STR,
375         FORMAT_TYPE_PTR,
376         FORMAT_TYPE_PERCENT_CHAR,
377         FORMAT_TYPE_INVALID,
378         FORMAT_TYPE_LONG_LONG,
379         FORMAT_TYPE_ULONG,
380         FORMAT_TYPE_LONG,
381         FORMAT_TYPE_UBYTE,
382         FORMAT_TYPE_BYTE,
383         FORMAT_TYPE_USHORT,
384         FORMAT_TYPE_SHORT,
385         FORMAT_TYPE_UINT,
386         FORMAT_TYPE_INT,
387         FORMAT_TYPE_SIZE_T,
388         FORMAT_TYPE_PTRDIFF
389 };
390
391 struct printf_spec {
392         unsigned int    type:8;         /* format_type enum */
393         signed int      field_width:24; /* width of output field */
394         unsigned int    flags:8;        /* flags to number() */
395         unsigned int    base:8;         /* number base, 8, 10 or 16 only */
396         signed int      precision:16;   /* # of digits/chars */
397 } __packed;
398 #define FIELD_WIDTH_MAX ((1 << 23) - 1)
399 #define PRECISION_MAX ((1 << 15) - 1)
400
401 static noinline_for_stack
402 char *number(char *buf, char *end, unsigned long long num,
403              struct printf_spec spec)
404 {
405         /* put_dec requires 2-byte alignment of the buffer. */
406         char tmp[3 * sizeof(num)] __aligned(2);
407         char sign;
408         char locase;
409         int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
410         int i;
411         bool is_zero = num == 0LL;
412         int field_width = spec.field_width;
413         int precision = spec.precision;
414
415         BUILD_BUG_ON(sizeof(struct printf_spec) != 8);
416
417         /* locase = 0 or 0x20. ORing digits or letters with 'locase'
418          * produces same digits or (maybe lowercased) letters */
419         locase = (spec.flags & SMALL);
420         if (spec.flags & LEFT)
421                 spec.flags &= ~ZEROPAD;
422         sign = 0;
423         if (spec.flags & SIGN) {
424                 if ((signed long long)num < 0) {
425                         sign = '-';
426                         num = -(signed long long)num;
427                         field_width--;
428                 } else if (spec.flags & PLUS) {
429                         sign = '+';
430                         field_width--;
431                 } else if (spec.flags & SPACE) {
432                         sign = ' ';
433                         field_width--;
434                 }
435         }
436         if (need_pfx) {
437                 if (spec.base == 16)
438                         field_width -= 2;
439                 else if (!is_zero)
440                         field_width--;
441         }
442
443         /* generate full string in tmp[], in reverse order */
444         i = 0;
445         if (num < spec.base)
446                 tmp[i++] = hex_asc_upper[num] | locase;
447         else if (spec.base != 10) { /* 8 or 16 */
448                 int mask = spec.base - 1;
449                 int shift = 3;
450
451                 if (spec.base == 16)
452                         shift = 4;
453                 do {
454                         tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
455                         num >>= shift;
456                 } while (num);
457         } else { /* base 10 */
458                 i = put_dec(tmp, num) - tmp;
459         }
460
461         /* printing 100 using %2d gives "100", not "00" */
462         if (i > precision)
463                 precision = i;
464         /* leading space padding */
465         field_width -= precision;
466         if (!(spec.flags & (ZEROPAD | LEFT))) {
467                 while (--field_width >= 0) {
468                         if (buf < end)
469                                 *buf = ' ';
470                         ++buf;
471                 }
472         }
473         /* sign */
474         if (sign) {
475                 if (buf < end)
476                         *buf = sign;
477                 ++buf;
478         }
479         /* "0x" / "0" prefix */
480         if (need_pfx) {
481                 if (spec.base == 16 || !is_zero) {
482                         if (buf < end)
483                                 *buf = '0';
484                         ++buf;
485                 }
486                 if (spec.base == 16) {
487                         if (buf < end)
488                                 *buf = ('X' | locase);
489                         ++buf;
490                 }
491         }
492         /* zero or space padding */
493         if (!(spec.flags & LEFT)) {
494                 char c = ' ' + (spec.flags & ZEROPAD);
495                 BUILD_BUG_ON(' ' + ZEROPAD != '0');
496                 while (--field_width >= 0) {
497                         if (buf < end)
498                                 *buf = c;
499                         ++buf;
500                 }
501         }
502         /* hmm even more zero padding? */
503         while (i <= --precision) {
504                 if (buf < end)
505                         *buf = '0';
506                 ++buf;
507         }
508         /* actual digits of result */
509         while (--i >= 0) {
510                 if (buf < end)
511                         *buf = tmp[i];
512                 ++buf;
513         }
514         /* trailing space padding */
515         while (--field_width >= 0) {
516                 if (buf < end)
517                         *buf = ' ';
518                 ++buf;
519         }
520
521         return buf;
522 }
523
524 static noinline_for_stack
525 char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
526 {
527         struct printf_spec spec;
528
529         spec.type = FORMAT_TYPE_PTR;
530         spec.field_width = 2 + 2 * size;        /* 0x + hex */
531         spec.flags = SPECIAL | SMALL | ZEROPAD;
532         spec.base = 16;
533         spec.precision = -1;
534
535         return number(buf, end, num, spec);
536 }
537
538 static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
539 {
540         size_t size;
541         if (buf >= end) /* nowhere to put anything */
542                 return;
543         size = end - buf;
544         if (size <= spaces) {
545                 memset(buf, ' ', size);
546                 return;
547         }
548         if (len) {
549                 if (len > size - spaces)
550                         len = size - spaces;
551                 memmove(buf + spaces, buf, len);
552         }
553         memset(buf, ' ', spaces);
554 }
555
556 /*
557  * Handle field width padding for a string.
558  * @buf: current buffer position
559  * @n: length of string
560  * @end: end of output buffer
561  * @spec: for field width and flags
562  * Returns: new buffer position after padding.
563  */
564 static noinline_for_stack
565 char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
566 {
567         unsigned spaces;
568
569         if (likely(n >= spec.field_width))
570                 return buf;
571         /* we want to pad the sucker */
572         spaces = spec.field_width - n;
573         if (!(spec.flags & LEFT)) {
574                 move_right(buf - n, end, n, spaces);
575                 return buf + spaces;
576         }
577         while (spaces--) {
578                 if (buf < end)
579                         *buf = ' ';
580                 ++buf;
581         }
582         return buf;
583 }
584
585 static noinline_for_stack
586 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
587 {
588         int len = 0;
589         size_t lim = spec.precision;
590
591         if ((unsigned long)s < PAGE_SIZE)
592                 s = "(null)";
593
594         while (lim--) {
595                 char c = *s++;
596                 if (!c)
597                         break;
598                 if (buf < end)
599                         *buf = c;
600                 ++buf;
601                 ++len;
602         }
603         return widen_string(buf, len, end, spec);
604 }
605
606 static noinline_for_stack
607 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
608                   const char *fmt)
609 {
610         const char *array[4], *s;
611         const struct dentry *p;
612         int depth;
613         int i, n;
614
615         switch (fmt[1]) {
616                 case '2': case '3': case '4':
617                         depth = fmt[1] - '0';
618                         break;
619                 default:
620                         depth = 1;
621         }
622
623         rcu_read_lock();
624         for (i = 0; i < depth; i++, d = p) {
625                 p = READ_ONCE(d->d_parent);
626                 array[i] = READ_ONCE(d->d_name.name);
627                 if (p == d) {
628                         if (i)
629                                 array[i] = "";
630                         i++;
631                         break;
632                 }
633         }
634         s = array[--i];
635         for (n = 0; n != spec.precision; n++, buf++) {
636                 char c = *s++;
637                 if (!c) {
638                         if (!i)
639                                 break;
640                         c = '/';
641                         s = array[--i];
642                 }
643                 if (buf < end)
644                         *buf = c;
645         }
646         rcu_read_unlock();
647         return widen_string(buf, n, end, spec);
648 }
649
650 #ifdef CONFIG_BLOCK
651 static noinline_for_stack
652 char *bdev_name(char *buf, char *end, struct block_device *bdev,
653                 struct printf_spec spec, const char *fmt)
654 {
655         struct gendisk *hd = bdev->bd_disk;
656         
657         buf = string(buf, end, hd->disk_name, spec);
658         if (bdev->bd_part->partno) {
659                 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
660                         if (buf < end)
661                                 *buf = 'p';
662                         buf++;
663                 }
664                 buf = number(buf, end, bdev->bd_part->partno, spec);
665         }
666         return buf;
667 }
668 #endif
669
670 static noinline_for_stack
671 char *symbol_string(char *buf, char *end, void *ptr,
672                     struct printf_spec spec, const char *fmt)
673 {
674         unsigned long value;
675 #ifdef CONFIG_KALLSYMS
676         char sym[KSYM_SYMBOL_LEN];
677 #endif
678
679         if (fmt[1] == 'R')
680                 ptr = __builtin_extract_return_addr(ptr);
681         value = (unsigned long)ptr;
682
683 #ifdef CONFIG_KALLSYMS
684         if (*fmt == 'B')
685                 sprint_backtrace(sym, value);
686         else if (*fmt != 'f' && *fmt != 's')
687                 sprint_symbol(sym, value);
688         else
689                 sprint_symbol_no_offset(sym, value);
690
691         return string(buf, end, sym, spec);
692 #else
693         return special_hex_number(buf, end, value, sizeof(void *));
694 #endif
695 }
696
697 static noinline_for_stack
698 char *resource_string(char *buf, char *end, struct resource *res,
699                       struct printf_spec spec, const char *fmt)
700 {
701 #ifndef IO_RSRC_PRINTK_SIZE
702 #define IO_RSRC_PRINTK_SIZE     6
703 #endif
704
705 #ifndef MEM_RSRC_PRINTK_SIZE
706 #define MEM_RSRC_PRINTK_SIZE    10
707 #endif
708         static const struct printf_spec io_spec = {
709                 .base = 16,
710                 .field_width = IO_RSRC_PRINTK_SIZE,
711                 .precision = -1,
712                 .flags = SPECIAL | SMALL | ZEROPAD,
713         };
714         static const struct printf_spec mem_spec = {
715                 .base = 16,
716                 .field_width = MEM_RSRC_PRINTK_SIZE,
717                 .precision = -1,
718                 .flags = SPECIAL | SMALL | ZEROPAD,
719         };
720         static const struct printf_spec bus_spec = {
721                 .base = 16,
722                 .field_width = 2,
723                 .precision = -1,
724                 .flags = SMALL | ZEROPAD,
725         };
726         static const struct printf_spec dec_spec = {
727                 .base = 10,
728                 .precision = -1,
729                 .flags = 0,
730         };
731         static const struct printf_spec str_spec = {
732                 .field_width = -1,
733                 .precision = 10,
734                 .flags = LEFT,
735         };
736         static const struct printf_spec flag_spec = {
737                 .base = 16,
738                 .precision = -1,
739                 .flags = SPECIAL | SMALL,
740         };
741
742         /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
743          * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
744 #define RSRC_BUF_SIZE           ((2 * sizeof(resource_size_t)) + 4)
745 #define FLAG_BUF_SIZE           (2 * sizeof(res->flags))
746 #define DECODED_BUF_SIZE        sizeof("[mem - 64bit pref window disabled]")
747 #define RAW_BUF_SIZE            sizeof("[mem - flags 0x]")
748         char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
749                      2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
750
751         char *p = sym, *pend = sym + sizeof(sym);
752         int decode = (fmt[0] == 'R') ? 1 : 0;
753         const struct printf_spec *specp;
754
755         *p++ = '[';
756         if (res->flags & IORESOURCE_IO) {
757                 p = string(p, pend, "io  ", str_spec);
758                 specp = &io_spec;
759         } else if (res->flags & IORESOURCE_MEM) {
760                 p = string(p, pend, "mem ", str_spec);
761                 specp = &mem_spec;
762         } else if (res->flags & IORESOURCE_IRQ) {
763                 p = string(p, pend, "irq ", str_spec);
764                 specp = &dec_spec;
765         } else if (res->flags & IORESOURCE_DMA) {
766                 p = string(p, pend, "dma ", str_spec);
767                 specp = &dec_spec;
768         } else if (res->flags & IORESOURCE_BUS) {
769                 p = string(p, pend, "bus ", str_spec);
770                 specp = &bus_spec;
771         } else {
772                 p = string(p, pend, "??? ", str_spec);
773                 specp = &mem_spec;
774                 decode = 0;
775         }
776         if (decode && res->flags & IORESOURCE_UNSET) {
777                 p = string(p, pend, "size ", str_spec);
778                 p = number(p, pend, resource_size(res), *specp);
779         } else {
780                 p = number(p, pend, res->start, *specp);
781                 if (res->start != res->end) {
782                         *p++ = '-';
783                         p = number(p, pend, res->end, *specp);
784                 }
785         }
786         if (decode) {
787                 if (res->flags & IORESOURCE_MEM_64)
788                         p = string(p, pend, " 64bit", str_spec);
789                 if (res->flags & IORESOURCE_PREFETCH)
790                         p = string(p, pend, " pref", str_spec);
791                 if (res->flags & IORESOURCE_WINDOW)
792                         p = string(p, pend, " window", str_spec);
793                 if (res->flags & IORESOURCE_DISABLED)
794                         p = string(p, pend, " disabled", str_spec);
795         } else {
796                 p = string(p, pend, " flags ", str_spec);
797                 p = number(p, pend, res->flags, flag_spec);
798         }
799         *p++ = ']';
800         *p = '\0';
801
802         return string(buf, end, sym, spec);
803 }
804
805 static noinline_for_stack
806 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
807                  const char *fmt)
808 {
809         int i, len = 1;         /* if we pass '%ph[CDN]', field width remains
810                                    negative value, fallback to the default */
811         char separator;
812
813         if (spec.field_width == 0)
814                 /* nothing to print */
815                 return buf;
816
817         if (ZERO_OR_NULL_PTR(addr))
818                 /* NULL pointer */
819                 return string(buf, end, NULL, spec);
820
821         switch (fmt[1]) {
822         case 'C':
823                 separator = ':';
824                 break;
825         case 'D':
826                 separator = '-';
827                 break;
828         case 'N':
829                 separator = 0;
830                 break;
831         default:
832                 separator = ' ';
833                 break;
834         }
835
836         if (spec.field_width > 0)
837                 len = min_t(int, spec.field_width, 64);
838
839         for (i = 0; i < len; ++i) {
840                 if (buf < end)
841                         *buf = hex_asc_hi(addr[i]);
842                 ++buf;
843                 if (buf < end)
844                         *buf = hex_asc_lo(addr[i]);
845                 ++buf;
846
847                 if (separator && i != len - 1) {
848                         if (buf < end)
849                                 *buf = separator;
850                         ++buf;
851                 }
852         }
853
854         return buf;
855 }
856
857 static noinline_for_stack
858 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
859                     struct printf_spec spec, const char *fmt)
860 {
861         const int CHUNKSZ = 32;
862         int nr_bits = max_t(int, spec.field_width, 0);
863         int i, chunksz;
864         bool first = true;
865
866         /* reused to print numbers */
867         spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
868
869         chunksz = nr_bits & (CHUNKSZ - 1);
870         if (chunksz == 0)
871                 chunksz = CHUNKSZ;
872
873         i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
874         for (; i >= 0; i -= CHUNKSZ) {
875                 u32 chunkmask, val;
876                 int word, bit;
877
878                 chunkmask = ((1ULL << chunksz) - 1);
879                 word = i / BITS_PER_LONG;
880                 bit = i % BITS_PER_LONG;
881                 val = (bitmap[word] >> bit) & chunkmask;
882
883                 if (!first) {
884                         if (buf < end)
885                                 *buf = ',';
886                         buf++;
887                 }
888                 first = false;
889
890                 spec.field_width = DIV_ROUND_UP(chunksz, 4);
891                 buf = number(buf, end, val, spec);
892
893                 chunksz = CHUNKSZ;
894         }
895         return buf;
896 }
897
898 static noinline_for_stack
899 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
900                          struct printf_spec spec, const char *fmt)
901 {
902         int nr_bits = max_t(int, spec.field_width, 0);
903         /* current bit is 'cur', most recently seen range is [rbot, rtop] */
904         int cur, rbot, rtop;
905         bool first = true;
906
907         /* reused to print numbers */
908         spec = (struct printf_spec){ .base = 10 };
909
910         rbot = cur = find_first_bit(bitmap, nr_bits);
911         while (cur < nr_bits) {
912                 rtop = cur;
913                 cur = find_next_bit(bitmap, nr_bits, cur + 1);
914                 if (cur < nr_bits && cur <= rtop + 1)
915                         continue;
916
917                 if (!first) {
918                         if (buf < end)
919                                 *buf = ',';
920                         buf++;
921                 }
922                 first = false;
923
924                 buf = number(buf, end, rbot, spec);
925                 if (rbot < rtop) {
926                         if (buf < end)
927                                 *buf = '-';
928                         buf++;
929
930                         buf = number(buf, end, rtop, spec);
931                 }
932
933                 rbot = cur;
934         }
935         return buf;
936 }
937
938 static noinline_for_stack
939 char *mac_address_string(char *buf, char *end, u8 *addr,
940                          struct printf_spec spec, const char *fmt)
941 {
942         char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
943         char *p = mac_addr;
944         int i;
945         char separator;
946         bool reversed = false;
947
948         switch (fmt[1]) {
949         case 'F':
950                 separator = '-';
951                 break;
952
953         case 'R':
954                 reversed = true;
955                 /* fall through */
956
957         default:
958                 separator = ':';
959                 break;
960         }
961
962         for (i = 0; i < 6; i++) {
963                 if (reversed)
964                         p = hex_byte_pack(p, addr[5 - i]);
965                 else
966                         p = hex_byte_pack(p, addr[i]);
967
968                 if (fmt[0] == 'M' && i != 5)
969                         *p++ = separator;
970         }
971         *p = '\0';
972
973         return string(buf, end, mac_addr, spec);
974 }
975
976 static noinline_for_stack
977 char *ip4_string(char *p, const u8 *addr, const char *fmt)
978 {
979         int i;
980         bool leading_zeros = (fmt[0] == 'i');
981         int index;
982         int step;
983
984         switch (fmt[2]) {
985         case 'h':
986 #ifdef __BIG_ENDIAN
987                 index = 0;
988                 step = 1;
989 #else
990                 index = 3;
991                 step = -1;
992 #endif
993                 break;
994         case 'l':
995                 index = 3;
996                 step = -1;
997                 break;
998         case 'n':
999         case 'b':
1000         default:
1001                 index = 0;
1002                 step = 1;
1003                 break;
1004         }
1005         for (i = 0; i < 4; i++) {
1006                 char temp[4] __aligned(2);      /* hold each IP quad in reverse order */
1007                 int digits = put_dec_trunc8(temp, addr[index]) - temp;
1008                 if (leading_zeros) {
1009                         if (digits < 3)
1010                                 *p++ = '0';
1011                         if (digits < 2)
1012                                 *p++ = '0';
1013                 }
1014                 /* reverse the digits in the quad */
1015                 while (digits--)
1016                         *p++ = temp[digits];
1017                 if (i < 3)
1018                         *p++ = '.';
1019                 index += step;
1020         }
1021         *p = '\0';
1022
1023         return p;
1024 }
1025
1026 static noinline_for_stack
1027 char *ip6_compressed_string(char *p, const char *addr)
1028 {
1029         int i, j, range;
1030         unsigned char zerolength[8];
1031         int longest = 1;
1032         int colonpos = -1;
1033         u16 word;
1034         u8 hi, lo;
1035         bool needcolon = false;
1036         bool useIPv4;
1037         struct in6_addr in6;
1038
1039         memcpy(&in6, addr, sizeof(struct in6_addr));
1040
1041         useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1042
1043         memset(zerolength, 0, sizeof(zerolength));
1044
1045         if (useIPv4)
1046                 range = 6;
1047         else
1048                 range = 8;
1049
1050         /* find position of longest 0 run */
1051         for (i = 0; i < range; i++) {
1052                 for (j = i; j < range; j++) {
1053                         if (in6.s6_addr16[j] != 0)
1054                                 break;
1055                         zerolength[i]++;
1056                 }
1057         }
1058         for (i = 0; i < range; i++) {
1059                 if (zerolength[i] > longest) {
1060                         longest = zerolength[i];
1061                         colonpos = i;
1062                 }
1063         }
1064         if (longest == 1)               /* don't compress a single 0 */
1065                 colonpos = -1;
1066
1067         /* emit address */
1068         for (i = 0; i < range; i++) {
1069                 if (i == colonpos) {
1070                         if (needcolon || i == 0)
1071                                 *p++ = ':';
1072                         *p++ = ':';
1073                         needcolon = false;
1074                         i += longest - 1;
1075                         continue;
1076                 }
1077                 if (needcolon) {
1078                         *p++ = ':';
1079                         needcolon = false;
1080                 }
1081                 /* hex u16 without leading 0s */
1082                 word = ntohs(in6.s6_addr16[i]);
1083                 hi = word >> 8;
1084                 lo = word & 0xff;
1085                 if (hi) {
1086                         if (hi > 0x0f)
1087                                 p = hex_byte_pack(p, hi);
1088                         else
1089                                 *p++ = hex_asc_lo(hi);
1090                         p = hex_byte_pack(p, lo);
1091                 }
1092                 else if (lo > 0x0f)
1093                         p = hex_byte_pack(p, lo);
1094                 else
1095                         *p++ = hex_asc_lo(lo);
1096                 needcolon = true;
1097         }
1098
1099         if (useIPv4) {
1100                 if (needcolon)
1101                         *p++ = ':';
1102                 p = ip4_string(p, &in6.s6_addr[12], "I4");
1103         }
1104         *p = '\0';
1105
1106         return p;
1107 }
1108
1109 static noinline_for_stack
1110 char *ip6_string(char *p, const char *addr, const char *fmt)
1111 {
1112         int i;
1113
1114         for (i = 0; i < 8; i++) {
1115                 p = hex_byte_pack(p, *addr++);
1116                 p = hex_byte_pack(p, *addr++);
1117                 if (fmt[0] == 'I' && i != 7)
1118                         *p++ = ':';
1119         }
1120         *p = '\0';
1121
1122         return p;
1123 }
1124
1125 static noinline_for_stack
1126 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1127                       struct printf_spec spec, const char *fmt)
1128 {
1129         char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1130
1131         if (fmt[0] == 'I' && fmt[2] == 'c')
1132                 ip6_compressed_string(ip6_addr, addr);
1133         else
1134                 ip6_string(ip6_addr, addr, fmt);
1135
1136         return string(buf, end, ip6_addr, spec);
1137 }
1138
1139 static noinline_for_stack
1140 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1141                       struct printf_spec spec, const char *fmt)
1142 {
1143         char ip4_addr[sizeof("255.255.255.255")];
1144
1145         ip4_string(ip4_addr, addr, fmt);
1146
1147         return string(buf, end, ip4_addr, spec);
1148 }
1149
1150 static noinline_for_stack
1151 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1152                          struct printf_spec spec, const char *fmt)
1153 {
1154         bool have_p = false, have_s = false, have_f = false, have_c = false;
1155         char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1156                       sizeof(":12345") + sizeof("/123456789") +
1157                       sizeof("%1234567890")];
1158         char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1159         const u8 *addr = (const u8 *) &sa->sin6_addr;
1160         char fmt6[2] = { fmt[0], '6' };
1161         u8 off = 0;
1162
1163         fmt++;
1164         while (isalpha(*++fmt)) {
1165                 switch (*fmt) {
1166                 case 'p':
1167                         have_p = true;
1168                         break;
1169                 case 'f':
1170                         have_f = true;
1171                         break;
1172                 case 's':
1173                         have_s = true;
1174                         break;
1175                 case 'c':
1176                         have_c = true;
1177                         break;
1178                 }
1179         }
1180
1181         if (have_p || have_s || have_f) {
1182                 *p = '[';
1183                 off = 1;
1184         }
1185
1186         if (fmt6[0] == 'I' && have_c)
1187                 p = ip6_compressed_string(ip6_addr + off, addr);
1188         else
1189                 p = ip6_string(ip6_addr + off, addr, fmt6);
1190
1191         if (have_p || have_s || have_f)
1192                 *p++ = ']';
1193
1194         if (have_p) {
1195                 *p++ = ':';
1196                 p = number(p, pend, ntohs(sa->sin6_port), spec);
1197         }
1198         if (have_f) {
1199                 *p++ = '/';
1200                 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1201                                           IPV6_FLOWINFO_MASK), spec);
1202         }
1203         if (have_s) {
1204                 *p++ = '%';
1205                 p = number(p, pend, sa->sin6_scope_id, spec);
1206         }
1207         *p = '\0';
1208
1209         return string(buf, end, ip6_addr, spec);
1210 }
1211
1212 static noinline_for_stack
1213 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1214                          struct printf_spec spec, const char *fmt)
1215 {
1216         bool have_p = false;
1217         char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1218         char *pend = ip4_addr + sizeof(ip4_addr);
1219         const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1220         char fmt4[3] = { fmt[0], '4', 0 };
1221
1222         fmt++;
1223         while (isalpha(*++fmt)) {
1224                 switch (*fmt) {
1225                 case 'p':
1226                         have_p = true;
1227                         break;
1228                 case 'h':
1229                 case 'l':
1230                 case 'n':
1231                 case 'b':
1232                         fmt4[2] = *fmt;
1233                         break;
1234                 }
1235         }
1236
1237         p = ip4_string(ip4_addr, addr, fmt4);
1238         if (have_p) {
1239                 *p++ = ':';
1240                 p = number(p, pend, ntohs(sa->sin_port), spec);
1241         }
1242         *p = '\0';
1243
1244         return string(buf, end, ip4_addr, spec);
1245 }
1246
1247 static noinline_for_stack
1248 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1249                      const char *fmt)
1250 {
1251         bool found = true;
1252         int count = 1;
1253         unsigned int flags = 0;
1254         int len;
1255
1256         if (spec.field_width == 0)
1257                 return buf;                             /* nothing to print */
1258
1259         if (ZERO_OR_NULL_PTR(addr))
1260                 return string(buf, end, NULL, spec);    /* NULL pointer */
1261
1262
1263         do {
1264                 switch (fmt[count++]) {
1265                 case 'a':
1266                         flags |= ESCAPE_ANY;
1267                         break;
1268                 case 'c':
1269                         flags |= ESCAPE_SPECIAL;
1270                         break;
1271                 case 'h':
1272                         flags |= ESCAPE_HEX;
1273                         break;
1274                 case 'n':
1275                         flags |= ESCAPE_NULL;
1276                         break;
1277                 case 'o':
1278                         flags |= ESCAPE_OCTAL;
1279                         break;
1280                 case 'p':
1281                         flags |= ESCAPE_NP;
1282                         break;
1283                 case 's':
1284                         flags |= ESCAPE_SPACE;
1285                         break;
1286                 default:
1287                         found = false;
1288                         break;
1289                 }
1290         } while (found);
1291
1292         if (!flags)
1293                 flags = ESCAPE_ANY_NP;
1294
1295         len = spec.field_width < 0 ? 1 : spec.field_width;
1296
1297         /*
1298          * string_escape_mem() writes as many characters as it can to
1299          * the given buffer, and returns the total size of the output
1300          * had the buffer been big enough.
1301          */
1302         buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1303
1304         return buf;
1305 }
1306
1307 static noinline_for_stack
1308 char *uuid_string(char *buf, char *end, const u8 *addr,
1309                   struct printf_spec spec, const char *fmt)
1310 {
1311         char uuid[UUID_STRING_LEN + 1];
1312         char *p = uuid;
1313         int i;
1314         const u8 *index = uuid_index;
1315         bool uc = false;
1316
1317         switch (*(++fmt)) {
1318         case 'L':
1319                 uc = true;              /* fall-through */
1320         case 'l':
1321                 index = guid_index;
1322                 break;
1323         case 'B':
1324                 uc = true;
1325                 break;
1326         }
1327
1328         for (i = 0; i < 16; i++) {
1329                 if (uc)
1330                         p = hex_byte_pack_upper(p, addr[index[i]]);
1331                 else
1332                         p = hex_byte_pack(p, addr[index[i]]);
1333                 switch (i) {
1334                 case 3:
1335                 case 5:
1336                 case 7:
1337                 case 9:
1338                         *p++ = '-';
1339                         break;
1340                 }
1341         }
1342
1343         *p = 0;
1344
1345         return string(buf, end, uuid, spec);
1346 }
1347
1348 int kptr_restrict __read_mostly;
1349
1350 static noinline_for_stack
1351 char *restricted_pointer(char *buf, char *end, const void *ptr,
1352                          struct printf_spec spec)
1353 {
1354         spec.base = 16;
1355         spec.flags |= SMALL;
1356         if (spec.field_width == -1) {
1357                 spec.field_width = 2 * sizeof(ptr);
1358                 spec.flags |= ZEROPAD;
1359         }
1360
1361         switch (kptr_restrict) {
1362         case 0:
1363                 /* Always print %pK values */
1364                 break;
1365         case 1: {
1366                 const struct cred *cred;
1367
1368                 /*
1369                  * kptr_restrict==1 cannot be used in IRQ context
1370                  * because its test for CAP_SYSLOG would be meaningless.
1371                  */
1372                 if (in_irq() || in_serving_softirq() || in_nmi())
1373                         return string(buf, end, "pK-error", spec);
1374
1375                 /*
1376                  * Only print the real pointer value if the current
1377                  * process has CAP_SYSLOG and is running with the
1378                  * same credentials it started with. This is because
1379                  * access to files is checked at open() time, but %pK
1380                  * checks permission at read() time. We don't want to
1381                  * leak pointer values if a binary opens a file using
1382                  * %pK and then elevates privileges before reading it.
1383                  */
1384                 cred = current_cred();
1385                 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1386                     !uid_eq(cred->euid, cred->uid) ||
1387                     !gid_eq(cred->egid, cred->gid))
1388                         ptr = NULL;
1389                 break;
1390         }
1391         case 2:
1392         default:
1393                 /* Always print 0's for %pK */
1394                 ptr = NULL;
1395                 break;
1396         }
1397
1398         return number(buf, end, (unsigned long)ptr, spec);
1399 }
1400
1401 static noinline_for_stack
1402 char *netdev_bits(char *buf, char *end, const void *addr, const char *fmt)
1403 {
1404         unsigned long long num;
1405         int size;
1406
1407         switch (fmt[1]) {
1408         case 'F':
1409                 num = *(const netdev_features_t *)addr;
1410                 size = sizeof(netdev_features_t);
1411                 break;
1412         default:
1413                 num = (unsigned long)addr;
1414                 size = sizeof(unsigned long);
1415                 break;
1416         }
1417
1418         return special_hex_number(buf, end, num, size);
1419 }
1420
1421 static noinline_for_stack
1422 char *address_val(char *buf, char *end, const void *addr, const char *fmt)
1423 {
1424         unsigned long long num;
1425         int size;
1426
1427         switch (fmt[1]) {
1428         case 'd':
1429                 num = *(const dma_addr_t *)addr;
1430                 size = sizeof(dma_addr_t);
1431                 break;
1432         case 'p':
1433         default:
1434                 num = *(const phys_addr_t *)addr;
1435                 size = sizeof(phys_addr_t);
1436                 break;
1437         }
1438
1439         return special_hex_number(buf, end, num, size);
1440 }
1441
1442 static noinline_for_stack
1443 char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1444             const char *fmt)
1445 {
1446         if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1447                 return string(buf, end, NULL, spec);
1448
1449         switch (fmt[1]) {
1450         case 'r':
1451                 return number(buf, end, clk_get_rate(clk), spec);
1452
1453         case 'n':
1454         default:
1455 #ifdef CONFIG_COMMON_CLK
1456                 return string(buf, end, __clk_get_name(clk), spec);
1457 #else
1458                 return special_hex_number(buf, end, (unsigned long)clk, sizeof(unsigned long));
1459 #endif
1460         }
1461 }
1462
1463 static
1464 char *format_flags(char *buf, char *end, unsigned long flags,
1465                                         const struct trace_print_flags *names)
1466 {
1467         unsigned long mask;
1468         const struct printf_spec strspec = {
1469                 .field_width = -1,
1470                 .precision = -1,
1471         };
1472         const struct printf_spec numspec = {
1473                 .flags = SPECIAL|SMALL,
1474                 .field_width = -1,
1475                 .precision = -1,
1476                 .base = 16,
1477         };
1478
1479         for ( ; flags && names->name; names++) {
1480                 mask = names->mask;
1481                 if ((flags & mask) != mask)
1482                         continue;
1483
1484                 buf = string(buf, end, names->name, strspec);
1485
1486                 flags &= ~mask;
1487                 if (flags) {
1488                         if (buf < end)
1489                                 *buf = '|';
1490                         buf++;
1491                 }
1492         }
1493
1494         if (flags)
1495                 buf = number(buf, end, flags, numspec);
1496
1497         return buf;
1498 }
1499
1500 static noinline_for_stack
1501 char *flags_string(char *buf, char *end, void *flags_ptr, const char *fmt)
1502 {
1503         unsigned long flags;
1504         const struct trace_print_flags *names;
1505
1506         switch (fmt[1]) {
1507         case 'p':
1508                 flags = *(unsigned long *)flags_ptr;
1509                 /* Remove zone id */
1510                 flags &= (1UL << NR_PAGEFLAGS) - 1;
1511                 names = pageflag_names;
1512                 break;
1513         case 'v':
1514                 flags = *(unsigned long *)flags_ptr;
1515                 names = vmaflag_names;
1516                 break;
1517         case 'g':
1518                 flags = *(gfp_t *)flags_ptr;
1519                 names = gfpflag_names;
1520                 break;
1521         default:
1522                 WARN_ONCE(1, "Unsupported flags modifier: %c\n", fmt[1]);
1523                 return buf;
1524         }
1525
1526         return format_flags(buf, end, flags, names);
1527 }
1528
1529 static const char *device_node_name_for_depth(const struct device_node *np, int depth)
1530 {
1531         for ( ; np && depth; depth--)
1532                 np = np->parent;
1533
1534         return kbasename(np->full_name);
1535 }
1536
1537 static noinline_for_stack
1538 char *device_node_gen_full_name(const struct device_node *np, char *buf, char *end)
1539 {
1540         int depth;
1541         const struct device_node *parent = np->parent;
1542         static const struct printf_spec strspec = {
1543                 .field_width = -1,
1544                 .precision = -1,
1545         };
1546
1547         /* special case for root node */
1548         if (!parent)
1549                 return string(buf, end, "/", strspec);
1550
1551         for (depth = 0; parent->parent; depth++)
1552                 parent = parent->parent;
1553
1554         for ( ; depth >= 0; depth--) {
1555                 buf = string(buf, end, "/", strspec);
1556                 buf = string(buf, end, device_node_name_for_depth(np, depth),
1557                              strspec);
1558         }
1559         return buf;
1560 }
1561
1562 static noinline_for_stack
1563 char *device_node_string(char *buf, char *end, struct device_node *dn,
1564                          struct printf_spec spec, const char *fmt)
1565 {
1566         char tbuf[sizeof("xxxx") + 1];
1567         const char *p;
1568         int ret;
1569         char *buf_start = buf;
1570         struct property *prop;
1571         bool has_mult, pass;
1572         static const struct printf_spec num_spec = {
1573                 .flags = SMALL,
1574                 .field_width = -1,
1575                 .precision = -1,
1576                 .base = 10,
1577         };
1578
1579         struct printf_spec str_spec = spec;
1580         str_spec.field_width = -1;
1581
1582         if (!IS_ENABLED(CONFIG_OF))
1583                 return string(buf, end, "(!OF)", spec);
1584
1585         if ((unsigned long)dn < PAGE_SIZE)
1586                 return string(buf, end, "(null)", spec);
1587
1588         /* simple case without anything any more format specifiers */
1589         fmt++;
1590         if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
1591                 fmt = "f";
1592
1593         for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
1594                 if (pass) {
1595                         if (buf < end)
1596                                 *buf = ':';
1597                         buf++;
1598                 }
1599
1600                 switch (*fmt) {
1601                 case 'f':       /* full_name */
1602                         buf = device_node_gen_full_name(dn, buf, end);
1603                         break;
1604                 case 'n':       /* name */
1605                         buf = string(buf, end, dn->name, str_spec);
1606                         break;
1607                 case 'p':       /* phandle */
1608                         buf = number(buf, end, (unsigned int)dn->phandle, num_spec);
1609                         break;
1610                 case 'P':       /* path-spec */
1611                         p = kbasename(of_node_full_name(dn));
1612                         if (!p[1])
1613                                 p = "/";
1614                         buf = string(buf, end, p, str_spec);
1615                         break;
1616                 case 'F':       /* flags */
1617                         tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
1618                         tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
1619                         tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
1620                         tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
1621                         tbuf[4] = 0;
1622                         buf = string(buf, end, tbuf, str_spec);
1623                         break;
1624                 case 'c':       /* major compatible string */
1625                         ret = of_property_read_string(dn, "compatible", &p);
1626                         if (!ret)
1627                                 buf = string(buf, end, p, str_spec);
1628                         break;
1629                 case 'C':       /* full compatible string */
1630                         has_mult = false;
1631                         of_property_for_each_string(dn, "compatible", prop, p) {
1632                                 if (has_mult)
1633                                         buf = string(buf, end, ",", str_spec);
1634                                 buf = string(buf, end, "\"", str_spec);
1635                                 buf = string(buf, end, p, str_spec);
1636                                 buf = string(buf, end, "\"", str_spec);
1637
1638                                 has_mult = true;
1639                         }
1640                         break;
1641                 default:
1642                         break;
1643                 }
1644         }
1645
1646         return widen_string(buf, buf - buf_start, end, spec);
1647 }
1648
1649 static noinline_for_stack
1650 char *pointer_string(char *buf, char *end, const void *ptr,
1651                      struct printf_spec spec)
1652 {
1653         spec.base = 16;
1654         spec.flags |= SMALL;
1655         if (spec.field_width == -1) {
1656                 spec.field_width = 2 * sizeof(ptr);
1657                 spec.flags |= ZEROPAD;
1658         }
1659
1660         return number(buf, end, (unsigned long int)ptr, spec);
1661 }
1662
1663 static bool have_filled_random_ptr_key __read_mostly;
1664 static siphash_key_t ptr_key __read_mostly;
1665
1666 static void fill_random_ptr_key(struct random_ready_callback *unused)
1667 {
1668         get_random_bytes(&ptr_key, sizeof(ptr_key));
1669         /*
1670          * have_filled_random_ptr_key==true is dependent on get_random_bytes().
1671          * ptr_to_id() needs to see have_filled_random_ptr_key==true
1672          * after get_random_bytes() returns.
1673          */
1674         smp_mb();
1675         WRITE_ONCE(have_filled_random_ptr_key, true);
1676 }
1677
1678 static struct random_ready_callback random_ready = {
1679         .func = fill_random_ptr_key
1680 };
1681
1682 static int __init initialize_ptr_random(void)
1683 {
1684         int ret = add_random_ready_callback(&random_ready);
1685
1686         if (!ret) {
1687                 return 0;
1688         } else if (ret == -EALREADY) {
1689                 fill_random_ptr_key(&random_ready);
1690                 return 0;
1691         }
1692
1693         return ret;
1694 }
1695 early_initcall(initialize_ptr_random);
1696
1697 /* Maps a pointer to a 32 bit unique identifier. */
1698 static char *ptr_to_id(char *buf, char *end, void *ptr, struct printf_spec spec)
1699 {
1700         unsigned long hashval;
1701         const int default_width = 2 * sizeof(ptr);
1702
1703         if (unlikely(!have_filled_random_ptr_key)) {
1704                 spec.field_width = default_width;
1705                 /* string length must be less than default_width */
1706                 return string(buf, end, "(ptrval)", spec);
1707         }
1708
1709 #ifdef CONFIG_64BIT
1710         hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
1711         /*
1712          * Mask off the first 32 bits, this makes explicit that we have
1713          * modified the address (and 32 bits is plenty for a unique ID).
1714          */
1715         hashval = hashval & 0xffffffff;
1716 #else
1717         hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
1718 #endif
1719
1720         spec.flags |= SMALL;
1721         if (spec.field_width == -1) {
1722                 spec.field_width = default_width;
1723                 spec.flags |= ZEROPAD;
1724         }
1725         spec.base = 16;
1726
1727         return number(buf, end, hashval, spec);
1728 }
1729
1730 /*
1731  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
1732  * by an extra set of alphanumeric characters that are extended format
1733  * specifiers.
1734  *
1735  * Please update scripts/checkpatch.pl when adding/removing conversion
1736  * characters.  (Search for "check for vsprintf extension").
1737  *
1738  * Right now we handle:
1739  *
1740  * - 'F' For symbolic function descriptor pointers with offset
1741  * - 'f' For simple symbolic function names without offset
1742  * - 'S' For symbolic direct pointers with offset
1743  * - 's' For symbolic direct pointers without offset
1744  * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1745  * - 'B' For backtraced symbolic direct pointers with offset
1746  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1747  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1748  * - 'b[l]' For a bitmap, the number of bits is determined by the field
1749  *       width which must be explicitly specified either as part of the
1750  *       format string '%32b[l]' or through '%*b[l]', [l] selects
1751  *       range-list format instead of hex format
1752  * - 'M' For a 6-byte MAC address, it prints the address in the
1753  *       usual colon-separated hex notation
1754  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1755  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1756  *       with a dash-separated hex notation
1757  * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1758  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1759  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1760  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
1761  *       [S][pfs]
1762  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1763  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1764  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1765  *       IPv6 omits the colons (01020304...0f)
1766  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1767  *       [S][pfs]
1768  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1769  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1770  * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1771  * - 'I[6S]c' for IPv6 addresses printed as specified by
1772  *       http://tools.ietf.org/html/rfc5952
1773  * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1774  *                of the following flags (see string_escape_mem() for the
1775  *                details):
1776  *                  a - ESCAPE_ANY
1777  *                  c - ESCAPE_SPECIAL
1778  *                  h - ESCAPE_HEX
1779  *                  n - ESCAPE_NULL
1780  *                  o - ESCAPE_OCTAL
1781  *                  p - ESCAPE_NP
1782  *                  s - ESCAPE_SPACE
1783  *                By default ESCAPE_ANY_NP is used.
1784  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1785  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1786  *       Options for %pU are:
1787  *         b big endian lower case hex (default)
1788  *         B big endian UPPER case hex
1789  *         l little endian lower case hex
1790  *         L little endian UPPER case hex
1791  *           big endian output byte order is:
1792  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1793  *           little endian output byte order is:
1794  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1795  * - 'V' For a struct va_format which contains a format string * and va_list *,
1796  *       call vsnprintf(->format, *->va_list).
1797  *       Implements a "recursive vsnprintf".
1798  *       Do not use this feature without some mechanism to verify the
1799  *       correctness of the format string and va_list arguments.
1800  * - 'K' For a kernel pointer that should be hidden from unprivileged users
1801  * - 'NF' For a netdev_features_t
1802  * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1803  *            a certain separator (' ' by default):
1804  *              C colon
1805  *              D dash
1806  *              N no separator
1807  *            The maximum supported length is 64 bytes of the input. Consider
1808  *            to use print_hex_dump() for the larger input.
1809  * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1810  *           (default assumed to be phys_addr_t, passed by reference)
1811  * - 'd[234]' For a dentry name (optionally 2-4 last components)
1812  * - 'D[234]' Same as 'd' but for a struct file
1813  * - 'g' For block_device name (gendisk + partition number)
1814  * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1815  *       (legacy clock framework) of the clock
1816  * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1817  *        (legacy clock framework) of the clock
1818  * - 'Cr' For a clock, it prints the current rate of the clock
1819  * - 'G' For flags to be printed as a collection of symbolic strings that would
1820  *       construct the specific value. Supported flags given by option:
1821  *       p page flags (see struct page) given as pointer to unsigned long
1822  *       g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
1823  *       v vma flags (VM_*) given as pointer to unsigned long
1824  * - 'O' For a kobject based struct. Must be one of the following:
1825  *       - 'OF[fnpPcCF]'  For a device tree object
1826  *                        Without any optional arguments prints the full_name
1827  *                        f device node full_name
1828  *                        n device node name
1829  *                        p device node phandle
1830  *                        P device node path spec (name + @unit)
1831  *                        F device node flags
1832  *                        c major compatible string
1833  *                        C full compatible string
1834  *
1835  * - 'x' For printing the address. Equivalent to "%lx".
1836  *
1837  * ** Please update also Documentation/printk-formats.txt when making changes **
1838  *
1839  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1840  * function pointers are really function descriptors, which contain a
1841  * pointer to the real address.
1842  *
1843  * Note: The default behaviour (unadorned %p) is to hash the address,
1844  * rendering it useful as a unique identifier.
1845  */
1846 static noinline_for_stack
1847 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1848               struct printf_spec spec)
1849 {
1850         const int default_width = 2 * sizeof(void *);
1851
1852         if (!ptr && *fmt != 'K') {
1853                 /*
1854                  * Print (null) with the same width as a pointer so it makes
1855                  * tabular output look nice.
1856                  */
1857                 if (spec.field_width == -1)
1858                         spec.field_width = default_width;
1859                 return string(buf, end, "(null)", spec);
1860         }
1861
1862         switch (*fmt) {
1863         case 'F':
1864         case 'f':
1865                 ptr = dereference_function_descriptor(ptr);
1866                 /* Fallthrough */
1867         case 'S':
1868         case 's':
1869         case 'B':
1870                 return symbol_string(buf, end, ptr, spec, fmt);
1871         case 'R':
1872         case 'r':
1873                 return resource_string(buf, end, ptr, spec, fmt);
1874         case 'h':
1875                 return hex_string(buf, end, ptr, spec, fmt);
1876         case 'b':
1877                 switch (fmt[1]) {
1878                 case 'l':
1879                         return bitmap_list_string(buf, end, ptr, spec, fmt);
1880                 default:
1881                         return bitmap_string(buf, end, ptr, spec, fmt);
1882                 }
1883         case 'M':                       /* Colon separated: 00:01:02:03:04:05 */
1884         case 'm':                       /* Contiguous: 000102030405 */
1885                                         /* [mM]F (FDDI) */
1886                                         /* [mM]R (Reverse order; Bluetooth) */
1887                 return mac_address_string(buf, end, ptr, spec, fmt);
1888         case 'I':                       /* Formatted IP supported
1889                                          * 4:   1.2.3.4
1890                                          * 6:   0001:0203:...:0708
1891                                          * 6c:  1::708 or 1::1.2.3.4
1892                                          */
1893         case 'i':                       /* Contiguous:
1894                                          * 4:   001.002.003.004
1895                                          * 6:   000102...0f
1896                                          */
1897                 switch (fmt[1]) {
1898                 case '6':
1899                         return ip6_addr_string(buf, end, ptr, spec, fmt);
1900                 case '4':
1901                         return ip4_addr_string(buf, end, ptr, spec, fmt);
1902                 case 'S': {
1903                         const union {
1904                                 struct sockaddr         raw;
1905                                 struct sockaddr_in      v4;
1906                                 struct sockaddr_in6     v6;
1907                         } *sa = ptr;
1908
1909                         switch (sa->raw.sa_family) {
1910                         case AF_INET:
1911                                 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1912                         case AF_INET6:
1913                                 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1914                         default:
1915                                 return string(buf, end, "(invalid address)", spec);
1916                         }}
1917                 }
1918                 break;
1919         case 'E':
1920                 return escaped_string(buf, end, ptr, spec, fmt);
1921         case 'U':
1922                 return uuid_string(buf, end, ptr, spec, fmt);
1923         case 'V':
1924                 {
1925                         va_list va;
1926
1927                         va_copy(va, *((struct va_format *)ptr)->va);
1928                         buf += vsnprintf(buf, end > buf ? end - buf : 0,
1929                                          ((struct va_format *)ptr)->fmt, va);
1930                         va_end(va);
1931                         return buf;
1932                 }
1933         case 'K':
1934                 return restricted_pointer(buf, end, ptr, spec);
1935         case 'N':
1936                 return netdev_bits(buf, end, ptr, fmt);
1937         case 'a':
1938                 return address_val(buf, end, ptr, fmt);
1939         case 'd':
1940                 return dentry_name(buf, end, ptr, spec, fmt);
1941         case 'C':
1942                 return clock(buf, end, ptr, spec, fmt);
1943         case 'D':
1944                 return dentry_name(buf, end,
1945                                    ((const struct file *)ptr)->f_path.dentry,
1946                                    spec, fmt);
1947 #ifdef CONFIG_BLOCK
1948         case 'g':
1949                 return bdev_name(buf, end, ptr, spec, fmt);
1950 #endif
1951
1952         case 'G':
1953                 return flags_string(buf, end, ptr, fmt);
1954         case 'O':
1955                 switch (fmt[1]) {
1956                 case 'F':
1957                         return device_node_string(buf, end, ptr, spec, fmt + 1);
1958                 }
1959         case 'x':
1960                 return pointer_string(buf, end, ptr, spec);
1961         }
1962
1963         /* default is to _not_ leak addresses, hash before printing */
1964         return ptr_to_id(buf, end, ptr, spec);
1965 }
1966
1967 /*
1968  * Helper function to decode printf style format.
1969  * Each call decode a token from the format and return the
1970  * number of characters read (or likely the delta where it wants
1971  * to go on the next call).
1972  * The decoded token is returned through the parameters
1973  *
1974  * 'h', 'l', or 'L' for integer fields
1975  * 'z' support added 23/7/1999 S.H.
1976  * 'z' changed to 'Z' --davidm 1/25/99
1977  * 'Z' changed to 'z' --adobriyan 2017-01-25
1978  * 't' added for ptrdiff_t
1979  *
1980  * @fmt: the format string
1981  * @type of the token returned
1982  * @flags: various flags such as +, -, # tokens..
1983  * @field_width: overwritten width
1984  * @base: base of the number (octal, hex, ...)
1985  * @precision: precision of a number
1986  * @qualifier: qualifier of a number (long, size_t, ...)
1987  */
1988 static noinline_for_stack
1989 int format_decode(const char *fmt, struct printf_spec *spec)
1990 {
1991         const char *start = fmt;
1992         char qualifier;
1993
1994         /* we finished early by reading the field width */
1995         if (spec->type == FORMAT_TYPE_WIDTH) {
1996                 if (spec->field_width < 0) {
1997                         spec->field_width = -spec->field_width;
1998                         spec->flags |= LEFT;
1999                 }
2000                 spec->type = FORMAT_TYPE_NONE;
2001                 goto precision;
2002         }
2003
2004         /* we finished early by reading the precision */
2005         if (spec->type == FORMAT_TYPE_PRECISION) {
2006                 if (spec->precision < 0)
2007                         spec->precision = 0;
2008
2009                 spec->type = FORMAT_TYPE_NONE;
2010                 goto qualifier;
2011         }
2012
2013         /* By default */
2014         spec->type = FORMAT_TYPE_NONE;
2015
2016         for (; *fmt ; ++fmt) {
2017                 if (*fmt == '%')
2018                         break;
2019         }
2020
2021         /* Return the current non-format string */
2022         if (fmt != start || !*fmt)
2023                 return fmt - start;
2024
2025         /* Process flags */
2026         spec->flags = 0;
2027
2028         while (1) { /* this also skips first '%' */
2029                 bool found = true;
2030
2031                 ++fmt;
2032
2033                 switch (*fmt) {
2034                 case '-': spec->flags |= LEFT;    break;
2035                 case '+': spec->flags |= PLUS;    break;
2036                 case ' ': spec->flags |= SPACE;   break;
2037                 case '#': spec->flags |= SPECIAL; break;
2038                 case '0': spec->flags |= ZEROPAD; break;
2039                 default:  found = false;
2040                 }
2041
2042                 if (!found)
2043                         break;
2044         }
2045
2046         /* get field width */
2047         spec->field_width = -1;
2048
2049         if (isdigit(*fmt))
2050                 spec->field_width = skip_atoi(&fmt);
2051         else if (*fmt == '*') {
2052                 /* it's the next argument */
2053                 spec->type = FORMAT_TYPE_WIDTH;
2054                 return ++fmt - start;
2055         }
2056
2057 precision:
2058         /* get the precision */
2059         spec->precision = -1;
2060         if (*fmt == '.') {
2061                 ++fmt;
2062                 if (isdigit(*fmt)) {
2063                         spec->precision = skip_atoi(&fmt);
2064                         if (spec->precision < 0)
2065                                 spec->precision = 0;
2066                 } else if (*fmt == '*') {
2067                         /* it's the next argument */
2068                         spec->type = FORMAT_TYPE_PRECISION;
2069                         return ++fmt - start;
2070                 }
2071         }
2072
2073 qualifier:
2074         /* get the conversion qualifier */
2075         qualifier = 0;
2076         if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2077             *fmt == 'z' || *fmt == 't') {
2078                 qualifier = *fmt++;
2079                 if (unlikely(qualifier == *fmt)) {
2080                         if (qualifier == 'l') {
2081                                 qualifier = 'L';
2082                                 ++fmt;
2083                         } else if (qualifier == 'h') {
2084                                 qualifier = 'H';
2085                                 ++fmt;
2086                         }
2087                 }
2088         }
2089
2090         /* default base */
2091         spec->base = 10;
2092         switch (*fmt) {
2093         case 'c':
2094                 spec->type = FORMAT_TYPE_CHAR;
2095                 return ++fmt - start;
2096
2097         case 's':
2098                 spec->type = FORMAT_TYPE_STR;
2099                 return ++fmt - start;
2100
2101         case 'p':
2102                 spec->type = FORMAT_TYPE_PTR;
2103                 return ++fmt - start;
2104
2105         case '%':
2106                 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2107                 return ++fmt - start;
2108
2109         /* integer number formats - set up the flags and "break" */
2110         case 'o':
2111                 spec->base = 8;
2112                 break;
2113
2114         case 'x':
2115                 spec->flags |= SMALL;
2116
2117         case 'X':
2118                 spec->base = 16;
2119                 break;
2120
2121         case 'd':
2122         case 'i':
2123                 spec->flags |= SIGN;
2124         case 'u':
2125                 break;
2126
2127         case 'n':
2128                 /*
2129                  * Since %n poses a greater security risk than
2130                  * utility, treat it as any other invalid or
2131                  * unsupported format specifier.
2132                  */
2133                 /* Fall-through */
2134
2135         default:
2136                 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2137                 spec->type = FORMAT_TYPE_INVALID;
2138                 return fmt - start;
2139         }
2140
2141         if (qualifier == 'L')
2142                 spec->type = FORMAT_TYPE_LONG_LONG;
2143         else if (qualifier == 'l') {
2144                 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2145                 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2146         } else if (qualifier == 'z') {
2147                 spec->type = FORMAT_TYPE_SIZE_T;
2148         } else if (qualifier == 't') {
2149                 spec->type = FORMAT_TYPE_PTRDIFF;
2150         } else if (qualifier == 'H') {
2151                 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2152                 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2153         } else if (qualifier == 'h') {
2154                 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2155                 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2156         } else {
2157                 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2158                 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2159         }
2160
2161         return ++fmt - start;
2162 }
2163
2164 static void
2165 set_field_width(struct printf_spec *spec, int width)
2166 {
2167         spec->field_width = width;
2168         if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2169                 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2170         }
2171 }
2172
2173 static void
2174 set_precision(struct printf_spec *spec, int prec)
2175 {
2176         spec->precision = prec;
2177         if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2178                 spec->precision = clamp(prec, 0, PRECISION_MAX);
2179         }
2180 }
2181
2182 /**
2183  * vsnprintf - Format a string and place it in a buffer
2184  * @buf: The buffer to place the result into
2185  * @size: The size of the buffer, including the trailing null space
2186  * @fmt: The format string to use
2187  * @args: Arguments for the format string
2188  *
2189  * This function generally follows C99 vsnprintf, but has some
2190  * extensions and a few limitations:
2191  *
2192  *  - ``%n`` is unsupported
2193  *  - ``%p*`` is handled by pointer()
2194  *
2195  * See pointer() or Documentation/printk-formats.txt for more
2196  * extensive description.
2197  *
2198  * **Please update the documentation in both places when making changes**
2199  *
2200  * The return value is the number of characters which would
2201  * be generated for the given input, excluding the trailing
2202  * '\0', as per ISO C99. If you want to have the exact
2203  * number of characters written into @buf as return value
2204  * (not including the trailing '\0'), use vscnprintf(). If the
2205  * return is greater than or equal to @size, the resulting
2206  * string is truncated.
2207  *
2208  * If you're not already dealing with a va_list consider using snprintf().
2209  */
2210 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2211 {
2212         unsigned long long num;
2213         char *str, *end;
2214         struct printf_spec spec = {0};
2215
2216         /* Reject out-of-range values early.  Large positive sizes are
2217            used for unknown buffer sizes. */
2218         if (WARN_ON_ONCE(size > INT_MAX))
2219                 return 0;
2220
2221         str = buf;
2222         end = buf + size;
2223
2224         /* Make sure end is always >= buf */
2225         if (end < buf) {
2226                 end = ((void *)-1);
2227                 size = end - buf;
2228         }
2229
2230         while (*fmt) {
2231                 const char *old_fmt = fmt;
2232                 int read = format_decode(fmt, &spec);
2233
2234                 fmt += read;
2235
2236                 switch (spec.type) {
2237                 case FORMAT_TYPE_NONE: {
2238                         int copy = read;
2239                         if (str < end) {
2240                                 if (copy > end - str)
2241                                         copy = end - str;
2242                                 memcpy(str, old_fmt, copy);
2243                         }
2244                         str += read;
2245                         break;
2246                 }
2247
2248                 case FORMAT_TYPE_WIDTH:
2249                         set_field_width(&spec, va_arg(args, int));
2250                         break;
2251
2252                 case FORMAT_TYPE_PRECISION:
2253                         set_precision(&spec, va_arg(args, int));
2254                         break;
2255
2256                 case FORMAT_TYPE_CHAR: {
2257                         char c;
2258
2259                         if (!(spec.flags & LEFT)) {
2260                                 while (--spec.field_width > 0) {
2261                                         if (str < end)
2262                                                 *str = ' ';
2263                                         ++str;
2264
2265                                 }
2266                         }
2267                         c = (unsigned char) va_arg(args, int);
2268                         if (str < end)
2269                                 *str = c;
2270                         ++str;
2271                         while (--spec.field_width > 0) {
2272                                 if (str < end)
2273                                         *str = ' ';
2274                                 ++str;
2275                         }
2276                         break;
2277                 }
2278
2279                 case FORMAT_TYPE_STR:
2280                         str = string(str, end, va_arg(args, char *), spec);
2281                         break;
2282
2283                 case FORMAT_TYPE_PTR:
2284                         str = pointer(fmt, str, end, va_arg(args, void *),
2285                                       spec);
2286                         while (isalnum(*fmt))
2287                                 fmt++;
2288                         break;
2289
2290                 case FORMAT_TYPE_PERCENT_CHAR:
2291                         if (str < end)
2292                                 *str = '%';
2293                         ++str;
2294                         break;
2295
2296                 case FORMAT_TYPE_INVALID:
2297                         /*
2298                          * Presumably the arguments passed gcc's type
2299                          * checking, but there is no safe or sane way
2300                          * for us to continue parsing the format and
2301                          * fetching from the va_list; the remaining
2302                          * specifiers and arguments would be out of
2303                          * sync.
2304                          */
2305                         goto out;
2306
2307                 default:
2308                         switch (spec.type) {
2309                         case FORMAT_TYPE_LONG_LONG:
2310                                 num = va_arg(args, long long);
2311                                 break;
2312                         case FORMAT_TYPE_ULONG:
2313                                 num = va_arg(args, unsigned long);
2314                                 break;
2315                         case FORMAT_TYPE_LONG:
2316                                 num = va_arg(args, long);
2317                                 break;
2318                         case FORMAT_TYPE_SIZE_T:
2319                                 if (spec.flags & SIGN)
2320                                         num = va_arg(args, ssize_t);
2321                                 else
2322                                         num = va_arg(args, size_t);
2323                                 break;
2324                         case FORMAT_TYPE_PTRDIFF:
2325                                 num = va_arg(args, ptrdiff_t);
2326                                 break;
2327                         case FORMAT_TYPE_UBYTE:
2328                                 num = (unsigned char) va_arg(args, int);
2329                                 break;
2330                         case FORMAT_TYPE_BYTE:
2331                                 num = (signed char) va_arg(args, int);
2332                                 break;
2333                         case FORMAT_TYPE_USHORT:
2334                                 num = (unsigned short) va_arg(args, int);
2335                                 break;
2336                         case FORMAT_TYPE_SHORT:
2337                                 num = (short) va_arg(args, int);
2338                                 break;
2339                         case FORMAT_TYPE_INT:
2340                                 num = (int) va_arg(args, int);
2341                                 break;
2342                         default:
2343                                 num = va_arg(args, unsigned int);
2344                         }
2345
2346                         str = number(str, end, num, spec);
2347                 }
2348         }
2349
2350 out:
2351         if (size > 0) {
2352                 if (str < end)
2353                         *str = '\0';
2354                 else
2355                         end[-1] = '\0';
2356         }
2357
2358         /* the trailing null byte doesn't count towards the total */
2359         return str-buf;
2360
2361 }
2362 EXPORT_SYMBOL(vsnprintf);
2363
2364 /**
2365  * vscnprintf - Format a string and place it in a buffer
2366  * @buf: The buffer to place the result into
2367  * @size: The size of the buffer, including the trailing null space
2368  * @fmt: The format string to use
2369  * @args: Arguments for the format string
2370  *
2371  * The return value is the number of characters which have been written into
2372  * the @buf not including the trailing '\0'. If @size is == 0 the function
2373  * returns 0.
2374  *
2375  * If you're not already dealing with a va_list consider using scnprintf().
2376  *
2377  * See the vsnprintf() documentation for format string extensions over C99.
2378  */
2379 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2380 {
2381         int i;
2382
2383         i = vsnprintf(buf, size, fmt, args);
2384
2385         if (likely(i < size))
2386                 return i;
2387         if (size != 0)
2388                 return size - 1;
2389         return 0;
2390 }
2391 EXPORT_SYMBOL(vscnprintf);
2392
2393 /**
2394  * snprintf - Format a string and place it in a buffer
2395  * @buf: The buffer to place the result into
2396  * @size: The size of the buffer, including the trailing null space
2397  * @fmt: The format string to use
2398  * @...: Arguments for the format string
2399  *
2400  * The return value is the number of characters which would be
2401  * generated for the given input, excluding the trailing null,
2402  * as per ISO C99.  If the return is greater than or equal to
2403  * @size, the resulting string is truncated.
2404  *
2405  * See the vsnprintf() documentation for format string extensions over C99.
2406  */
2407 int snprintf(char *buf, size_t size, const char *fmt, ...)
2408 {
2409         va_list args;
2410         int i;
2411
2412         va_start(args, fmt);
2413         i = vsnprintf(buf, size, fmt, args);
2414         va_end(args);
2415
2416         return i;
2417 }
2418 EXPORT_SYMBOL(snprintf);
2419
2420 /**
2421  * scnprintf - Format a string and place it in a buffer
2422  * @buf: The buffer to place the result into
2423  * @size: The size of the buffer, including the trailing null space
2424  * @fmt: The format string to use
2425  * @...: Arguments for the format string
2426  *
2427  * The return value is the number of characters written into @buf not including
2428  * the trailing '\0'. If @size is == 0 the function returns 0.
2429  */
2430
2431 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2432 {
2433         va_list args;
2434         int i;
2435
2436         va_start(args, fmt);
2437         i = vscnprintf(buf, size, fmt, args);
2438         va_end(args);
2439
2440         return i;
2441 }
2442 EXPORT_SYMBOL(scnprintf);
2443
2444 /**
2445  * vsprintf - Format a string and place it in a buffer
2446  * @buf: The buffer to place the result into
2447  * @fmt: The format string to use
2448  * @args: Arguments for the format string
2449  *
2450  * The function returns the number of characters written
2451  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2452  * buffer overflows.
2453  *
2454  * If you're not already dealing with a va_list consider using sprintf().
2455  *
2456  * See the vsnprintf() documentation for format string extensions over C99.
2457  */
2458 int vsprintf(char *buf, const char *fmt, va_list args)
2459 {
2460         return vsnprintf(buf, INT_MAX, fmt, args);
2461 }
2462 EXPORT_SYMBOL(vsprintf);
2463
2464 /**
2465  * sprintf - Format a string and place it in a buffer
2466  * @buf: The buffer to place the result into
2467  * @fmt: The format string to use
2468  * @...: Arguments for the format string
2469  *
2470  * The function returns the number of characters written
2471  * into @buf. Use snprintf() or scnprintf() in order to avoid
2472  * buffer overflows.
2473  *
2474  * See the vsnprintf() documentation for format string extensions over C99.
2475  */
2476 int sprintf(char *buf, const char *fmt, ...)
2477 {
2478         va_list args;
2479         int i;
2480
2481         va_start(args, fmt);
2482         i = vsnprintf(buf, INT_MAX, fmt, args);
2483         va_end(args);
2484
2485         return i;
2486 }
2487 EXPORT_SYMBOL(sprintf);
2488
2489 #ifdef CONFIG_BINARY_PRINTF
2490 /*
2491  * bprintf service:
2492  * vbin_printf() - VA arguments to binary data
2493  * bstr_printf() - Binary data to text string
2494  */
2495
2496 /**
2497  * vbin_printf - Parse a format string and place args' binary value in a buffer
2498  * @bin_buf: The buffer to place args' binary value
2499  * @size: The size of the buffer(by words(32bits), not characters)
2500  * @fmt: The format string to use
2501  * @args: Arguments for the format string
2502  *
2503  * The format follows C99 vsnprintf, except %n is ignored, and its argument
2504  * is skipped.
2505  *
2506  * The return value is the number of words(32bits) which would be generated for
2507  * the given input.
2508  *
2509  * NOTE:
2510  * If the return value is greater than @size, the resulting bin_buf is NOT
2511  * valid for bstr_printf().
2512  */
2513 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2514 {
2515         struct printf_spec spec = {0};
2516         char *str, *end;
2517
2518         str = (char *)bin_buf;
2519         end = (char *)(bin_buf + size);
2520
2521 #define save_arg(type)                                                  \
2522 do {                                                                    \
2523         if (sizeof(type) == 8) {                                        \
2524                 unsigned long long value;                               \
2525                 str = PTR_ALIGN(str, sizeof(u32));                      \
2526                 value = va_arg(args, unsigned long long);               \
2527                 if (str + sizeof(type) <= end) {                        \
2528                         *(u32 *)str = *(u32 *)&value;                   \
2529                         *(u32 *)(str + 4) = *((u32 *)&value + 1);       \
2530                 }                                                       \
2531         } else {                                                        \
2532                 unsigned long value;                                    \
2533                 str = PTR_ALIGN(str, sizeof(type));                     \
2534                 value = va_arg(args, int);                              \
2535                 if (str + sizeof(type) <= end)                          \
2536                         *(typeof(type) *)str = (type)value;             \
2537         }                                                               \
2538         str += sizeof(type);                                            \
2539 } while (0)
2540
2541         while (*fmt) {
2542                 int read = format_decode(fmt, &spec);
2543
2544                 fmt += read;
2545
2546                 switch (spec.type) {
2547                 case FORMAT_TYPE_NONE:
2548                 case FORMAT_TYPE_PERCENT_CHAR:
2549                         break;
2550                 case FORMAT_TYPE_INVALID:
2551                         goto out;
2552
2553                 case FORMAT_TYPE_WIDTH:
2554                 case FORMAT_TYPE_PRECISION:
2555                         save_arg(int);
2556                         break;
2557
2558                 case FORMAT_TYPE_CHAR:
2559                         save_arg(char);
2560                         break;
2561
2562                 case FORMAT_TYPE_STR: {
2563                         const char *save_str = va_arg(args, char *);
2564                         size_t len;
2565
2566                         if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2567                                         || (unsigned long)save_str < PAGE_SIZE)
2568                                 save_str = "(null)";
2569                         len = strlen(save_str) + 1;
2570                         if (str + len < end)
2571                                 memcpy(str, save_str, len);
2572                         str += len;
2573                         break;
2574                 }
2575
2576                 case FORMAT_TYPE_PTR:
2577                         save_arg(void *);
2578                         /* skip all alphanumeric pointer suffixes */
2579                         while (isalnum(*fmt))
2580                                 fmt++;
2581                         break;
2582
2583                 default:
2584                         switch (spec.type) {
2585
2586                         case FORMAT_TYPE_LONG_LONG:
2587                                 save_arg(long long);
2588                                 break;
2589                         case FORMAT_TYPE_ULONG:
2590                         case FORMAT_TYPE_LONG:
2591                                 save_arg(unsigned long);
2592                                 break;
2593                         case FORMAT_TYPE_SIZE_T:
2594                                 save_arg(size_t);
2595                                 break;
2596                         case FORMAT_TYPE_PTRDIFF:
2597                                 save_arg(ptrdiff_t);
2598                                 break;
2599                         case FORMAT_TYPE_UBYTE:
2600                         case FORMAT_TYPE_BYTE:
2601                                 save_arg(char);
2602                                 break;
2603                         case FORMAT_TYPE_USHORT:
2604                         case FORMAT_TYPE_SHORT:
2605                                 save_arg(short);
2606                                 break;
2607                         default:
2608                                 save_arg(int);
2609                         }
2610                 }
2611         }
2612
2613 out:
2614         return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2615 #undef save_arg
2616 }
2617 EXPORT_SYMBOL_GPL(vbin_printf);
2618
2619 /**
2620  * bstr_printf - Format a string from binary arguments and place it in a buffer
2621  * @buf: The buffer to place the result into
2622  * @size: The size of the buffer, including the trailing null space
2623  * @fmt: The format string to use
2624  * @bin_buf: Binary arguments for the format string
2625  *
2626  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2627  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2628  * a binary buffer that generated by vbin_printf.
2629  *
2630  * The format follows C99 vsnprintf, but has some extensions:
2631  *  see vsnprintf comment for details.
2632  *
2633  * The return value is the number of characters which would
2634  * be generated for the given input, excluding the trailing
2635  * '\0', as per ISO C99. If you want to have the exact
2636  * number of characters written into @buf as return value
2637  * (not including the trailing '\0'), use vscnprintf(). If the
2638  * return is greater than or equal to @size, the resulting
2639  * string is truncated.
2640  */
2641 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2642 {
2643         struct printf_spec spec = {0};
2644         char *str, *end;
2645         const char *args = (const char *)bin_buf;
2646
2647         if (WARN_ON_ONCE(size > INT_MAX))
2648                 return 0;
2649
2650         str = buf;
2651         end = buf + size;
2652
2653 #define get_arg(type)                                                   \
2654 ({                                                                      \
2655         typeof(type) value;                                             \
2656         if (sizeof(type) == 8) {                                        \
2657                 args = PTR_ALIGN(args, sizeof(u32));                    \
2658                 *(u32 *)&value = *(u32 *)args;                          \
2659                 *((u32 *)&value + 1) = *(u32 *)(args + 4);              \
2660         } else {                                                        \
2661                 args = PTR_ALIGN(args, sizeof(type));                   \
2662                 value = *(typeof(type) *)args;                          \
2663         }                                                               \
2664         args += sizeof(type);                                           \
2665         value;                                                          \
2666 })
2667
2668         /* Make sure end is always >= buf */
2669         if (end < buf) {
2670                 end = ((void *)-1);
2671                 size = end - buf;
2672         }
2673
2674         while (*fmt) {
2675                 const char *old_fmt = fmt;
2676                 int read = format_decode(fmt, &spec);
2677
2678                 fmt += read;
2679
2680                 switch (spec.type) {
2681                 case FORMAT_TYPE_NONE: {
2682                         int copy = read;
2683                         if (str < end) {
2684                                 if (copy > end - str)
2685                                         copy = end - str;
2686                                 memcpy(str, old_fmt, copy);
2687                         }
2688                         str += read;
2689                         break;
2690                 }
2691
2692                 case FORMAT_TYPE_WIDTH:
2693                         set_field_width(&spec, get_arg(int));
2694                         break;
2695
2696                 case FORMAT_TYPE_PRECISION:
2697                         set_precision(&spec, get_arg(int));
2698                         break;
2699
2700                 case FORMAT_TYPE_CHAR: {
2701                         char c;
2702
2703                         if (!(spec.flags & LEFT)) {
2704                                 while (--spec.field_width > 0) {
2705                                         if (str < end)
2706                                                 *str = ' ';
2707                                         ++str;
2708                                 }
2709                         }
2710                         c = (unsigned char) get_arg(char);
2711                         if (str < end)
2712                                 *str = c;
2713                         ++str;
2714                         while (--spec.field_width > 0) {
2715                                 if (str < end)
2716                                         *str = ' ';
2717                                 ++str;
2718                         }
2719                         break;
2720                 }
2721
2722                 case FORMAT_TYPE_STR: {
2723                         const char *str_arg = args;
2724                         args += strlen(str_arg) + 1;
2725                         str = string(str, end, (char *)str_arg, spec);
2726                         break;
2727                 }
2728
2729                 case FORMAT_TYPE_PTR:
2730                         str = pointer(fmt, str, end, get_arg(void *), spec);
2731                         while (isalnum(*fmt))
2732                                 fmt++;
2733                         break;
2734
2735                 case FORMAT_TYPE_PERCENT_CHAR:
2736                         if (str < end)
2737                                 *str = '%';
2738                         ++str;
2739                         break;
2740
2741                 case FORMAT_TYPE_INVALID:
2742                         goto out;
2743
2744                 default: {
2745                         unsigned long long num;
2746
2747                         switch (spec.type) {
2748
2749                         case FORMAT_TYPE_LONG_LONG:
2750                                 num = get_arg(long long);
2751                                 break;
2752                         case FORMAT_TYPE_ULONG:
2753                         case FORMAT_TYPE_LONG:
2754                                 num = get_arg(unsigned long);
2755                                 break;
2756                         case FORMAT_TYPE_SIZE_T:
2757                                 num = get_arg(size_t);
2758                                 break;
2759                         case FORMAT_TYPE_PTRDIFF:
2760                                 num = get_arg(ptrdiff_t);
2761                                 break;
2762                         case FORMAT_TYPE_UBYTE:
2763                                 num = get_arg(unsigned char);
2764                                 break;
2765                         case FORMAT_TYPE_BYTE:
2766                                 num = get_arg(signed char);
2767                                 break;
2768                         case FORMAT_TYPE_USHORT:
2769                                 num = get_arg(unsigned short);
2770                                 break;
2771                         case FORMAT_TYPE_SHORT:
2772                                 num = get_arg(short);
2773                                 break;
2774                         case FORMAT_TYPE_UINT:
2775                                 num = get_arg(unsigned int);
2776                                 break;
2777                         default:
2778                                 num = get_arg(int);
2779                         }
2780
2781                         str = number(str, end, num, spec);
2782                 } /* default: */
2783                 } /* switch(spec.type) */
2784         } /* while(*fmt) */
2785
2786 out:
2787         if (size > 0) {
2788                 if (str < end)
2789                         *str = '\0';
2790                 else
2791                         end[-1] = '\0';
2792         }
2793
2794 #undef get_arg
2795
2796         /* the trailing null byte doesn't count towards the total */
2797         return str - buf;
2798 }
2799 EXPORT_SYMBOL_GPL(bstr_printf);
2800
2801 /**
2802  * bprintf - Parse a format string and place args' binary value in a buffer
2803  * @bin_buf: The buffer to place args' binary value
2804  * @size: The size of the buffer(by words(32bits), not characters)
2805  * @fmt: The format string to use
2806  * @...: Arguments for the format string
2807  *
2808  * The function returns the number of words(u32) written
2809  * into @bin_buf.
2810  */
2811 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2812 {
2813         va_list args;
2814         int ret;
2815
2816         va_start(args, fmt);
2817         ret = vbin_printf(bin_buf, size, fmt, args);
2818         va_end(args);
2819
2820         return ret;
2821 }
2822 EXPORT_SYMBOL_GPL(bprintf);
2823
2824 #endif /* CONFIG_BINARY_PRINTF */
2825
2826 /**
2827  * vsscanf - Unformat a buffer into a list of arguments
2828  * @buf:        input buffer
2829  * @fmt:        format of buffer
2830  * @args:       arguments
2831  */
2832 int vsscanf(const char *buf, const char *fmt, va_list args)
2833 {
2834         const char *str = buf;
2835         char *next;
2836         char digit;
2837         int num = 0;
2838         u8 qualifier;
2839         unsigned int base;
2840         union {
2841                 long long s;
2842                 unsigned long long u;
2843         } val;
2844         s16 field_width;
2845         bool is_sign;
2846
2847         while (*fmt) {
2848                 /* skip any white space in format */
2849                 /* white space in format matchs any amount of
2850                  * white space, including none, in the input.
2851                  */
2852                 if (isspace(*fmt)) {
2853                         fmt = skip_spaces(++fmt);
2854                         str = skip_spaces(str);
2855                 }
2856
2857                 /* anything that is not a conversion must match exactly */
2858                 if (*fmt != '%' && *fmt) {
2859                         if (*fmt++ != *str++)
2860                                 break;
2861                         continue;
2862                 }
2863
2864                 if (!*fmt)
2865                         break;
2866                 ++fmt;
2867
2868                 /* skip this conversion.
2869                  * advance both strings to next white space
2870                  */
2871                 if (*fmt == '*') {
2872                         if (!*str)
2873                                 break;
2874                         while (!isspace(*fmt) && *fmt != '%' && *fmt) {
2875                                 /* '%*[' not yet supported, invalid format */
2876                                 if (*fmt == '[')
2877                                         return num;
2878                                 fmt++;
2879                         }
2880                         while (!isspace(*str) && *str)
2881                                 str++;
2882                         continue;
2883                 }
2884
2885                 /* get field width */
2886                 field_width = -1;
2887                 if (isdigit(*fmt)) {
2888                         field_width = skip_atoi(&fmt);
2889                         if (field_width <= 0)
2890                                 break;
2891                 }
2892
2893                 /* get conversion qualifier */
2894                 qualifier = -1;
2895                 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2896                     *fmt == 'z') {
2897                         qualifier = *fmt++;
2898                         if (unlikely(qualifier == *fmt)) {
2899                                 if (qualifier == 'h') {
2900                                         qualifier = 'H';
2901                                         fmt++;
2902                                 } else if (qualifier == 'l') {
2903                                         qualifier = 'L';
2904                                         fmt++;
2905                                 }
2906                         }
2907                 }
2908
2909                 if (!*fmt)
2910                         break;
2911
2912                 if (*fmt == 'n') {
2913                         /* return number of characters read so far */
2914                         *va_arg(args, int *) = str - buf;
2915                         ++fmt;
2916                         continue;
2917                 }
2918
2919                 if (!*str)
2920                         break;
2921
2922                 base = 10;
2923                 is_sign = false;
2924
2925                 switch (*fmt++) {
2926                 case 'c':
2927                 {
2928                         char *s = (char *)va_arg(args, char*);
2929                         if (field_width == -1)
2930                                 field_width = 1;
2931                         do {
2932                                 *s++ = *str++;
2933                         } while (--field_width > 0 && *str);
2934                         num++;
2935                 }
2936                 continue;
2937                 case 's':
2938                 {
2939                         char *s = (char *)va_arg(args, char *);
2940                         if (field_width == -1)
2941                                 field_width = SHRT_MAX;
2942                         /* first, skip leading white space in buffer */
2943                         str = skip_spaces(str);
2944
2945                         /* now copy until next white space */
2946                         while (*str && !isspace(*str) && field_width--)
2947                                 *s++ = *str++;
2948                         *s = '\0';
2949                         num++;
2950                 }
2951                 continue;
2952                 /*
2953                  * Warning: This implementation of the '[' conversion specifier
2954                  * deviates from its glibc counterpart in the following ways:
2955                  * (1) It does NOT support ranges i.e. '-' is NOT a special
2956                  *     character
2957                  * (2) It cannot match the closing bracket ']' itself
2958                  * (3) A field width is required
2959                  * (4) '%*[' (discard matching input) is currently not supported
2960                  *
2961                  * Example usage:
2962                  * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
2963                  *              buf1, buf2, buf3);
2964                  * if (ret < 3)
2965                  *    // etc..
2966                  */
2967                 case '[':
2968                 {
2969                         char *s = (char *)va_arg(args, char *);
2970                         DECLARE_BITMAP(set, 256) = {0};
2971                         unsigned int len = 0;
2972                         bool negate = (*fmt == '^');
2973
2974                         /* field width is required */
2975                         if (field_width == -1)
2976                                 return num;
2977
2978                         if (negate)
2979                                 ++fmt;
2980
2981                         for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
2982                                 set_bit((u8)*fmt, set);
2983
2984                         /* no ']' or no character set found */
2985                         if (!*fmt || !len)
2986                                 return num;
2987                         ++fmt;
2988
2989                         if (negate) {
2990                                 bitmap_complement(set, set, 256);
2991                                 /* exclude null '\0' byte */
2992                                 clear_bit(0, set);
2993                         }
2994
2995                         /* match must be non-empty */
2996                         if (!test_bit((u8)*str, set))
2997                                 return num;
2998
2999                         while (test_bit((u8)*str, set) && field_width--)
3000                                 *s++ = *str++;
3001                         *s = '\0';
3002                         ++num;
3003                 }
3004                 continue;
3005                 case 'o':
3006                         base = 8;
3007                         break;
3008                 case 'x':
3009                 case 'X':
3010                         base = 16;
3011                         break;
3012                 case 'i':
3013                         base = 0;
3014                 case 'd':
3015                         is_sign = true;
3016                 case 'u':
3017                         break;
3018                 case '%':
3019                         /* looking for '%' in str */
3020                         if (*str++ != '%')
3021                                 return num;
3022                         continue;
3023                 default:
3024                         /* invalid format; stop here */
3025                         return num;
3026                 }
3027
3028                 /* have some sort of integer conversion.
3029                  * first, skip white space in buffer.
3030                  */
3031                 str = skip_spaces(str);
3032
3033                 digit = *str;
3034                 if (is_sign && digit == '-')
3035                         digit = *(str + 1);
3036
3037                 if (!digit
3038                     || (base == 16 && !isxdigit(digit))
3039                     || (base == 10 && !isdigit(digit))
3040                     || (base == 8 && (!isdigit(digit) || digit > '7'))
3041                     || (base == 0 && !isdigit(digit)))
3042                         break;
3043
3044                 if (is_sign)
3045                         val.s = qualifier != 'L' ?
3046                                 simple_strtol(str, &next, base) :
3047                                 simple_strtoll(str, &next, base);
3048                 else
3049                         val.u = qualifier != 'L' ?
3050                                 simple_strtoul(str, &next, base) :
3051                                 simple_strtoull(str, &next, base);
3052
3053                 if (field_width > 0 && next - str > field_width) {
3054                         if (base == 0)
3055                                 _parse_integer_fixup_radix(str, &base);
3056                         while (next - str > field_width) {
3057                                 if (is_sign)
3058                                         val.s = div_s64(val.s, base);
3059                                 else
3060                                         val.u = div_u64(val.u, base);
3061                                 --next;
3062                         }
3063                 }
3064
3065                 switch (qualifier) {
3066                 case 'H':       /* that's 'hh' in format */
3067                         if (is_sign)
3068                                 *va_arg(args, signed char *) = val.s;
3069                         else
3070                                 *va_arg(args, unsigned char *) = val.u;
3071                         break;
3072                 case 'h':
3073                         if (is_sign)
3074                                 *va_arg(args, short *) = val.s;
3075                         else
3076                                 *va_arg(args, unsigned short *) = val.u;
3077                         break;
3078                 case 'l':
3079                         if (is_sign)
3080                                 *va_arg(args, long *) = val.s;
3081                         else
3082                                 *va_arg(args, unsigned long *) = val.u;
3083                         break;
3084                 case 'L':
3085                         if (is_sign)
3086                                 *va_arg(args, long long *) = val.s;
3087                         else
3088                                 *va_arg(args, unsigned long long *) = val.u;
3089                         break;
3090                 case 'z':
3091                         *va_arg(args, size_t *) = val.u;
3092                         break;
3093                 default:
3094                         if (is_sign)
3095                                 *va_arg(args, int *) = val.s;
3096                         else
3097                                 *va_arg(args, unsigned int *) = val.u;
3098                         break;
3099                 }
3100                 num++;
3101
3102                 if (!next)
3103                         break;
3104                 str = next;
3105         }
3106
3107         return num;
3108 }
3109 EXPORT_SYMBOL(vsscanf);
3110
3111 /**
3112  * sscanf - Unformat a buffer into a list of arguments
3113  * @buf:        input buffer
3114  * @fmt:        formatting of buffer
3115  * @...:        resulting arguments
3116  */
3117 int sscanf(const char *buf, const char *fmt, ...)
3118 {
3119         va_list args;
3120         int i;
3121
3122         va_start(args, fmt);
3123         i = vsscanf(buf, fmt, args);
3124         va_end(args);
3125
3126         return i;
3127 }
3128 EXPORT_SYMBOL(sscanf);