vsprintf.c 83.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
L
Linus Torvalds 已提交
2 3 4 5 6 7 8 9 10 11 12
/*
 *  linux/lib/vsprintf.c
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 */

/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
/*
 * Wirzenius wrote this portably, Torvalds fucked it up :-)
 */

13
/*
L
Linus Torvalds 已提交
14 15 16 17 18 19 20
 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
 * - changed to provide snprintf and vsnprintf functions
 * So Feb  1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
 * - scnprintf and vscnprintf
 */

#include <stdarg.h>
21
#include <linux/build_bug.h>
S
Stephen Boyd 已提交
22
#include <linux/clk.h>
23
#include <linux/clk-provider.h>
24
#include <linux/errname.h>
25
#include <linux/module.h>	/* for KSYM_SYMBOL_LEN */
L
Linus Torvalds 已提交
26 27 28 29
#include <linux/types.h>
#include <linux/string.h>
#include <linux/ctype.h>
#include <linux/kernel.h>
30
#include <linux/kallsyms.h>
31
#include <linux/math64.h>
32
#include <linux/uaccess.h>
33
#include <linux/ioport.h>
A
Al Viro 已提交
34
#include <linux/dcache.h>
35
#include <linux/cred.h>
36
#include <linux/rtc.h>
37
#include <linux/time.h>
38
#include <linux/uuid.h>
39
#include <linux/of.h>
40
#include <net/addrconf.h>
41 42
#include <linux/siphash.h>
#include <linux/compiler.h>
43
#include <linux/property.h>
44 45 46
#ifdef CONFIG_BLOCK
#include <linux/blkdev.h>
#endif
L
Linus Torvalds 已提交
47

48 49
#include "../mm/internal.h"	/* For the trace_print_flags arrays */

T
Tim Schmielau 已提交
50
#include <asm/page.h>		/* for PAGE_SIZE */
51
#include <asm/byteorder.h>	/* cpu_to_le16 */
L
Linus Torvalds 已提交
52

53
#include <linux/string_helpers.h>
54
#include "kstrtox.h"
55

L
Linus Torvalds 已提交
56
/**
57
 * simple_strtoull - convert a string to an unsigned long long
L
Linus Torvalds 已提交
58 59 60
 * @cp: The start of the string
 * @endp: A pointer to the end of the parsed string will be placed here
 * @base: The number base to use
61
 *
62
 * This function has caveats. Please use kstrtoull instead.
L
Linus Torvalds 已提交
63
 */
64
unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
65
{
66 67
	unsigned long long result;
	unsigned int rv;
68

69 70 71 72
	cp = _parse_integer_fixup_radix(cp, &base);
	rv = _parse_integer(cp, base, &result);
	/* FIXME */
	cp += (rv & ~KSTRTOX_OVERFLOW);
73

L
Linus Torvalds 已提交
74 75
	if (endp)
		*endp = (char *)cp;
76

L
Linus Torvalds 已提交
77 78
	return result;
}
79
EXPORT_SYMBOL(simple_strtoull);
L
Linus Torvalds 已提交
80 81

/**
82
 * simple_strtoul - convert a string to an unsigned long
L
Linus Torvalds 已提交
83 84 85
 * @cp: The start of the string
 * @endp: A pointer to the end of the parsed string will be placed here
 * @base: The number base to use
86
 *
87
 * This function has caveats. Please use kstrtoul instead.
L
Linus Torvalds 已提交
88
 */
89
unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
90
{
91
	return simple_strtoull(cp, endp, base);
L
Linus Torvalds 已提交
92
}
93
EXPORT_SYMBOL(simple_strtoul);
L
Linus Torvalds 已提交
94 95

/**
96
 * simple_strtol - convert a string to a signed long
L
Linus Torvalds 已提交
97 98 99
 * @cp: The start of the string
 * @endp: A pointer to the end of the parsed string will be placed here
 * @base: The number base to use
100
 *
101
 * This function has caveats. Please use kstrtol instead.
L
Linus Torvalds 已提交
102
 */
