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