projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
zram: use __bio_add_page for adding single page to bio
[linux-block.git] / lib / vsprintf.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT		 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
7b9186f5 13/*
1da177e4
LT		 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
c0891ac1 20#include <linux/stdarg.h>
ef27ac18 21#include <linux/build_bug.h>
0d1d7a55 22#include <linux/clk.h>
900cca29 23#include <linux/clk-provider.h>
57f5677e 24#include <linux/errname.h>
8bc3bcc9 25#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
1da177e4
LT		 26#include <linux/types.h>
27#include <linux/string.h>
28#include <linux/ctype.h>
29#include <linux/kernel.h>
0fe1ef24 30#include <linux/kallsyms.h>
53809751 31#include <linux/math64.h>
0fe1ef24 32#include <linux/uaccess.h>
332d2e78 33#include <linux/ioport.h>
4b6ccca7 34#include <linux/dcache.h>
312b4e22 35#include <linux/cred.h>
4d42c447 36#include <linux/rtc.h>
7daac5b2 37#include <linux/time.h>
2b1b0d66 38#include <linux/uuid.h>
ce4fecf1 39#include <linux/of.h>
8a27f7c9 40#include <net/addrconf.h>
ad67b74d
TH		 41#include <linux/siphash.h>
42#include <linux/compiler.h>
a92eb762 43#include <linux/property.h>
898f1e5c 44#include <linux/notifier.h>
1031bc58
DM		 45#ifdef CONFIG_BLOCK
46#include <linux/blkdev.h>
47#endif
1da177e4 48
edf14cdb
VB		 49#include "../mm/internal.h" /* For the trace_print_flags arrays */
50
4e57b681 51#include <asm/page.h> /* for PAGE_SIZE */
7c43d9a3 52#include <asm/byteorder.h> /* cpu_to_le16 */
d75b26f8 53#include <asm/unaligned.h>
1da177e4 54
71dca95d 55#include <linux/string_helpers.h>
1dff46d6 56#include "kstrtox.h"
aa46a63e 57
84842911
CL		 58/* Disable pointer hashing if requested */
59bool no_hash_pointers __ro_after_init;
60EXPORT_SYMBOL_GPL(no_hash_pointers);
61
839b395e 62static noinline unsigned long long simple_strntoull(const char *startp, size_t max_chars, char **endp, unsigned int base)
900fdc45
RF		 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
1da177e4 86/**
922ac25c 87 * simple_strtoull - convert a string to an unsigned long long
1da177e4
LT		 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
462e4711 91 *
e8cc2b97 92 * This function has caveats. Please use kstrtoull instead.
1da177e4 93 */
ad65dcef 94noinline
922ac25c 95unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
1da177e4 96{
900fdc45 97 return simple_strntoull(cp, INT_MAX, endp, base);
1da177e4 98}
922ac25c 99EXPORT_SYMBOL(simple_strtoull);
1da177e4
LT		 100
101/**
922ac25c 102 * simple_strtoul - convert a string to an unsigned long
1da177e4
LT		 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
462e4711 106 *
e8cc2b97 107 * This function has caveats. Please use kstrtoul instead.
1da177e4 108 */
922ac25c 109unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
1da177e4 110{
922ac25c 111 return simple_strtoull(cp, endp, base);
1da177e4 112}
922ac25c 113EXPORT_SYMBOL(simple_strtoul);
1da177e4
LT		 114
115/**
922ac25c 116 * simple_strtol - convert a string to a signed long
1da177e4
LT		 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
462e4711 120 *
e8cc2b97 121 * This function has caveats. Please use kstrtol instead.
1da177e4 122 */
922ac25c 123long simple_strtol(const char *cp, char **endp, unsigned int base)
1da177e4 124{
922ac25c
AGR		 125 if (*cp == '-')
126 return -simple_strtoul(cp + 1, endp, base);
7b9186f5 127
922ac25c 128 return simple_strtoul(cp, endp, base);
1da177e4 129}
922ac25c 130EXPORT_SYMBOL(simple_strtol);
1da177e4 131
900fdc45
RF		 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
1da177e4
LT		 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
462e4711 152 *
e8cc2b97 153 * This function has caveats. Please use kstrtoll instead.
1da177e4 154 */
22d27051 155long long simple_strtoll(const char *cp, char **endp, unsigned int base)
1da177e4 156{
900fdc45 157 return simple_strntoll(cp, INT_MAX, endp, base);
1da177e4 158}
98d5ce0d 159EXPORT_SYMBOL(simple_strtoll);
1da177e4 160
cf3b429b
JP		 161static noinline_for_stack
162int skip_atoi(const char **s)
1da177e4 163{
7b9186f5 164 int i = 0;
1da177e4 165
43e5b666 166 do {
1da177e4 167 i = i*10 + *((*s)++) - '0';
43e5b666 168 } while (isdigit(**s));
7b9186f5 169
1da177e4
LT		 170 return i;
171}
172
7c43d9a3
RV		 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.
133fd9f5 196 */
4277eedd 197
7c43d9a3
RV		 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
675cf53c
RV		 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.
7c43d9a3 218*/
cf3b429b 219static noinline_for_stack
7c43d9a3 220char *put_dec_trunc8(char *buf, unsigned r)
4277eedd 221{
7c43d9a3
RV		 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];
675cf53c 256 buf += r < 10 ? 1 : 2;
4277eedd
DV		 257 return buf;
258}
133fd9f5 259
7c43d9a3 260#if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
cf3b429b 261static noinline_for_stack
7c43d9a3 262char *put_dec_full8(char *buf, unsigned r)
4277eedd 263{
133fd9f5
DV		 264 unsigned q;
265
7c43d9a3
RV		 266 /* 0 <= r < 10^8 */
267 q = (r * (u64)0x28f5c29) >> 32;
268 *((u16 *)buf) = decpair[r - 100*q];
269 buf += 2;
4277eedd 270
7c43d9a3
RV		 271 /* 0 <= q < 10^6 */
272 r = (q * (u64)0x28f5c29) >> 32;
273 *((u16 *)buf) = decpair[q - 100*r];
274 buf += 2;
7b9186f5 275
7c43d9a3
RV		 276 /* 0 <= r < 10^4 */
277 q = (r * 0x147b) >> 19;
278 *((u16 *)buf) = decpair[r - 100*q];
279 buf += 2;
133fd9f5 280
7c43d9a3
RV		 281 /* 0 <= q < 100 */
282 *((u16 *)buf) = decpair[q];
283 buf += 2;
284 return buf;
285}
133fd9f5 286
7c43d9a3 287static noinline_for_stack
133fd9f5
DV		 288char *put_dec(char *buf, unsigned long long n)
289{
7c43d9a3
RV		 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 */
133fd9f5 296 return put_dec_trunc8(buf, n);
4277eedd 297}
133fd9f5 298
7c43d9a3 299#elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
133fd9f5 300
7c43d9a3
RV		 301static void
302put_dec_full4(char *buf, unsigned r)
4277eedd 303{
7c43d9a3
RV		 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];
2359172a
GS		 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.
7c43d9a3 319 * (second call in the put_dec code, assuming n is all-ones).
2359172a 320 */
7c43d9a3 321static noinline_for_stack
2359172a
GS		 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;
4277eedd
DV		 328}
329
133fd9f5
DV		 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
7c43d9a3
RV		 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 */
133fd9f5 350 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
2359172a
GS		 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);
133fd9f5 358
2359172a
GS		 359 q += 281 * d3;
360 buf += 12;
361 if (q)
362 buf = put_dec_trunc8(buf, q);
363 else while (buf[-1] == '0')
133fd9f5
DV		 364 --buf;
365
366 return buf;
367}
368
369#endif
370
1ac101a5
KH		 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 */
d1be35cb 377int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
1ac101a5 378{
7c43d9a3
RV		 379 /* put_dec requires 2-byte alignment of the buffer. */
380 char tmp[sizeof(num) * 3] __aligned(2);
1ac101a5
KH		 381 int idx, len;
382
133fd9f5
DV		 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 }
1ac101a5 390
d1be35cb 391 if (len > size || width > size)
1ac101a5 392 return 0;
d1be35cb
AV		 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
1ac101a5 402 for (idx = 0; idx < len; ++idx)
d1be35cb
AV		 403 buf[idx + width] = tmp[len - idx - 1];
404
405 return len + width;
1ac101a5
KH		 406}
407
51be17df 408#define SIGN 1 /* unsigned/signed, must be 1 */
d1c1b121 409#define LEFT 2 /* left justified */
1da177e4
LT		 410#define PLUS 4 /* show plus */
411#define SPACE 8 /* space if plus */
d1c1b121 412#define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
b89dc5d6
BH		 413#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
414#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
1da177e4 415
24a1dffb 416static_assert(SIGN == 1);
b886690d 417static_assert(ZEROPAD == ('0' - ' '));
24a1dffb 418static_assert(SMALL == ('a' ^ 'A'));
b886690d 419
fef20d9c
FW		 420enum format_type {
421 FORMAT_TYPE_NONE, /* Just a string part */
ed681a91 422 FORMAT_TYPE_WIDTH,
fef20d9c
FW		 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,
a4e94ef0
Z		 432 FORMAT_TYPE_UBYTE,
433 FORMAT_TYPE_BYTE,
fef20d9c
FW		 434 FORMAT_TYPE_USHORT,
435 FORMAT_TYPE_SHORT,
436 FORMAT_TYPE_UINT,
437 FORMAT_TYPE_INT,
fef20d9c
FW		 438 FORMAT_TYPE_SIZE_T,
439 FORMAT_TYPE_PTRDIFF
440};
441
442struct printf_spec {
d0484193
RV		 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;
ef27ac18
RV		 449static_assert(sizeof(struct printf_spec) == 8);
450
4d72ba01
RV		 451#define FIELD_WIDTH_MAX ((1 << 23) - 1)
452#define PRECISION_MAX ((1 << 15) - 1)
fef20d9c 453
cf3b429b
JP		 454static noinline_for_stack
455char *number(char *buf, char *end, unsigned long long num,
456 struct printf_spec spec)
1da177e4 457{
7c43d9a3
RV		 458 /* put_dec requires 2-byte alignment of the buffer. */
459 char tmp[3 * sizeof(num)] __aligned(2);
9b706aee
DV		 460 char sign;
461 char locase;
fef20d9c 462 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
1da177e4 463 int i;
7c203422 464 bool is_zero = num == 0LL;
1c7a8e62
RV		 465 int field_width = spec.field_width;
466 int precision = spec.precision;
1da177e4 467
9b706aee
DV		 468 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
469 * produces same digits or (maybe lowercased) letters */
fef20d9c
FW		 470 locase = (spec.flags & SMALL);
471 if (spec.flags & LEFT)
472 spec.flags &= ~ZEROPAD;
1da177e4 473 sign = 0;
fef20d9c 474 if (spec.flags & SIGN) {
7b9186f5 475 if ((signed long long)num < 0) {
1da177e4 476 sign = '-';
7b9186f5 477 num = -(signed long long)num;
1c7a8e62 478 field_width--;
fef20d9c 479 } else if (spec.flags & PLUS) {
1da177e4 480 sign = '+';
1c7a8e62 481 field_width--;
fef20d9c 482 } else if (spec.flags & SPACE) {
1da177e4 483 sign = ' ';
1c7a8e62 484 field_width--;
1da177e4
LT		 485 }
486 }
b39a7340 487 if (need_pfx) {
fef20d9c 488 if (spec.base == 16)
1c7a8e62 489 field_width -= 2;
7c203422 490 else if (!is_zero)
1c7a8e62 491 field_width--;
1da177e4 492 }
b39a7340
DV		 493
494 /* generate full string in tmp[], in reverse order */
1da177e4 495 i = 0;
133fd9f5 496 if (num < spec.base)
3ea8d440 497 tmp[i++] = hex_asc_upper[num] | locase;
fef20d9c
FW		 498 else if (spec.base != 10) { /* 8 or 16 */
499 int mask = spec.base - 1;
b39a7340 500 int shift = 3;
7b9186f5
AGR		 501
502 if (spec.base == 16)
503 shift = 4;
b39a7340 504 do {
3ea8d440 505 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
b39a7340
DV		 506 num >>= shift;
507 } while (num);
4277eedd
DV		 508 } else { /* base 10 */
509 i = put_dec(tmp, num) - tmp;
510 }
b39a7340
DV		 511
512 /* printing 100 using %2d gives "100", not "00" */
1c7a8e62
RV		 513 if (i > precision)
514 precision = i;
b39a7340 515 /* leading space padding */
1c7a8e62 516 field_width -= precision;
51be17df 517 if (!(spec.flags & (ZEROPAD | LEFT))) {
1c7a8e62 518 while (--field_width >= 0) {
f796937a 519 if (buf < end)
1da177e4
LT		 520 *buf = ' ';
521 ++buf;
522 }
523 }
b39a7340 524 /* sign */
1da177e4 525 if (sign) {
f796937a 526 if (buf < end)
1da177e4
LT		 527 *buf = sign;
528 ++buf;
529 }
b39a7340
DV		 530 /* "0x" / "0" prefix */
531 if (need_pfx) {
7c203422
PC		 532 if (spec.base == 16 || !is_zero) {
533 if (buf < end)
534 *buf = '0';
535 ++buf;
536 }
fef20d9c 537 if (spec.base == 16) {
f796937a 538 if (buf < end)
9b706aee 539 *buf = ('X' | locase);
1da177e4
LT		 540 ++buf;
541 }
542 }
b39a7340 543 /* zero or space padding */
fef20d9c 544 if (!(spec.flags & LEFT)) {
d1c1b121 545 char c = ' ' + (spec.flags & ZEROPAD);
b886690d 546
1c7a8e62 547 while (--field_width >= 0) {
f796937a 548 if (buf < end)
1da177e4
LT		 549 *buf = c;
550 ++buf;
551 }
552 }
b39a7340 553 /* hmm even more zero padding? */
1c7a8e62 554 while (i <= --precision) {
f796937a 555 if (buf < end)
1da177e4
LT		 556 *buf = '0';
557 ++buf;
558 }
b39a7340
DV		 559 /* actual digits of result */
560 while (--i >= 0) {
f796937a 561 if (buf < end)
1da177e4
LT		 562 *buf = tmp[i];
563 ++buf;
564 }
b39a7340 565 /* trailing space padding */
1c7a8e62 566 while (--field_width >= 0) {
f796937a 567 if (buf < end)
1da177e4
LT		 568 *buf = ' ';
569 ++buf;
570 }
7b9186f5 571
1da177e4
LT		 572 return buf;
573}
574
3cab1e71
AS		 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
cfccde04 589static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
4b6ccca7
AV		 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
cfccde04
RV		 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
d529ac41
PM		 636/* Handle string from a well known address. */
637static char *string_nocheck(char *buf, char *end, const char *s,
638 struct printf_spec spec)
95508cfa 639{
34fc8b90 640 int len = 0;
b314dd49 641 int lim = spec.precision;
95508cfa 642
34fc8b90
RV		 643 while (lim--) {
644 char c = *s++;
645 if (!c)
646 break;
95508cfa 647 if (buf < end)
34fc8b90 648 *buf = c;
95508cfa 649 ++buf;
34fc8b90 650 ++len;
95508cfa 651 }
34fc8b90 652 return widen_string(buf, len, end, spec);
95508cfa
RV		 653}
654
57f5677e
RV		 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
c8c3b584
PM		 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
3e5903eb 689/*
2ac5a3bf
PM		 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.
3e5903eb
PM		 693 */
694static const char *check_pointer_msg(const void *ptr)
695{
3e5903eb
PM		 696 if (!ptr)
697 return "(null)";
698
2ac5a3bf 699 if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
3e5903eb
PM		 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) {
c8c3b584 712 *buf = error_string(*buf, end, err_msg, spec);
3e5903eb
PM		 713 return -EFAULT;
714 }
715
716 return 0;
717}
718
9073dac1 719static noinline_for_stack
d529ac41
PM		 720char *string(char *buf, char *end, const char *s,
721 struct printf_spec spec)
722{
3e5903eb
PM		 723 if (check_pointer(&buf, end, s, spec))
724 return buf;
d529ac41
PM		 725
726 return string_nocheck(buf, end, s, spec);
727}
728
ce9d3ece
Y		 729static char *pointer_string(char *buf, char *end,
730 const void *ptr,
731 struct printf_spec spec)
9073dac1
GU		 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
e4279b59 754static bool filled_random_ptr_key __read_mostly;
6f0ac3b5 755static siphash_key_t ptr_key __read_mostly;
9073dac1 756
898f1e5c 757static int fill_ptr_key(struct notifier_block *nb, unsigned long action, void *data)
9073dac1 758{
6f0ac3b5
SAS		 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);
898f1e5c 764 return NOTIFY_DONE;
6f0ac3b5
SAS		 765}
766
767static int __init vsprintf_init_hashval(void)
768{
898f1e5c
JD		 769 static struct notifier_block fill_ptr_key_nb = { .notifier_call = fill_ptr_key };
770 execute_with_initialized_rng(&fill_ptr_key_nb);
6f0ac3b5 771 return 0;
9073dac1 772}
6f0ac3b5 773subsys_initcall(vsprintf_init_hashval)
9073dac1 774
9073dac1 775/* Maps a pointer to a 32 bit unique identifier. */
e4dcad20
JFG		 776static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
777{
778 unsigned long hashval;
779
6f0ac3b5
SAS		 780 if (!READ_ONCE(filled_random_ptr_key))
781 return -EBUSY;
6701de6c 782
e4279b59
SAS		 783 /* Pairs with smp_wmb() after writing ptr_key. */
784 smp_rmb();
e4dcad20
JFG		 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
9073dac1
GU		 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;
e4dcad20 810 int ret;
9073dac1 811
7bd57fbc
ID		 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
9073dac1
GU		 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
e4dcad20
JFG		 825 ret = __ptr_to_hashval(ptr, &hashval);
826 if (ret) {
9073dac1
GU		 827 spec.field_width = 2 * sizeof(ptr);
828 /* string length must be less than default_width */
c8c3b584 829 return error_string(buf, end, str, spec);
9073dac1
GU		 830 }
831
9073dac1
GU		 832 return pointer_string(buf, end, (const void *)hashval, spec);
833}
834
84842911
CL		 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
6eea242f
PM		 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:
1ac2f978 856 /* Handle as %p, hash and do _not_ leak addresses. */
84842911 857 return default_pointer(buf, end, ptr, spec);
6eea242f
PM		 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 */
66283a8f 865 if (in_hardirq() || in_serving_softirq() || in_nmi()) {
6eea242f
PM		 866 if (spec.field_width == -1)
867 spec.field_width = 2 * sizeof(ptr);
c8c3b584 868 return error_string(buf, end, "pK-error", spec);
6eea242f
PM		 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
4b6ccca7
AV		 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) {
3e5903eb
PM		 916 if (check_pointer(&buf, end, d, spec)) {
917 rcu_read_unlock();
918 return buf;
919 }
920
6aa7de05
MR		 921 p = READ_ONCE(d->d_parent);
922 array[i] = READ_ONCE(d->d_name.name);
4b6ccca7
AV		 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();
cfccde04 943 return widen_string(buf, n, end, spec);
4b6ccca7
AV		 944}
945
36594b31
JH		 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}
1031bc58
DM		 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{
3e5903eb
PM		 960 struct gendisk *hd;
961
962 if (check_pointer(&buf, end, bdev, spec))
963 return buf;
964
965 hd = bdev->bd_disk;
1031bc58 966 buf = string(buf, end, hd->disk_name, spec);
700cd59d 967 if (bdev->bd_partno) {
1031bc58
DM		 968 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
969 if (buf < end)
970 *buf = 'p';
971 buf++;
972 }
700cd59d 973 buf = number(buf, end, bdev->bd_partno, spec);
1031bc58
DM		 974 }
975 return buf;
976}
977#endif
978
cf3b429b
JP		 979static noinline_for_stack
980char *symbol_string(char *buf, char *end, void *ptr,
b0d33c2b 981 struct printf_spec spec, const char *fmt)
0fe1ef24 982{
b0d33c2b 983 unsigned long value;
0fe1ef24
LT		 984#ifdef CONFIG_KALLSYMS
985 char sym[KSYM_SYMBOL_LEN];
b0d33c2b
JP		 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
9294523e
SB		 993 if (*fmt == 'B' && fmt[1] == 'b')
994 sprint_backtrace_build_id(sym, value);
995 else if (*fmt == 'B')
0f77a8d3 996 sprint_backtrace(sym, value);
9294523e
SB		 997 else if (*fmt == 'S' && (fmt[1] == 'b' || (fmt[1] == 'R' && fmt[2] == 'b')))
998 sprint_symbol_build_id(sym, value);
9af77064 999 else if (*fmt != 's')
0c8b946e
FW		 1000 sprint_symbol(sym, value);
1001 else
4796dd20 1002 sprint_symbol_no_offset(sym, value);
7b9186f5 1003
d529ac41 1004 return string_nocheck(buf, end, sym, spec);
0fe1ef24 1005#else
3cab1e71 1006 return special_hex_number(buf, end, value, sizeof(void *));
0fe1ef24
LT		 1007#endif
1008}
1009
abd4fe62
AS		 1010static const struct printf_spec default_str_spec = {
1011 .field_width = -1,
1012 .precision = -1,
1013};
1014
54433973
AS		 1015static const struct printf_spec default_flag_spec = {
1016 .base = 16,
1017 .precision = -1,
1018 .flags = SPECIAL | SMALL,
1019};
1020
ce0b4910
AS		 1021static const struct printf_spec default_dec_spec = {
1022 .base = 10,
1023 .precision = -1,
1024};
1025
4d42c447
AS		 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
cf3b429b
JP		 1040static noinline_for_stack
1041char *resource_string(char *buf, char *end, struct resource *res,
1042 struct printf_spec spec, const char *fmt)
332d2e78
LT		 1043{
1044#ifndef IO_RSRC_PRINTK_SIZE
28405372 1045#define IO_RSRC_PRINTK_SIZE 6
332d2e78
LT		 1046#endif
1047
1048#ifndef MEM_RSRC_PRINTK_SIZE
28405372 1049#define MEM_RSRC_PRINTK_SIZE 10
332d2e78 1050#endif
4da0b66c 1051 static const struct printf_spec io_spec = {
fef20d9c 1052 .base = 16,
4da0b66c 1053 .field_width = IO_RSRC_PRINTK_SIZE,
fef20d9c
FW		 1054 .precision = -1,
1055 .flags = SPECIAL | SMALL | ZEROPAD,
1056 };
4da0b66c
BH		 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 };
0f4050c7
BH		 1063 static const struct printf_spec bus_spec = {
1064 .base = 16,
1065 .field_width = 2,
1066 .precision = -1,
1067 .flags = SMALL | ZEROPAD,
1068 };
4da0b66c 1069 static const struct printf_spec str_spec = {
fd95541e
BH		 1070 .field_width = -1,
1071 .precision = 10,
1072 .flags = LEFT,
1073 };
c7dabef8
BH		 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))
9d7cca04 1079#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
c7dabef8
BH		 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
332d2e78 1084 char *p = sym, *pend = sym + sizeof(sym);
c7dabef8 1085 int decode = (fmt[0] == 'R') ? 1 : 0;
4da0b66c 1086 const struct printf_spec *specp;
332d2e78 1087
3e5903eb
PM		 1088 if (check_pointer(&buf, end, res, spec))
1089 return buf;
1090
332d2e78 1091 *p++ = '[';
4da0b66c 1092 if (res->flags & IORESOURCE_IO) {
d529ac41 1093 p = string_nocheck(p, pend, "io ", str_spec);
4da0b66c
BH		 1094 specp = &io_spec;
1095 } else if (res->flags & IORESOURCE_MEM) {
d529ac41 1096 p = string_nocheck(p, pend, "mem ", str_spec);
4da0b66c
BH		 1097 specp = &mem_spec;
1098 } else if (res->flags & IORESOURCE_IRQ) {
d529ac41 1099 p = string_nocheck(p, pend, "irq ", str_spec);
ce0b4910 1100 specp = &default_dec_spec;
4da0b66c 1101 } else if (res->flags & IORESOURCE_DMA) {
d529ac41 1102 p = string_nocheck(p, pend, "dma ", str_spec);
ce0b4910 1103 specp = &default_dec_spec;
0f4050c7 1104 } else if (res->flags & IORESOURCE_BUS) {
d529ac41 1105 p = string_nocheck(p, pend, "bus ", str_spec);
0f4050c7 1106 specp = &bus_spec;
4da0b66c 1107 } else {
d529ac41 1108 p = string_nocheck(p, pend, "??? ", str_spec);
4da0b66c 1109 specp = &mem_spec;
c7dabef8 1110 decode = 0;
fd95541e 1111 }
d19cb803 1112 if (decode && res->flags & IORESOURCE_UNSET) {
d529ac41 1113 p = string_nocheck(p, pend, "size ", str_spec);
d19cb803
BH		 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 }
c91d3376 1121 }
c7dabef8 1122 if (decode) {
fd95541e 1123 if (res->flags & IORESOURCE_MEM_64)
d529ac41 1124 p = string_nocheck(p, pend, " 64bit", str_spec);
fd95541e 1125 if (res->flags & IORESOURCE_PREFETCH)
d529ac41 1126 p = string_nocheck(p, pend, " pref", str_spec);
9d7cca04 1127 if (res->flags & IORESOURCE_WINDOW)
d529ac41 1128 p = string_nocheck(p, pend, " window", str_spec);
fd95541e 1129 if (res->flags & IORESOURCE_DISABLED)
d529ac41 1130 p = string_nocheck(p, pend, " disabled", str_spec);
c7dabef8 1131 } else {
d529ac41 1132 p = string_nocheck(p, pend, " flags ", str_spec);
54433973 1133 p = number(p, pend, res->flags, default_flag_spec);
fd95541e 1134 }
332d2e78 1135 *p++ = ']';
c7dabef8 1136 *p = '\0';
332d2e78 1137
d529ac41 1138 return string_nocheck(buf, end, sym, spec);
332d2e78
LT		 1139}
1140
31550a16
AS		 1141static noinline_for_stack
1142char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1143 const char *fmt)
1144{
360603a1 1145 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
31550a16
AS		 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
3e5903eb
PM		 1153 if (check_pointer(&buf, end, addr, spec))
1154 return buf;
31550a16
AS		 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
9c98f235
RV		 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;
31550a16 1181
9c98f235
RV		 1182 if (separator && i != len - 1) {
1183 if (buf < end)
1184 *buf = separator;
1185 ++buf;
1186 }
31550a16
AS		 1187 }
1188
1189 return buf;
1190}
1191
dbc760bc 1192static noinline_for_stack
dc453dd8 1193char *bitmap_string(char *buf, char *end, const unsigned long *bitmap,
dbc760bc
TH		 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
3e5903eb
PM		 1201 if (check_pointer(&buf, end, bitmap, spec))
1202 return buf;
1203
dbc760bc
TH		 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
dc453dd8 1237char *bitmap_list_string(char *buf, char *end, const unsigned long *bitmap,
dbc760bc
TH		 1238 struct printf_spec spec, const char *fmt)
1239{
1240 int nr_bits = max_t(int, spec.field_width, 0);
dbc760bc 1241 bool first = true;
15325b4f 1242 int rbot, rtop;
dbc760bc 1243
3e5903eb
PM		 1244 if (check_pointer(&buf, end, bitmap, spec))
1245 return buf;
1246
15325b4f 1247 for_each_set_bitrange(rbot, rtop, bitmap, nr_bits) {
dbc760bc
TH		 1248 if (!first) {
1249 if (buf < end)
1250 *buf = ',';
1251 buf++;
1252 }
1253 first = false;
1254
ce0b4910 1255 buf = number(buf, end, rbot, default_dec_spec);
15325b4f
YN		 1256 if (rtop == rbot + 1)
1257 continue;
dbc760bc 1258
15325b4f
YN		 1259 if (buf < end)
1260 *buf = '-';
1261 buf = number(++buf, end, rtop - 1, default_dec_spec);
dbc760bc
TH		 1262 }
1263 return buf;
1264}
1265
cf3b429b
JP		 1266static noinline_for_stack
1267char *mac_address_string(char *buf, char *end, u8 *addr,
1268 struct printf_spec spec, const char *fmt)
dd45c9cf 1269{
8a27f7c9 1270 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
dd45c9cf
HH		 1271 char *p = mac_addr;
1272 int i;
bc7259a2 1273 char separator;
76597ff9 1274 bool reversed = false;
bc7259a2 1275
3e5903eb
PM		 1276 if (check_pointer(&buf, end, addr, spec))
1277 return buf;
1278
76597ff9
AE		 1279 switch (fmt[1]) {
1280 case 'F':
bc7259a2 1281 separator = '-';
76597ff9
AE		 1282 break;
1283
1284 case 'R':
1285 reversed = true;
4c1ca831 1286 fallthrough;
76597ff9
AE		 1287
1288 default:
bc7259a2 1289 separator = ':';
76597ff9 1290 break;
bc7259a2 1291 }
dd45c9cf
HH		 1292
1293 for (i = 0; i < 6; i++) {
76597ff9
AE		 1294 if (reversed)
1295 p = hex_byte_pack(p, addr[5 - i]);
1296 else
1297 p = hex_byte_pack(p, addr[i]);
1298
8a27f7c9 1299 if (fmt[0] == 'M' && i != 5)
bc7259a2 1300 *p++ = separator;
dd45c9cf
HH		 1301 }
1302 *p = '\0';
1303
d529ac41 1304 return string_nocheck(buf, end, mac_addr, spec);
dd45c9cf
HH		 1305}
1306
cf3b429b
JP		 1307static noinline_for_stack
1308char *ip4_string(char *p, const u8 *addr, const char *fmt)
8a27f7c9
JP		 1309{
1310 int i;
0159f24e
JP		 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 }
8a27f7c9 1336 for (i = 0; i < 4; i++) {
7c43d9a3 1337 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
133fd9f5 1338 int digits = put_dec_trunc8(temp, addr[index]) - temp;
8a27f7c9
JP		 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++ = '.';
0159f24e 1350 index += step;
8a27f7c9 1351 }
8a27f7c9 1352 *p = '\0';
7b9186f5 1353
8a27f7c9
JP		 1354 return p;
1355}
1356
cf3b429b
JP		 1357static noinline_for_stack
1358char *ip6_compressed_string(char *p, const char *addr)
689afa7d 1359{
7b9186f5 1360 int i, j, range;
8a27f7c9
JP		 1361 unsigned char zerolength[8];
1362 int longest = 1;
1363 int colonpos = -1;
1364 u16 word;
7b9186f5 1365 u8 hi, lo;
8a27f7c9 1366 bool needcolon = false;
eb78cd26
JP		 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);
8a27f7c9
JP		 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++) {
eb78cd26 1384 if (in6.s6_addr16[j] != 0)
8a27f7c9
JP		 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 }
29cf519e
JP		 1395 if (longest == 1) /* don't compress a single 0 */
1396 colonpos = -1;
689afa7d 1397
8a27f7c9
JP		 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 */
eb78cd26 1413 word = ntohs(in6.s6_addr16[i]);
8a27f7c9
JP		 1414 hi = word >> 8;
1415 lo = word & 0xff;
1416 if (hi) {
1417 if (hi > 0x0f)
55036ba7 1418 p = hex_byte_pack(p, hi);
8a27f7c9
JP		 1419 else
1420 *p++ = hex_asc_lo(hi);
55036ba7 1421 p = hex_byte_pack(p, lo);
8a27f7c9 1422 }
b5ff992b 1423 else if (lo > 0x0f)
55036ba7 1424 p = hex_byte_pack(p, lo);
8a27f7c9
JP		 1425 else
1426 *p++ = hex_asc_lo(lo);
1427 needcolon = true;
1428 }
1429
1430 if (useIPv4) {
1431 if (needcolon)
1432 *p++ = ':';
0159f24e 1433 p = ip4_string(p, &in6.s6_addr[12], "I4");
8a27f7c9 1434 }
8a27f7c9 1435 *p = '\0';
7b9186f5 1436
8a27f7c9
JP		 1437 return p;
1438}
1439
cf3b429b
JP		 1440static noinline_for_stack
1441char *ip6_string(char *p, const char *addr, const char *fmt)
8a27f7c9
JP		 1442{
1443 int i;
7b9186f5 1444
689afa7d 1445 for (i = 0; i < 8; i++) {
55036ba7
AS		 1446 p = hex_byte_pack(p, *addr++);
1447 p = hex_byte_pack(p, *addr++);
8a27f7c9 1448 if (fmt[0] == 'I' && i != 7)
689afa7d
HH		 1449 *p++ = ':';
1450 }
1451 *p = '\0';
7b9186f5 1452
8a27f7c9
JP		 1453 return p;
1454}
1455
cf3b429b
JP		 1456static noinline_for_stack
1457char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1458 struct printf_spec spec, const char *fmt)
8a27f7c9
JP		 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')
eb78cd26 1463 ip6_compressed_string(ip6_addr, addr);
8a27f7c9 1464 else
eb78cd26 1465 ip6_string(ip6_addr, addr, fmt);
689afa7d 1466
d529ac41 1467 return string_nocheck(buf, end, ip6_addr, spec);
689afa7d
HH		 1468}
1469
cf3b429b
JP		 1470static noinline_for_stack
1471char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1472 struct printf_spec spec, const char *fmt)
4aa99606 1473{
8a27f7c9 1474 char ip4_addr[sizeof("255.255.255.255")];
4aa99606 1475
0159f24e 1476 ip4_string(ip4_addr, addr, fmt);
4aa99606 1477
d529ac41 1478 return string_nocheck(buf, end, ip4_addr, spec);
4aa99606
HH		 1479}
1480
10679643
DB		 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
d529ac41 1540 return string_nocheck(buf, end, ip6_addr, spec);
10679643
DB		 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
d529ac41 1575 return string_nocheck(buf, end, ip4_addr, spec);
10679643
DB		 1576}
1577
f00cc102
PM		 1578static noinline_for_stack
1579char *ip_addr_string(char *buf, char *end, const void *ptr,
1580 struct printf_spec spec, const char *fmt)
1581{
0b74d4d7
PM		 1582 char *err_fmt_msg;
1583
3e5903eb
PM		 1584 if (check_pointer(&buf, end, ptr, spec))
1585 return buf;
1586
f00cc102
PM		 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:
c8c3b584 1605 return error_string(buf, end, "(einval)", spec);
f00cc102
PM		 1606 }}
1607 }
1608
0b74d4d7 1609 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
c8c3b584 1610 return error_string(buf, end, err_fmt_msg, spec);
f00cc102
PM		 1611}
1612
71dca95d
AS		 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
3e5903eb
PM		 1625 if (check_pointer(&buf, end, addr, spec))
1626 return buf;
71dca95d
AS		 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
41416f23
RV		 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);
71dca95d
AS		 1668
1669 return buf;
1670}
1671
3e5903eb
PM		 1672static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1673 struct printf_spec spec, const char *fmt)
45c3e93d
PM		 1674{
1675 va_list va;
1676
3e5903eb
PM		 1677 if (check_pointer(&buf, end, va_fmt, spec))
1678 return buf;
1679
45c3e93d
PM		 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
cf3b429b
JP		 1687static noinline_for_stack
1688char *uuid_string(char *buf, char *end, const u8 *addr,
1689 struct printf_spec spec, const char *fmt)
9ac6e44e 1690{
2b1b0d66 1691 char uuid[UUID_STRING_LEN + 1];
9ac6e44e
JP		 1692 char *p = uuid;
1693 int i;
f9727a17 1694 const u8 *index = uuid_index;
9ac6e44e
JP		 1695 bool uc = false;
1696
3e5903eb
PM		 1697 if (check_pointer(&buf, end, addr, spec))
1698 return buf;
1699
9ac6e44e
JP		 1700 switch (*(++fmt)) {
1701 case 'L':
df561f66 1702 uc = true;
4c1ca831 1703 fallthrough;
9ac6e44e 1704 case 'l':
f9727a17 1705 index = guid_index;
9ac6e44e
JP		 1706 break;
1707 case 'B':
1708 uc = true;
1709 break;
1710 }
1711
1712 for (i = 0; i < 16; i++) {
aa4ea1c3
AS		 1713 if (uc)
1714 p = hex_byte_pack_upper(p, addr[index[i]]);
1715 else
1716 p = hex_byte_pack(p, addr[index[i]]);
9ac6e44e
JP		 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
d529ac41 1729 return string_nocheck(buf, end, uuid, spec);
9ac6e44e
JP		 1730}
1731
5b17aecf 1732static noinline_for_stack
431bca24
GU		 1733char *netdev_bits(char *buf, char *end, const void *addr,
1734 struct printf_spec spec, const char *fmt)
c8f44aff 1735{
5b17aecf
AS		 1736 unsigned long long num;
1737 int size;
1738
3e5903eb
PM		 1739 if (check_pointer(&buf, end, addr, spec))
1740 return buf;
1741
5b17aecf
AS		 1742 switch (fmt[1]) {
1743 case 'F':
1744 num = *(const netdev_features_t *)addr;
1745 size = sizeof(netdev_features_t);
1746 break;
1747 default:
c8c3b584 1748 return error_string(buf, end, "(%pN?)", spec);
5b17aecf 1749 }
c8f44aff 1750
3cab1e71 1751 return special_hex_number(buf, end, num, size);
c8f44aff
MM		 1752}
1753
af612e43
SA		 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;
d75b26f8 1761 u32 orig, val;
af612e43
SA		 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
d75b26f8
AS		 1769 orig = get_unaligned(fourcc);
1770 val = orig & ~BIT(31);
af612e43 1771
d75b26f8 1772 for (i = 0; i < sizeof(u32); i++) {
af612e43
SA		 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
f74a08fc
AS		 1779 *p++ = ' ';
1780 strcpy(p, orig & BIT(31) ? "big-endian" : "little-endian");
af612e43
SA		 1781 p += strlen(p);
1782
1783 *p++ = ' ';
1784 *p++ = '(';
d75b26f8 1785 p = special_hex_number(p, output + sizeof(output) - 2, orig, sizeof(u32));
af612e43
SA		 1786 *p++ = ')';
1787 *p = '\0';
1788
1789 return string(buf, end, output, spec);
1790}
1791
aaf07621 1792static noinline_for_stack
3e5903eb
PM		 1793char *address_val(char *buf, char *end, const void *addr,
1794 struct printf_spec spec, const char *fmt)
aaf07621
JP		 1795{
1796 unsigned long long num;
3cab1e71 1797 int size;
aaf07621 1798
3e5903eb
PM		 1799 if (check_pointer(&buf, end, addr, spec))
1800 return buf;
1801
aaf07621
JP		 1802 switch (fmt[1]) {
1803 case 'd':
1804 num = *(const dma_addr_t *)addr;
3cab1e71 1805 size = sizeof(dma_addr_t);
aaf07621
JP		 1806 break;
1807 case 'p':
1808 default:
1809 num = *(const phys_addr_t *)addr;
3cab1e71 1810 size = sizeof(phys_addr_t);
aaf07621
JP		 1811 break;
1812 }
1813
3cab1e71 1814 return special_hex_number(buf, end, num, size);
aaf07621
JP		 1815}
1816
4d42c447
AS		 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
3e5903eb
PM		 1853char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1854 struct printf_spec spec, const char *fmt)
4d42c447
AS		 1855{
1856 bool have_t = true, have_d = true;
20bc8c1e
AS		 1857 bool raw = false, iso8601_separator = true;
1858 bool found = true;
4d42c447
AS		 1859 int count = 2;
1860
3e5903eb
PM		 1861 if (check_pointer(&buf, end, tm, spec))
1862 return buf;
1863
4d42c447
AS		 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
20bc8c1e
AS		 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);
4d42c447
AS		 1888
1889 if (have_d)
1890 buf = date_str(buf, end, tm, raw);
1891 if (have_d && have_t) {
4d42c447 1892 if (buf < end)
20bc8c1e 1893 *buf = iso8601_separator ? 'T' : ' ';
4d42c447
AS		 1894 buf++;
1895 }
1896 if (have_t)
1897 buf = time_str(buf, end, tm, raw);
1898
1899 return buf;
1900}
1901
7daac5b2
AS		 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
4d42c447
AS		 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':
3e5903eb 1931 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
7daac5b2
AS		 1932 case 'T':
1933 return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
4d42c447 1934 default:
7daac5b2 1935 return error_string(buf, end, "(%pt?)", spec);
4d42c447
AS		 1936 }
1937}
1938
900cca29
GU		 1939static noinline_for_stack
1940char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1941 const char *fmt)
1942{
0b74d4d7 1943 if (!IS_ENABLED(CONFIG_HAVE_CLK))
c8c3b584 1944 return error_string(buf, end, "(%pC?)", spec);
0b74d4d7 1945
3e5903eb
PM		 1946 if (check_pointer(&buf, end, clk, spec))
1947 return buf;
900cca29
GU		 1948
1949 switch (fmt[1]) {
900cca29
GU		 1950 case 'n':
1951 default:
1952#ifdef CONFIG_COMMON_CLK
1953 return string(buf, end, __clk_get_name(clk), spec);
1954#else
4ca96aa9 1955 return ptr_to_id(buf, end, clk, spec);
900cca29
GU		 1956#endif
1957 }
1958}
1959
edf14cdb
VB		 1960static
1961char *format_flags(char *buf, char *end, unsigned long flags,
1962 const struct trace_print_flags *names)
1963{
1964 unsigned long mask;
edf14cdb
VB		 1965
1966 for ( ; flags && names->name; names++) {
1967 mask = names->mask;
1968 if ((flags & mask) != mask)
1969 continue;
1970
abd4fe62 1971 buf = string(buf, end, names->name, default_str_spec);
edf14cdb
VB		 1972
1973 flags &= ~mask;
1974 if (flags) {
1975 if (buf < end)
1976 *buf = '|';
1977 buf++;
1978 }
1979 }
1980
1981 if (flags)
54433973 1982 buf = number(buf, end, flags, default_flag_spec);
edf14cdb
VB		 1983
1984 return buf;
1985}
1986
c244297a
YS		 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{
41c961b9 2011 unsigned long main_flags = flags & PAGEFLAGS_MASK;
c244297a
YS		 2012 bool append = false;
2013 int i;
2014
23efd080
MWO		 2015 buf = number(buf, end, flags, default_flag_spec);
2016 if (buf < end)
2017 *buf = '(';
2018 buf++;
2019
c244297a
YS		 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 }
23efd080
MWO		 2048 if (buf < end)
2049 *buf = ')';
2050 buf++;
c244297a
YS		 2051
2052 return buf;
2053}
2054
4c85c0be
HY		 2055static
2056char *format_page_type(char *buf, char *end, unsigned int page_type)
2057{
2058 buf = number(buf, end, page_type, default_flag_spec);
2059
2060 if (buf < end)
2061 *buf = '(';
2062 buf++;
2063
2064 if (page_type_has_type(page_type))
2065 buf = format_flags(buf, end, ~page_type, pagetype_names);
2066
2067 if (buf < end)
2068 *buf = ')';
2069 buf++;
2070
2071 return buf;
2072}
2073
edf14cdb 2074static noinline_for_stack
0b74d4d7
PM		 2075char *flags_string(char *buf, char *end, void *flags_ptr,
2076 struct printf_spec spec, const char *fmt)
edf14cdb
VB		 2077{
2078 unsigned long flags;
2079 const struct trace_print_flags *names;
2080
3e5903eb
PM		 2081 if (check_pointer(&buf, end, flags_ptr, spec))
2082 return buf;
2083
edf14cdb
VB		 2084 switch (fmt[1]) {
2085 case 'p':
c244297a 2086 return format_page_flags(buf, end, *(unsigned long *)flags_ptr);
4c85c0be
HY		 2087 case 't':
2088 return format_page_type(buf, end, *(unsigned int *)flags_ptr);
edf14cdb
VB		 2089 case 'v':
2090 flags = *(unsigned long *)flags_ptr;
2091 names = vmaflag_names;
2092 break;
2093 case 'g':
30d497a0 2094 flags = (__force unsigned long)(*(gfp_t *)flags_ptr);
edf14cdb
VB		 2095 names = gfpflag_names;
2096 break;
2097 default:
c8c3b584 2098 return error_string(buf, end, "(%pG?)", spec);
edf14cdb
VB		 2099 }
2100
2101 return format_flags(buf, end, flags, names);
2102}
2103
ce4fecf1 2104static noinline_for_stack
a92eb762
SA		 2105char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
2106 char *end)
ce4fecf1
PA		 2107{
2108 int depth;
ce4fecf1 2109
a92eb762
SA		 2110 /* Loop starting from the root node to the current node. */
2111 for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
2112 struct fwnode_handle *__fwnode =
2113 fwnode_get_nth_parent(fwnode, depth);
ce4fecf1 2114
a92eb762 2115 buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
abd4fe62 2116 default_str_spec);
a92eb762 2117 buf = string(buf, end, fwnode_get_name(__fwnode),
abd4fe62 2118 default_str_spec);
a92eb762
SA		 2119
2120 fwnode_handle_put(__fwnode);
ce4fecf1 2121 }
a92eb762 2122
ce4fecf1
PA		 2123 return buf;
2124}
2125
2126static noinline_for_stack
2127char *device_node_string(char *buf, char *end, struct device_node *dn,
2128 struct printf_spec spec, const char *fmt)
2129{
2130 char tbuf[sizeof("xxxx") + 1];
2131 const char *p;
2132 int ret;
2133 char *buf_start = buf;
2134 struct property *prop;
2135 bool has_mult, pass;
ce4fecf1
PA		 2136
2137 struct printf_spec str_spec = spec;
2138 str_spec.field_width = -1;
2139
83abc5a7
SA		 2140 if (fmt[0] != 'F')
2141 return error_string(buf, end, "(%pO?)", spec);
2142
ce4fecf1 2143 if (!IS_ENABLED(CONFIG_OF))
c8c3b584 2144 return error_string(buf, end, "(%pOF?)", spec);
ce4fecf1 2145
3e5903eb
PM		 2146 if (check_pointer(&buf, end, dn, spec))
2147 return buf;
ce4fecf1
PA		 2148
2149 /* simple case without anything any more format specifiers */
2150 fmt++;
2151 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
2152 fmt = "f";
2153
2154 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
6d0a70a2 2155 int precision;
ce4fecf1
PA		 2156 if (pass) {
2157 if (buf < end)
2158 *buf = ':';
2159 buf++;
2160 }
2161
2162 switch (*fmt) {
2163 case 'f': /* full_name */
a92eb762
SA		 2164 buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
2165 end);
ce4fecf1
PA		 2166 break;
2167 case 'n': /* name */
a92eb762 2168 p = fwnode_get_name(of_fwnode_handle(dn));
6d0a70a2
RH		 2169 precision = str_spec.precision;
2170 str_spec.precision = strchrnul(p, '@') - p;
2171 buf = string(buf, end, p, str_spec);
2172 str_spec.precision = precision;
ce4fecf1
PA		 2173 break;
2174 case 'p': /* phandle */
09ceb8d7 2175 buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec);
ce4fecf1
PA		 2176 break;
2177 case 'P': /* path-spec */
a92eb762 2178 p = fwnode_get_name(of_fwnode_handle(dn));
ce4fecf1
PA		 2179 if (!p[1])
2180 p = "/";
2181 buf = string(buf, end, p, str_spec);
2182 break;
2183 case 'F': /* flags */
2184 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2185 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2186 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2187 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2188 tbuf[4] = 0;
d529ac41 2189 buf = string_nocheck(buf, end, tbuf, str_spec);
ce4fecf1
PA		 2190 break;
2191 case 'c': /* major compatible string */
2192 ret = of_property_read_string(dn, "compatible", &p);
2193 if (!ret)
2194 buf = string(buf, end, p, str_spec);
2195 break;
2196 case 'C': /* full compatible string */
2197 has_mult = false;
2198 of_property_for_each_string(dn, "compatible", prop, p) {
2199 if (has_mult)
d529ac41
PM		 2200 buf = string_nocheck(buf, end, ",", str_spec);
2201 buf = string_nocheck(buf, end, "\"", str_spec);
ce4fecf1 2202 buf = string(buf, end, p, str_spec);
d529ac41 2203 buf = string_nocheck(buf, end, "\"", str_spec);
ce4fecf1
PA		 2204
2205 has_mult = true;
2206 }
2207 break;
2208 default:
2209 break;
2210 }
2211 }
2212
2213 return widen_string(buf, buf - buf_start, end, spec);
2214}
2215
3bd32d6a
SA		 2216static noinline_for_stack
2217char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
2218 struct printf_spec spec, const char *fmt)
798cc27a 2219{
3bd32d6a
SA		 2220 struct printf_spec str_spec = spec;
2221 char *buf_start = buf;
2222
2223 str_spec.field_width = -1;
2224
2225 if (*fmt != 'w')
2226 return error_string(buf, end, "(%pf?)", spec);
2227
2228 if (check_pointer(&buf, end, fwnode, spec))
2229 return buf;
2230
2231 fmt++;
2232
2233 switch (*fmt) {
2234 case 'P': /* name */
2235 buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
2236 break;
2237 case 'f': /* full_name */
2238 default:
2239 buf = fwnode_full_name_string(fwnode, buf, end);
2240 break;
798cc27a
PM		 2241 }
2242
3bd32d6a 2243 return widen_string(buf, buf - buf_start, end, spec);
798cc27a
PM		 2244}
2245
79270291 2246int __init no_hash_pointers_enable(char *str)
5ead723a 2247{
9f961c2e
ME		 2248 if (no_hash_pointers)
2249 return 0;
2250
5ead723a
TT		 2251 no_hash_pointers = true;
2252
2253 pr_warn("**********************************************************\n");
2254 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2255 pr_warn("** **\n");
2256 pr_warn("** This system shows unhashed kernel memory addresses **\n");
2257 pr_warn("** via the console, logs, and other interfaces. This **\n");
2258 pr_warn("** might reduce the security of your system. **\n");
2259 pr_warn("** **\n");
2260 pr_warn("** If you see this message and you are not debugging **\n");
2261 pr_warn("** the kernel, report this immediately to your system **\n");
2262 pr_warn("** administrator! **\n");
2263 pr_warn("** **\n");
2264 pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n");
2265 pr_warn("**********************************************************\n");
2266
2267 return 0;
2268}
2269early_param("no_hash_pointers", no_hash_pointers_enable);
2270
787983da
GG		 2271/* Used for Rust formatting ('%pA'). */
2272char *rust_fmt_argument(char *buf, char *end, void *ptr);
2273
4d8a743c
LT		 2274/*
2275 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2276 * by an extra set of alphanumeric characters that are extended format
2277 * specifiers.
2278 *
0b523769
JP		 2279 * Please update scripts/checkpatch.pl when adding/removing conversion
2280 * characters. (Search for "check for vsprintf extension").
2281 *
332d2e78
LT		 2282 * Right now we handle:
2283 *
cdb7e52d
SS		 2284 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2285 * - 's' For symbolic direct pointers (or function descriptors) without offset
9af77064 2286 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
9294523e 2287 * - 'S[R]b' as above with module build ID (for use in backtraces)
1586c5ae
SA		 2288 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2289 * %ps and %pS. Be careful when re-using these specifiers.
0f77a8d3 2290 * - 'B' For backtraced symbolic direct pointers with offset
9294523e 2291 * - 'Bb' as above with module build ID (for use in backtraces)
c7dabef8
BH		 2292 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2293 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
dbc760bc
TH		 2294 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2295 * width which must be explicitly specified either as part of the
2296 * format string '%32b[l]' or through '%*b[l]', [l] selects
2297 * range-list format instead of hex format
dd45c9cf
HH		 2298 * - 'M' For a 6-byte MAC address, it prints the address in the
2299 * usual colon-separated hex notation
8a27f7c9 2300 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
bc7259a2 2301 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
c8e00060 2302 * with a dash-separated hex notation
7c59154e 2303 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
8a27f7c9
JP		 2304 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2305 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2306 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
10679643
DB		 2307 * [S][pfs]
2308 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2309 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
8a27f7c9
JP		 2310 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2311 * IPv6 omits the colons (01020304...0f)
2312 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
10679643
DB		 2313 * [S][pfs]
2314 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2315 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2316 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2317 * - 'I[6S]c' for IPv6 addresses printed as specified by
8eda94bd 2318 * https://tools.ietf.org/html/rfc5952
71dca95d
AS		 2319 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2320 * of the following flags (see string_escape_mem() for the
2321 * details):
2322 * a - ESCAPE_ANY
2323 * c - ESCAPE_SPECIAL
2324 * h - ESCAPE_HEX
2325 * n - ESCAPE_NULL
2326 * o - ESCAPE_OCTAL
2327 * p - ESCAPE_NP
2328 * s - ESCAPE_SPACE
2329 * By default ESCAPE_ANY_NP is used.
9ac6e44e
JP		 2330 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2331 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2332 * Options for %pU are:
2333 * b big endian lower case hex (default)
2334 * B big endian UPPER case hex
2335 * l little endian lower case hex
2336 * L little endian UPPER case hex
2337 * big endian output byte order is:
2338 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2339 * little endian output byte order is:
2340 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
7db6f5fb
JP		 2341 * - 'V' For a struct va_format which contains a format string * and va_list *,
2342 * call vsnprintf(->format, *->va_list).
2343 * Implements a "recursive vsnprintf".
2344 * Do not use this feature without some mechanism to verify the
2345 * correctness of the format string and va_list arguments.
a48849e2
VB		 2346 * - 'K' For a kernel pointer that should be hidden from unprivileged users.
2347 * Use only for procfs, sysfs and similar files, not printk(); please
2348 * read the documentation (path below) first.
c8f44aff 2349 * - 'NF' For a netdev_features_t
af612e43 2350 * - '4cc' V4L2 or DRM FourCC code, with endianness and raw numerical value.
31550a16
AS		 2351 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2352 * a certain separator (' ' by default):
2353 * C colon
2354 * D dash
2355 * N no separator
2356 * The maximum supported length is 64 bytes of the input. Consider
2357 * to use print_hex_dump() for the larger input.
aaf07621
JP		 2358 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2359 * (default assumed to be phys_addr_t, passed by reference)
c0d92a57
OJ		 2360 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2361 * - 'D[234]' Same as 'd' but for a struct file
1031bc58 2362 * - 'g' For block_device name (gendisk + partition number)
20bc8c1e 2363 * - 't[RT][dt][r][s]' For time and date as represented by:
4d42c447 2364 * R struct rtc_time
7daac5b2 2365 * T time64_t
900cca29
GU		 2366 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2367 * (legacy clock framework) of the clock
2368 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2369 * (legacy clock framework) of the clock
edf14cdb
VB		 2370 * - 'G' For flags to be printed as a collection of symbolic strings that would
2371 * construct the specific value. Supported flags given by option:
2372 * p page flags (see struct page) given as pointer to unsigned long
2373 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2374 * v vma flags (VM_*) given as pointer to unsigned long
94ac8f20
GU		 2375 * - 'OF[fnpPcCF]' For a device tree object
2376 * Without any optional arguments prints the full_name
2377 * f device node full_name
2378 * n device node name
2379 * p device node phandle
2380 * P device node path spec (name + @unit)
2381 * F device node flags
2382 * c major compatible string
2383 * C full compatible string
3bd32d6a
SA		 2384 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2385 * Without an option prints the full name of the node
2386 * f full name
2387 * P node name, including a possible unit address
a48849e2
VB		 2388 * - 'x' For printing the address unmodified. Equivalent to "%lx".
2389 * Please read the documentation (path below) before using!
b2a5212f
DB		 2390 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
2391 * bpf_trace_printk() where [ku] prefix specifies either kernel (k)
2392 * or user (u) memory to probe, and:
2393 * s a string, equivalent to "%s" on direct vsnprintf() use
7b1924a1 2394 *
b3ed2321
TH		 2395 * ** When making changes please also update:
2396 * Documentation/core-api/printk-formats.rst
9ac6e44e 2397 *
ad67b74d
TH		 2398 * Note: The default behaviour (unadorned %p) is to hash the address,
2399 * rendering it useful as a unique identifier.
787983da
GG		 2400 *
2401 * There is also a '%pA' format specifier, but it is only intended to be used
2402 * from Rust code to format core::fmt::Arguments. Do *not* use it from C.
2403 * See rust/kernel/print.rs for details.
4d8a743c 2404 */
cf3b429b
JP		 2405static noinline_for_stack
2406char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2407 struct printf_spec spec)
78a8bf69 2408{
0fe1ef24 2409 switch (*fmt) {
0fe1ef24 2410 case 'S':
9ac6e44e 2411 case 's':
04b8eb7a 2412 ptr = dereference_symbol_descriptor(ptr);
4c1ca831 2413 fallthrough;
0f77a8d3 2414 case 'B':
b0d33c2b 2415 return symbol_string(buf, end, ptr, spec, fmt);
332d2e78 2416 case 'R':
c7dabef8 2417 case 'r':
fd95541e 2418 return resource_string(buf, end, ptr, spec, fmt);
31550a16
AS		 2419 case 'h':
2420 return hex_string(buf, end, ptr, spec, fmt);
dbc760bc
TH		 2421 case 'b':
2422 switch (fmt[1]) {
2423 case 'l':
2424 return bitmap_list_string(buf, end, ptr, spec, fmt);
2425 default:
2426 return bitmap_string(buf, end, ptr, spec, fmt);
2427 }
8a27f7c9
JP		 2428 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2429 case 'm': /* Contiguous: 000102030405 */
76597ff9
AE		 2430 /* [mM]F (FDDI) */
2431 /* [mM]R (Reverse order; Bluetooth) */
8a27f7c9
JP		 2432 return mac_address_string(buf, end, ptr, spec, fmt);
2433 case 'I': /* Formatted IP supported
2434 * 4: 1.2.3.4
2435 * 6: 0001:0203:...:0708
2436 * 6c: 1::708 or 1::1.2.3.4
2437 */
2438 case 'i': /* Contiguous:
2439 * 4: 001.002.003.004
2440 * 6: 000102...0f
2441 */
f00cc102 2442 return ip_addr_string(buf, end, ptr, spec, fmt);
71dca95d
AS		 2443 case 'E':
2444 return escaped_string(buf, end, ptr, spec, fmt);
9ac6e44e
JP		 2445 case 'U':
2446 return uuid_string(buf, end, ptr, spec, fmt);
7db6f5fb 2447 case 'V':
3e5903eb 2448 return va_format(buf, end, ptr, spec, fmt);
455cd5ab 2449 case 'K':
57e73442 2450 return restricted_pointer(buf, end, ptr, spec);
c8f44aff 2451 case 'N':
431bca24 2452 return netdev_bits(buf, end, ptr, spec, fmt);
af612e43
SA		 2453 case '4':
2454 return fourcc_string(buf, end, ptr, spec, fmt);
7d799210 2455 case 'a':
3e5903eb 2456 return address_val(buf, end, ptr, spec, fmt);
4b6ccca7
AV		 2457 case 'd':
2458 return dentry_name(buf, end, ptr, spec, fmt);
4d42c447
AS		 2459 case 't':
2460 return time_and_date(buf, end, ptr, spec, fmt);
900cca29
GU		 2461 case 'C':
2462 return clock(buf, end, ptr, spec, fmt);
4b6ccca7 2463 case 'D':
36594b31 2464 return file_dentry_name(buf, end, ptr, spec, fmt);
1031bc58
DM		 2465#ifdef CONFIG_BLOCK
2466 case 'g':
2467 return bdev_name(buf, end, ptr, spec, fmt);
2468#endif
2469
edf14cdb 2470 case 'G':
0b74d4d7 2471 return flags_string(buf, end, ptr, spec, fmt);
ce4fecf1 2472 case 'O':
83abc5a7 2473 return device_node_string(buf, end, ptr, spec, fmt + 1);
3bd32d6a
SA		 2474 case 'f':
2475 return fwnode_string(buf, end, ptr, spec, fmt + 1);
787983da
GG		 2476 case 'A':
2477 if (!IS_ENABLED(CONFIG_RUST)) {
2478 WARN_ONCE(1, "Please remove %%pA from non-Rust code\n");
2479 return error_string(buf, end, "(%pA?)", spec);
2480 }
2481 return rust_fmt_argument(buf, end, ptr);
7b1924a1
TH		 2482 case 'x':
2483 return pointer_string(buf, end, ptr, spec);
57f5677e
RV		 2484 case 'e':
2485 /* %pe with a non-ERR_PTR gets treated as plain %p */
2486 if (!IS_ERR(ptr))
84842911 2487 return default_pointer(buf, end, ptr, spec);
57f5677e 2488 return err_ptr(buf, end, ptr, spec);
b2a5212f
DB		 2489 case 'u':
2490 case 'k':
2491 switch (fmt[1]) {
2492 case 's':
2493 return string(buf, end, ptr, spec);
2494 default:
2495 return error_string(buf, end, "(einval)", spec);
2496 }
84842911
CL		 2497 default:
2498 return default_pointer(buf, end, ptr, spec);
fef20d9c 2499 }
fef20d9c
FW		 2500}
2501
2502/*
2503 * Helper function to decode printf style format.
2504 * Each call decode a token from the format and return the
2505 * number of characters read (or likely the delta where it wants
2506 * to go on the next call).
2507 * The decoded token is returned through the parameters
2508 *
2509 * 'h', 'l', or 'L' for integer fields
2510 * 'z' support added 23/7/1999 S.H.
2511 * 'z' changed to 'Z' --davidm 1/25/99
5b5e0928 2512 * 'Z' changed to 'z' --adobriyan 2017-01-25
fef20d9c
FW		 2513 * 't' added for ptrdiff_t
2514 *
2515 * @fmt: the format string
2516 * @type of the token returned
2517 * @flags: various flags such as +, -, # tokens..
2518 * @field_width: overwritten width
2519 * @base: base of the number (octal, hex, ...)
2520 * @precision: precision of a number
2521 * @qualifier: qualifier of a number (long, size_t, ...)
2522 */
cf3b429b
JP		 2523static noinline_for_stack
2524int format_decode(const char *fmt, struct printf_spec *spec)
fef20d9c
FW		 2525{
2526 const char *start = fmt;
d0484193 2527 char qualifier;
fef20d9c
FW		 2528
2529 /* we finished early by reading the field width */
ed681a91 2530 if (spec->type == FORMAT_TYPE_WIDTH) {
fef20d9c
FW		 2531 if (spec->field_width < 0) {
2532 spec->field_width = -spec->field_width;
2533 spec->flags |= LEFT;
2534 }
2535 spec->type = FORMAT_TYPE_NONE;
2536 goto precision;
2537 }
2538
2539 /* we finished early by reading the precision */
2540 if (spec->type == FORMAT_TYPE_PRECISION) {
2541 if (spec->precision < 0)
2542 spec->precision = 0;
2543
2544 spec->type = FORMAT_TYPE_NONE;
2545 goto qualifier;
2546 }
2547
2548 /* By default */
2549 spec->type = FORMAT_TYPE_NONE;
2550
2551 for (; *fmt ; ++fmt) {
2552 if (*fmt == '%')
2553 break;
2554 }
2555
2556 /* Return the current non-format string */
2557 if (fmt != start || !*fmt)
2558 return fmt - start;
2559
2560 /* Process flags */
2561 spec->flags = 0;
2562
2563 while (1) { /* this also skips first '%' */
2564 bool found = true;
2565
2566 ++fmt;
2567
2568 switch (*fmt) {
2569 case '-': spec->flags |= LEFT; break;
2570 case '+': spec->flags |= PLUS; break;
2571 case ' ': spec->flags |= SPACE; break;
2572 case '#': spec->flags |= SPECIAL; break;
2573 case '0': spec->flags |= ZEROPAD; break;
2574 default: found = false;
2575 }
2576
2577 if (!found)
2578 break;
2579 }
2580
2581 /* get field width */
2582 spec->field_width = -1;
2583
2584 if (isdigit(*fmt))
2585 spec->field_width = skip_atoi(&fmt);
2586 else if (*fmt == '*') {
2587 /* it's the next argument */
ed681a91 2588 spec->type = FORMAT_TYPE_WIDTH;
fef20d9c
FW		 2589 return ++fmt - start;
2590 }
2591
2592precision:
2593 /* get the precision */
2594 spec->precision = -1;
2595 if (*fmt == '.') {
2596 ++fmt;
2597 if (isdigit(*fmt)) {
2598 spec->precision = skip_atoi(&fmt);
2599 if (spec->precision < 0)
2600 spec->precision = 0;
2601 } else if (*fmt == '*') {
2602 /* it's the next argument */
adf26f84 2603 spec->type = FORMAT_TYPE_PRECISION;
fef20d9c
FW		 2604 return ++fmt - start;
2605 }
2606 }
2607
2608qualifier:
2609 /* get the conversion qualifier */
d0484193 2610 qualifier = 0;
75fb8f26 2611 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
5b5e0928 2612 *fmt == 'z' || *fmt == 't') {
d0484193
RV		 2613 qualifier = *fmt++;
2614 if (unlikely(qualifier == *fmt)) {
2615 if (qualifier == 'l') {
2616 qualifier = 'L';
a4e94ef0 2617 ++fmt;
d0484193
RV		 2618 } else if (qualifier == 'h') {
2619 qualifier = 'H';
a4e94ef0
Z		 2620 ++fmt;
2621 }
fef20d9c
FW		 2622 }
2623 }
2624
2625 /* default base */
2626 spec->base = 10;
2627 switch (*fmt) {
2628 case 'c':
2629 spec->type = FORMAT_TYPE_CHAR;
2630 return ++fmt - start;
2631
2632 case 's':
2633 spec->type = FORMAT_TYPE_STR;
2634 return ++fmt - start;
2635
2636 case 'p':
2637 spec->type = FORMAT_TYPE_PTR;
ffbfed03 2638 return ++fmt - start;
fef20d9c 2639
fef20d9c
FW		 2640 case '%':
2641 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2642 return ++fmt - start;
2643
2644 /* integer number formats - set up the flags and "break" */
2645 case 'o':
2646 spec->base = 8;
2647 break;
2648
2649 case 'x':
2650 spec->flags |= SMALL;
4c1ca831 2651 fallthrough;
fef20d9c
FW		 2652
2653 case 'X':
2654 spec->base = 16;
2655 break;
2656
2657 case 'd':
2658 case 'i':
39e874f8 2659 spec->flags |= SIGN;
36f9ff9e 2660 break;
fef20d9c 2661 case 'u':
4aa99606 2662 break;
fef20d9c 2663
708d96fd
RM		 2664 case 'n':
2665 /*
b006f19b
RV		 2666 * Since %n poses a greater security risk than
2667 * utility, treat it as any other invalid or
2668 * unsupported format specifier.
708d96fd 2669 */
4c1ca831 2670 fallthrough;
708d96fd 2671
fef20d9c 2672 default:
b006f19b 2673 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
fef20d9c
FW		 2674 spec->type = FORMAT_TYPE_INVALID;
2675 return fmt - start;
0fe1ef24 2676 }
fef20d9c 2677
d0484193 2678 if (qualifier == 'L')
fef20d9c 2679 spec->type = FORMAT_TYPE_LONG_LONG;
d0484193 2680 else if (qualifier == 'l') {
51be17df
RV		 2681 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2682 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
5b5e0928 2683 } else if (qualifier == 'z') {
fef20d9c 2684 spec->type = FORMAT_TYPE_SIZE_T;
d0484193 2685 } else if (qualifier == 't') {
fef20d9c 2686 spec->type = FORMAT_TYPE_PTRDIFF;
d0484193 2687 } else if (qualifier == 'H') {
51be17df
RV		 2688 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2689 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
d0484193 2690 } else if (qualifier == 'h') {
51be17df
RV		 2691 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2692 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
fef20d9c 2693 } else {
51be17df
RV		 2694 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2695 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
78a8bf69 2696 }
fef20d9c
FW		 2697
2698 return ++fmt - start;
78a8bf69
LT		 2699}
2700
4d72ba01
RV		 2701static void
2702set_field_width(struct printf_spec *spec, int width)
2703{
2704 spec->field_width = width;
2705 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2706 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2707 }
2708}
2709
2710static void
2711set_precision(struct printf_spec *spec, int prec)
2712{
2713 spec->precision = prec;
2714 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2715 spec->precision = clamp(prec, 0, PRECISION_MAX);
2716 }
2717}
2718
1da177e4
LT		 2719/**
2720 * vsnprintf - Format a string and place it in a buffer
2721 * @buf: The buffer to place the result into
2722 * @size: The size of the buffer, including the trailing null space
2723 * @fmt: The format string to use
2724 * @args: Arguments for the format string
2725 *
d7ec9a05
RV		 2726 * This function generally follows C99 vsnprintf, but has some
2727 * extensions and a few limitations:
2728 *
6cc89134 2729 * - ``%n`` is unsupported
2730 * - ``%p*`` is handled by pointer()
5e4ee7b1 2731 *
27e7c0e8 2732 * See pointer() or Documentation/core-api/printk-formats.rst for more
5e4ee7b1 2733 * extensive description.
20036fdc 2734 *
6cc89134 2735 * **Please update the documentation in both places when making changes**
80f548e0 2736 *
1da177e4
LT		 2737 * The return value is the number of characters which would
2738 * be generated for the given input, excluding the trailing
2739 * '\0', as per ISO C99. If you want to have the exact
2740 * number of characters written into @buf as return value
72fd4a35 2741 * (not including the trailing '\0'), use vscnprintf(). If the
1da177e4
LT		 2742 * return is greater than or equal to @size, the resulting
2743 * string is truncated.
2744 *
ba1835eb 2745 * If you're not already dealing with a va_list consider using snprintf().
1da177e4
LT		 2746 */
2747int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2748{
1da177e4 2749 unsigned long long num;
d4be151b 2750 char *str, *end;
fef20d9c 2751 struct printf_spec spec = {0};
1da177e4 2752
f796937a
JF		 2753 /* Reject out-of-range values early. Large positive sizes are
2754 used for unknown buffer sizes. */
2aa2f9e2 2755 if (WARN_ON_ONCE(size > INT_MAX))
1da177e4 2756 return 0;
1da177e4
LT		 2757
2758 str = buf;
f796937a 2759 end = buf + size;
1da177e4 2760
f796937a
JF		 2761 /* Make sure end is always >= buf */
2762 if (end < buf) {
2763 end = ((void *)-1);
2764 size = end - buf;
1da177e4
LT		 2765 }
2766
fef20d9c
FW		 2767 while (*fmt) {
2768 const char *old_fmt = fmt;
d4be151b 2769 int read = format_decode(fmt, &spec);
1da177e4 2770
fef20d9c 2771 fmt += read;
1da177e4 2772
fef20d9c
FW		 2773 switch (spec.type) {
2774 case FORMAT_TYPE_NONE: {
2775 int copy = read;
2776 if (str < end) {
2777 if (copy > end - str)
2778 copy = end - str;
2779 memcpy(str, old_fmt, copy);
1da177e4 2780 }
fef20d9c
FW		 2781 str += read;
2782 break;
1da177e4
LT		 2783 }
2784
ed681a91 2785 case FORMAT_TYPE_WIDTH:
4d72ba01 2786 set_field_width(&spec, va_arg(args, int));
fef20d9c 2787 break;
1da177e4 2788
fef20d9c 2789 case FORMAT_TYPE_PRECISION:
4d72ba01 2790 set_precision(&spec, va_arg(args, int));
fef20d9c 2791 break;
1da177e4 2792
d4be151b
AGR		 2793 case FORMAT_TYPE_CHAR: {
2794 char c;
2795
fef20d9c
FW		 2796 if (!(spec.flags & LEFT)) {
2797 while (--spec.field_width > 0) {
f796937a 2798 if (str < end)
1da177e4
LT		 2799 *str = ' ';
2800 ++str;
1da177e4 2801
fef20d9c
FW		 2802 }
2803 }
2804 c = (unsigned char) va_arg(args, int);
2805 if (str < end)
2806 *str = c;
2807 ++str;
2808 while (--spec.field_width > 0) {
f796937a 2809 if (str < end)
fef20d9c 2810 *str = ' ';
1da177e4 2811 ++str;
fef20d9c
FW		 2812 }
2813 break;
d4be151b 2814 }
1da177e4 2815
fef20d9c
FW		 2816 case FORMAT_TYPE_STR:
2817 str = string(str, end, va_arg(args, char *), spec);
2818 break;
1da177e4 2819
fef20d9c 2820 case FORMAT_TYPE_PTR:
ffbfed03 2821 str = pointer(fmt, str, end, va_arg(args, void *),
fef20d9c
FW		 2822 spec);
2823 while (isalnum(*fmt))
2824 fmt++;
2825 break;
1da177e4 2826
fef20d9c
FW		 2827 case FORMAT_TYPE_PERCENT_CHAR:
2828 if (str < end)
2829 *str = '%';
2830 ++str;
2831 break;
1da177e4 2832
fef20d9c 2833 case FORMAT_TYPE_INVALID:
b006f19b
RV		 2834 /*
2835 * Presumably the arguments passed gcc's type
2836 * checking, but there is no safe or sane way
2837 * for us to continue parsing the format and
2838 * fetching from the va_list; the remaining
2839 * specifiers and arguments would be out of
2840 * sync.
2841 */
2842 goto out;
fef20d9c 2843
fef20d9c
FW		 2844 default:
2845 switch (spec.type) {
2846 case FORMAT_TYPE_LONG_LONG:
2847 num = va_arg(args, long long);
2848 break;
2849 case FORMAT_TYPE_ULONG:
2850 num = va_arg(args, unsigned long);
2851 break;
2852 case FORMAT_TYPE_LONG:
2853 num = va_arg(args, long);
2854 break;
2855 case FORMAT_TYPE_SIZE_T:
ef124960
JG		 2856 if (spec.flags & SIGN)
2857 num = va_arg(args, ssize_t);
2858 else
2859 num = va_arg(args, size_t);
fef20d9c
FW		 2860 break;
2861 case FORMAT_TYPE_PTRDIFF:
2862 num = va_arg(args, ptrdiff_t);
2863 break;
a4e94ef0
Z		 2864 case FORMAT_TYPE_UBYTE:
2865 num = (unsigned char) va_arg(args, int);
2866 break;
2867 case FORMAT_TYPE_BYTE:
2868 num = (signed char) va_arg(args, int);
2869 break;
fef20d9c
FW		 2870 case FORMAT_TYPE_USHORT:
2871 num = (unsigned short) va_arg(args, int);
2872 break;
2873 case FORMAT_TYPE_SHORT:
2874 num = (short) va_arg(args, int);
2875 break;
39e874f8
FW		 2876 case FORMAT_TYPE_INT:
2877 num = (int) va_arg(args, int);
fef20d9c
FW		 2878 break;
2879 default:
2880 num = va_arg(args, unsigned int);
2881 }
2882
2883 str = number(str, end, num, spec);
1da177e4 2884 }
1da177e4 2885 }
fef20d9c 2886
b006f19b 2887out:
f796937a
JF		 2888 if (size > 0) {
2889 if (str < end)
2890 *str = '\0';
2891 else
0a6047ee 2892 end[-1] = '\0';
f796937a 2893 }
fef20d9c 2894
f796937a 2895 /* the trailing null byte doesn't count towards the total */
1da177e4 2896 return str-buf;
fef20d9c 2897
1da177e4 2898}
1da177e4
LT		 2899EXPORT_SYMBOL(vsnprintf);
2900
2901/**
2902 * vscnprintf - Format a string and place it in a buffer
2903 * @buf: The buffer to place the result into
2904 * @size: The size of the buffer, including the trailing null space
2905 * @fmt: The format string to use
2906 * @args: Arguments for the format string
2907 *
2908 * The return value is the number of characters which have been written into
b921c69f 2909 * the @buf not including the trailing '\0'. If @size is == 0 the function
1da177e4
LT		 2910 * returns 0.
2911 *
ba1835eb 2912 * If you're not already dealing with a va_list consider using scnprintf().
20036fdc
AK		 2913 *
2914 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4
LT		 2915 */
2916int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2917{
2918 int i;
2919
ef62c8ff
WL		 2920 if (unlikely(!size))
2921 return 0;
2922
7b9186f5
AGR		 2923 i = vsnprintf(buf, size, fmt, args);
2924
b921c69f
AA		 2925 if (likely(i < size))
2926 return i;
ef62c8ff
WL		 2927
2928 return size - 1;
1da177e4 2929}
1da177e4
LT		 2930EXPORT_SYMBOL(vscnprintf);
2931
2932/**
2933 * snprintf - Format a string and place it in a buffer
2934 * @buf: The buffer to place the result into
2935 * @size: The size of the buffer, including the trailing null space
2936 * @fmt: The format string to use
2937 * @...: Arguments for the format string
2938 *
2939 * The return value is the number of characters which would be
2940 * generated for the given input, excluding the trailing null,
2941 * as per ISO C99. If the return is greater than or equal to
2942 * @size, the resulting string is truncated.
20036fdc
AK		 2943 *
2944 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 2945 */
7b9186f5 2946int snprintf(char *buf, size_t size, const char *fmt, ...)
1da177e4
LT		 2947{
2948 va_list args;
2949 int i;
2950
2951 va_start(args, fmt);
7b9186f5 2952 i = vsnprintf(buf, size, fmt, args);
1da177e4 2953 va_end(args);
7b9186f5 2954
1da177e4
LT		 2955 return i;
2956}
1da177e4
LT		 2957EXPORT_SYMBOL(snprintf);
2958
2959/**
2960 * scnprintf - Format a string and place it in a buffer
2961 * @buf: The buffer to place the result into
2962 * @size: The size of the buffer, including the trailing null space
2963 * @fmt: The format string to use
2964 * @...: Arguments for the format string
2965 *
2966 * The return value is the number of characters written into @buf not including
b903c0b8 2967 * the trailing '\0'. If @size is == 0 the function returns 0.
1da177e4
LT		 2968 */
2969
7b9186f5 2970int scnprintf(char *buf, size_t size, const char *fmt, ...)
1da177e4
LT		 2971{
2972 va_list args;
2973 int i;
2974
2975 va_start(args, fmt);
b921c69f 2976 i = vscnprintf(buf, size, fmt, args);
1da177e4 2977 va_end(args);
7b9186f5 2978
b921c69f 2979 return i;
1da177e4
LT		 2980}
2981EXPORT_SYMBOL(scnprintf);
2982
2983/**
2984 * vsprintf - Format a string and place it in a buffer
2985 * @buf: The buffer to place the result into
2986 * @fmt: The format string to use
2987 * @args: Arguments for the format string
2988 *
2989 * The function returns the number of characters written
72fd4a35 2990 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1da177e4
LT		 2991 * buffer overflows.
2992 *
ba1835eb 2993 * If you're not already dealing with a va_list consider using sprintf().
20036fdc
AK		 2994 *
2995 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4
LT		 2996 */
2997int vsprintf(char *buf, const char *fmt, va_list args)
2998{
2999 return vsnprintf(buf, INT_MAX, fmt, args);
3000}
1da177e4
LT		 3001EXPORT_SYMBOL(vsprintf);
3002
3003/**
3004 * sprintf - Format a string and place it in a buffer
3005 * @buf: The buffer to place the result into
3006 * @fmt: The format string to use
3007 * @...: Arguments for the format string
3008 *
3009 * The function returns the number of characters written
72fd4a35 3010 * into @buf. Use snprintf() or scnprintf() in order to avoid
1da177e4 3011 * buffer overflows.
20036fdc
AK		 3012 *
3013 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 3014 */
7b9186f5 3015int sprintf(char *buf, const char *fmt, ...)
1da177e4
LT		 3016{
3017 va_list args;
3018 int i;
3019
3020 va_start(args, fmt);
7b9186f5 3021 i = vsnprintf(buf, INT_MAX, fmt, args);
1da177e4 3022 va_end(args);
7b9186f5 3023
1da177e4
LT		 3024 return i;
3025}
1da177e4
LT		 3026EXPORT_SYMBOL(sprintf);
3027
4370aa4a
LJ		 3028#ifdef CONFIG_BINARY_PRINTF
3029/*
3030 * bprintf service:
3031 * vbin_printf() - VA arguments to binary data
3032 * bstr_printf() - Binary data to text string
3033 */
3034
3035/**
3036 * vbin_printf - Parse a format string and place args' binary value in a buffer
3037 * @bin_buf: The buffer to place args' binary value
3038 * @size: The size of the buffer(by words(32bits), not characters)
3039 * @fmt: The format string to use
3040 * @args: Arguments for the format string
3041 *
3042 * The format follows C99 vsnprintf, except %n is ignored, and its argument
da3dae54 3043 * is skipped.
4370aa4a
LJ		 3044 *
3045 * The return value is the number of words(32bits) which would be generated for
3046 * the given input.
3047 *
3048 * NOTE:
3049 * If the return value is greater than @size, the resulting bin_buf is NOT
3050 * valid for bstr_printf().
3051 */
3052int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
3053{
fef20d9c 3054 struct printf_spec spec = {0};
4370aa4a 3055 char *str, *end;
841a915d 3056 int width;
4370aa4a
LJ		 3057
3058 str = (char *)bin_buf;
3059 end = (char *)(bin_buf + size);
3060
3061#define save_arg(type) \
841a915d
SRV		 3062({ \
3063 unsigned long long value; \
4370aa4a 3064 if (sizeof(type) == 8) { \
841a915d 3065 unsigned long long val8; \
4370aa4a 3066 str = PTR_ALIGN(str, sizeof(u32)); \
841a915d 3067 val8 = va_arg(args, unsigned long long); \
4370aa4a 3068 if (str + sizeof(type) <= end) { \
841a915d
SRV		 3069 *(u32 *)str = *(u32 *)&val8; \
3070 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
4370aa4a 3071 } \
841a915d 3072 value = val8; \
4370aa4a 3073 } else { \
841a915d 3074 unsigned int val4; \
4370aa4a 3075 str = PTR_ALIGN(str, sizeof(type)); \
841a915d 3076 val4 = va_arg(args, int); \
4370aa4a 3077 if (str + sizeof(type) <= end) \
841a915d
SRV		 3078 *(typeof(type) *)str = (type)(long)val4; \
3079 value = (unsigned long long)val4; \
4370aa4a
LJ		 3080 } \
3081 str += sizeof(type); \
841a915d
SRV		 3082 value; \
3083})
4370aa4a 3084
fef20d9c 3085 while (*fmt) {
d4be151b 3086 int read = format_decode(fmt, &spec);
4370aa4a 3087
fef20d9c 3088 fmt += read;
4370aa4a 3089
fef20d9c
FW		 3090 switch (spec.type) {
3091 case FORMAT_TYPE_NONE:
d4be151b 3092 case FORMAT_TYPE_PERCENT_CHAR:
fef20d9c 3093 break;
b006f19b
RV		 3094 case FORMAT_TYPE_INVALID:
3095 goto out;
fef20d9c 3096
ed681a91 3097 case FORMAT_TYPE_WIDTH:
fef20d9c 3098 case FORMAT_TYPE_PRECISION:
841a915d
SRV		 3099 width = (int)save_arg(int);
3100 /* Pointers may require the width */
3101 if (*fmt == 'p')
3102 set_field_width(&spec, width);
fef20d9c
FW		 3103 break;
3104
3105 case FORMAT_TYPE_CHAR:
4370aa4a 3106 save_arg(char);
fef20d9c
FW		 3107 break;
3108
3109 case FORMAT_TYPE_STR: {
4370aa4a 3110 const char *save_str = va_arg(args, char *);
3e5903eb 3111 const char *err_msg;
4370aa4a 3112 size_t len;
6c356634 3113
3e5903eb
PM		 3114 err_msg = check_pointer_msg(save_str);
3115 if (err_msg)
3116 save_str = err_msg;
3117
6c356634
AGR		 3118 len = strlen(save_str) + 1;
3119 if (str + len < end)
3120 memcpy(str, save_str, len);
3121 str += len;
fef20d9c 3122 break;
4370aa4a 3123 }
fef20d9c
FW		 3124
3125 case FORMAT_TYPE_PTR:
841a915d
SRV		 3126 /* Dereferenced pointers must be done now */
3127 switch (*fmt) {
3128 /* Dereference of functions is still OK */
3129 case 'S':
3130 case 's':
1e6338cf
SRV		 3131 case 'x':
3132 case 'K':
57f5677e 3133 case 'e':
841a915d
SRV		 3134 save_arg(void *);
3135 break;
3136 default:
3137 if (!isalnum(*fmt)) {
3138 save_arg(void *);
3139 break;
3140 }
3141 str = pointer(fmt, str, end, va_arg(args, void *),
3142 spec);
3143 if (str + 1 < end)
3144 *str++ = '\0';
3145 else
3146 end[-1] = '\0'; /* Must be nul terminated */
3147 }
4370aa4a 3148 /* skip all alphanumeric pointer suffixes */
fef20d9c 3149 while (isalnum(*fmt))
4370aa4a 3150 fmt++;
fef20d9c
FW		 3151 break;
3152
fef20d9c
FW		 3153 default:
3154 switch (spec.type) {
3155
3156 case FORMAT_TYPE_LONG_LONG:
4370aa4a 3157 save_arg(long long);
fef20d9c
FW		 3158 break;
3159 case FORMAT_TYPE_ULONG:
3160 case FORMAT_TYPE_LONG:
4370aa4a 3161 save_arg(unsigned long);
fef20d9c
FW		 3162 break;
3163 case FORMAT_TYPE_SIZE_T:
4370aa4a 3164 save_arg(size_t);
fef20d9c
FW		 3165 break;
3166 case FORMAT_TYPE_PTRDIFF:
4370aa4a 3167 save_arg(ptrdiff_t);
fef20d9c 3168 break;
a4e94ef0
Z		 3169 case FORMAT_TYPE_UBYTE:
3170 case FORMAT_TYPE_BYTE:
3171 save_arg(char);
3172 break;
fef20d9c
FW		 3173 case FORMAT_TYPE_USHORT:
3174 case FORMAT_TYPE_SHORT:
4370aa4a 3175 save_arg(short);
fef20d9c
FW		 3176 break;
3177 default:
4370aa4a 3178 save_arg(int);
fef20d9c 3179 }
4370aa4a
LJ		 3180 }
3181 }
fef20d9c 3182
b006f19b 3183out:
7b9186f5 3184 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
fef20d9c 3185#undef save_arg
4370aa4a
LJ		 3186}
3187EXPORT_SYMBOL_GPL(vbin_printf);
3188
3189/**
3190 * bstr_printf - Format a string from binary arguments and place it in a buffer
3191 * @buf: The buffer to place the result into
3192 * @size: The size of the buffer, including the trailing null space
3193 * @fmt: The format string to use
3194 * @bin_buf: Binary arguments for the format string
3195 *
3196 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
3197 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
3198 * a binary buffer that generated by vbin_printf.
3199 *
3200 * The format follows C99 vsnprintf, but has some extensions:
0efb4d20 3201 * see vsnprintf comment for details.
4370aa4a
LJ		 3202 *
3203 * The return value is the number of characters which would
3204 * be generated for the given input, excluding the trailing
3205 * '\0', as per ISO C99. If you want to have the exact
3206 * number of characters written into @buf as return value
3207 * (not including the trailing '\0'), use vscnprintf(). If the
3208 * return is greater than or equal to @size, the resulting
3209 * string is truncated.
3210 */
3211int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
3212{
fef20d9c 3213 struct printf_spec spec = {0};
d4be151b
AGR		 3214 char *str, *end;
3215 const char *args = (const char *)bin_buf;
4370aa4a 3216
762abb51 3217 if (WARN_ON_ONCE(size > INT_MAX))
4370aa4a 3218 return 0;
4370aa4a
LJ		 3219
3220 str = buf;
3221 end = buf + size;
3222
3223#define get_arg(type) \
3224({ \
3225 typeof(type) value; \
3226 if (sizeof(type) == 8) { \
3227 args = PTR_ALIGN(args, sizeof(u32)); \
3228 *(u32 *)&value = *(u32 *)args; \
3229 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3230 } else { \
3231 args = PTR_ALIGN(args, sizeof(type)); \
3232 value = *(typeof(type) *)args; \
3233 } \
3234 args += sizeof(type); \
3235 value; \
3236})
3237
3238 /* Make sure end is always >= buf */
3239 if (end < buf) {
3240 end = ((void *)-1);
3241 size = end - buf;
3242 }
3243
fef20d9c 3244 while (*fmt) {
fef20d9c 3245 const char *old_fmt = fmt;
d4be151b 3246 int read = format_decode(fmt, &spec);
4370aa4a 3247
fef20d9c 3248 fmt += read;
4370aa4a 3249
fef20d9c
FW		 3250 switch (spec.type) {
3251 case FORMAT_TYPE_NONE: {
3252 int copy = read;
3253 if (str < end) {
3254 if (copy > end - str)
3255 copy = end - str;
3256 memcpy(str, old_fmt, copy);
4370aa4a 3257 }
fef20d9c
FW		 3258 str += read;
3259 break;
4370aa4a
LJ		 3260 }
3261
ed681a91 3262 case FORMAT_TYPE_WIDTH:
4d72ba01 3263 set_field_width(&spec, get_arg(int));
fef20d9c 3264 break;
4370aa4a 3265
fef20d9c 3266 case FORMAT_TYPE_PRECISION:
4d72ba01 3267 set_precision(&spec, get_arg(int));
fef20d9c 3268 break;
4370aa4a 3269
d4be151b
AGR		 3270 case FORMAT_TYPE_CHAR: {
3271 char c;
3272
fef20d9c
FW		 3273 if (!(spec.flags & LEFT)) {
3274 while (--spec.field_width > 0) {
4370aa4a
LJ		 3275 if (str < end)
3276 *str = ' ';
3277 ++str;
3278 }
3279 }
3280 c = (unsigned char) get_arg(char);
3281 if (str < end)
3282 *str = c;
3283 ++str;
fef20d9c 3284 while (--spec.field_width > 0) {
4370aa4a
LJ		 3285 if (str < end)
3286 *str = ' ';
3287 ++str;
3288 }
fef20d9c 3289 break;
d4be151b 3290 }
4370aa4a 3291
fef20d9c 3292 case FORMAT_TYPE_STR: {
4370aa4a 3293 const char *str_arg = args;
d4be151b 3294 args += strlen(str_arg) + 1;
fef20d9c
FW		 3295 str = string(str, end, (char *)str_arg, spec);
3296 break;
4370aa4a
LJ		 3297 }
3298
841a915d
SRV		 3299 case FORMAT_TYPE_PTR: {
3300 bool process = false;
3301 int copy, len;
3302 /* Non function dereferences were already done */
3303 switch (*fmt) {
3304 case 'S':
3305 case 's':
1e6338cf
SRV		 3306 case 'x':
3307 case 'K':
57f5677e 3308 case 'e':
841a915d
SRV		 3309 process = true;
3310 break;
3311 default:
3312 if (!isalnum(*fmt)) {
3313 process = true;
3314 break;
3315 }
3316 /* Pointer dereference was already processed */
3317 if (str < end) {
3318 len = copy = strlen(args);
3319 if (copy > end - str)
3320 copy = end - str;
3321 memcpy(str, args, copy);
3322 str += len;
62165600 3323 args += len + 1;
841a915d
SRV		 3324 }
3325 }
3326 if (process)
3327 str = pointer(fmt, str, end, get_arg(void *), spec);
3328
fef20d9c 3329 while (isalnum(*fmt))
4370aa4a 3330 fmt++;
fef20d9c 3331 break;
841a915d 3332 }
4370aa4a 3333
fef20d9c 3334 case FORMAT_TYPE_PERCENT_CHAR:
4370aa4a
LJ		 3335 if (str < end)
3336 *str = '%';
3337 ++str;
fef20d9c
FW		 3338 break;
3339
b006f19b
RV		 3340 case FORMAT_TYPE_INVALID:
3341 goto out;
3342
d4be151b
AGR		 3343 default: {
3344 unsigned long long num;
3345
fef20d9c
FW		 3346 switch (spec.type) {
3347
3348 case FORMAT_TYPE_LONG_LONG:
3349 num = get_arg(long long);
3350 break;
3351 case FORMAT_TYPE_ULONG:
fef20d9c
FW		 3352 case FORMAT_TYPE_LONG:
3353 num = get_arg(unsigned long);
3354 break;
3355 case FORMAT_TYPE_SIZE_T:
3356 num = get_arg(size_t);
3357 break;
3358 case FORMAT_TYPE_PTRDIFF:
3359 num = get_arg(ptrdiff_t);
3360 break;
a4e94ef0
Z		 3361 case FORMAT_TYPE_UBYTE:
3362 num = get_arg(unsigned char);
3363 break;
3364 case FORMAT_TYPE_BYTE:
3365 num = get_arg(signed char);
3366 break;
fef20d9c
FW		 3367 case FORMAT_TYPE_USHORT:
3368 num = get_arg(unsigned short);
3369 break;
3370 case FORMAT_TYPE_SHORT:
3371 num = get_arg(short);
3372 break;
3373 case FORMAT_TYPE_UINT:
3374 num = get_arg(unsigned int);
3375 break;
3376 default:
3377 num = get_arg(int);
3378 }
3379
3380 str = number(str, end, num, spec);
d4be151b
AGR		 3381 } /* default: */
3382 } /* switch(spec.type) */
3383 } /* while(*fmt) */
fef20d9c 3384
b006f19b 3385out:
4370aa4a
LJ		 3386 if (size > 0) {
3387 if (str < end)
3388 *str = '\0';
3389 else
3390 end[-1] = '\0';
3391 }
fef20d9c 3392
4370aa4a
LJ		 3393#undef get_arg
3394
3395 /* the trailing null byte doesn't count towards the total */
3396 return str - buf;
3397}
3398EXPORT_SYMBOL_GPL(bstr_printf);
3399
3400/**
3401 * bprintf - Parse a format string and place args' binary value in a buffer
3402 * @bin_buf: The buffer to place args' binary value
3403 * @size: The size of the buffer(by words(32bits), not characters)
3404 * @fmt: The format string to use
3405 * @...: Arguments for the format string
3406 *
3407 * The function returns the number of words(u32) written
3408 * into @bin_buf.
3409 */
3410int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3411{
3412 va_list args;
3413 int ret;
3414
3415 va_start(args, fmt);
3416 ret = vbin_printf(bin_buf, size, fmt, args);
3417 va_end(args);
7b9186f5 3418
4370aa4a
LJ		 3419 return ret;
3420}
3421EXPORT_SYMBOL_GPL(bprintf);
3422
3423#endif /* CONFIG_BINARY_PRINTF */
3424
1da177e4
LT		 3425/**
3426 * vsscanf - Unformat a buffer into a list of arguments
3427 * @buf: input buffer
3428 * @fmt: format of buffer
3429 * @args: arguments
3430 */
7b9186f5 3431int vsscanf(const char *buf, const char *fmt, va_list args)
1da177e4
LT		 3432{
3433 const char *str = buf;
3434 char *next;
3435 char digit;
3436 int num = 0;
ef0658f3 3437 u8 qualifier;
53809751
JB		 3438 unsigned int base;
3439 union {
3440 long long s;
3441 unsigned long long u;
3442 } val;
ef0658f3 3443 s16 field_width;
d4be151b 3444 bool is_sign;
1da177e4 3445
da99075c 3446 while (*fmt) {
1da177e4 3447 /* skip any white space in format */
9dbbc3b9 3448 /* white space in format matches any amount of
1da177e4
LT		 3449 * white space, including none, in the input.
3450 */
3451 if (isspace(*fmt)) {
e7d2860b
AGR		 3452 fmt = skip_spaces(++fmt);
3453 str = skip_spaces(str);
1da177e4
LT		 3454 }
3455
3456 /* anything that is not a conversion must match exactly */
3457 if (*fmt != '%' && *fmt) {
3458 if (*fmt++ != *str++)
3459 break;
3460 continue;
3461 }
3462
3463 if (!*fmt)
3464 break;
3465 ++fmt;
7b9186f5 3466
1da177e4
LT		 3467 /* skip this conversion.
3468 * advance both strings to next white space
3469 */
3470 if (*fmt == '*') {
da99075c
JB		 3471 if (!*str)
3472 break;
f9310b2f
JY		 3473 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3474 /* '%*[' not yet supported, invalid format */
3475 if (*fmt == '[')
3476 return num;
1da177e4 3477 fmt++;
f9310b2f 3478 }
1da177e4
LT		 3479 while (!isspace(*str) && *str)
3480 str++;
3481 continue;
3482 }
3483
3484 /* get field width */
3485 field_width = -1;
53809751 3486 if (isdigit(*fmt)) {
1da177e4 3487 field_width = skip_atoi(&fmt);
53809751
JB		 3488 if (field_width <= 0)
3489 break;
3490 }
1da177e4
LT		 3491
3492 /* get conversion qualifier */
3493 qualifier = -1;
75fb8f26 3494 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
5b5e0928 3495 *fmt == 'z') {
1da177e4
LT		 3496 qualifier = *fmt++;
3497 if (unlikely(qualifier == *fmt)) {
3498 if (qualifier == 'h') {
3499 qualifier = 'H';
3500 fmt++;
3501 } else if (qualifier == 'l') {
3502 qualifier = 'L';
3503 fmt++;
3504 }
3505 }
3506 }
1da177e4 3507
da99075c
JB		 3508 if (!*fmt)
3509 break;
3510
3511 if (*fmt == 'n') {
3512 /* return number of characters read so far */
3513 *va_arg(args, int *) = str - buf;
3514 ++fmt;
3515 continue;
3516 }
3517
3518 if (!*str)
1da177e4
LT		 3519 break;
3520
d4be151b 3521 base = 10;
3f623eba 3522 is_sign = false;
d4be151b 3523
7b9186f5 3524 switch (*fmt++) {
1da177e4
LT		 3525 case 'c':
3526 {
7b9186f5 3527 char *s = (char *)va_arg(args, char*);
1da177e4
LT		 3528 if (field_width == -1)
3529 field_width = 1;
3530 do {
3531 *s++ = *str++;
3532 } while (--field_width > 0 && *str);
3533 num++;
3534 }
3535 continue;
3536 case 's':
3537 {
7b9186f5
AGR		 3538 char *s = (char *)va_arg(args, char *);
3539 if (field_width == -1)
4be929be 3540 field_width = SHRT_MAX;
1da177e4 3541 /* first, skip leading white space in buffer */
e7d2860b 3542 str = skip_spaces(str);
1da177e4
LT		 3543
3544 /* now copy until next white space */
7b9186f5 3545 while (*str && !isspace(*str) && field_width--)
1da177e4 3546 *s++ = *str++;
1da177e4
LT		 3547 *s = '\0';
3548 num++;
3549 }
3550 continue;
f9310b2f
JY		 3551 /*
3552 * Warning: This implementation of the '[' conversion specifier
3553 * deviates from its glibc counterpart in the following ways:
3554 * (1) It does NOT support ranges i.e. '-' is NOT a special
3555 * character
3556 * (2) It cannot match the closing bracket ']' itself
3557 * (3) A field width is required
3558 * (4) '%*[' (discard matching input) is currently not supported
3559 *
3560 * Example usage:
3561 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3562 * buf1, buf2, buf3);
3563 * if (ret < 3)
3564 * // etc..
3565 */
3566 case '[':
3567 {
3568 char *s = (char *)va_arg(args, char *);
3569 DECLARE_BITMAP(set, 256) = {0};
3570 unsigned int len = 0;
3571 bool negate = (*fmt == '^');
3572
3573 /* field width is required */
3574 if (field_width == -1)
3575 return num;
3576
3577 if (negate)
3578 ++fmt;
3579
3580 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
52e68cd6 3581 __set_bit((u8)*fmt, set);
f9310b2f
JY		 3582
3583 /* no ']' or no character set found */
3584 if (!*fmt || !len)
3585 return num;
3586 ++fmt;
3587
3588 if (negate) {
3589 bitmap_complement(set, set, 256);
3590 /* exclude null '\0' byte */
52e68cd6 3591 __clear_bit(0, set);
f9310b2f
JY		 3592 }
3593
3594 /* match must be non-empty */
3595 if (!test_bit((u8)*str, set))
3596 return num;
3597
3598 while (test_bit((u8)*str, set) && field_width--)
3599 *s++ = *str++;
3600 *s = '\0';
3601 ++num;
3602 }
3603 continue;
1da177e4
LT		 3604 case 'o':
3605 base = 8;
3606 break;
3607 case 'x':
3608 case 'X':
3609 base = 16;
3610 break;
3611 case 'i':
7b9186f5 3612 base = 0;
4c1ca831 3613 fallthrough;
1da177e4 3614 case 'd':
3f623eba 3615 is_sign = true;
4c1ca831 3616 fallthrough;
1da177e4
LT		 3617 case 'u':
3618 break;
3619 case '%':
3620 /* looking for '%' in str */
7b9186f5 3621 if (*str++ != '%')
1da177e4
LT		 3622 return num;
3623 continue;
3624 default:
3625 /* invalid format; stop here */
3626 return num;
3627 }
3628
3629 /* have some sort of integer conversion.
3630 * first, skip white space in buffer.
3631 */
e7d2860b 3632 str = skip_spaces(str);
1da177e4
LT		 3633
3634 digit = *str;
11b3dda5
RF		 3635 if (is_sign && digit == '-') {
3636 if (field_width == 1)
3637 break;
3638
1da177e4 3639 digit = *(str + 1);
11b3dda5 3640 }
1da177e4
LT		 3641
3642 if (!digit
7b9186f5
AGR		 3643 || (base == 16 && !isxdigit(digit))
3644 || (base == 10 && !isdigit(digit))
48e1a66f 3645 || (base == 8 && !isodigit(digit))
7b9186f5
AGR		 3646 || (base == 0 && !isdigit(digit)))
3647 break;
1da177e4 3648
53809751 3649 if (is_sign)
900fdc45
RF		 3650 val.s = simple_strntoll(str,
3651 field_width >= 0 ? field_width : INT_MAX,
3652 &next, base);
53809751 3653 else
900fdc45
RF		 3654 val.u = simple_strntoull(str,
3655 field_width >= 0 ? field_width : INT_MAX,
3656 &next, base);
53809751 3657
7b9186f5 3658 switch (qualifier) {
1da177e4 3659 case 'H': /* that's 'hh' in format */
53809751
JB		 3660 if (is_sign)
3661 *va_arg(args, signed char *) = val.s;
3662 else
3663 *va_arg(args, unsigned char *) = val.u;
1da177e4
LT		 3664 break;
3665 case 'h':
53809751
JB		 3666 if (is_sign)
3667 *va_arg(args, short *) = val.s;
3668 else
3669 *va_arg(args, unsigned short *) = val.u;
1da177e4
LT		 3670 break;
3671 case 'l':
53809751
JB		 3672 if (is_sign)
3673 *va_arg(args, long *) = val.s;
3674 else
3675 *va_arg(args, unsigned long *) = val.u;
1da177e4
LT		 3676 break;
3677 case 'L':
53809751
JB		 3678 if (is_sign)
3679 *va_arg(args, long long *) = val.s;
3680 else
3681 *va_arg(args, unsigned long long *) = val.u;
1da177e4 3682 break;
1da177e4 3683 case 'z':
53809751
JB		 3684 *va_arg(args, size_t *) = val.u;
3685 break;
1da177e4 3686 default:
53809751
JB		 3687 if (is_sign)
3688 *va_arg(args, int *) = val.s;
3689 else
3690 *va_arg(args, unsigned int *) = val.u;
1da177e4
LT		 3691 break;
3692 }
3693 num++;
3694
3695 if (!next)
3696 break;
3697 str = next;
3698 }
c6b40d16 3699
1da177e4
LT		 3700 return num;
3701}
1da177e4
LT		 3702EXPORT_SYMBOL(vsscanf);
3703
3704/**
3705 * sscanf - Unformat a buffer into a list of arguments
3706 * @buf: input buffer
3707 * @fmt: formatting of buffer
3708 * @...: resulting arguments
3709 */
7b9186f5 3710int sscanf(const char *buf, const char *fmt, ...)
1da177e4
LT		 3711{
3712 va_list args;
3713 int i;
3714
7b9186f5
AGR		 3715 va_start(args, fmt);
3716 i = vsscanf(buf, fmt, args);
1da177e4 3717 va_end(args);
7b9186f5 3718
1da177e4
LT		 3719 return i;
3720}
1da177e4 3721EXPORT_SYMBOL(sscanf);
Linux 6.x block layer and io_uring tree(s)