103
long simple_strtol(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
104
{
105 106
	if (*cp == '-')
		return -simple_strtoul(cp + 1, endp, base);
107

108
	return simple_strtoul(cp, endp, base);
L
Linus Torvalds 已提交
109
}
110
EXPORT_SYMBOL(simple_strtol);
L
Linus Torvalds 已提交
111 112 113 114 115 116

/**
 * simple_strtoll - convert a string to a signed long long
 * @cp: The start of the string
 * @endp: A pointer to the end of the parsed string will be placed here
 * @base: The number base to use
117
 *
118
 * This function has caveats. Please use kstrtoll instead.
L
Linus Torvalds 已提交
119
 */
H
Harvey Harrison 已提交
120
long long simple_strtoll(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
121
{
122
	if (*cp == '-')
H
Harvey Harrison 已提交
123
		return -simple_strtoull(cp + 1, endp, base);
124

H
Harvey Harrison 已提交
125
	return simple_strtoull(cp, endp, base);
L
Linus Torvalds 已提交
126
}
127
EXPORT_SYMBOL(simple_strtoll);
L
Linus Torvalds 已提交
128

J
Joe Perches 已提交
129 130
static noinline_for_stack
int skip_atoi(const char **s)
L
Linus Torvalds 已提交
131
{
132
	int i = 0;
L
Linus Torvalds 已提交
133

134
	do {
L
Linus Torvalds 已提交
135
		i = i*10 + *((*s)++) - '0';
136
	} while (isdigit(**s));
137

L
Linus Torvalds 已提交
138 139 140
	return i;
}

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/*
 * Decimal conversion is by far the most typical, and is used for
 * /proc and /sys data. This directly impacts e.g. top performance
 * with many processes running. We optimize it for speed by emitting
 * two characters at a time, using a 200 byte lookup table. This
 * roughly halves the number of multiplications compared to computing
 * the digits one at a time. Implementation strongly inspired by the
 * previous version, which in turn used ideas described at
 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
 * from the author, Douglas W. Jones).
 *
 * It turns out there is precisely one 26 bit fixed-point
 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
 * range happens to be somewhat larger (x <= 1073741898), but that's
 * irrelevant for our purpose.
 *
 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
 * need a 32x32->64 bit multiply, so we simply use the same constant.
 *
 * For dividing a number in the range [100, 10^4-1] by 100, there are
 * several options. The simplest is (x * 0x147b) >> 19, which is valid
 * for all x <= 43698.
164
 */
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
static const u16 decpair[100] = {
#define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
	_( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
	_(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
	_(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
	_(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
	_(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
	_(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
	_(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
	_(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
	_(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
	_(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
#undef _
};

/*
 * This will print a single '0' even if r == 0, since we would
183 184 185
 * immediately jump to out_r where two 0s would be written but only
 * one of them accounted for in buf. This is needed by ip4_string
 * below. All other callers pass a non-zero value of r.
186
*/
J
Joe Perches 已提交
187
static noinline_for_stack
188
char *put_dec_trunc8(char *buf, unsigned r)
189
{
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
	unsigned q;

	/* 1 <= r < 10^8 */
	if (r < 100)
		goto out_r;

	/* 100 <= r < 10^8 */
	q = (r * (u64)0x28f5c29) >> 32;
	*((u16 *)buf) = decpair[r - 100*q];
	buf += 2;

	/* 1 <= q < 10^6 */
	if (q < 100)
		goto out_q;

	/*  100 <= q < 10^6 */
	r = (q * (u64)0x28f5c29) >> 32;
	*((u16 *)buf) = decpair[q - 100*r];
	buf += 2;

	/* 1 <= r < 10^4 */
	if (r < 100)
		goto out_r;

	/* 100 <= r < 10^4 */
	q = (r * 0x147b) >> 19;
	*((u16 *)buf) = decpair[r - 100*q];
	buf += 2;
out_q:
	/* 1 <= q < 100 */
	r = q;
out_r:
	/* 1 <= r < 100 */
	*((u16 *)buf) = decpair[r];
224
	buf += r < 10 ? 1 : 2;
225 226
	return buf;
}
227

228
#if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
J
Joe Perches 已提交
229
static noinline_for_stack
230
char *put_dec_full8(char *buf, unsigned r)
231
{
232 233
	unsigned q;

234 235 236 237
	/* 0 <= r < 10^8 */
	q = (r * (u64)0x28f5c29) >> 32;
	*((u16 *)buf) = decpair[r - 100*q];
	buf += 2;
238

239 240 241 242
	/* 0 <= q < 10^6 */
	r = (q * (u64)0x28f5c29) >> 32;
	*((u16 *)buf) = decpair[q - 100*r];
	buf += 2;
243

244 245 246 247
	/* 0 <= r < 10^4 */
	q = (r * 0x147b) >> 19;
	*((u16 *)buf) = decpair[r - 100*q];
	buf += 2;
248

249 250 251 252 253
	/* 0 <= q < 100 */
	*((u16 *)buf) = decpair[q];
	buf += 2;
	return buf;
}
254

255
static noinline_for_stack
256 257
char *put_dec(char *buf, unsigned long long n)
{
258 259 260 261 262 263
	if (n >= 100*1000*1000)
		buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
	/* 1 <= n <= 1.6e11 */
	if (n >= 100*1000*1000)
		buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
	/* 1 <= n < 1e8 */
264
	return put_dec_trunc8(buf, n);
265
}
266

267
#elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
268

269 270
static void
put_dec_full4(char *buf, unsigned r)
271
{
272 273 274 275 276 277 278 279
	unsigned q;

	/* 0 <= r < 10^4 */
	q = (r * 0x147b) >> 19;
	*((u16 *)buf) = decpair[r - 100*q];
	buf += 2;
	/* 0 <= q < 100 */
	*((u16 *)buf) = decpair[q];
280 281 282 283 284 285 286
}

/*
 * Call put_dec_full4 on x % 10000, return x / 10000.
 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
 * holds for all x < 1,128,869,999.  The largest value this
 * helper will ever be asked to convert is 1,125,520,955.
287
 * (second call in the put_dec code, assuming n is all-ones).
288
 */
289
static noinline_for_stack
290 291 292 293 294 295
unsigned put_dec_helper4(char *buf, unsigned x)
{
        uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;

        put_dec_full4(buf, x - q * 10000);
        return q;
296 297
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
/* Based on code by Douglas W. Jones found at
 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
 * (with permission from the author).
 * Performs no 64-bit division and hence should be fast on 32-bit machines.
 */
static
char *put_dec(char *buf, unsigned long long n)
{
	uint32_t d3, d2, d1, q, h;

	if (n < 100*1000*1000)
		return put_dec_trunc8(buf, n);

	d1  = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
	h   = (n >> 32);
	d2  = (h      ) & 0xffff;
	d3  = (h >> 16); /* implicit "& 0xffff" */

316 317
	/* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
	     = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
318
	q   = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
319 320 321 322 323 324 325
	q = put_dec_helper4(buf, q);

	q += 7671 * d3 + 9496 * d2 + 6 * d1;
	q = put_dec_helper4(buf+4, q);

	q += 4749 * d3 + 42 * d2;
	q = put_dec_helper4(buf+8, q);
326

327 328 329 330 331
	q += 281 * d3;
	buf += 12;
	if (q)
		buf = put_dec_trunc8(buf, q);
	else while (buf[-1] == '0')
332 333 334 335 336 337 338
		--buf;

	return buf;
}

#endif

339 340 341 342 343 344
/*
 * Convert passed number to decimal string.
 * Returns the length of string.  On buffer overflow, returns 0.
 *
 * If speed is not important, use snprintf(). It's easy to read the code.
 */
345
int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
346
{
347 348
	/* put_dec requires 2-byte alignment of the buffer. */
	char tmp[sizeof(num) * 3] __aligned(2);
349 350
	int idx, len;

351 352 353 354 355 356 357
	/* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
	if (num <= 9) {
		tmp[0] = '0' + num;
		len = 1;
	} else {
		len = put_dec(tmp, num) - tmp;
	}
358

359
	if (len > size || width > size)
360
		return 0;
361 362 363 364 365 366 367 368 369

	if (width > len) {
		width = width - len;
		for (idx = 0; idx < width; idx++)
			buf[idx] = ' ';
	} else {
		width = 0;
	}

370
	for (idx = 0; idx < len; ++idx)
371 372 373
		buf[idx + width] = tmp[len - idx - 1];

	return len + width;
374 375
}

376
#define SIGN	1		/* unsigned/signed, must be 1 */
377
#define LEFT	2		/* left justified */
L
Linus Torvalds 已提交
378 379
#define PLUS	4		/* show plus */
#define SPACE	8		/* space if plus */
380
#define ZEROPAD	16		/* pad with zero, must be 16 == '0' - ' ' */
381 382
#define SMALL	32		/* use lowercase in hex (must be 32 == 0x20) */
#define SPECIAL	64		/* prefix hex with "0x", octal with "0" */
L
Linus Torvalds 已提交
383

384 385 386
static_assert(ZEROPAD == ('0' - ' '));
static_assert(SMALL == ' ');

387 388
enum format_type {
	FORMAT_TYPE_NONE, /* Just a string part */
389
	FORMAT_TYPE_WIDTH,
390 391 392 393 394 395 396 397 398
	FORMAT_TYPE_PRECISION,
	FORMAT_TYPE_CHAR,
	FORMAT_TYPE_STR,
	FORMAT_TYPE_PTR,
	FORMAT_TYPE_PERCENT_CHAR,
	FORMAT_TYPE_INVALID,
	FORMAT_TYPE_LONG_LONG,
	FORMAT_TYPE_ULONG,
	FORMAT_TYPE_LONG,
399 400
	FORMAT_TYPE_UBYTE,
	FORMAT_TYPE_BYTE,
401 402 403 404 405 406 407 408 409
	FORMAT_TYPE_USHORT,
	FORMAT_TYPE_SHORT,
	FORMAT_TYPE_UINT,
	FORMAT_TYPE_INT,
	FORMAT_TYPE_SIZE_T,
	FORMAT_TYPE_PTRDIFF
};

struct printf_spec {
410 411 412 413 414 415
	unsigned int	type:8;		/* format_type enum */
	signed int	field_width:24;	/* width of output field */
	unsigned int	flags:8;	/* flags to number() */
	unsigned int	base:8;		/* number base, 8, 10 or 16 only */
	signed int	precision:16;	/* # of digits/chars */
} __packed;
416 417
static_assert(sizeof(struct printf_spec) == 8);

418 419
#define FIELD_WIDTH_MAX ((1 << 23) - 1)
#define PRECISION_MAX ((1 << 15) - 1)
420

J
Joe Perches 已提交
421 422 423
static noinline_for_stack
char *number(char *buf, char *end, unsigned long long num,
	     struct printf_spec spec)
L
Linus Torvalds 已提交
424
{
425 426
	/* put_dec requires 2-byte alignment of the buffer. */
	char tmp[3 * sizeof(num)] __aligned(2);
427 428
	char sign;
	char locase;
429
	int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
L
Linus Torvalds 已提交
430
	int i;
431
	bool is_zero = num == 0LL;
432 433
	int field_width = spec.field_width;
	int precision = spec.precision;
L
Linus Torvalds 已提交
434

435 436
	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
	 * produces same digits or (maybe lowercased) letters */
437 438 439
	locase = (spec.flags & SMALL);
	if (spec.flags & LEFT)
		spec.flags &= ~ZEROPAD;
L
Linus Torvalds 已提交
440
	sign = 0;
441
	if (spec.flags & SIGN) {
442
		if ((signed long long)num < 0) {
L
Linus Torvalds 已提交
443
			sign = '-';
444
			num = -(signed long long)num;
445
			field_width--;
446
		} else if (spec.flags & PLUS) {
L
Linus Torvalds 已提交
447
			sign = '+';
448
			field_width--;
449
		} else if (spec.flags & SPACE) {
L
Linus Torvalds 已提交
450
			sign = ' ';
451
			field_width--;
L
Linus Torvalds 已提交
452 453
		}
	}
454
	if (need_pfx) {
455
		if (spec.base == 16)
456
			field_width -= 2;
457
		else if (!is_zero)
458
			field_width--;
L
Linus Torvalds 已提交
459
	}
460 461

	/* generate full string in tmp[], in reverse order */
L
Linus Torvalds 已提交
462
	i = 0;
463
	if (num < spec.base)
464
		tmp[i++] = hex_asc_upper[num] | locase;
465 466
	else if (spec.base != 10) { /* 8 or 16 */
		int mask = spec.base - 1;
467
		int shift = 3;
468 469 470

		if (spec.base == 16)
			shift = 4;
471
		do {
472
			tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
473 474
			num >>= shift;
		} while (num);
475 476 477
	} else { /* base 10 */
		i = put_dec(tmp, num) - tmp;
	}
478 479

	/* printing 100 using %2d gives "100", not "00" */
480 481
	if (i > precision)
		precision = i;
482
	/* leading space padding */
483
	field_width -= precision;
484
	if (!(spec.flags & (ZEROPAD | LEFT))) {
485
		while (--field_width >= 0) {
486
			if (buf < end)
L
Linus Torvalds 已提交
487 488 489 490
				*buf = ' ';
			++buf;
		}
	}
491
	/* sign */
L
Linus Torvalds 已提交
492
	if (sign) {
493
		if (buf < end)
L
Linus Torvalds 已提交
494 495 496
			*buf = sign;
		++buf;
	}
497 498
	/* "0x" / "0" prefix */
	if (need_pfx) {
499 500 501 502 503
		if (spec.base == 16 || !is_zero) {
			if (buf < end)
				*buf = '0';
			++buf;
		}
504
		if (spec.base == 16) {
505
			if (buf < end)
506
				*buf = ('X' | locase);
L
Linus Torvalds 已提交
507 508 509
			++buf;
		}
	}
510
	/* zero or space padding */
511
	if (!(spec.flags & LEFT)) {
512
		char c = ' ' + (spec.flags & ZEROPAD);
513

514
		while (--field_width >= 0) {
515
			if (buf < end)
L
Linus Torvalds 已提交
516 517 518 519
				*buf = c;
			++buf;
		}
	}
520
	/* hmm even more zero padding? */
521
	while (i <= --precision) {
522
		if (buf < end)
L
Linus Torvalds 已提交
523 524 525
			*buf = '0';
		++buf;
	}
526 527
	/* actual digits of result */
	while (--i >= 0) {
528
		if (buf < end)
L
Linus Torvalds 已提交
529 530 531
			*buf = tmp[i];
		++buf;
	}
532
	/* trailing space padding */
533
	while (--field_width >= 0) {
534
		if (buf < end)
L
Linus Torvalds 已提交
535 536 537
			*buf = ' ';
		++buf;
	}
538

L
Linus Torvalds 已提交
539 540 541
	return buf;
}

542 543 544 545 546 547 548 549 550 551 552 553 554 555
static noinline_for_stack
char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
{
	struct printf_spec spec;

	spec.type = FORMAT_TYPE_PTR;
	spec.field_width = 2 + 2 * size;	/* 0x + hex */
	spec.flags = SPECIAL | SMALL | ZEROPAD;
	spec.base = 16;
	spec.precision = -1;

	return number(buf, end, num, spec);
}

556
static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
A
Al Viro 已提交
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
{
	size_t size;
	if (buf >= end)	/* nowhere to put anything */
		return;
	size = end - buf;
	if (size <= spaces) {
		memset(buf, ' ', size);
		return;
	}
	if (len) {
		if (len > size - spaces)
			len = size - spaces;
		memmove(buf + spaces, buf, len);
	}
	memset(buf, ' ', spaces);
}

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
/*
 * Handle field width padding for a string.
 * @buf: current buffer position
 * @n: length of string
 * @end: end of output buffer
 * @spec: for field width and flags
 * Returns: new buffer position after padding.
 */
static noinline_for_stack
char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
{
	unsigned spaces;

	if (likely(n >= spec.field_width))
		return buf;
	/* we want to pad the sucker */
	spaces = spec.field_width - n;
	if (!(spec.flags & LEFT)) {
		move_right(buf - n, end, n, spaces);
		return buf + spaces;
	}
	while (spaces--) {
		if (buf < end)
			*buf = ' ';
		++buf;
	}
	return buf;
}

603 604 605
/* Handle string from a well known address. */
static char *string_nocheck(char *buf, char *end, const char *s,
			    struct printf_spec spec)
606
{
607
	int len = 0;
608
	int lim = spec.precision;
609

610 611 612 613
	while (lim--) {
		char c = *s++;
		if (!c)
			break;
614
		if (buf < end)
615
			*buf = c;
616
		++buf;
617
		++len;
618
	}
619
	return widen_string(buf, len, end, spec);
620 621
}

622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
static char *err_ptr(char *buf, char *end, void *ptr,
		     struct printf_spec spec)
{
	int err = PTR_ERR(ptr);
	const char *sym = errname(err);

	if (sym)
		return string_nocheck(buf, end, sym, spec);

	/*
	 * Somebody passed ERR_PTR(-1234) or some other non-existing
	 * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to
	 * printing it as its decimal representation.
	 */
	spec.flags |= SIGN;
	spec.base = 10;
	return number(buf, end, err, spec);
}

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
/* Be careful: error messages must fit into the given buffer. */
static char *error_string(char *buf, char *end, const char *s,
			  struct printf_spec spec)
{
	/*
	 * Hard limit to avoid a completely insane messages. It actually
	 * works pretty well because most error messages are in
	 * the many pointer format modifiers.
	 */
	if (spec.precision == -1)
		spec.precision = 2 * sizeof(void *);

	return string_nocheck(buf, end, s, spec);
}

656
/*
657 658 659
 * Do not call any complex external code here. Nested printk()/vsprintf()
 * might cause infinite loops. Failures might break printk() and would
 * be hard to debug.
660 661 662 663 664 665
 */
static const char *check_pointer_msg(const void *ptr)
{
	if (!ptr)
		return "(null)";

666
	if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
667 668 669 670 671 672 673 674 675 676 677 678
		return "(efault)";

	return NULL;
}

static int check_pointer(char **buf, char *end, const void *ptr,
			 struct printf_spec spec)
{
	const char *err_msg;

	err_msg = check_pointer_msg(ptr);
	if (err_msg) {
679
		*buf = error_string(*buf, end, err_msg, spec);
680 681 682 683 684 685
		return -EFAULT;
	}

	return 0;
}

686
static noinline_for_stack
687 688 689
char *string(char *buf, char *end, const char *s,
	     struct printf_spec spec)
{
690 691
	if (check_pointer(&buf, end, s, spec))
		return buf;
692 693 694 695

	return string_nocheck(buf, end, s, spec);
}

696 697 698
static char *pointer_string(char *buf, char *end,
			    const void *ptr,
			    struct printf_spec spec)
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
{
	spec.base = 16;
	spec.flags |= SMALL;
	if (spec.field_width == -1) {
		spec.field_width = 2 * sizeof(ptr);
		spec.flags |= ZEROPAD;
	}

	return number(buf, end, (unsigned long int)ptr, spec);
}

/* Make pointers available for printing early in the boot sequence. */
static int debug_boot_weak_hash __ro_after_init;

static int __init debug_boot_weak_hash_enable(char *str)
{
	debug_boot_weak_hash = 1;
	pr_info("debug_boot_weak_hash enabled\n");
	return 0;
}
early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable);

static DEFINE_STATIC_KEY_TRUE(not_filled_random_ptr_key);
static siphash_key_t ptr_key __read_mostly;

static void enable_ptr_key_workfn(struct work_struct *work)
{
	get_random_bytes(&ptr_key, sizeof(ptr_key));
	/* Needs to run from preemptible context */
	static_branch_disable(&not_filled_random_ptr_key);
}

static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn);

static void fill_random_ptr_key(struct random_ready_callback *unused)
{
	/* This may be in an interrupt handler. */
	queue_work(system_unbound_wq, &enable_ptr_key_work);
}

static struct random_ready_callback random_ready = {
	.func = fill_random_ptr_key
};

static int __init initialize_ptr_random(void)
{
	int key_size = sizeof(ptr_key);
	int ret;

	/* Use hw RNG if available. */
	if (get_random_bytes_arch(&ptr_key, key_size) == key_size) {
		static_branch_disable(&not_filled_random_ptr_key);
		return 0;
	}

	ret = add_random_ready_callback(&random_ready);
	if (!ret) {
		return 0;
	} else if (ret == -EALREADY) {
		/* This is in preemptible context */
		enable_ptr_key_workfn(&enable_ptr_key_work);
		return 0;
	}

	return ret;
}
early_initcall(initialize_ptr_random);

/* Maps a pointer to a 32 bit unique identifier. */
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
{
	unsigned long hashval;

	if (static_branch_unlikely(&not_filled_random_ptr_key))
		return -EAGAIN;

#ifdef CONFIG_64BIT
	hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
	/*
	 * Mask off the first 32 bits, this makes explicit that we have
	 * modified the address (and 32 bits is plenty for a unique ID).
	 */
	hashval = hashval & 0xffffffff;
#else
	hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
#endif
	*hashval_out = hashval;
	return 0;
}

int ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
{
	return __ptr_to_hashval(ptr, hashval_out);
}

794 795 796 797 798
static char *ptr_to_id(char *buf, char *end, const void *ptr,
		       struct printf_spec spec)
{
	const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
	unsigned long hashval;
799
	int ret;
800

801 802 803 804 805 806 807
	/*
	 * Print the real pointer value for NULL and error pointers,
	 * as they are not actual addresses.
	 */
	if (IS_ERR_OR_NULL(ptr))
		return pointer_string(buf, end, ptr, spec);

808 809 810 811 812 813
	/* When debugging early boot use non-cryptographically secure hash. */
	if (unlikely(debug_boot_weak_hash)) {
		hashval = hash_long((unsigned long)ptr, 32);
		return pointer_string(buf, end, (const void *)hashval, spec);
	}

814 815
	ret = __ptr_to_hashval(ptr, &hashval);
	if (ret) {
816 817
		spec.field_width = 2 * sizeof(ptr);
		/* string length must be less than default_width */
818
		return error_string(buf, end, str, spec);
819 820 821 822 823
	}

	return pointer_string(buf, end, (const void *)hashval, spec);
}

824 825 826 827 828 829 830 831
int kptr_restrict __read_mostly;

static noinline_for_stack
char *restricted_pointer(char *buf, char *end, const void *ptr,
			 struct printf_spec spec)
{
	switch (kptr_restrict) {
	case 0:
832 833
		/* Handle as %p, hash and do _not_ leak addresses. */
		return ptr_to_id(buf, end, ptr, spec);
834 835 836 837 838 839 840 841 842 843
	case 1: {
		const struct cred *cred;

		/*
		 * kptr_restrict==1 cannot be used in IRQ context
		 * because its test for CAP_SYSLOG would be meaningless.
		 */
		if (in_irq() || in_serving_softirq() || in_nmi()) {
			if (spec.field_width == -1)
				spec.field_width = 2 * sizeof(ptr);
844
			return error_string(buf, end, "pK-error", spec);
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
		}

		/*
		 * Only print the real pointer value if the current
		 * process has CAP_SYSLOG and is running with the
		 * same credentials it started with. This is because
		 * access to files is checked at open() time, but %pK
		 * checks permission at read() time. We don't want to
		 * leak pointer values if a binary opens a file using
		 * %pK and then elevates privileges before reading it.
		 */
		cred = current_cred();
		if (!has_capability_noaudit(current, CAP_SYSLOG) ||
		    !uid_eq(cred->euid, cred->uid) ||
		    !gid_eq(cred->egid, cred->gid))
			ptr = NULL;
		break;
	}
	case 2:
	default:
		/* Always print 0's for %pK */
		ptr = NULL;
		break;
	}

	return pointer_string(buf, end, ptr, spec);
}

A
Al Viro 已提交
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
static noinline_for_stack
char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
		  const char *fmt)
{
	const char *array[4], *s;
	const struct dentry *p;
	int depth;
	int i, n;

	switch (fmt[1]) {
		case '2': case '3': case '4':
			depth = fmt[1] - '0';
			break;
		default:
			depth = 1;
	}

	rcu_read_lock();
	for (i = 0; i < depth; i++, d = p) {
892 893 894 895 896
		if (check_pointer(&buf, end, d, spec)) {
			rcu_read_unlock();
			return buf;
		}

897 898
		p = READ_ONCE(d->d_parent);
		array[i] = READ_ONCE(d->d_name.name);
A
Al Viro 已提交
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
		if (p == d) {
			if (i)
				array[i] = "";
			i++;
			break;
		}
	}
	s = array[--i];
	for (n = 0; n != spec.precision; n++, buf++) {
		char c = *s++;
		if (!c) {
			if (!i)
				break;
			c = '/';
			s = array[--i];
		}
		if (buf < end)
			*buf = c;
	}
	rcu_read_unlock();
919
	return widen_string(buf, n, end, spec);
A
Al Viro 已提交
920 921
}

922 923 924 925 926 927 928 929 930
static noinline_for_stack
char *file_dentry_name(char *buf, char *end, const struct file *f,
			struct printf_spec spec, const char *fmt)
{
	if (check_pointer(&buf, end, f, spec))
		return buf;

	return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
}
931 932 933 934 935
#ifdef CONFIG_BLOCK
static noinline_for_stack
char *bdev_name(char *buf, char *end, struct block_device *bdev,
		struct printf_spec spec, const char *fmt)
{
936 937 938 939 940 941
	struct gendisk *hd;

	if (check_pointer(&buf, end, bdev, spec))
		return buf;

	hd = bdev->bd_disk;
942
	buf = string(buf, end, hd->disk_name, spec);
943
	if (bdev->bd_partno) {
944 945 946 947 948
		if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
			if (buf < end)
				*buf = 'p';
			buf++;
		}
949
		buf = number(buf, end, bdev->bd_partno, spec);
950 951 952 953 954
	}
	return buf;
}
#endif

J
Joe Perches 已提交
955 956
static noinline_for_stack
char *symbol_string(char *buf, char *end, void *ptr,
957
		    struct printf_spec spec, const char *fmt)
958
{
959
	unsigned long value;
960 961
#ifdef CONFIG_KALLSYMS
	char sym[KSYM_SYMBOL_LEN];
962 963 964 965 966 967 968 969
#endif

	if (fmt[1] == 'R')
		ptr = __builtin_extract_return_addr(ptr);
	value = (unsigned long)ptr;

#ifdef CONFIG_KALLSYMS
	if (*fmt == 'B')
970
		sprint_backtrace(sym, value);
971
	else if (*fmt != 's')
972 973
		sprint_symbol(sym, value);
	else
974
		sprint_symbol_no_offset(sym, value);
975

976
	return string_nocheck(buf, end, sym, spec);
977
#else
978
	return special_hex_number(buf, end, value, sizeof(void *));
979 980 981
#endif
}

982 983 984 985 986
static const struct printf_spec default_str_spec = {
	.field_width = -1,
	.precision = -1,
};

987 988 989 990 991 992
static const struct printf_spec default_flag_spec = {
	.base = 16,
	.precision = -1,
	.flags = SPECIAL | SMALL,
};

993 994 995 996 997
static const struct printf_spec default_dec_spec = {
	.base = 10,
	.precision = -1,
};

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
static const struct printf_spec default_dec02_spec = {
	.base = 10,
	.field_width = 2,
	.precision = -1,
	.flags = ZEROPAD,
};

static const struct printf_spec default_dec04_spec = {
	.base = 10,
	.field_width = 4,
	.precision = -1,
	.flags = ZEROPAD,
};

J
Joe Perches 已提交
1012 1013 1014
static noinline_for_stack
char *resource_string(char *buf, char *end, struct resource *res,
		      struct printf_spec spec, const char *fmt)
1015 1016
{
#ifndef IO_RSRC_PRINTK_SIZE
1017
#define IO_RSRC_PRINTK_SIZE	6
1018 1019 1020
#endif

#ifndef MEM_RSRC_PRINTK_SIZE
1021
#define MEM_RSRC_PRINTK_SIZE	10
1022
#endif
1023
	static const struct printf_spec io_spec = {
1024
		.base = 16,
1025
		.field_width = IO_RSRC_PRINTK_SIZE,
1026 1027 1028
		.precision = -1,
		.flags = SPECIAL | SMALL | ZEROPAD,
	};
1029 1030 1031 1032 1033 1034
	static const struct printf_spec mem_spec = {
		.base = 16,
		.field_width = MEM_RSRC_PRINTK_SIZE,
		.precision = -1,
		.flags = SPECIAL | SMALL | ZEROPAD,
	};
B
Bjorn Helgaas 已提交
1035 1036 1037 1038 1039 1040
	static const struct printf_spec bus_spec = {
		.base = 16,
		.field_width = 2,
		.precision = -1,
		.flags = SMALL | ZEROPAD,
	};
1041
	static const struct printf_spec str_spec = {
1042 1043 1044 1045
		.field_width = -1,
		.precision = 10,
		.flags = LEFT,
	};
1046 1047 1048 1049 1050

	/* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
	 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
#define RSRC_BUF_SIZE		((2 * sizeof(resource_size_t)) + 4)
#define FLAG_BUF_SIZE		(2 * sizeof(res->flags))
B
Bjorn Helgaas 已提交
1051
#define DECODED_BUF_SIZE	sizeof("[mem - 64bit pref window disabled]")
1052 1053 1054 1055
#define RAW_BUF_SIZE		sizeof("[mem - flags 0x]")
	char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
		     2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];

1056
	char *p = sym, *pend = sym + sizeof(sym);
1057
	int decode = (fmt[0] == 'R') ? 1 : 0;
1058
	const struct printf_spec *specp;
1059

1060 1061 1062
	if (check_pointer(&buf, end, res, spec))
		return buf;

1063
	*p++ = '[';
1064
	if (res->flags & IORESOURCE_IO) {
1065
		p = string_nocheck(p, pend, "io  ", str_spec);
1066 1067
		specp = &io_spec;
	} else if (res->flags & IORESOURCE_MEM) {
1068
		p = string_nocheck(p, pend, "mem ", str_spec);
1069 1070
		specp = &mem_spec;
	} else if (res->flags & IORESOURCE_IRQ) {
1071
		p = string_nocheck(p, pend, "irq ", str_spec);
1072
		specp = &default_dec_spec;
1073
	} else if (res->flags & IORESOURCE_DMA) {
1074
		p = string_nocheck(p, pend, "dma ", str_spec);
1075
		specp = &default_dec_spec;
B
Bjorn Helgaas 已提交
1076
	} else if (res->flags & IORESOURCE_BUS) {
1077
		p = string_nocheck(p, pend, "bus ", str_spec);
B
Bjorn Helgaas 已提交
1078
		specp = &bus_spec;
1079
	} else {
1080
		p = string_nocheck(p, pend, "??? ", str_spec);
1081
		specp = &mem_spec;
1082
		decode = 0;
1083
	}
1084
	if (decode && res->flags & IORESOURCE_UNSET) {
1085
		p = string_nocheck(p, pend, "size ", str_spec);
1086 1087 1088 1089 1090 1091 1092
		p = number(p, pend, resource_size(res), *specp);
	} else {
		p = number(p, pend, res->start, *specp);
		if (res->start != res->end) {
			*p++ = '-';
			p = number(p, pend, res->end, *specp);
		}
1093
	}
1094
	if (decode) {
1095
		if (res->flags & IORESOURCE_MEM_64)
1096
			p = string_nocheck(p, pend, " 64bit", str_spec);
1097
		if (res->flags & IORESOURCE_PREFETCH)
1098
			p = string_nocheck(p, pend, " pref", str_spec);
B
Bjorn Helgaas 已提交
1099
		if (res->flags & IORESOURCE_WINDOW)
1100
			p = string_nocheck(p, pend, " window", str_spec);
1101
		if (res->flags & IORESOURCE_DISABLED)
1102
			p = string_nocheck(p, pend, " disabled", str_spec);
1103
	} else {
1104
		p = string_nocheck(p, pend, " flags ", str_spec);
1105
		p = number(p, pend, res->flags, default_flag_spec);
1106
	}
1107
	*p++ = ']';
1108
	*p = '\0';
1109

1110
	return string_nocheck(buf, end, sym, spec);
1111 1112
}

1113 1114 1115 1116
static noinline_for_stack
char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
		 const char *fmt)
{
1117
	int i, len = 1;		/* if we pass '%ph[CDN]', field width remains
1118 1119 1120 1121 1122 1123 1124
				   negative value, fallback to the default */
	char separator;

	if (spec.field_width == 0)
		/* nothing to print */
		return buf;

1125 1126
	if (check_pointer(&buf, end, addr, spec))
		return buf;
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145

	switch (fmt[1]) {
	case 'C':
		separator = ':';
		break;
	case 'D':
		separator = '-';
		break;
	case 'N':
		separator = 0;
		break;
	default:
		separator = ' ';
		break;
	}

	if (spec.field_width > 0)
		len = min_t(int, spec.field_width, 64);

1146 1147 1148 1149 1150 1151 1152
	for (i = 0; i < len; ++i) {
		if (buf < end)
			*buf = hex_asc_hi(addr[i]);
		++buf;
		if (buf < end)
			*buf = hex_asc_lo(addr[i]);
		++buf;
1153

1154 1155 1156 1157 1158
		if (separator && i != len - 1) {
			if (buf < end)
				*buf = separator;
			++buf;
		}
1159 1160 1161 1162 1163
	}

	return buf;
}

1164 1165 1166 1167 1168 1169 1170 1171 1172
static noinline_for_stack
char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
		    struct printf_spec spec, const char *fmt)
{
	const int CHUNKSZ = 32;
	int nr_bits = max_t(int, spec.field_width, 0);
	int i, chunksz;
	bool first = true;

1173 1174 1175
	if (check_pointer(&buf, end, bitmap, spec))
		return buf;

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
	/* reused to print numbers */
	spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };

	chunksz = nr_bits & (CHUNKSZ - 1);
	if (chunksz == 0)
		chunksz = CHUNKSZ;

	i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
	for (; i >= 0; i -= CHUNKSZ) {
		u32 chunkmask, val;
		int word, bit;

		chunkmask = ((1ULL << chunksz) - 1);
		word = i / BITS_PER_LONG;
		bit = i % BITS_PER_LONG;
		val = (bitmap[word] >> bit) & chunkmask;

		if (!first) {
			if (buf < end)
				*buf = ',';
			buf++;
		}
		first = false;

		spec.field_width = DIV_ROUND_UP(chunksz, 4);
		buf = number(buf, end, val, spec);

		chunksz = CHUNKSZ;
	}
	return buf;
}

static noinline_for_stack
char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
			 struct printf_spec spec, const char *fmt)
{
	int nr_bits = max_t(int, spec.field_width, 0);
	/* current bit is 'cur', most recently seen range is [rbot, rtop] */
	int cur, rbot, rtop;
	bool first = true;

1217 1218 1219
	if (check_pointer(&buf, end, bitmap, spec))
		return buf;

1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
	rbot = cur = find_first_bit(bitmap, nr_bits);
	while (cur < nr_bits) {
		rtop = cur;
		cur = find_next_bit(bitmap, nr_bits, cur + 1);
		if (cur < nr_bits && cur <= rtop + 1)
			continue;

		if (!first) {
			if (buf < end)
				*buf = ',';
			buf++;
		}
		first = false;

1234
		buf = number(buf, end, rbot, default_dec_spec);
1235 1236 1237 1238 1239
		if (rbot < rtop) {
			if (buf < end)
				*buf = '-';
			buf++;

1240
			buf = number(buf, end, rtop, default_dec_spec);
1241 1242 1243 1244 1245 1246 1247
		}

		rbot = cur;
	}
	return buf;
}

J
Joe Perches 已提交
1248 1249 1250
static noinline_for_stack
char *mac_address_string(char *buf, char *end, u8 *addr,
			 struct printf_spec spec, const char *fmt)
1251
{
1252
	char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
1253 1254
	char *p = mac_addr;
	int i;
1255
	char separator;
1256
	bool reversed = false;
1257

1258 1259 1260
	if (check_pointer(&buf, end, addr, spec))
		return buf;

1261 1262
	switch (fmt[1]) {
	case 'F':
1263
		separator = '-';
1264 1265 1266 1267
		break;

	case 'R':
		reversed = true;
1268
		fallthrough;
1269 1270

	default:
1271
		separator = ':';
1272
		break;
1273
	}
1274 1275

	for (i = 0; i < 6; i++) {
1276 1277 1278 1279 1280
		if (reversed)
			p = hex_byte_pack(p, addr[5 - i]);
		else
			p = hex_byte_pack(p, addr[i]);

1281
		if (fmt[0] == 'M' && i != 5)
1282
			*p++ = separator;
1283 1284 1285
	}
	*p = '\0';

1286
	return string_nocheck(buf, end, mac_addr, spec);
1287 1288
}

J
Joe Perches 已提交
1289 1290
static noinline_for_stack
char *ip4_string(char *p, const u8 *addr, const char *fmt)
1291 1292
{
	int i;
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
	bool leading_zeros = (fmt[0] == 'i');
	int index;
	int step;

	switch (fmt[2]) {
	case 'h':
#ifdef __BIG_ENDIAN
		index = 0;
		step = 1;
#else
		index = 3;
		step = -1;
#endif
		break;
	case 'l':
		index = 3;
		step = -1;
		break;
	case 'n':
	case 'b':
	default:
		index = 0;
		step = 1;
		break;
	}
1318
	for (i = 0; i < 4; i++) {
1319
		char temp[4] __aligned(2);	/* hold each IP quad in reverse order */
1320
		int digits = put_dec_trunc8(temp, addr[index]) - temp;
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
		if (leading_zeros) {
			if (digits < 3)
				*p++ = '0';
			if (digits < 2)
				*p++ = '0';
		}
		/* reverse the digits in the quad */
		while (digits--)
			*p++ = temp[digits];
		if (i < 3)
			*p++ = '.';
1332
		index += step;
1333 1334
	}
	*p = '\0';
1335

1336 1337 1338
	return p;
}

J
Joe Perches 已提交
1339 1340
static noinline_for_stack
char *ip6_compressed_string(char *p, const char *addr)
1341
{
1342
	int i, j, range;
1343 1344 1345 1346
	unsigned char zerolength[8];
	int longest = 1;
	int colonpos = -1;
	u16 word;
1347
	u8 hi, lo;
1348
	bool needcolon = false;
1349 1350 1351 1352 1353 1354
	bool useIPv4;
	struct in6_addr in6;

	memcpy(&in6, addr, sizeof(struct in6_addr));

	useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365

	memset(zerolength, 0, sizeof(zerolength));

	if (useIPv4)
		range = 6;
	else
		range = 8;

	/* find position of longest 0 run */
	for (i = 0; i < range; i++) {
		for (j = i; j < range; j++) {
1366
			if (in6.s6_addr16[j] != 0)
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
				break;
			zerolength[i]++;
		}
	}
	for (i = 0; i < range; i++) {
		if (zerolength[i] > longest) {
			longest = zerolength[i];
			colonpos = i;
		}
	}
1377 1378
	if (longest == 1)		/* don't compress a single 0 */
		colonpos = -1;
1379

1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
	/* emit address */
	for (i = 0; i < range; i++) {
		if (i == colonpos) {
			if (needcolon || i == 0)
				*p++ = ':';
			*p++ = ':';
			needcolon = false;
			i += longest - 1;
			continue;
		}
		if (needcolon) {
			*p++ = ':';
			needcolon = false;
		}
		/* hex u16 without leading 0s */
1395
		word = ntohs(in6.s6_addr16[i]);
1396 1397 1398 1399
		hi = word >> 8;
		lo = word & 0xff;
		if (hi) {
			if (hi > 0x0f)
1400
				p = hex_byte_pack(p, hi);
1401 1402
			else
				*p++ = hex_asc_lo(hi);
1403
			p = hex_byte_pack(p, lo);
1404
		}
1405
		else if (lo > 0x0f)
1406
			p = hex_byte_pack(p, lo);
1407 1408 1409 1410 1411 1412 1413 1414
		else
			*p++ = hex_asc_lo(lo);
		needcolon = true;
	}

	if (useIPv4) {
		if (needcolon)
			*p++ = ':';
1415
		p = ip4_string(p, &in6.s6_addr[12], "I4");
1416 1417
	}
	*p = '\0';
1418

1419 1420 1421
	return p;
}

J
Joe Perches 已提交
1422 1423
static noinline_for_stack
char *ip6_string(char *p, const char *addr, const char *fmt)
1424 1425
{
	int i;
1426

1427
	for (i = 0; i < 8; i++) {
1428 1429
		p = hex_byte_pack(p, *addr++);
		p = hex_byte_pack(p, *addr++);
1430
		if (fmt[0] == 'I' && i != 7)
1431 1432 1433
			*p++ = ':';
	}
	*p = '\0';
1434

1435 1436 1437
	return p;
}

J
Joe Perches 已提交
1438 1439 1440
static noinline_for_stack
char *ip6_addr_string(char *buf, char *end, const u8 *addr,
		      struct printf_spec spec, const char *fmt)
1441 1442 1443 1444
{
	char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];

	if (fmt[0] == 'I' && fmt[2] == 'c')
1445
		ip6_compressed_string(ip6_addr, addr);
1446
	else
1447
		ip6_string(ip6_addr, addr, fmt);
1448

1449
	return string_nocheck(buf, end, ip6_addr, spec);
1450 1451
}

J
Joe Perches 已提交
1452 1453 1454
static noinline_for_stack
char *ip4_addr_string(char *buf, char *end, const u8 *addr,
		      struct printf_spec spec, const char *fmt)
1455
{
1456
	char ip4_addr[sizeof("255.255.255.255")];
1457

1458
	ip4_string(ip4_addr, addr, fmt);
1459

1460
	return string_nocheck(buf, end, ip4_addr, spec);
1461 1462
}

1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
static noinline_for_stack
char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
			 struct printf_spec spec, const char *fmt)
{
	bool have_p = false, have_s = false, have_f = false, have_c = false;
	char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
		      sizeof(":12345") + sizeof("/123456789") +
		      sizeof("%1234567890")];
	char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
	const u8 *addr = (const u8 *) &sa->sin6_addr;
	char fmt6[2] = { fmt[0], '6' };
	u8 off = 0;

	fmt++;
	while (isalpha(*++fmt)) {
		switch (*fmt) {
		case 'p':
			have_p = true;
			break;
		case 'f':
			have_f = true;
			break;
		case 's':
			have_s = true;
			break;
		case 'c':
			have_c = true;
			break;
		}
	}

	if (have_p || have_s || have_f) {
		*p = '[';
		off = 1;
	}

	if (fmt6[0] == 'I' && have_c)
		p = ip6_compressed_string(ip6_addr + off, addr);
	else
		p = ip6_string(ip6_addr + off, addr, fmt6);

	if (have_p || have_s || have_f)
		*p++ = ']';

	if (have_p) {
		*p++ = ':';
		p = number(p, pend, ntohs(sa->sin6_port), spec);
	}
	if (have_f) {
		*p++ = '/';
		p = number(p, pend, ntohl(sa->sin6_flowinfo &
					  IPV6_FLOWINFO_MASK), spec);
	}
	if (have_s) {
		*p++ = '%';
		p = number(p, pend, sa->sin6_scope_id, spec);
	}
	*p = '\0';

1522
	return string_nocheck(buf, end, ip6_addr, spec);
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
}

static noinline_for_stack
char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
			 struct printf_spec spec, const char *fmt)
{
	bool have_p = false;
	char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
	char *pend = ip4_addr + sizeof(ip4_addr);
	const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
	char fmt4[3] = { fmt[0], '4', 0 };

	fmt++;
	while (isalpha(*++fmt)) {
		switch (*fmt) {
		case 'p':
			have_p = true;
			break;
		case 'h':
		case 'l':
		case 'n':
		case 'b':
			fmt4[2] = *fmt;
			break;
		}
	}

	p = ip4_string(ip4_addr, addr, fmt4);
	if (have_p) {
		*p++ = ':';
		p = number(p, pend, ntohs(sa->sin_port), spec);
	}
	*p = '\0';

1557
	return string_nocheck(buf, end, ip4_addr, spec);
1558 1559
}

1560 1561 1562 1563
static noinline_for_stack
char *ip_addr_string(char *buf, char *end, const void *ptr,
		     struct printf_spec spec, const char *fmt)
{
1564 1565
	char *err_fmt_msg;

1566 1567 1568
	if (check_pointer(&buf, end, ptr, spec))
		return buf;

1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
	switch (fmt[1]) {
	case '6':
		return ip6_addr_string(buf, end, ptr, spec, fmt);
	case '4':
		return ip4_addr_string(buf, end, ptr, spec, fmt);
	case 'S': {
		const union {
			struct sockaddr		raw;
			struct sockaddr_in	v4;
			struct sockaddr_in6	v6;
		} *sa = ptr;

		switch (sa->raw.sa_family) {
		case AF_INET:
			return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
		case AF_INET6:
			return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
		default:
1587
			return error_string(buf, end, "(einval)", spec);
1588 1589 1590
		}}
	}

1591
	err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
1592
	return error_string(buf, end, err_fmt_msg, spec);
1593 1594
}

1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
static noinline_for_stack
char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
		     const char *fmt)
{
	bool found = true;
	int count = 1;
	unsigned int flags = 0;
	int len;

	if (spec.field_width == 0)
		return buf;				/* nothing to print */

1607 1608
	if (check_pointer(&buf, end, addr, spec))
		return buf;
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643

	do {
		switch (fmt[count++]) {
		case 'a':
			flags |= ESCAPE_ANY;
			break;
		case 'c':
			flags |= ESCAPE_SPECIAL;
			break;
		case 'h':
			flags |= ESCAPE_HEX;
			break;
		case 'n':
			flags |= ESCAPE_NULL;
			break;
		case 'o':
			flags |= ESCAPE_OCTAL;
			break;
		case 'p':
			flags |= ESCAPE_NP;
			break;
		case 's':
			flags |= ESCAPE_SPACE;
			break;
		default:
			found = false;
			break;
		}
	} while (found);

	if (!flags)
		flags = ESCAPE_ANY_NP;

	len = spec.field_width < 0 ? 1 : spec.field_width;

1644 1645 1646 1647 1648 1649
	/*
	 * string_escape_mem() writes as many characters as it can to
	 * the given buffer, and returns the total size of the output
	 * had the buffer been big enough.
	 */
	buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
1650 1651 1652 1653

	return buf;
}

1654 1655
static char *va_format(char *buf, char *end, struct va_format *va_fmt,
		       struct printf_spec spec, const char *fmt)
1656 1657 1658
{
	va_list va;

1659 1660 1661
	if (check_pointer(&buf, end, va_fmt, spec))
		return buf;

1662 1663 1664 1665 1666 1667 1668
	va_copy(va, *va_fmt->va);
	buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
	va_end(va);

	return buf;
}

J
Joe Perches 已提交
1669 1670 1671
static noinline_for_stack
char *uuid_string(char *buf, char *end, const u8 *addr,
		  struct printf_spec spec, const char *fmt)
1672
{
1673
	char uuid[UUID_STRING_LEN + 1];
1674 1675
	char *p = uuid;
	int i;
C
Christoph Hellwig 已提交
1676
	const u8 *index = uuid_index;
1677 1678
	bool uc = false;

1679 1680 1681
	if (check_pointer(&buf, end, addr, spec))
		return buf;

1682 1683
	switch (*(++fmt)) {
	case 'L':
1684
		uc = true;
1685
		fallthrough;
1686
	case 'l':
C
Christoph Hellwig 已提交
1687
		index = guid_index;
1688 1689 1690 1691 1692 1693 1694
		break;
	case 'B':
		uc = true;
		break;
	}

	for (i = 0; i < 16; i++) {
1695 1696 1697 1698
		if (uc)
			p = hex_byte_pack_upper(p, addr[index[i]]);
		else
			p = hex_byte_pack(p, addr[index[i]]);
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
		switch (i) {
		case 3:
		case 5:
		case 7:
		case 9:
			*p++ = '-';
			break;
		}
	}

	*p = 0;

1711
	return string_nocheck(buf, end, uuid, spec);
1712 1713
}

1714
static noinline_for_stack
1715 1716
char *netdev_bits(char *buf, char *end, const void *addr,
		  struct printf_spec spec,  const char *fmt)
1717
{
1718 1719 1720
	unsigned long long num;
	int size;

1721 1722 1723
	if (check_pointer(&buf, end, addr, spec))
		return buf;

1724 1725 1726 1727 1728 1729
	switch (fmt[1]) {
	case 'F':
		num = *(const netdev_features_t *)addr;
		size = sizeof(netdev_features_t);
		break;
	default:
1730
		return error_string(buf, end, "(%pN?)", spec);
1731
	}
1732

1733
	return special_hex_number(buf, end, num, size);
1734 1735
}

1736
static noinline_for_stack
1737 1738
char *address_val(char *buf, char *end, const void *addr,
		  struct printf_spec spec, const char *fmt)
1739 1740
{
	unsigned long long num;
1741
	int size;
1742

1743 1744 1745
	if (check_pointer(&buf, end, addr, spec))
		return buf;

1746 1747 1748
	switch (fmt[1]) {
	case 'd':
		num = *(const dma_addr_t *)addr;
1749
		size = sizeof(dma_addr_t);
1750 1751 1752 1753
		break;
	case 'p':
	default:
		num = *(const phys_addr_t *)addr;
1754
		size = sizeof(phys_addr_t);
1755 1756 1757
		break;
	}

1758
	return special_hex_number(buf, end, num, size);
1759 1760
}

1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
static noinline_for_stack
char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
{
	int year = tm->tm_year + (r ? 0 : 1900);
	int mon = tm->tm_mon + (r ? 0 : 1);

	buf = number(buf, end, year, default_dec04_spec);
	if (buf < end)
		*buf = '-';
	buf++;

	buf = number(buf, end, mon, default_dec02_spec);
	if (buf < end)
		*buf = '-';
	buf++;

	return number(buf, end, tm->tm_mday, default_dec02_spec);
}

static noinline_for_stack
char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
{
	buf = number(buf, end, tm->tm_hour, default_dec02_spec);
	if (buf < end)
		*buf = ':';
	buf++;

	buf = number(buf, end, tm->tm_min, default_dec02_spec);
	if (buf < end)
		*buf = ':';
	buf++;

	return number(buf, end, tm->tm_sec, default_dec02_spec);
}

static noinline_for_stack
1797 1798
char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
	      struct printf_spec spec, const char *fmt)
1799 1800 1801 1802 1803
{
	bool have_t = true, have_d = true;
	bool raw = false;
	int count = 2;

1804 1805 1806
	if (check_pointer(&buf, end, tm, spec))
		return buf;

1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
	switch (fmt[count]) {
	case 'd':
		have_t = false;
		count++;
		break;
	case 't':
		have_d = false;
		count++;
		break;
	}

	raw = fmt[count] == 'r';

	if (have_d)
		buf = date_str(buf, end, tm, raw);
	if (have_d && have_t) {
		/* Respect ISO 8601 */
		if (buf < end)
			*buf = 'T';
		buf++;
	}
	if (have_t)
		buf = time_str(buf, end, tm, raw);

	return buf;
}

1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856
static noinline_for_stack
char *time64_str(char *buf, char *end, const time64_t time,
		 struct printf_spec spec, const char *fmt)
{
	struct rtc_time rtc_time;
	struct tm tm;

	time64_to_tm(time, 0, &tm);

	rtc_time.tm_sec = tm.tm_sec;
	rtc_time.tm_min = tm.tm_min;
	rtc_time.tm_hour = tm.tm_hour;
	rtc_time.tm_mday = tm.tm_mday;
	rtc_time.tm_mon = tm.tm_mon;
	rtc_time.tm_year = tm.tm_year;
	rtc_time.tm_wday = tm.tm_wday;
	rtc_time.tm_yday = tm.tm_yday;

	rtc_time.tm_isdst = 0;

	return rtc_str(buf, end, &rtc_time, spec, fmt);
}

1857 1858 1859 1860 1861 1862
static noinline_for_stack
char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
		    const char *fmt)
{
	switch (fmt[1]) {
	case 'R':
1863
		return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
1864 1865
	case 'T':
		return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
1866
	default:
1867
		return error_string(buf, end, "(%pt?)", spec);
1868 1869 1870
	}
}

1871 1872 1873 1874
static noinline_for_stack
char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
	    const char *fmt)
{
1875
	if (!IS_ENABLED(CONFIG_HAVE_CLK))
1876
		return error_string(buf, end, "(%pC?)", spec);
1877

1878 1879
	if (check_pointer(&buf, end, clk, spec))
		return buf;
1880 1881 1882 1883 1884 1885 1886

	switch (fmt[1]) {
	case 'n':
	default:
#ifdef CONFIG_COMMON_CLK
		return string(buf, end, __clk_get_name(clk), spec);
#else
1887
		return ptr_to_id(buf, end, clk, spec);
1888 1889 1890 1891
#endif
	}
}

