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