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