1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902
static
char *format_flags(char *buf, char *end, unsigned long flags,
					const struct trace_print_flags *names)
{
	unsigned long mask;

	for ( ; flags && names->name; names++) {
		mask = names->mask;
		if ((flags & mask) != mask)
			continue;

1903
		buf = string(buf, end, names->name, default_str_spec);
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913

		flags &= ~mask;
		if (flags) {
			if (buf < end)
				*buf = '|';
			buf++;
		}
	}

	if (flags)
1914
		buf = number(buf, end, flags, default_flag_spec);
1915 1916 1917 1918 1919

	return buf;
}

static noinline_for_stack
1920 1921
char *flags_string(char *buf, char *end, void *flags_ptr,
		   struct printf_spec spec, const char *fmt)
1922 1923 1924 1925
{
	unsigned long flags;
	const struct trace_print_flags *names;

1926 1927 1928
	if (check_pointer(&buf, end, flags_ptr, spec))
		return buf;

1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
	switch (fmt[1]) {
	case 'p':
		flags = *(unsigned long *)flags_ptr;
		/* Remove zone id */
		flags &= (1UL << NR_PAGEFLAGS) - 1;
		names = pageflag_names;
		break;
	case 'v':
		flags = *(unsigned long *)flags_ptr;
		names = vmaflag_names;
		break;
	case 'g':
1941
		flags = (__force unsigned long)(*(gfp_t *)flags_ptr);
1942 1943 1944
		names = gfpflag_names;
		break;
	default:
1945
		return error_string(buf, end, "(%pG?)", spec);
1946 1947 1948 1949 1950
	}

	return format_flags(buf, end, flags, names);
}

