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