]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - lib/vsprintf.c
projects / mirror_ubuntu-bionic-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
treewide: Use DEVICE_ATTR_RW
[mirror_ubuntu-bionic-kernel.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 #ifdef CONFIG_KMSG_IDS
1731
1732 unsigned long long __jhash_string(const char *str);
1733
1734 static noinline_for_stack
1735 char *jhash_string(char *buf, char *end, const char *str, const char *fmt)
1736 {
1737 struct printf_spec spec;
1738 unsigned long long num;
1739
1740 num = __jhash_string(str);
1741
1742 spec.type = FORMAT_TYPE_PTR;
1743 spec.field_width = 6;
1744 spec.flags = SMALL | ZEROPAD;
1745 spec.base = 16;
1746 spec.precision = -1;
1747
1748 return number(buf, end, num, spec);
1749 }
1750
1751 #endif
1752
1753 /*
1754 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1755 * by an extra set of alphanumeric characters that are extended format
1756 * specifiers.
1757 *
1758 * Please update scripts/checkpatch.pl when adding/removing conversion
1759 * characters. (Search for "check for vsprintf extension").
1760 *
1761 * Right now we handle:
1762 *
1763 * - 'F' For symbolic function descriptor pointers with offset
1764 * - 'f' For simple symbolic function names without offset
1765 * - 'S' For symbolic direct pointers with offset
1766 * - 's' For symbolic direct pointers without offset
1767 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1768 * - 'B' For backtraced symbolic direct pointers with offset
1769 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1770 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1771 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1772 * width which must be explicitly specified either as part of the
1773 * format string '%32b[l]' or through '%*b[l]', [l] selects
1774 * range-list format instead of hex format
1775 * - 'M' For a 6-byte MAC address, it prints the address in the
1776 * usual colon-separated hex notation
1777 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1778 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1779 * with a dash-separated hex notation
1780 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1781 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1782 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1783 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
1784 * [S][pfs]
1785 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1786 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1787 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1788 * IPv6 omits the colons (01020304...0f)
1789 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1790 * [S][pfs]
1791 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1792 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1793 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1794 * - 'I[6S]c' for IPv6 addresses printed as specified by
1795 * http://tools.ietf.org/html/rfc5952
1796 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1797 * of the following flags (see string_escape_mem() for the
1798 * details):
1799 * a - ESCAPE_ANY
1800 * c - ESCAPE_SPECIAL
1801 * h - ESCAPE_HEX
1802 * n - ESCAPE_NULL
1803 * o - ESCAPE_OCTAL
1804 * p - ESCAPE_NP
1805 * s - ESCAPE_SPACE
1806 * By default ESCAPE_ANY_NP is used.
1807 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1808 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1809 * Options for %pU are:
1810 * b big endian lower case hex (default)
1811 * B big endian UPPER case hex
1812 * l little endian lower case hex
1813 * L little endian UPPER case hex
1814 * big endian output byte order is:
1815 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1816 * little endian output byte order is:
1817 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1818 * - 'V' For a struct va_format which contains a format string * and va_list *,
1819 * call vsnprintf(->format, *->va_list).
1820 * Implements a "recursive vsnprintf".
1821 * Do not use this feature without some mechanism to verify the
1822 * correctness of the format string and va_list arguments.
1823 * - 'K' For a kernel pointer that should be hidden from unprivileged users
1824 * - 'NF' For a netdev_features_t
1825 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1826 * a certain separator (' ' by default):
1827 * C colon
1828 * D dash
1829 * N no separator
1830 * The maximum supported length is 64 bytes of the input. Consider
1831 * to use print_hex_dump() for the larger input.
1832 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1833 * (default assumed to be phys_addr_t, passed by reference)
1834 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1835 * - 'D[234]' Same as 'd' but for a struct file
1836 * - 'g' For block_device name (gendisk + partition number)
1837 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1838 * (legacy clock framework) of the clock
1839 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1840 * (legacy clock framework) of the clock
1841 * - 'Cr' For a clock, it prints the current rate of the clock
1842 * - 'G' For flags to be printed as a collection of symbolic strings that would
1843 * construct the specific value. Supported flags given by option:
1844 * p page flags (see struct page) given as pointer to unsigned long
1845 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
1846 * v vma flags (VM_*) given as pointer to unsigned long
1847 * - 'j' Kernel message catalog jhash for System z
1848 * - 'O' For a kobject based struct. Must be one of the following:
1849 * - 'OF[fnpPcCF]' For a device tree object
1850 * Without any optional arguments prints the full_name
1851 * f device node full_name
1852 * n device node name
1853 * p device node phandle
1854 * P device node path spec (name + @unit)
1855 * F device node flags
1856 * c major compatible string
1857 * C full compatible string
1858 *
1859 * - 'x' For printing the address. Equivalent to "%lx".
1860 *
1861 * ** Please update also Documentation/printk-formats.txt when making changes **
1862 *
1863 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1864 * function pointers are really function descriptors, which contain a
1865 * pointer to the real address.
1866 *
1867 * Note: The default behaviour (unadorned %p) is to hash the address,
1868 * rendering it useful as a unique identifier.
1869 */
1870 static noinline_for_stack
1871 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1872 struct printf_spec spec)
1873 {
1874 const int default_width = 2 * sizeof(void *);
1875
1876 if (!ptr && *fmt != 'K' && *fmt != 'x') {
1877 /*
1878 * Print (null) with the same width as a pointer so it makes
1879 * tabular output look nice.
1880 */
1881 if (spec.field_width == -1)
1882 spec.field_width = default_width;
1883 return string(buf, end, "(null)", spec);
1884 }
1885
1886 switch (*fmt) {
1887 case 'F':
1888 case 'f':
1889 ptr = dereference_function_descriptor(ptr);
1890 /* Fallthrough */
1891 case 'S':
1892 case 's':
1893 case 'B':
1894 return symbol_string(buf, end, ptr, spec, fmt);
1895 case 'R':
1896 case 'r':
1897 return resource_string(buf, end, ptr, spec, fmt);
1898 case 'h':
1899 return hex_string(buf, end, ptr, spec, fmt);
1900 case 'b':
1901 switch (fmt[1]) {
1902 case 'l':
1903 return bitmap_list_string(buf, end, ptr, spec, fmt);
1904 default:
1905 return bitmap_string(buf, end, ptr, spec, fmt);
1906 }
1907 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1908 case 'm': /* Contiguous: 000102030405 */
1909 /* [mM]F (FDDI) */
1910 /* [mM]R (Reverse order; Bluetooth) */
1911 return mac_address_string(buf, end, ptr, spec, fmt);
1912 case 'I': /* Formatted IP supported
1913 * 4: 1.2.3.4
1914 * 6: 0001:0203:...:0708
1915 * 6c: 1::708 or 1::1.2.3.4
1916 */
1917 case 'i': /* Contiguous:
1918 * 4: 001.002.003.004
1919 * 6: 000102...0f
1920 */
1921 switch (fmt[1]) {
1922 case '6':
1923 return ip6_addr_string(buf, end, ptr, spec, fmt);
1924 case '4':
1925 return ip4_addr_string(buf, end, ptr, spec, fmt);
1926 case 'S': {
1927 const union {
1928 struct sockaddr raw;
1929 struct sockaddr_in v4;
1930 struct sockaddr_in6 v6;
1931 } *sa = ptr;
1932
1933 switch (sa->raw.sa_family) {
1934 case AF_INET:
1935 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1936 case AF_INET6:
1937 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1938 default:
1939 return string(buf, end, "(invalid address)", spec);
1940 }}
1941 }
1942 break;
1943 case 'E':
1944 return escaped_string(buf, end, ptr, spec, fmt);
1945 case 'U':
1946 return uuid_string(buf, end, ptr, spec, fmt);
1947 case 'V':
1948 {
1949 va_list va;
1950
1951 va_copy(va, *((struct va_format *)ptr)->va);
1952 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1953 ((struct va_format *)ptr)->fmt, va);
1954 va_end(va);
1955 return buf;
1956 }
1957 case 'K':
1958 if (!kptr_restrict)
1959 break;
1960 return restricted_pointer(buf, end, ptr, spec);
1961 case 'N':
1962 return netdev_bits(buf, end, ptr, fmt);
1963 case 'a':
1964 return address_val(buf, end, ptr, fmt);
1965 case 'd':
1966 return dentry_name(buf, end, ptr, spec, fmt);
1967 case 'C':
1968 return clock(buf, end, ptr, spec, fmt);
1969 case 'D':
1970 return dentry_name(buf, end,
1971 ((const struct file *)ptr)->f_path.dentry,
1972 spec, fmt);
1973 #ifdef CONFIG_BLOCK
1974 case 'g':
1975 return bdev_name(buf, end, ptr, spec, fmt);
1976 #endif
1977
1978 case 'G':
1979 return flags_string(buf, end, ptr, fmt);
1980 case 'O':
1981 switch (fmt[1]) {
1982 case 'F':
1983 return device_node_string(buf, end, ptr, spec, fmt + 1);
1984 }
1985 case 'x':
1986 return pointer_string(buf, end, ptr, spec);
1987 #ifdef CONFIG_KMSG_IDS
1988 case 'j':
1989 return jhash_string(buf, end, ptr, fmt);
1990 #endif
1991 }
1992
1993 /* default is to _not_ leak addresses, hash before printing */
1994 return ptr_to_id(buf, end, ptr, spec);
1995 }
1996
1997 /*
1998 * Helper function to decode printf style format.
1999 * Each call decode a token from the format and return the
2000 * number of characters read (or likely the delta where it wants
2001 * to go on the next call).
2002 * The decoded token is returned through the parameters
2003 *
2004 * 'h', 'l', or 'L' for integer fields
2005 * 'z' support added 23/7/1999 S.H.
2006 * 'z' changed to 'Z' --davidm 1/25/99
2007 * 'Z' changed to 'z' --adobriyan 2017-01-25
2008 * 't' added for ptrdiff_t
2009 *
2010 * @fmt: the format string
2011 * @type of the token returned
2012 * @flags: various flags such as +, -, # tokens..
2013 * @field_width: overwritten width
2014 * @base: base of the number (octal, hex, ...)
2015 * @precision: precision of a number
2016 * @qualifier: qualifier of a number (long, size_t, ...)
2017 */
2018 static noinline_for_stack
2019 int format_decode(const char *fmt, struct printf_spec *spec)
2020 {
2021 const char *start = fmt;
2022 char qualifier;
2023
2024 /* we finished early by reading the field width */
2025 if (spec->type == FORMAT_TYPE_WIDTH) {
2026 if (spec->field_width < 0) {
2027 spec->field_width = -spec->field_width;
2028 spec->flags |= LEFT;
2029 }
2030 spec->type = FORMAT_TYPE_NONE;
2031 goto precision;
2032 }
2033
2034 /* we finished early by reading the precision */
2035 if (spec->type == FORMAT_TYPE_PRECISION) {
2036 if (spec->precision < 0)
2037 spec->precision = 0;
2038
2039 spec->type = FORMAT_TYPE_NONE;
2040 goto qualifier;
2041 }
2042
2043 /* By default */
2044 spec->type = FORMAT_TYPE_NONE;
2045
2046 for (; *fmt ; ++fmt) {
2047 if (*fmt == '%')
2048 break;
2049 }
2050
2051 /* Return the current non-format string */
2052 if (fmt != start || !*fmt)
2053 return fmt - start;
2054
2055 /* Process flags */
2056 spec->flags = 0;
2057
2058 while (1) { /* this also skips first '%' */
2059 bool found = true;
2060
2061 ++fmt;
2062
2063 switch (*fmt) {
2064 case '-': spec->flags |= LEFT; break;
2065 case '+': spec->flags |= PLUS; break;
2066 case ' ': spec->flags |= SPACE; break;
2067 case '#': spec->flags |= SPECIAL; break;
2068 case '0': spec->flags |= ZEROPAD; break;
2069 default: found = false;
2070 }
2071
2072 if (!found)
2073 break;
2074 }
2075
2076 /* get field width */
2077 spec->field_width = -1;
2078
2079 if (isdigit(*fmt))
2080 spec->field_width = skip_atoi(&fmt);
2081 else if (*fmt == '*') {
2082 /* it's the next argument */
2083 spec->type = FORMAT_TYPE_WIDTH;
2084 return ++fmt - start;
2085 }
2086
2087 precision:
2088 /* get the precision */
2089 spec->precision = -1;
2090 if (*fmt == '.') {
2091 ++fmt;
2092 if (isdigit(*fmt)) {
2093 spec->precision = skip_atoi(&fmt);
2094 if (spec->precision < 0)
2095 spec->precision = 0;
2096 } else if (*fmt == '*') {
2097 /* it's the next argument */
2098 spec->type = FORMAT_TYPE_PRECISION;
2099 return ++fmt - start;
2100 }
2101 }
2102
2103 qualifier:
2104 /* get the conversion qualifier */
2105 qualifier = 0;
2106 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2107 *fmt == 'z' || *fmt == 't') {
2108 qualifier = *fmt++;
2109 if (unlikely(qualifier == *fmt)) {
2110 if (qualifier == 'l') {
2111 qualifier = 'L';
2112 ++fmt;
2113 } else if (qualifier == 'h') {
2114 qualifier = 'H';
2115 ++fmt;
2116 }
2117 }
2118 }
2119
2120 /* default base */
2121 spec->base = 10;
2122 switch (*fmt) {
2123 case 'c':
2124 spec->type = FORMAT_TYPE_CHAR;
2125 return ++fmt - start;
2126
2127 case 's':
2128 spec->type = FORMAT_TYPE_STR;
2129 return ++fmt - start;
2130
2131 case 'p':
2132 spec->type = FORMAT_TYPE_PTR;
2133 return ++fmt - start;
2134
2135 case '%':
2136 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2137 return ++fmt - start;
2138
2139 /* integer number formats - set up the flags and "break" */
2140 case 'o':
2141 spec->base = 8;
2142 break;
2143
2144 case 'x':
2145 spec->flags |= SMALL;
2146
2147 case 'X':
2148 spec->base = 16;
2149 break;
2150
2151 case 'd':
2152 case 'i':
2153 spec->flags |= SIGN;
2154 case 'u':
2155 break;
2156
2157 case 'n':
2158 /*
2159 * Since %n poses a greater security risk than
2160 * utility, treat it as any other invalid or
2161 * unsupported format specifier.
2162 */
2163 /* Fall-through */
2164
2165 default:
2166 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2167 spec->type = FORMAT_TYPE_INVALID;
2168 return fmt - start;
2169 }
2170
2171 if (qualifier == 'L')
2172 spec->type = FORMAT_TYPE_LONG_LONG;
2173 else if (qualifier == 'l') {
2174 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2175 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2176 } else if (qualifier == 'z') {
2177 spec->type = FORMAT_TYPE_SIZE_T;
2178 } else if (qualifier == 't') {
2179 spec->type = FORMAT_TYPE_PTRDIFF;
2180 } else if (qualifier == 'H') {
2181 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2182 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2183 } else if (qualifier == 'h') {
2184 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2185 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2186 } else {
2187 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2188 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2189 }
2190
2191 return ++fmt - start;
2192 }
2193
2194 static void
2195 set_field_width(struct printf_spec *spec, int width)
2196 {
2197 spec->field_width = width;
2198 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2199 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2200 }
2201 }
2202
2203 static void
2204 set_precision(struct printf_spec *spec, int prec)
2205 {
2206 spec->precision = prec;
2207 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2208 spec->precision = clamp(prec, 0, PRECISION_MAX);
2209 }
2210 }
2211
2212 /**
2213 * vsnprintf - Format a string and place it in a buffer
2214 * @buf: The buffer to place the result into
2215 * @size: The size of the buffer, including the trailing null space
2216 * @fmt: The format string to use
2217 * @args: Arguments for the format string
2218 *
2219 * This function generally follows C99 vsnprintf, but has some
2220 * extensions and a few limitations:
2221 *
2222 * - ``%n`` is unsupported
2223 * - ``%p*`` is handled by pointer()
2224 *
2225 * See pointer() or Documentation/printk-formats.txt for more
2226 * extensive description.
2227 *
2228 * **Please update the documentation in both places when making changes**
2229 *
2230 * The return value is the number of characters which would
2231 * be generated for the given input, excluding the trailing
2232 * '\0', as per ISO C99. If you want to have the exact
2233 * number of characters written into @buf as return value
2234 * (not including the trailing '\0'), use vscnprintf(). If the
2235 * return is greater than or equal to @size, the resulting
2236 * string is truncated.
2237 *
2238 * If you're not already dealing with a va_list consider using snprintf().
2239 */
2240 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2241 {
2242 unsigned long long num;
2243 char *str, *end;
2244 struct printf_spec spec = {0};
2245
2246 /* Reject out-of-range values early. Large positive sizes are
2247 used for unknown buffer sizes. */
2248 if (WARN_ON_ONCE(size > INT_MAX))
2249 return 0;
2250
2251 str = buf;
2252 end = buf + size;
2253
2254 /* Make sure end is always >= buf */
2255 if (end < buf) {
2256 end = ((void *)-1);
2257 size = end - buf;
2258 }
2259
2260 while (*fmt) {
2261 const char *old_fmt = fmt;
2262 int read = format_decode(fmt, &spec);
2263
2264 fmt += read;
2265
2266 switch (spec.type) {
2267 case FORMAT_TYPE_NONE: {
2268 int copy = read;
2269 if (str < end) {
2270 if (copy > end - str)
2271 copy = end - str;
2272 memcpy(str, old_fmt, copy);
2273 }
2274 str += read;
2275 break;
2276 }
2277
2278 case FORMAT_TYPE_WIDTH:
2279 set_field_width(&spec, va_arg(args, int));
2280 break;
2281
2282 case FORMAT_TYPE_PRECISION:
2283 set_precision(&spec, va_arg(args, int));
2284 break;
2285
2286 case FORMAT_TYPE_CHAR: {
2287 char c;
2288
2289 if (!(spec.flags & LEFT)) {
2290 while (--spec.field_width > 0) {
2291 if (str < end)
2292 *str = ' ';
2293 ++str;
2294
2295 }
2296 }
2297 c = (unsigned char) va_arg(args, int);
2298 if (str < end)
2299 *str = c;
2300 ++str;
2301 while (--spec.field_width > 0) {
2302 if (str < end)
2303 *str = ' ';
2304 ++str;
2305 }
2306 break;
2307 }
2308
2309 case FORMAT_TYPE_STR:
2310 str = string(str, end, va_arg(args, char *), spec);
2311 break;
2312
2313 case FORMAT_TYPE_PTR:
2314 str = pointer(fmt, str, end, va_arg(args, void *),
2315 spec);
2316 while (isalnum(*fmt))
2317 fmt++;
2318 break;
2319
2320 case FORMAT_TYPE_PERCENT_CHAR:
2321 if (str < end)
2322 *str = '%';
2323 ++str;
2324 break;
2325
2326 case FORMAT_TYPE_INVALID:
2327 /*
2328 * Presumably the arguments passed gcc's type
2329 * checking, but there is no safe or sane way
2330 * for us to continue parsing the format and
2331 * fetching from the va_list; the remaining
2332 * specifiers and arguments would be out of
2333 * sync.
2334 */
2335 goto out;
2336
2337 default:
2338 switch (spec.type) {
2339 case FORMAT_TYPE_LONG_LONG:
2340 num = va_arg(args, long long);
2341 break;
2342 case FORMAT_TYPE_ULONG:
2343 num = va_arg(args, unsigned long);
2344 break;
2345 case FORMAT_TYPE_LONG:
2346 num = va_arg(args, long);
2347 break;
2348 case FORMAT_TYPE_SIZE_T:
2349 if (spec.flags & SIGN)
2350 num = va_arg(args, ssize_t);
2351 else
2352 num = va_arg(args, size_t);
2353 break;
2354 case FORMAT_TYPE_PTRDIFF:
2355 num = va_arg(args, ptrdiff_t);
2356 break;
2357 case FORMAT_TYPE_UBYTE:
2358 num = (unsigned char) va_arg(args, int);
2359 break;
2360 case FORMAT_TYPE_BYTE:
2361 num = (signed char) va_arg(args, int);
2362 break;
2363 case FORMAT_TYPE_USHORT:
2364 num = (unsigned short) va_arg(args, int);
2365 break;
2366 case FORMAT_TYPE_SHORT:
2367 num = (short) va_arg(args, int);
2368 break;
2369 case FORMAT_TYPE_INT:
2370 num = (int) va_arg(args, int);
2371 break;
2372 default:
2373 num = va_arg(args, unsigned int);
2374 }
2375
2376 str = number(str, end, num, spec);
2377 }
2378 }
2379
2380 out:
2381 if (size > 0) {
2382 if (str < end)
2383 *str = '\0';
2384 else
2385 end[-1] = '\0';
2386 }
2387
2388 /* the trailing null byte doesn't count towards the total */
2389 return str-buf;
2390
2391 }
2392 EXPORT_SYMBOL(vsnprintf);
2393
2394 /**
2395 * vscnprintf - Format a string and place it in a buffer
2396 * @buf: The buffer to place the result into
2397 * @size: The size of the buffer, including the trailing null space
2398 * @fmt: The format string to use
2399 * @args: Arguments for the format string
2400 *
2401 * The return value is the number of characters which have been written into
2402 * the @buf not including the trailing '\0'. If @size is == 0 the function
2403 * returns 0.
2404 *
2405 * If you're not already dealing with a va_list consider using scnprintf().
2406 *
2407 * See the vsnprintf() documentation for format string extensions over C99.
2408 */
2409 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2410 {
2411 int i;
2412
2413 i = vsnprintf(buf, size, fmt, args);
2414
2415 if (likely(i < size))
2416 return i;
2417 if (size != 0)
2418 return size - 1;
2419 return 0;
2420 }
2421 EXPORT_SYMBOL(vscnprintf);
2422
2423 /**
2424 * snprintf - Format a string and place it in a buffer
2425 * @buf: The buffer to place the result into
2426 * @size: The size of the buffer, including the trailing null space
2427 * @fmt: The format string to use
2428 * @...: Arguments for the format string
2429 *
2430 * The return value is the number of characters which would be
2431 * generated for the given input, excluding the trailing null,
2432 * as per ISO C99. If the return is greater than or equal to
2433 * @size, the resulting string is truncated.
2434 *
2435 * See the vsnprintf() documentation for format string extensions over C99.
2436 */
2437 int snprintf(char *buf, size_t size, const char *fmt, ...)
2438 {
2439 va_list args;
2440 int i;
2441
2442 va_start(args, fmt);
2443 i = vsnprintf(buf, size, fmt, args);
2444 va_end(args);
2445
2446 return i;
2447 }
2448 EXPORT_SYMBOL(snprintf);
2449
2450 /**
2451 * scnprintf - Format a string and place it in a buffer
2452 * @buf: The buffer to place the result into
2453 * @size: The size of the buffer, including the trailing null space
2454 * @fmt: The format string to use
2455 * @...: Arguments for the format string
2456 *
2457 * The return value is the number of characters written into @buf not including
2458 * the trailing '\0'. If @size is == 0 the function returns 0.
2459 */
2460
2461 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2462 {
2463 va_list args;
2464 int i;
2465
2466 va_start(args, fmt);
2467 i = vscnprintf(buf, size, fmt, args);
2468 va_end(args);
2469
2470 return i;
2471 }
2472 EXPORT_SYMBOL(scnprintf);
2473
2474 /**
2475 * vsprintf - Format a string and place it in a buffer
2476 * @buf: The buffer to place the result into
2477 * @fmt: The format string to use
2478 * @args: Arguments for the format string
2479 *
2480 * The function returns the number of characters written
2481 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2482 * buffer overflows.
2483 *
2484 * If you're not already dealing with a va_list consider using sprintf().
2485 *
2486 * See the vsnprintf() documentation for format string extensions over C99.
2487 */
2488 int vsprintf(char *buf, const char *fmt, va_list args)
2489 {
2490 return vsnprintf(buf, INT_MAX, fmt, args);
2491 }
2492 EXPORT_SYMBOL(vsprintf);
2493
2494 /**
2495 * sprintf - Format a string and place it in a buffer
2496 * @buf: The buffer to place the result into
2497 * @fmt: The format string to use
2498 * @...: Arguments for the format string
2499 *
2500 * The function returns the number of characters written
2501 * into @buf. Use snprintf() or scnprintf() in order to avoid
2502 * buffer overflows.
2503 *
2504 * See the vsnprintf() documentation for format string extensions over C99.
2505 */
2506 int sprintf(char *buf, const char *fmt, ...)
2507 {
2508 va_list args;
2509 int i;
2510
2511 va_start(args, fmt);
2512 i = vsnprintf(buf, INT_MAX, fmt, args);
2513 va_end(args);
2514
2515 return i;
2516 }
2517 EXPORT_SYMBOL(sprintf);
2518
2519 #ifdef CONFIG_BINARY_PRINTF
2520 /*
2521 * bprintf service:
2522 * vbin_printf() - VA arguments to binary data
2523 * bstr_printf() - Binary data to text string
2524 */
2525
2526 /**
2527 * vbin_printf - Parse a format string and place args' binary value in a buffer
2528 * @bin_buf: The buffer to place args' binary value
2529 * @size: The size of the buffer(by words(32bits), not characters)
2530 * @fmt: The format string to use
2531 * @args: Arguments for the format string
2532 *
2533 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2534 * is skipped.
2535 *
2536 * The return value is the number of words(32bits) which would be generated for
2537 * the given input.
2538 *
2539 * NOTE:
2540 * If the return value is greater than @size, the resulting bin_buf is NOT
2541 * valid for bstr_printf().
2542 */
2543 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2544 {
2545 struct printf_spec spec = {0};
2546 char *str, *end;
2547
2548 str = (char *)bin_buf;
2549 end = (char *)(bin_buf + size);
2550
2551 #define save_arg(type) \
2552 do { \
2553 if (sizeof(type) == 8) { \
2554 unsigned long long value; \
2555 str = PTR_ALIGN(str, sizeof(u32)); \
2556 value = va_arg(args, unsigned long long); \
2557 if (str + sizeof(type) <= end) { \
2558 *(u32 *)str = *(u32 *)&value; \
2559 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2560 } \
2561 } else { \
2562 unsigned long value; \
2563 str = PTR_ALIGN(str, sizeof(type)); \
2564 value = va_arg(args, int); \
2565 if (str + sizeof(type) <= end) \
2566 *(typeof(type) *)str = (type)value; \
2567 } \
2568 str += sizeof(type); \
2569 } while (0)
2570
2571 while (*fmt) {
2572 int read = format_decode(fmt, &spec);
2573
2574 fmt += read;
2575
2576 switch (spec.type) {
2577 case FORMAT_TYPE_NONE:
2578 case FORMAT_TYPE_PERCENT_CHAR:
2579 break;
2580 case FORMAT_TYPE_INVALID:
2581 goto out;
2582
2583 case FORMAT_TYPE_WIDTH:
2584 case FORMAT_TYPE_PRECISION:
2585 save_arg(int);
2586 break;
2587
2588 case FORMAT_TYPE_CHAR:
2589 save_arg(char);
2590 break;
2591
2592 case FORMAT_TYPE_STR: {
2593 const char *save_str = va_arg(args, char *);
2594 size_t len;
2595
2596 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2597 || (unsigned long)save_str < PAGE_SIZE)
2598 save_str = "(null)";
2599 len = strlen(save_str) + 1;
2600 if (str + len < end)
2601 memcpy(str, save_str, len);
2602 str += len;
2603 break;
2604 }
2605
2606 case FORMAT_TYPE_PTR:
2607 save_arg(void *);
2608 /* skip all alphanumeric pointer suffixes */
2609 while (isalnum(*fmt))
2610 fmt++;
2611 break;
2612
2613 default:
2614 switch (spec.type) {
2615
2616 case FORMAT_TYPE_LONG_LONG:
2617 save_arg(long long);
2618 break;
2619 case FORMAT_TYPE_ULONG:
2620 case FORMAT_TYPE_LONG:
2621 save_arg(unsigned long);
2622 break;
2623 case FORMAT_TYPE_SIZE_T:
2624 save_arg(size_t);
2625 break;
2626 case FORMAT_TYPE_PTRDIFF:
2627 save_arg(ptrdiff_t);
2628 break;
2629 case FORMAT_TYPE_UBYTE:
2630 case FORMAT_TYPE_BYTE:
2631 save_arg(char);
2632 break;
2633 case FORMAT_TYPE_USHORT:
2634 case FORMAT_TYPE_SHORT:
2635 save_arg(short);
2636 break;
2637 default:
2638 save_arg(int);
2639 }
2640 }
2641 }
2642
2643 out:
2644 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2645 #undef save_arg
2646 }
2647 EXPORT_SYMBOL_GPL(vbin_printf);
2648
2649 /**
2650 * bstr_printf - Format a string from binary arguments and place it in a buffer
2651 * @buf: The buffer to place the result into
2652 * @size: The size of the buffer, including the trailing null space
2653 * @fmt: The format string to use
2654 * @bin_buf: Binary arguments for the format string
2655 *
2656 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2657 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2658 * a binary buffer that generated by vbin_printf.
2659 *
2660 * The format follows C99 vsnprintf, but has some extensions:
2661 * see vsnprintf comment for details.
2662 *
2663 * The return value is the number of characters which would
2664 * be generated for the given input, excluding the trailing
2665 * '\0', as per ISO C99. If you want to have the exact
2666 * number of characters written into @buf as return value
2667 * (not including the trailing '\0'), use vscnprintf(). If the
2668 * return is greater than or equal to @size, the resulting
2669 * string is truncated.
2670 */
2671 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2672 {
2673 struct printf_spec spec = {0};
2674 char *str, *end;
2675 const char *args = (const char *)bin_buf;
2676
2677 if (WARN_ON_ONCE(size > INT_MAX))
2678 return 0;
2679
2680 str = buf;
2681 end = buf + size;
2682
2683 #define get_arg(type) \
2684 ({ \
2685 typeof(type) value; \
2686 if (sizeof(type) == 8) { \
2687 args = PTR_ALIGN(args, sizeof(u32)); \
2688 *(u32 *)&value = *(u32 *)args; \
2689 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2690 } else { \
2691 args = PTR_ALIGN(args, sizeof(type)); \
2692 value = *(typeof(type) *)args; \
2693 } \
2694 args += sizeof(type); \
2695 value; \
2696 })
2697
2698 /* Make sure end is always >= buf */
2699 if (end < buf) {
2700 end = ((void *)-1);
2701 size = end - buf;
2702 }
2703
2704 while (*fmt) {
2705 const char *old_fmt = fmt;
2706 int read = format_decode(fmt, &spec);
2707
2708 fmt += read;
2709
2710 switch (spec.type) {
2711 case FORMAT_TYPE_NONE: {
2712 int copy = read;
2713 if (str < end) {
2714 if (copy > end - str)
2715 copy = end - str;
2716 memcpy(str, old_fmt, copy);
2717 }
2718 str += read;
2719 break;
2720 }
2721
2722 case FORMAT_TYPE_WIDTH:
2723 set_field_width(&spec, get_arg(int));
2724 break;
2725
2726 case FORMAT_TYPE_PRECISION:
2727 set_precision(&spec, get_arg(int));
2728 break;
2729
2730 case FORMAT_TYPE_CHAR: {
2731 char c;
2732
2733 if (!(spec.flags & LEFT)) {
2734 while (--spec.field_width > 0) {
2735 if (str < end)
2736 *str = ' ';
2737 ++str;
2738 }
2739 }
2740 c = (unsigned char) get_arg(char);
2741 if (str < end)
2742 *str = c;
2743 ++str;
2744 while (--spec.field_width > 0) {
2745 if (str < end)
2746 *str = ' ';
2747 ++str;
2748 }
2749 break;
2750 }
2751
2752 case FORMAT_TYPE_STR: {
2753 const char *str_arg = args;
2754 args += strlen(str_arg) + 1;
2755 str = string(str, end, (char *)str_arg, spec);
2756 break;
2757 }
2758
2759 case FORMAT_TYPE_PTR:
2760 str = pointer(fmt, str, end, get_arg(void *), spec);
2761 while (isalnum(*fmt))
2762 fmt++;
2763 break;
2764
2765 case FORMAT_TYPE_PERCENT_CHAR:
2766 if (str < end)
2767 *str = '%';
2768 ++str;
2769 break;
2770
2771 case FORMAT_TYPE_INVALID:
2772 goto out;
2773
2774 default: {
2775 unsigned long long num;
2776
2777 switch (spec.type) {
2778
2779 case FORMAT_TYPE_LONG_LONG:
2780 num = get_arg(long long);
2781 break;
2782 case FORMAT_TYPE_ULONG:
2783 case FORMAT_TYPE_LONG:
2784 num = get_arg(unsigned long);
2785 break;
2786 case FORMAT_TYPE_SIZE_T:
2787 num = get_arg(size_t);
2788 break;
2789 case FORMAT_TYPE_PTRDIFF:
2790 num = get_arg(ptrdiff_t);
2791 break;
2792 case FORMAT_TYPE_UBYTE:
2793 num = get_arg(unsigned char);
2794 break;
2795 case FORMAT_TYPE_BYTE:
2796 num = get_arg(signed char);
2797 break;
2798 case FORMAT_TYPE_USHORT:
2799 num = get_arg(unsigned short);
2800 break;
2801 case FORMAT_TYPE_SHORT:
2802 num = get_arg(short);
2803 break;
2804 case FORMAT_TYPE_UINT:
2805 num = get_arg(unsigned int);
2806 break;
2807 default:
2808 num = get_arg(int);
2809 }
2810
2811 str = number(str, end, num, spec);
2812 } /* default: */
2813 } /* switch(spec.type) */
2814 } /* while(*fmt) */
2815
2816 out:
2817 if (size > 0) {
2818 if (str < end)
2819 *str = '\0';
2820 else
2821 end[-1] = '\0';
2822 }
2823
2824 #undef get_arg
2825
2826 /* the trailing null byte doesn't count towards the total */
2827 return str - buf;
2828 }
2829 EXPORT_SYMBOL_GPL(bstr_printf);
2830
2831 /**
2832 * bprintf - Parse a format string and place args' binary value in a buffer
2833 * @bin_buf: The buffer to place args' binary value
2834 * @size: The size of the buffer(by words(32bits), not characters)
2835 * @fmt: The format string to use
2836 * @...: Arguments for the format string
2837 *
2838 * The function returns the number of words(u32) written
2839 * into @bin_buf.
2840 */
2841 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2842 {
2843 va_list args;
2844 int ret;
2845
2846 va_start(args, fmt);
2847 ret = vbin_printf(bin_buf, size, fmt, args);
2848 va_end(args);
2849
2850 return ret;
2851 }
2852 EXPORT_SYMBOL_GPL(bprintf);
2853
2854 #endif /* CONFIG_BINARY_PRINTF */
2855
2856 /**
2857 * vsscanf - Unformat a buffer into a list of arguments
2858 * @buf: input buffer
2859 * @fmt: format of buffer
2860 * @args: arguments
2861 */
2862 int vsscanf(const char *buf, const char *fmt, va_list args)
2863 {
2864 const char *str = buf;
2865 char *next;
2866 char digit;
2867 int num = 0;
2868 u8 qualifier;
2869 unsigned int base;
2870 union {
2871 long long s;
2872 unsigned long long u;
2873 } val;
2874 s16 field_width;
2875 bool is_sign;
2876
2877 while (*fmt) {
2878 /* skip any white space in format */
2879 /* white space in format matchs any amount of
2880 * white space, including none, in the input.
2881 */
2882 if (isspace(*fmt)) {
2883 fmt = skip_spaces(++fmt);
2884 str = skip_spaces(str);
2885 }
2886
2887 /* anything that is not a conversion must match exactly */
2888 if (*fmt != '%' && *fmt) {
2889 if (*fmt++ != *str++)
2890 break;
2891 continue;
2892 }
2893
2894 if (!*fmt)
2895 break;
2896 ++fmt;
2897
2898 /* skip this conversion.
2899 * advance both strings to next white space
2900 */
2901 if (*fmt == '*') {
2902 if (!*str)
2903 break;
2904 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
2905 /* '%*[' not yet supported, invalid format */
2906 if (*fmt == '[')
2907 return num;
2908 fmt++;
2909 }
2910 while (!isspace(*str) && *str)
2911 str++;
2912 continue;
2913 }
2914
2915 /* get field width */
2916 field_width = -1;
2917 if (isdigit(*fmt)) {
2918 field_width = skip_atoi(&fmt);
2919 if (field_width <= 0)
2920 break;
2921 }
2922
2923 /* get conversion qualifier */
2924 qualifier = -1;
2925 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2926 *fmt == 'z') {
2927 qualifier = *fmt++;
2928 if (unlikely(qualifier == *fmt)) {
2929 if (qualifier == 'h') {
2930 qualifier = 'H';
2931 fmt++;
2932 } else if (qualifier == 'l') {
2933 qualifier = 'L';
2934 fmt++;
2935 }
2936 }
2937 }
2938
2939 if (!*fmt)
2940 break;
2941
2942 if (*fmt == 'n') {
2943 /* return number of characters read so far */
2944 *va_arg(args, int *) = str - buf;
2945 ++fmt;
2946 continue;
2947 }
2948
2949 if (!*str)
2950 break;
2951
2952 base = 10;
2953 is_sign = false;
2954
2955 switch (*fmt++) {
2956 case 'c':
2957 {
2958 char *s = (char *)va_arg(args, char*);
2959 if (field_width == -1)
2960 field_width = 1;
2961 do {
2962 *s++ = *str++;
2963 } while (--field_width > 0 && *str);
2964 num++;
2965 }
2966 continue;
2967 case 's':
2968 {
2969 char *s = (char *)va_arg(args, char *);
2970 if (field_width == -1)
2971 field_width = SHRT_MAX;
2972 /* first, skip leading white space in buffer */
2973 str = skip_spaces(str);
2974
2975 /* now copy until next white space */
2976 while (*str && !isspace(*str) && field_width--)
2977 *s++ = *str++;
2978 *s = '\0';
2979 num++;
2980 }
2981 continue;
2982 /*
2983 * Warning: This implementation of the '[' conversion specifier
2984 * deviates from its glibc counterpart in the following ways:
2985 * (1) It does NOT support ranges i.e. '-' is NOT a special
2986 * character
2987 * (2) It cannot match the closing bracket ']' itself
2988 * (3) A field width is required
2989 * (4) '%*[' (discard matching input) is currently not supported
2990 *
2991 * Example usage:
2992 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
2993 * buf1, buf2, buf3);
2994 * if (ret < 3)
2995 * // etc..
2996 */
2997 case '[':
2998 {
2999 char *s = (char *)va_arg(args, char *);
3000 DECLARE_BITMAP(set, 256) = {0};
3001 unsigned int len = 0;
3002 bool negate = (*fmt == '^');
3003
3004 /* field width is required */
3005 if (field_width == -1)
3006 return num;
3007
3008 if (negate)
3009 ++fmt;
3010
3011 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3012 set_bit((u8)*fmt, set);
3013
3014 /* no ']' or no character set found */
3015 if (!*fmt || !len)
3016 return num;
3017 ++fmt;
3018
3019 if (negate) {
3020 bitmap_complement(set, set, 256);
3021 /* exclude null '\0' byte */
3022 clear_bit(0, set);
3023 }
3024
3025 /* match must be non-empty */
3026 if (!test_bit((u8)*str, set))
3027 return num;
3028
3029 while (test_bit((u8)*str, set) && field_width--)
3030 *s++ = *str++;
3031 *s = '\0';
3032 ++num;
3033 }
3034 continue;
3035 case 'o':
3036 base = 8;
3037 break;
3038 case 'x':
3039 case 'X':
3040 base = 16;
3041 break;
3042 case 'i':
3043 base = 0;
3044 case 'd':
3045 is_sign = true;
3046 case 'u':
3047 break;
3048 case '%':
3049 /* looking for '%' in str */
3050 if (*str++ != '%')
3051 return num;
3052 continue;
3053 default:
3054 /* invalid format; stop here */
3055 return num;
3056 }
3057
3058 /* have some sort of integer conversion.
3059 * first, skip white space in buffer.
3060 */
3061 str = skip_spaces(str);
3062
3063 digit = *str;
3064 if (is_sign && digit == '-')
3065 digit = *(str + 1);
3066
3067 if (!digit
3068 || (base == 16 && !isxdigit(digit))
3069 || (base == 10 && !isdigit(digit))
3070 || (base == 8 && (!isdigit(digit) || digit > '7'))
3071 || (base == 0 && !isdigit(digit)))
3072 break;
3073
3074 if (is_sign)
3075 val.s = qualifier != 'L' ?
3076 simple_strtol(str, &next, base) :
3077 simple_strtoll(str, &next, base);
3078 else
3079 val.u = qualifier != 'L' ?
3080 simple_strtoul(str, &next, base) :
3081 simple_strtoull(str, &next, base);
3082
3083 if (field_width > 0 && next - str > field_width) {
3084 if (base == 0)
3085 _parse_integer_fixup_radix(str, &base);
3086 while (next - str > field_width) {
3087 if (is_sign)
3088 val.s = div_s64(val.s, base);
3089 else
3090 val.u = div_u64(val.u, base);
3091 --next;
3092 }
3093 }
3094
3095 switch (qualifier) {
3096 case 'H': /* that's 'hh' in format */
3097 if (is_sign)
3098 *va_arg(args, signed char *) = val.s;
3099 else
3100 *va_arg(args, unsigned char *) = val.u;
3101 break;
3102 case 'h':
3103 if (is_sign)
3104 *va_arg(args, short *) = val.s;
3105 else
3106 *va_arg(args, unsigned short *) = val.u;
3107 break;
3108 case 'l':
3109 if (is_sign)
3110 *va_arg(args, long *) = val.s;
3111 else
3112 *va_arg(args, unsigned long *) = val.u;
3113 break;
3114 case 'L':
3115 if (is_sign)
3116 *va_arg(args, long long *) = val.s;
3117 else
3118 *va_arg(args, unsigned long long *) = val.u;
3119 break;
3120 case 'z':
3121 *va_arg(args, size_t *) = val.u;
3122 break;
3123 default:
3124 if (is_sign)
3125 *va_arg(args, int *) = val.s;
3126 else
3127 *va_arg(args, unsigned int *) = val.u;
3128 break;
3129 }
3130 num++;
3131
3132 if (!next)
3133 break;
3134 str = next;
3135 }
3136
3137 return num;
3138 }
3139 EXPORT_SYMBOL(vsscanf);
3140
3141 /**
3142 * sscanf - Unformat a buffer into a list of arguments
3143 * @buf: input buffer
3144 * @fmt: formatting of buffer
3145 * @...: resulting arguments
3146 */
3147 int sscanf(const char *buf, const char *fmt, ...)
3148 {
3149 va_list args;
3150 int i;
3151
3152 va_start(args, fmt);
3153 i = vsscanf(buf, fmt, args);
3154 va_end(args);
3155
3156 return i;
3157 }
3158 EXPORT_SYMBOL(sscanf);
ubuntu-bionic-kernel mirror