1951
static noinline_for_stack
1952 1953
char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
			      char *end)
1954 1955 1956
{
	int depth;

1957 1958 1959 1960
	/* Loop starting from the root node to the current node. */
	for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
		struct fwnode_handle *__fwnode =
			fwnode_get_nth_parent(fwnode, depth);
1961

1962
		buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
1963
			     default_str_spec);
1964
		buf = string(buf, end, fwnode_get_name(__fwnode),
1965
			     default_str_spec);
1966 1967

		fwnode_handle_put(__fwnode);
1968
	}
1969

1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986
	return buf;
}

static noinline_for_stack
char *device_node_string(char *buf, char *end, struct device_node *dn,
			 struct printf_spec spec, const char *fmt)
{
	char tbuf[sizeof("xxxx") + 1];
	const char *p;
	int ret;
	char *buf_start = buf;
	struct property *prop;
	bool has_mult, pass;

	struct printf_spec str_spec = spec;
	str_spec.field_width = -1;

1987 1988 1989
	if (fmt[0] != 'F')
		return error_string(buf, end, "(%pO?)", spec);

1990
	if (!IS_ENABLED(CONFIG_OF))
1991
		return error_string(buf, end, "(%pOF?)", spec);
1992

1993 1994
	if (check_pointer(&buf, end, dn, spec))
		return buf;
1995 1996 1997 1998 1999 2000 2001

