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