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