	/* simple case without anything any more format specifiers */
	fmt++;
	if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
		fmt = "f";

	for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
2002
		int precision;
2003 2004 2005 2006 2007 2008 2009 2010
		if (pass) {
			if (buf < end)
				*buf = ':';
			buf++;
		}

		switch (*fmt) {
		case 'f':	/* full_name */
2011 2012
			buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
						      end);
2013 2014
			break;
		case 'n':	/* name */
2015
			p = fwnode_get_name(of_fwnode_handle(dn));
2016 2017 2018 2019
			precision = str_spec.precision;
			str_spec.precision = strchrnul(p, '@') - p;
			buf = string(buf, end, p, str_spec);
			str_spec.precision = precision;
2020 2021
			break;
		case 'p':	/* phandle */
2022
			buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec);
2023 2024
			break;
		case 'P':	/* path-spec */
2025
			p = fwnode_get_name(of_fwnode_handle(dn));
2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
			if (!p[1])
				p = "/";
			buf = string(buf, end, p, str_spec);
			break;
		case 'F':	/* flags */
			tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
			tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
			tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
			tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
			tbuf[4] = 0;
2036
			buf = string_nocheck(buf, end, tbuf, str_spec);
2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
			break;
		case 'c':	/* major compatible string */
			ret = of_property_read_string(dn, "compatible", &p);
			if (!ret)
				buf = string(buf, end, p, str_spec);
			break;
		case 'C':	/* full compatible string */
			has_mult = false;
			of_property_for_each_string(dn, "compatible", prop, p) {
				if (has_mult)
2047 2048
					buf = string_nocheck(buf, end, ",", str_spec);
				buf = string_nocheck(buf, end, "\"", str_spec);
2049
				buf = string(buf, end, p, str_spec);
2050
				buf = string_nocheck(buf, end, "\"", str_spec);
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062

				has_mult = true;
			}
			break;
		default:
			break;
		}
	}

	return widen_string(buf, buf - buf_start, end, spec);
}

2063 2064 2065
static noinline_for_stack
char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
		    struct printf_spec spec, const char *fmt)
2066
{
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087
	struct printf_spec str_spec = spec;
	char *buf_start = buf;

	str_spec.field_width = -1;

	if (*fmt != 'w')
		return error_string(buf, end, "(%pf?)", spec);

	if (check_pointer(&buf, end, fwnode, spec))
		return buf;

	fmt++;

	switch (*fmt) {
	case 'P':	/* name */
		buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
		break;
	case 'f':	/* full_name */
	default:
		buf = fwnode_full_name_string(fwnode, buf, end);
		break;
2088 2089
	}

2090
	return widen_string(buf, buf - buf_start, end, spec);
2091 2092
}

2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118
/* Disable pointer hashing if requested */
bool no_hash_pointers __ro_after_init;
EXPORT_SYMBOL_GPL(no_hash_pointers);

static int __init no_hash_pointers_enable(char *str)
{
	no_hash_pointers = true;

	pr_warn("**********************************************************\n");
	pr_warn("**   NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE   **\n");
	pr_warn("**                                                      **\n");
	pr_warn("** This system shows unhashed kernel memory addresses   **\n");
	pr_warn("** via the console, logs, and other interfaces. This    **\n");
	pr_warn("** might reduce the security of your system.            **\n");
	pr_warn("**                                                      **\n");
	pr_warn("** If you see this message and you are not debugging    **\n");
	pr_warn("** the kernel, report this immediately to your system   **\n");
	pr_warn("** administrator!                                       **\n");
	pr_warn("**                                                      **\n");
	pr_warn("**   NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE   **\n");
	pr_warn("**********************************************************\n");

	return 0;
}
early_param("no_hash_pointers", no_hash_pointers_enable);

2119 2120 2121 2122 2123
/*
 * Show a '%p' thing.  A kernel extension is that the '%p' is followed
 * by an extra set of alphanumeric characters that are extended format
 * specifiers.
 *
2124 2125 2126
 * Please update scripts/checkpatch.pl when adding/removing conversion
 * characters.  (Search for "check for vsprintf extension").
 *
2127 2128
 * Right now we handle:
 *
2129 2130
 * - 'S' For symbolic direct pointers (or function descriptors) with offset
 * - 's' For symbolic direct pointers (or function descriptors) without offset
2131
 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
2132 2133
 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
 *	    %ps and %pS. Be careful when re-using these specifiers.
2134
 * - 'B' For backtraced symbolic direct pointers with offset
2135 2136
 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
2137 2138 2139 2140
 * - 'b[l]' For a bitmap, the number of bits is determined by the field
 *       width which must be explicitly specified either as part of the
 *       format string '%32b[l]' or through '%*b[l]', [l] selects
 *       range-list format instead of hex format
2141 2142
 * - 'M' For a 6-byte MAC address, it prints the address in the
 *       usual colon-separated hex notation
2143
 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
2144
 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
2145
 *       with a dash-separated hex notation
2146
 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
2147 2148 2149
 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
 *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
 *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
2150 2151 2152
 *       [S][pfs]
 *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
 *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2153 2154 2155
 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
 *       IPv6 omits the colons (01020304...0f)
 *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
2156 2157 2158 2159 2160
 *       [S][pfs]
 *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
 *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
 * - 'I[6S]c' for IPv6 addresses printed as specified by
2161
 *       https://tools.ietf.org/html/rfc5952
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172
 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
 *                of the following flags (see string_escape_mem() for the
 *                details):
 *                  a - ESCAPE_ANY
 *                  c - ESCAPE_SPECIAL
 *                  h - ESCAPE_HEX
 *                  n - ESCAPE_NULL
 *                  o - ESCAPE_OCTAL
 *                  p - ESCAPE_NP
 *                  s - ESCAPE_SPACE
 *                By default ESCAPE_ANY_NP is used.
2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
 *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 *       Options for %pU are:
 *         b big endian lower case hex (default)
 *         B big endian UPPER case hex
 *         l little endian lower case hex
 *         L little endian UPPER case hex
 *           big endian output byte order is:
 *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
 *           little endian output byte order is:
 *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
2184 2185 2186 2187 2188
 * - 'V' For a struct va_format which contains a format string * and va_list *,
 *       call vsnprintf(->format, *->va_list).
 *       Implements a "recursive vsnprintf".
 *       Do not use this feature without some mechanism to verify the
 *       correctness of the format string and va_list arguments.
2189
 * - 'K' For a kernel pointer that should be hidden from unprivileged users
2190
 * - 'NF' For a netdev_features_t
2191 2192 2193 2194 2195 2196 2197
 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
 *            a certain separator (' ' by default):
 *              C colon
 *              D dash
 *              N no separator
 *            The maximum supported length is 64 bytes of the input. Consider
 *            to use print_hex_dump() for the larger input.
2198 2199
 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
 *           (default assumed to be phys_addr_t, passed by reference)
2200 2201
 * - 'd[234]' For a dentry name (optionally 2-4 last components)
 * - 'D[234]' Same as 'd' but for a struct file
2202
 * - 'g' For block_device name (gendisk + partition number)
2203
 * - 't[RT][dt][r]' For time and date as represented by:
2204
 *      R    struct rtc_time
2205
 *      T    time64_t
2206 2207 2208 2209
 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
 *       (legacy clock framework) of the clock
 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
 *        (legacy clock framework) of the clock
2210 2211 2212 2213 2214
 * - 'G' For flags to be printed as a collection of symbolic strings that would
 *       construct the specific value. Supported flags given by option:
 *       p page flags (see struct page) given as pointer to unsigned long
 *       g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
 *       v vma flags (VM_*) given as pointer to unsigned long
2215 2216 2217 2218 2219 2220 2221 2222 2223
 * - 'OF[fnpPcCF]'  For a device tree object
 *                  Without any optional arguments prints the full_name
 *                  f device node full_name
 *                  n device node name
 *                  p device node phandle
 *                  P device node path spec (name + @unit)
 *                  F device node flags
 *                  c major compatible string
 *                  C full compatible string
2224 2225 2226 2227
 * - 'fw[fP]'	For a firmware node (struct fwnode_handle) pointer
 *		Without an option prints the full name of the node
 *		f full name
 *		P node name, including a possible unit address
2228
 * - 'x' For printing the address. Equivalent to "%lx".
2229 2230 2231 2232
 * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of
 *           bpf_trace_printk() where [ku] prefix specifies either kernel (k)
 *           or user (u) memory to probe, and:
 *              s a string, equivalent to "%s" on direct vsnprintf() use
2233
 *
2234 2235
 * ** When making changes please also update:
 *	Documentation/core-api/printk-formats.rst
2236
 *
2237 2238
 * Note: The default behaviour (unadorned %p) is to hash the address,
 * rendering it useful as a unique identifier.
2239
 */
J
Joe Perches 已提交
2240 2241 2242
static noinline_for_stack
char *pointer(const char *fmt, char *buf, char *end, void *ptr,
	      struct printf_spec spec)
2243
{
2244 2245
	switch (*fmt) {
	case 'S':
2246
	case 's':
2247
		ptr = dereference_symbol_descriptor(ptr);
2248
		fallthrough;
2249
	case 'B':
2250
		return symbol_string(buf, end, ptr, spec, fmt);
2251
	case 'R':
2252
	case 'r':
2253
		return resource_string(buf, end, ptr, spec, fmt);
2254 2255
	case 'h':
		return hex_string(buf, end, ptr, spec, fmt);
2256 2257 2258 2259 2260 2261 2262
	case 'b':
		switch (fmt[1]) {
		case 'l':
			return bitmap_list_string(buf, end, ptr, spec, fmt);
		default:
			return bitmap_string(buf, end, ptr, spec, fmt);
		}
2263 2264
	case 'M':			/* Colon separated: 00:01:02:03:04:05 */
	case 'm':			/* Contiguous: 000102030405 */
2265 2266
					/* [mM]F (FDDI) */
					/* [mM]R (Reverse order; Bluetooth) */
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
		return mac_address_string(buf, end, ptr, spec, fmt);
	case 'I':			/* Formatted IP supported
					 * 4:	1.2.3.4
					 * 6:	0001:0203:...:0708
					 * 6c:	1::708 or 1::1.2.3.4
					 */
	case 'i':			/* Contiguous:
					 * 4:	001.002.003.004
					 * 6:   000102...0f
					 */
2277
		return ip_addr_string(buf, end, ptr, spec, fmt);
2278 2279
	case 'E':
		return escaped_string(buf, end, ptr, spec, fmt);
2280 2281
	case 'U':
		return uuid_string(buf, end, ptr, spec, fmt);
2282
	case 'V':
2283
		return va_format(buf, end, ptr, spec, fmt);
2284
	case 'K':
2285
		return restricted_pointer(buf, end, ptr, spec);
2286
	case 'N':
2287
		return netdev_bits(buf, end, ptr, spec, fmt);
2288
	case 'a':
2289
		return address_val(buf, end, ptr, spec, fmt);
A
Al Viro 已提交
2290 2291
	case 'd':
		return dentry_name(buf, end, ptr, spec, fmt);
2292 2293
	case 't':
		return time_and_date(buf, end, ptr, spec, fmt);
2294 2295
	case 'C':
		return clock(buf, end, ptr, spec, fmt);
A
Al Viro 已提交
2296
	case 'D':
2297
		return file_dentry_name(buf, end, ptr, spec, fmt);
2298 2299 2300 2301 2302
#ifdef CONFIG_BLOCK
	case 'g':
		return bdev_name(buf, end, ptr, spec, fmt);
#endif

2303
	case 'G':
2304
		return flags_string(buf, end, ptr, spec, fmt);
2305
	case 'O':
2306
		return device_node_string(buf, end, ptr, spec, fmt + 1);
2307 2308
	case 'f':
		return fwnode_string(buf, end, ptr, spec, fmt + 1);
2309 2310
	case 'x':
		return pointer_string(buf, end, ptr, spec);
2311 2312 2313 2314 2315
	case 'e':
		/* %pe with a non-ERR_PTR gets treated as plain %p */
		if (!IS_ERR(ptr))
			break;
		return err_ptr(buf, end, ptr, spec);
2316 2317 2318 2319 2320 2321 2322 2323
	case 'u':
	case 'k':
		switch (fmt[1]) {
		case 's':
			return string(buf, end, ptr, spec);
		default:
			return error_string(buf, end, "(einval)", spec);
		}
2324 2325
	}

2326 2327 2328 2329 2330 2331 2332 2333
	/*
	 * default is to _not_ leak addresses, so hash before printing,
	 * unless no_hash_pointers is specified on the command line.
	 */
	if (unlikely(no_hash_pointers))
		return pointer_string(buf, end, ptr, spec);
	else
		return ptr_to_id(buf, end, ptr, spec);
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345
}

/*
 * Helper function to decode printf style format.
 * Each call decode a token from the format and return the
 * number of characters read (or likely the delta where it wants
 * to go on the next call).
 * The decoded token is returned through the parameters
 *
 * 'h', 'l', or 'L' for integer fields
 * 'z' support added 23/7/1999 S.H.
 * 'z' changed to 'Z' --davidm 1/25/99
2346
 * 'Z' changed to 'z' --adobriyan 2017-01-25
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356
 * 't' added for ptrdiff_t
 *
 * @fmt: the format string
 * @type of the token returned
 * @flags: various flags such as +, -, # tokens..
 * @field_width: overwritten width
 * @base: base of the number (octal, hex, ...)
 * @precision: precision of a number
 * @qualifier: qualifier of a number (long, size_t, ...)
 */
J
Joe Perches 已提交
2357 2358
static noinline_for_stack
int format_decode(const char *fmt, struct printf_spec *spec)
2359 2360
{
	const char *start = fmt;
2361
	char qualifier;
2362 2363

	/* we finished early by reading the field width */
2364
	if (spec->type == FORMAT_TYPE_WIDTH) {
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
		if (spec->field_width < 0) {
			spec->field_width = -spec->field_width;
			spec->flags |= LEFT;
		}
		spec->type = FORMAT_TYPE_NONE;
		goto precision;
	}

	/* we finished early by reading the precision */
	if (spec->type == FORMAT_TYPE_PRECISION) {
		if (spec->precision < 0)
			spec->precision = 0;

		spec->type = FORMAT_TYPE_NONE;
		goto qualifier;
	}

	/* By default */
	spec->type = FORMAT_TYPE_NONE;

	for (; *fmt ; ++fmt) {
		if (*fmt == '%')
			break;
	}

	/* Return the current non-format string */
	if (fmt != start || !*fmt)
		return fmt - start;

	/* Process flags */
	spec->flags = 0;

	while (1) { /* this also skips first '%' */
		bool found = true;

		++fmt;

		switch (*fmt) {
		case '-': spec->flags |= LEFT;    break;
		case '+': spec->flags |= PLUS;    break;
		case ' ': spec->flags |= SPACE;   break;
		case '#': spec->flags |= SPECIAL; break;
		case '0': spec->flags |= ZEROPAD; break;
		default:  found = false;
		}

		if (!found)
			break;
	}

	/* get field width */
	spec->field_width = -1;

	if (isdigit(*fmt))
		spec->field_width = skip_atoi(&fmt);
	else if (*fmt == '*') {
		/* it's the next argument */
2422
		spec->type = FORMAT_TYPE_WIDTH;
2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436
		return ++fmt - start;
	}

precision:
	/* get the precision */
	spec->precision = -1;
	if (*fmt == '.') {
		++fmt;
		if (isdigit(*fmt)) {
			spec->precision = skip_atoi(&fmt);
			if (spec->precision < 0)
				spec->precision = 0;
		} else if (*fmt == '*') {
			/* it's the next argument */
2437
			spec->type = FORMAT_TYPE_PRECISION;
2438 2439 2440 2441 2442 2443
			return ++fmt - start;
		}
	}

qualifier:
	/* get the conversion qualifier */
2444
	qualifier = 0;
A
Andy Shevchenko 已提交
2445
	if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2446
	    *fmt == 'z' || *fmt == 't') {
2447 2448 2449 2450
		qualifier = *fmt++;
		if (unlikely(qualifier == *fmt)) {
			if (qualifier == 'l') {
				qualifier = 'L';
2451
				++fmt;
2452 2453
			} else if (qualifier == 'h') {
				qualifier = 'H';
2454 2455
				++fmt;
			}
2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
		}
	}

	/* default base */
	spec->base = 10;
	switch (*fmt) {
	case 'c':
		spec->type = FORMAT_TYPE_CHAR;
		return ++fmt - start;

	case 's':
		spec->type = FORMAT_TYPE_STR;
		return ++fmt - start;

	case 'p':
		spec->type = FORMAT_TYPE_PTR;
2472
		return ++fmt - start;
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484

	case '%':
		spec->type = FORMAT_TYPE_PERCENT_CHAR;
		return ++fmt - start;

	/* integer number formats - set up the flags and "break" */
	case 'o':
		spec->base = 8;
		break;

	case 'x':
		spec->flags |= SMALL;
2485
		fallthrough;
2486 2487 2488 2489 2490 2491 2492

	case 'X':
		spec->base = 16;
		break;

	case 'd':
	case 'i':
2493
		spec->flags |= SIGN;
2494
		break;
2495
	case 'u':
2496
		break;
2497

R
Ryan Mallon 已提交
2498 2499
	case 'n':
		/*
2500 2501 2502
		 * Since %n poses a greater security risk than
		 * utility, treat it as any other invalid or
		 * unsupported format specifier.
R
Ryan Mallon 已提交
2503
		 */
2504
		fallthrough;
R
Ryan Mallon 已提交
2505

2506
	default:
2507
		WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
2508 2509
		spec->type = FORMAT_TYPE_INVALID;
		return fmt - start;
2510
	}
2511

2512
	if (qualifier == 'L')
2513
		spec->type = FORMAT_TYPE_LONG_LONG;
2514
	else if (qualifier == 'l') {
2515 2516
		BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
		spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
2517
	} else if (qualifier == 'z') {
2518
		spec->type = FORMAT_TYPE_SIZE_T;
2519
	} else if (qualifier == 't') {
2520
		spec->type = FORMAT_TYPE_PTRDIFF;
2521
	} else if (qualifier == 'H') {
2522 2523
		BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
		spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
2524
	} else if (qualifier == 'h') {
2525 2526
		BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
		spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
2527
	} else {
2528 2529
		BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
		spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
2530
	}
2531 2532

	return ++fmt - start;
2533 2534
}

2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552
static void
set_field_width(struct printf_spec *spec, int width)
{
	spec->field_width = width;
	if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
		spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
	}
}

static void
set_precision(struct printf_spec *spec, int prec)
{
	spec->precision = prec;
	if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
		spec->precision = clamp(prec, 0, PRECISION_MAX);
	}
}

L
Linus Torvalds 已提交
2553 2554 2555 2556 2557 2558 2559
/**
 * vsnprintf - Format a string and place it in a buffer
 * @buf: The buffer to place the result into
 * @size: The size of the buffer, including the trailing null space
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
2560 2561 2562
 * This function generally follows C99 vsnprintf, but has some
 * extensions and a few limitations:
 *
2563 2564
 *  - ``%n`` is unsupported
 *  - ``%p*`` is handled by pointer()
2565
 *
2566
 * See pointer() or Documentation/core-api/printk-formats.rst for more
2567
 * extensive description.
2568
 *
2569
 * **Please update the documentation in both places when making changes**
2570
 *
L
Linus Torvalds 已提交
2571 2572 2573 2574
 * The return value is the number of characters which would
 * be generated for the given input, excluding the trailing
 * '\0', as per ISO C99. If you want to have the exact
 * number of characters written into @buf as return value
2575
 * (not including the trailing '\0'), use vscnprintf(). If the
L
Linus Torvalds 已提交
2576 2577 2578
 * return is greater than or equal to @size, the resulting
 * string is truncated.
 *
2579
 * If you're not already dealing with a va_list consider using snprintf().
L
Linus Torvalds 已提交
2580 2581 2582 2583
 */
int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
{
	unsigned long long num;
2584
	char *str, *end;
2585
	struct printf_spec spec = {0};
L
Linus Torvalds 已提交
2586

2587 2588
	/* Reject out-of-range values early.  Large positive sizes are
	   used for unknown buffer sizes. */
2589
	if (WARN_ON_ONCE(size > INT_MAX))
L
Linus Torvalds 已提交
2590 2591 2592
		return 0;

	str = buf;
2593
	end = buf + size;
L
Linus Torvalds 已提交
2594

2595 2596 2597 2598
	/* Make sure end is always >= buf */
	if (end < buf) {
		end = ((void *)-1);
		size = end - buf;
L
Linus Torvalds 已提交
2599 2600
	}

2601 2602
	while (*fmt) {
		const char *old_fmt = fmt;
2603
		int read = format_decode(fmt, &spec);
L
Linus Torvalds 已提交
2604

2605
		fmt += read;
L
Linus Torvalds 已提交
2606

2607 2608 2609 2610 2611 2612 2613
		switch (spec.type) {
		case FORMAT_TYPE_NONE: {
			int copy = read;
			if (str < end) {
				if (copy > end - str)
					copy = end - str;
				memcpy(str, old_fmt, copy);
L
Linus Torvalds 已提交
2614
			}
2615 2616
			str += read;
			break;
L
Linus Torvalds 已提交
2617 2618
		}

2619
		case FORMAT_TYPE_WIDTH:
2620
			set_field_width(&spec, va_arg(args, int));
2621
			break;
L
Linus Torvalds 已提交
2622

2623
		case FORMAT_TYPE_PRECISION:
2624
			set_precision(&spec, va_arg(args, int));
2625
			break;
L
Linus Torvalds 已提交
2626

2627 2628 2629
		case FORMAT_TYPE_CHAR: {
			char c;

2630 2631
			if (!(spec.flags & LEFT)) {
				while (--spec.field_width > 0) {
2632
					if (str < end)
L
Linus Torvalds 已提交
2633 2634 2635
						*str = ' ';
					++str;

2636 2637 2638 2639 2640 2641 2642
				}
			}
			c = (unsigned char) va_arg(args, int);
			if (str < end)
				*str = c;
			++str;
			while (--spec.field_width > 0) {
2643
				if (str < end)
2644
					*str = ' ';
L
Linus Torvalds 已提交
2645
				++str;
2646 2647
			}
			break;
2648
		}
L
Linus Torvalds 已提交
2649

2650 2651 2652
		case FORMAT_TYPE_STR:
			str = string(str, end, va_arg(args, char *), spec);
			break;
L
Linus Torvalds 已提交
2653

2654
		case FORMAT_TYPE_PTR:
2655
			str = pointer(fmt, str, end, va_arg(args, void *),
2656 2657 2658 2659
				      spec);
			while (isalnum(*fmt))
				fmt++;
			break;
L
Linus Torvalds 已提交
2660

2661 2662 2663 2664 2665
		case FORMAT_TYPE_PERCENT_CHAR:
			if (str < end)
				*str = '%';
			++str;
			break;
L
Linus Torvalds 已提交
2666

2667
		case FORMAT_TYPE_INVALID:
2668 2669 2670 2671 2672 2673 2674 2675 2676
			/*
			 * Presumably the arguments passed gcc's type
			 * checking, but there is no safe or sane way
			 * for us to continue parsing the format and
			 * fetching from the va_list; the remaining
			 * specifiers and arguments would be out of
			 * sync.
			 */
			goto out;
2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689

		default:
			switch (spec.type) {
			case FORMAT_TYPE_LONG_LONG:
				num = va_arg(args, long long);
				break;
			case FORMAT_TYPE_ULONG:
				num = va_arg(args, unsigned long);
				break;
			case FORMAT_TYPE_LONG:
				num = va_arg(args, long);
				break;
			case FORMAT_TYPE_SIZE_T:
2690 2691 2692 2693
				if (spec.flags & SIGN)
					num = va_arg(args, ssize_t);
				else
					num = va_arg(args, size_t);
2694 2695 2696 2697
				break;
			case FORMAT_TYPE_PTRDIFF:
				num = va_arg(args, ptrdiff_t);
				break;
2698 2699 2700 2701 2702 2703
			case FORMAT_TYPE_UBYTE:
				num = (unsigned char) va_arg(args, int);
				break;
			case FORMAT_TYPE_BYTE:
				num = (signed char) va_arg(args, int);
				break;
2704 2705 2706 2707 2708 2709
			case FORMAT_TYPE_USHORT:
				num = (unsigned short) va_arg(args, int);
				break;
			case FORMAT_TYPE_SHORT:
				num = (short) va_arg(args, int);
				break;
2710 2711
			case FORMAT_TYPE_INT:
				num = (int) va_arg(args, int);
2712 2713 2714 2715 2716 2717
				break;
			default:
				num = va_arg(args, unsigned int);
			}

			str = number(str, end, num, spec);
L
Linus Torvalds 已提交
2718 2719
		}
	}
2720

2721
out:
2722 2723 2724 2725
	if (size > 0) {
		if (str < end)
			*str = '\0';
		else
L
Linus Torvalds 已提交
2726
			end[-1] = '\0';
2727
	}
2728

2729
	/* the trailing null byte doesn't count towards the total */
L
Linus Torvalds 已提交
2730
	return str-buf;
2731

L
Linus Torvalds 已提交
2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742
}
EXPORT_SYMBOL(vsnprintf);

/**
 * vscnprintf - Format a string and place it in a buffer
 * @buf: The buffer to place the result into
 * @size: The size of the buffer, including the trailing null space
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
 * The return value is the number of characters which have been written into
2743
 * the @buf not including the trailing '\0'. If @size is == 0 the function
L
Linus Torvalds 已提交
2744 2745
 * returns 0.
 *
2746
 * If you're not already dealing with a va_list consider using scnprintf().
2747 2748
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
2749 2750 2751 2752 2753
 */
int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
{
	int i;

2754 2755
	i = vsnprintf(buf, size, fmt, args);

2756 2757 2758 2759 2760
	if (likely(i < size))
		return i;
	if (size != 0)
		return size - 1;
	return 0;
L
Linus Torvalds 已提交
2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
}
EXPORT_SYMBOL(vscnprintf);

/**
 * snprintf - Format a string and place it in a buffer
 * @buf: The buffer to place the result into
 * @size: The size of the buffer, including the trailing null space
 * @fmt: The format string to use
 * @...: Arguments for the format string
 *
 * The return value is the number of characters which would be
 * generated for the given input, excluding the trailing null,
 * as per ISO C99.  If the return is greater than or equal to
 * @size, the resulting string is truncated.
2775 2776
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
2777
 */
2778
int snprintf(char *buf, size_t size, const char *fmt, ...)
L
Linus Torvalds 已提交
2779 2780 2781 2782 2783
{
	va_list args;
	int i;

	va_start(args, fmt);
2784
	i = vsnprintf(buf, size, fmt, args);
L
Linus Torvalds 已提交
2785
	va_end(args);
2786

L
Linus Torvalds 已提交
2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798
	return i;
}
EXPORT_SYMBOL(snprintf);

/**
 * scnprintf - Format a string and place it in a buffer
 * @buf: The buffer to place the result into
 * @size: The size of the buffer, including the trailing null space
 * @fmt: The format string to use
 * @...: Arguments for the format string
 *
 * The return value is the number of characters written into @buf not including
2799
 * the trailing '\0'. If @size is == 0 the function returns 0.
L
Linus Torvalds 已提交
2800 2801
 */

2802
int scnprintf(char *buf, size_t size, const char *fmt, ...)
L
Linus Torvalds 已提交
2803 2804 2805 2806 2807
{
	va_list args;
	int i;

	va_start(args, fmt);
2808
	i = vscnprintf(buf, size, fmt, args);
L
Linus Torvalds 已提交
2809
	va_end(args);
2810

2811
	return i;
L
Linus Torvalds 已提交
2812 2813 2814 2815 2816 2817 2818 2819 2820 2821
}
EXPORT_SYMBOL(scnprintf);

/**
 * vsprintf - Format a string and place it in a buffer
 * @buf: The buffer to place the result into
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
 * The function returns the number of characters written
2822
 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
L
Linus Torvalds 已提交
2823 2824
 * buffer overflows.
 *
2825
 * If you're not already dealing with a va_list consider using sprintf().
2826 2827
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841
 */
int vsprintf(char *buf, const char *fmt, va_list args)
{
	return vsnprintf(buf, INT_MAX, fmt, args);
}
EXPORT_SYMBOL(vsprintf);

/**
 * sprintf - Format a string and place it in a buffer
 * @buf: The buffer to place the result into
 * @fmt: The format string to use
 * @...: Arguments for the format string
 *
 * The function returns the number of characters written
2842
 * into @buf. Use snprintf() or scnprintf() in order to avoid
L
Linus Torvalds 已提交
2843
 * buffer overflows.
2844 2845
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
2846
 */
2847
int sprintf(char *buf, const char *fmt, ...)
L
Linus Torvalds 已提交
2848 2849 2850 2851 2852
{
	va_list args;
	int i;

	va_start(args, fmt);
2853
	i = vsnprintf(buf, INT_MAX, fmt, args);
L
Linus Torvalds 已提交
2854
	va_end(args);
2855

L
Linus Torvalds 已提交
2856 2857 2858 2859
	return i;
}
EXPORT_SYMBOL(sprintf);

L
Lai Jiangshan 已提交
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
#ifdef CONFIG_BINARY_PRINTF
/*
 * bprintf service:
 * vbin_printf() - VA arguments to binary data
 * bstr_printf() - Binary data to text string
 */

/**
 * vbin_printf - Parse a format string and place args' binary value in a buffer
 * @bin_buf: The buffer to place args' binary value
 * @size: The size of the buffer(by words(32bits), not characters)
 * @fmt: The format string to use
 * @args: Arguments for the format string
 *
 * The format follows C99 vsnprintf, except %n is ignored, and its argument
2875
 * is skipped.
L
Lai Jiangshan 已提交
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885
 *
 * The return value is the number of words(32bits) which would be generated for
 * the given input.
 *
 * NOTE:
 * If the return value is greater than @size, the resulting bin_buf is NOT
 * valid for bstr_printf().
 */
int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
{
2886
	struct printf_spec spec = {0};
L
Lai Jiangshan 已提交
2887
	char *str, *end;
2888
	int width;
L
Lai Jiangshan 已提交
2889 2890 2891 2892 2893

	str = (char *)bin_buf;
	end = (char *)(bin_buf + size);

#define save_arg(type)							\
2894 2895
({									\
	unsigned long long value;					\
L
Lai Jiangshan 已提交
2896
	if (sizeof(type) == 8) {					\
2897
		unsigned long long val8;				\
L
Lai Jiangshan 已提交
2898
		str = PTR_ALIGN(str, sizeof(u32));			\
2899
		val8 = va_arg(args, unsigned long long);		\
L
Lai Jiangshan 已提交
2900
		if (str + sizeof(type) <= end) {			\
2901 2902
			*(u32 *)str = *(u32 *)&val8;			\
			*(u32 *)(str + 4) = *((u32 *)&val8 + 1);	\
L
Lai Jiangshan 已提交
2903
		}							\
2904
		value = val8;						\
L
Lai Jiangshan 已提交
2905
	} else {							\
2906
		unsigned int val4;					\
L
Lai Jiangshan 已提交
2907
		str = PTR_ALIGN(str, sizeof(type));			\
2908
		val4 = va_arg(args, int);				\
L
Lai Jiangshan 已提交
2909
		if (str + sizeof(type) <= end)				\
2910 2911
			*(typeof(type) *)str = (type)(long)val4;	\
		value = (unsigned long long)val4;			\
L
Lai Jiangshan 已提交
2912 2913
	}								\
	str += sizeof(type);						\
2914 2915
	value;								\
})
L
Lai Jiangshan 已提交
2916

2917
	while (*fmt) {
2918
		int read = format_decode(fmt, &spec);
L
Lai Jiangshan 已提交
2919

2920
		fmt += read;
L
Lai Jiangshan 已提交
2921

2922 2923
		switch (spec.type) {
		case FORMAT_TYPE_NONE:
2924
		case FORMAT_TYPE_PERCENT_CHAR:
2925
			break;
2926 2927
		case FORMAT_TYPE_INVALID:
			goto out;
2928

2929
		case FORMAT_TYPE_WIDTH:
2930
		case FORMAT_TYPE_PRECISION:
2931 2932 2933 2934
			width = (int)save_arg(int);
			/* Pointers may require the width */
			if (*fmt == 'p')
				set_field_width(&spec, width);
2935 2936 2937
			break;

		case FORMAT_TYPE_CHAR:
L
Lai Jiangshan 已提交
2938
			save_arg(char);
2939 2940 2941
			break;

		case FORMAT_TYPE_STR: {
L
Lai Jiangshan 已提交
2942
			const char *save_str = va_arg(args, char *);
2943
			const char *err_msg;
L
Lai Jiangshan 已提交
2944
			size_t len;
2945

2946 2947 2948 2949
			err_msg = check_pointer_msg(save_str);
			if (err_msg)
				save_str = err_msg;

2950 2951 2952 2953
			len = strlen(save_str) + 1;
			if (str + len < end)
				memcpy(str, save_str, len);
			str += len;
2954
			break;
L
Lai Jiangshan 已提交
2955
		}
2956 2957

		case FORMAT_TYPE_PTR:
2958 2959 2960 2961 2962
			/* Dereferenced pointers must be done now */
			switch (*fmt) {
			/* Dereference of functions is still OK */
			case 'S':
			case 's':
2963 2964
			case 'x':
			case 'K':
2965
			case 'e':
2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979
				save_arg(void *);
				break;
			default:
				if (!isalnum(*fmt)) {
					save_arg(void *);
					break;
				}
				str = pointer(fmt, str, end, va_arg(args, void *),
					      spec);
				if (str + 1 < end)
					*str++ = '\0';
				else
					end[-1] = '\0'; /* Must be nul terminated */
			}
L
Lai Jiangshan 已提交
2980
			/* skip all alphanumeric pointer suffixes */
2981
			while (isalnum(*fmt))
L
Lai Jiangshan 已提交
2982
				fmt++;
2983 2984 2985 2986 2987 2988
			break;

		default:
			switch (spec.type) {

			case FORMAT_TYPE_LONG_LONG:
L
Lai Jiangshan 已提交
2989
				save_arg(long long);
2990 2991 2992
				break;
			case FORMAT_TYPE_ULONG:
			case FORMAT_TYPE_LONG:
L
Lai Jiangshan 已提交
2993
				save_arg(unsigned long);
2994 2995
				break;
			case FORMAT_TYPE_SIZE_T:
L
Lai Jiangshan 已提交
2996
				save_arg(size_t);
2997 2998
				break;
			case FORMAT_TYPE_PTRDIFF:
L
Lai Jiangshan 已提交
2999
				save_arg(ptrdiff_t);
3000
				break;
3001 3002 3003 3004
			case FORMAT_TYPE_UBYTE:
			case FORMAT_TYPE_BYTE:
				save_arg(char);
				break;
3005 3006
			case FORMAT_TYPE_USHORT:
			case FORMAT_TYPE_SHORT:
L
Lai Jiangshan 已提交
3007
				save_arg(short);
3008 3009
				break;
			default:
L
Lai Jiangshan 已提交
3010
				save_arg(int);
3011
			}
L
Lai Jiangshan 已提交
3012 3013
		}
	}
3014

3015
out:
3016
	return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
3017
#undef save_arg
L
Lai Jiangshan 已提交
3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032
}
EXPORT_SYMBOL_GPL(vbin_printf);

/**
 * bstr_printf - Format a string from binary arguments and place it in a buffer
 * @buf: The buffer to place the result into
 * @size: The size of the buffer, including the trailing null space
 * @fmt: The format string to use
 * @bin_buf: Binary arguments for the format string
 *
 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
 * a binary buffer that generated by vbin_printf.
 *
 * The format follows C99 vsnprintf, but has some extensions:
3033
 *  see vsnprintf comment for details.
L
Lai Jiangshan 已提交
3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044
 *
 * The return value is the number of characters which would
 * be generated for the given input, excluding the trailing
 * '\0', as per ISO C99. If you want to have the exact
 * number of characters written into @buf as return value
 * (not including the trailing '\0'), use vscnprintf(). If the
 * return is greater than or equal to @size, the resulting
 * string is truncated.
 */
int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
{
3045
	struct printf_spec spec = {0};
3046 3047
	char *str, *end;
	const char *args = (const char *)bin_buf;
L
Lai Jiangshan 已提交
3048

3049
	if (WARN_ON_ONCE(size > INT_MAX))
L
Lai Jiangshan 已提交
3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075
		return 0;

	str = buf;
	end = buf + size;

#define get_arg(type)							\
({									\
	typeof(type) value;						\
	if (sizeof(type) == 8) {					\
		args = PTR_ALIGN(args, sizeof(u32));			\
		*(u32 *)&value = *(u32 *)args;				\
		*((u32 *)&value + 1) = *(u32 *)(args + 4);		\
	} else {							\
		args = PTR_ALIGN(args, sizeof(type));			\
		value = *(typeof(type) *)args;				\
	}								\
	args += sizeof(type);						\
	value;								\
})

	/* Make sure end is always >= buf */
	if (end < buf) {
		end = ((void *)-1);
		size = end - buf;
	}

3076 3077
	while (*fmt) {
		const char *old_fmt = fmt;
3078
		int read = format_decode(fmt, &spec);
L
Lai Jiangshan 已提交
3079

3080
		fmt += read;
L
Lai Jiangshan 已提交
3081

3082 3083 3084 3085 3086 3087 3088
		switch (spec.type) {
		case FORMAT_TYPE_NONE: {
			int copy = read;
			if (str < end) {
				if (copy > end - str)
					copy = end - str;
				memcpy(str, old_fmt, copy);
L
Lai Jiangshan 已提交
3089
			}
3090 3091
			str += read;
			break;
L
Lai Jiangshan 已提交
3092 3093
		}

3094
		case FORMAT_TYPE_WIDTH:
3095
			set_field_width(&spec, get_arg(int));
3096
			break;
L
Lai Jiangshan 已提交
3097

3098
		case FORMAT_TYPE_PRECISION:
3099
			set_precision(&spec, get_arg(int));
3100
			break;
L
Lai Jiangshan 已提交
3101

3102 3103 3104
		case FORMAT_TYPE_CHAR: {
			char c;

3105 3106
			if (!(spec.flags & LEFT)) {
				while (--spec.field_width > 0) {
L
Lai Jiangshan 已提交
3107 3108 3109 3110 3111 3112 3113 3114 3115
					if (str < end)
						*str = ' ';
					++str;
				}
			}
			c = (unsigned char) get_arg(char);
			if (str < end)
				*str = c;
			++str;
3116
			while (--spec.field_width > 0) {
L
Lai Jiangshan 已提交
3117 3118 3119 3120
				if (str < end)
					*str = ' ';
				++str;
			}
3121
			break;
3122
		}
L
Lai Jiangshan 已提交
3123

3124
		case FORMAT_TYPE_STR: {
L
Lai Jiangshan 已提交
3125
			const char *str_arg = args;
3126
			args += strlen(str_arg) + 1;
3127 3128
			str = string(str, end, (char *)str_arg, spec);
			break;
L
Lai Jiangshan 已提交
3129 3130
		}

3131 3132 3133 3134 3135 3136 3137 3138 3139
		case FORMAT_TYPE_PTR: {
			bool process = false;
			int copy, len;
			/* Non function dereferences were already done */
			switch (*fmt) {
			case 'S':
			case 's':
			case 'F':
			case 'f':
3140 3141
			case 'x':
			case 'K':
3142
			case 'e':
3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156
				process = true;
				break;
			default:
				if (!isalnum(*fmt)) {
					process = true;
					break;
				}
				/* Pointer dereference was already processed */
				if (str < end) {
					len = copy = strlen(args);
					if (copy > end - str)
						copy = end - str;
					memcpy(str, args, copy);
					str += len;
3157
					args += len + 1;
3158 3159 3160 3161 3162
				}
			}
			if (process)
				str = pointer(fmt, str, end, get_arg(void *), spec);

3163
			while (isalnum(*fmt))
L
Lai Jiangshan 已提交
3164
				fmt++;
3165
			break;
3166
		}
L
Lai Jiangshan 已提交
3167

3168
		case FORMAT_TYPE_PERCENT_CHAR:
L
Lai Jiangshan 已提交
3169 3170 3171
			if (str < end)
				*str = '%';
			++str;
3172 3173
			break;

3174 3175 3176
		case FORMAT_TYPE_INVALID:
			goto out;

3177 3178 3179
		default: {
			unsigned long long num;

3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194
			switch (spec.type) {

			case FORMAT_TYPE_LONG_LONG:
				num = get_arg(long long);
				break;
			case FORMAT_TYPE_ULONG:
			case FORMAT_TYPE_LONG:
				num = get_arg(unsigned long);
				break;
			case FORMAT_TYPE_SIZE_T:
				num = get_arg(size_t);
				break;
			case FORMAT_TYPE_PTRDIFF:
				num = get_arg(ptrdiff_t);
				break;
3195 3196 3197 3198 3199 3200
			case FORMAT_TYPE_UBYTE:
				num = get_arg(unsigned char);
				break;
			case FORMAT_TYPE_BYTE:
				num = get_arg(signed char);
				break;
3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214
			case FORMAT_TYPE_USHORT:
				num = get_arg(unsigned short);
				break;
			case FORMAT_TYPE_SHORT:
				num = get_arg(short);
				break;
			case FORMAT_TYPE_UINT:
				num = get_arg(unsigned int);
				break;
			default:
				num = get_arg(int);
			}

			str = number(str, end, num, spec);
3215 3216 3217
		} /* default: */
		} /* switch(spec.type) */
	} /* while(*fmt) */
3218

3219
out:
L
Lai Jiangshan 已提交
3220 3221 3222 3223 3224 3225
	if (size > 0) {
		if (str < end)
			*str = '\0';
		else
			end[-1] = '\0';
	}
3226

L
Lai Jiangshan 已提交
3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251
#undef get_arg

	/* the trailing null byte doesn't count towards the total */
	return str - buf;
}
EXPORT_SYMBOL_GPL(bstr_printf);

/**
 * bprintf - Parse a format string and place args' binary value in a buffer
 * @bin_buf: The buffer to place args' binary value
 * @size: The size of the buffer(by words(32bits), not characters)
 * @fmt: The format string to use
 * @...: Arguments for the format string
 *
 * The function returns the number of words(u32) written
 * into @bin_buf.
 */
int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
{
	va_list args;
	int ret;

	va_start(args, fmt);
	ret = vbin_printf(bin_buf, size, fmt, args);
	va_end(args);
3252

L
Lai Jiangshan 已提交
3253 3254 3255 3256 3257 3258
	return ret;
}
EXPORT_SYMBOL_GPL(bprintf);

#endif /* CONFIG_BINARY_PRINTF */

L
Linus Torvalds 已提交
3259 3260 3261 3262 3263 3264
/**
 * vsscanf - Unformat a buffer into a list of arguments
 * @buf:	input buffer
 * @fmt:	format of buffer
 * @args:	arguments
 */
3265
int vsscanf(const char *buf, const char *fmt, va_list args)
L
Linus Torvalds 已提交
3266 3267 3268 3269 3270
{
	const char *str = buf;
	char *next;
	char digit;
	int num = 0;
3271
	u8 qualifier;
3272 3273 3274 3275 3276
	unsigned int base;
	union {
		long long s;
		unsigned long long u;
	} val;
3277
	s16 field_width;
3278
	bool is_sign;
L
Linus Torvalds 已提交
3279

3280
	while (*fmt) {
L
Linus Torvalds 已提交
3281 3282 3283 3284 3285
		/* skip any white space in format */
		/* white space in format matchs any amount of
		 * white space, including none, in the input.
		 */
		if (isspace(*fmt)) {
3286 3287
			fmt = skip_spaces(++fmt);
			str = skip_spaces(str);
L
Linus Torvalds 已提交
3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
		}

		/* anything that is not a conversion must match exactly */
		if (*fmt != '%' && *fmt) {
			if (*fmt++ != *str++)
				break;
			continue;
		}

		if (!*fmt)
			break;
		++fmt;
3300

L
Linus Torvalds 已提交
3301 3302 3303 3304
		/* skip this conversion.
		 * advance both strings to next white space
		 */
		if (*fmt == '*') {
3305 3306
			if (!*str)
				break;
3307 3308 3309 3310
			while (!isspace(*fmt) && *fmt != '%' && *fmt) {
				/* '%*[' not yet supported, invalid format */
				if (*fmt == '[')
					return num;
L
Linus Torvalds 已提交
3311
				fmt++;
3312
			}
L
Linus Torvalds 已提交
3313 3314 3315 3316 3317 3318 3319
			while (!isspace(*str) && *str)
				str++;
			continue;
		}

		/* get field width */
		field_width = -1;
3320
		if (isdigit(*fmt)) {
L
Linus Torvalds 已提交
3321
			field_width = skip_atoi(&fmt);
3322 3323 3324
			if (field_width <= 0)
				break;
		}
L
Linus Torvalds 已提交
3325 3326 3327

		/* get conversion qualifier */
		qualifier = -1;
A
Andy Shevchenko 已提交
3328
		if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
3329
		    *fmt == 'z') {
L
Linus Torvalds 已提交
3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341
			qualifier = *fmt++;
			if (unlikely(qualifier == *fmt)) {
				if (qualifier == 'h') {
					qualifier = 'H';
					fmt++;
				} else if (qualifier == 'l') {
					qualifier = 'L';
					fmt++;
				}
			}
		}

3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352
		if (!*fmt)
			break;

		if (*fmt == 'n') {
			/* return number of characters read so far */
			*va_arg(args, int *) = str - buf;
			++fmt;
			continue;
		}

		if (!*str)
L
Linus Torvalds 已提交
3353 3354
			break;

3355
		base = 10;
3356
		is_sign = false;
3357

3358
		switch (*fmt++) {
L
Linus Torvalds 已提交
3359 3360
		case 'c':
		{
3361
			char *s = (char *)va_arg(args, char*);
L
Linus Torvalds 已提交
3362 3363 3364 3365 3366 3367 3368 3369 3370 3371
			if (field_width == -1)
				field_width = 1;
			do {
				*s++ = *str++;
			} while (--field_width > 0 && *str);
			num++;
		}
		continue;
		case 's':
		{
3372 3373
			char *s = (char *)va_arg(args, char *);
			if (field_width == -1)
3374
				field_width = SHRT_MAX;
L
Linus Torvalds 已提交
3375
			/* first, skip leading white space in buffer */
3376
			str = skip_spaces(str);
L
Linus Torvalds 已提交
3377 3378

			/* now copy until next white space */
3379
			while (*str && !isspace(*str) && field_width--)
L
Linus Torvalds 已提交
3380 3381 3382 3383 3384
				*s++ = *str++;
			*s = '\0';
			num++;
		}
		continue;
3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437
		/*
		 * Warning: This implementation of the '[' conversion specifier
		 * deviates from its glibc counterpart in the following ways:
		 * (1) It does NOT support ranges i.e. '-' is NOT a special
		 *     character
		 * (2) It cannot match the closing bracket ']' itself
		 * (3) A field width is required
		 * (4) '%*[' (discard matching input) is currently not supported
		 *
		 * Example usage:
		 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
		 *		buf1, buf2, buf3);
		 * if (ret < 3)
		 *    // etc..
		 */
		case '[':
		{
			char *s = (char *)va_arg(args, char *);
			DECLARE_BITMAP(set, 256) = {0};
			unsigned int len = 0;
			bool negate = (*fmt == '^');

			/* field width is required */
			if (field_width == -1)
				return num;

			if (negate)
				++fmt;

			for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
				set_bit((u8)*fmt, set);

			/* no ']' or no character set found */
			if (!*fmt || !len)
				return num;
			++fmt;

			if (negate) {
				bitmap_complement(set, set, 256);
				/* exclude null '\0' byte */
				clear_bit(0, set);
			}

			/* match must be non-empty */
			if (!test_bit((u8)*str, set))
				return num;

			while (test_bit((u8)*str, set) && field_width--)
				*s++ = *str++;
			*s = '\0';
			++num;
		}
		continue;
L
Linus Torvalds 已提交
3438 3439 3440 3441 3442 3443 3444 3445
		case 'o':
			base = 8;
			break;
		case 'x':
		case 'X':
			base = 16;
			break;
		case 'i':
3446
			base = 0;
3447
			fallthrough;
L
Linus Torvalds 已提交
3448
		case 'd':
3449
			is_sign = true;
3450
			fallthrough;
L
Linus Torvalds 已提交
3451 3452 3453 3454
		case 'u':
			break;
		case '%':
			/* looking for '%' in str */
3455
			if (*str++ != '%')
L
Linus Torvalds 已提交
3456 3457 3458 3459 3460 3461 3462 3463 3464 3465
				return num;
			continue;
		default:
			/* invalid format; stop here */
			return num;
		}

		/* have some sort of integer conversion.
		 * first, skip white space in buffer.
		 */
3466
		str = skip_spaces(str);
L
Linus Torvalds 已提交
3467 3468 3469 3470 3471 3472

		digit = *str;
		if (is_sign && digit == '-')
			digit = *(str + 1);

		if (!digit
3473 3474 3475 3476 3477
		    || (base == 16 && !isxdigit(digit))
		    || (base == 10 && !isdigit(digit))
		    || (base == 8 && (!isdigit(digit) || digit > '7'))
		    || (base == 0 && !isdigit(digit)))
			break;
L
Linus Torvalds 已提交
3478

3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499
		if (is_sign)
			val.s = qualifier != 'L' ?
				simple_strtol(str, &next, base) :
				simple_strtoll(str, &next, base);
		else
			val.u = qualifier != 'L' ?
				simple_strtoul(str, &next, base) :
				simple_strtoull(str, &next, base);

		if (field_width > 0 && next - str > field_width) {
			if (base == 0)
				_parse_integer_fixup_radix(str, &base);
			while (next - str > field_width) {
				if (is_sign)
					val.s = div_s64(val.s, base);
				else
					val.u = div_u64(val.u, base);
				--next;
			}
		}

3500
		switch (qualifier) {
L
Linus Torvalds 已提交
3501
		case 'H':	/* that's 'hh' in format */
3502 3503 3504 3505
			if (is_sign)
				*va_arg(args, signed char *) = val.s;
			else
				*va_arg(args, unsigned char *) = val.u;
L
Linus Torvalds 已提交
3506 3507
			break;
		case 'h':
3508 3509 3510 3511
			if (is_sign)
				*va_arg(args, short *) = val.s;
			else
				*va_arg(args, unsigned short *) = val.u;
L
Linus Torvalds 已提交
3512 3513
			break;
		case 'l':
3514 3515 3516 3517
			if (is_sign)
				*va_arg(args, long *) = val.s;
			else
				*va_arg(args, unsigned long *) = val.u;
L
Linus Torvalds 已提交
3518 3519
			break;
		case 'L':
3520 3521 3522 3523
			if (is_sign)
				*va_arg(args, long long *) = val.s;
			else
				*va_arg(args, unsigned long long *) = val.u;
L
Linus Torvalds 已提交
3524 3525
			break;
		case 'z':
3526 3527
			*va_arg(args, size_t *) = val.u;
			break;
L
Linus Torvalds 已提交
3528
		default:
3529 3530 3531 3532
			if (is_sign)
				*va_arg(args, int *) = val.s;
			else
				*va_arg(args, unsigned int *) = val.u;
L
Linus Torvalds 已提交
3533 3534 3535 3536 3537 3538 3539 3540
			break;
		}
		num++;

		if (!next)
			break;
		str = next;
	}
3541

L
Linus Torvalds 已提交
3542 3543 3544 3545 3546 3547 3548 3549 3550 3551
	return num;
}
EXPORT_SYMBOL(vsscanf);

/**
 * sscanf - Unformat a buffer into a list of arguments
 * @buf:	input buffer
 * @fmt:	formatting of buffer
 * @...:	resulting arguments
 */
3552
int sscanf(const char *buf, const char *fmt, ...)
L
Linus Torvalds 已提交
3553 3554 3555 3556
{
	va_list args;
	int i;

3557 3558
	va_start(args, fmt);
	i = vsscanf(buf, fmt, args);
L
Linus Torvalds 已提交
3559
	va_end(args);
3560

L
Linus Torvalds 已提交
3561 3562 3563
	return i;
}
EXPORT_SYMBOL(sscanf);