vsprintf.c 51.1 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11
/*
 *  linux/lib/vsprintf.c
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 */

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

12
/*
L
Linus Torvalds 已提交
13 14 15 16 17 18 19 20 21 22 23 24
 * 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>
#include <linux/module.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/ctype.h>
#include <linux/kernel.h>
25 26
#include <linux/kallsyms.h>
#include <linux/uaccess.h>
27
#include <linux/ioport.h>
28
#include <net/addrconf.h>
L
Linus Torvalds 已提交
29

T
Tim Schmielau 已提交
30
#include <asm/page.h>		/* for PAGE_SIZE */
L
Linus Torvalds 已提交
31
#include <asm/div64.h>
32
#include <asm/sections.h>	/* for dereference_function_descriptor() */
L
Linus Torvalds 已提交
33

34 35 36
/* Works only for digits and letters, but small and fast */
#define TOLOWER(x) ((x) | 0x20)

37 38 39 40 41 42 43 44 45 46 47 48
static unsigned int simple_guess_base(const char *cp)
{
	if (cp[0] == '0') {
		if (TOLOWER(cp[1]) == 'x' && isxdigit(cp[2]))
			return 16;
		else
			return 8;
	} else {
		return 10;
	}
}

L
Linus Torvalds 已提交
49
/**
50
 * simple_strtoull - convert a string to an unsigned long long
L
Linus Torvalds 已提交
51 52 53 54
 * @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
 */
55
unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
56
{
57
	unsigned long long result = 0;
58 59 60 61 62 63 64 65 66 67 68 69 70 71

	if (!base)
		base = simple_guess_base(cp);

	if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
		cp += 2;

	while (isxdigit(*cp)) {
		unsigned int value;

		value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
		if (value >= base)
			break;
		result = result * base + value;
L
Linus Torvalds 已提交
72 73 74 75
		cp++;
	}
	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 86
 * @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
 */
87
unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
88
{
89
	return simple_strtoull(cp, endp, base);
L
Linus Torvalds 已提交
90
}
91
EXPORT_SYMBOL(simple_strtoul);
L
Linus Torvalds 已提交
92 93

/**
94
 * simple_strtol - convert a string to a signed long
L
Linus Torvalds 已提交
95 96 97 98
 * @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
 */
99
long simple_strtol(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
100
{
101 102
	if (*cp == '-')
		return -simple_strtoul(cp + 1, endp, base);
103

104
	return simple_strtoul(cp, endp, base);
L
Linus Torvalds 已提交
105
}
106
EXPORT_SYMBOL(simple_strtol);
L
Linus Torvalds 已提交
107 108 109 110 111 112 113

/**
 * 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
 */
H
Harvey Harrison 已提交
114
long long simple_strtoll(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
115
{
116
	if (*cp == '-')
H
Harvey Harrison 已提交
117
		return -simple_strtoull(cp + 1, endp, base);
118

H
Harvey Harrison 已提交
119
	return simple_strtoull(cp, endp, base);
L
Linus Torvalds 已提交
120
}
121
EXPORT_SYMBOL(simple_strtoll);
L
Linus Torvalds 已提交
122

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
/**
 * strict_strtoul - convert a string to an unsigned long strictly
 * @cp: The string to be converted
 * @base: The number base to use
 * @res: The converted result value
 *
 * strict_strtoul converts a string to an unsigned long only if the
 * string is really an unsigned long string, any string containing
 * any invalid char at the tail will be rejected and -EINVAL is returned,
 * only a newline char at the tail is acceptible because people generally
 * change a module parameter in the following way:
 *
 * 	echo 1024 > /sys/module/e1000/parameters/copybreak
 *
 * echo will append a newline to the tail.
 *
 * It returns 0 if conversion is successful and *res is set to the converted
 * value, otherwise it returns -EINVAL and *res is set to 0.
 *
 * simple_strtoul just ignores the successive invalid characters and
 * return the converted value of prefix part of the string.
 */
145 146 147 148 149 150
int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
{
	char *tail;
	unsigned long val;

	*res = 0;
151
	if (!*cp)
152 153 154
		return -EINVAL;

	val = simple_strtoul(cp, &tail, base);
155 156
	if (tail == cp)
		return -EINVAL;
157

158
	if ((tail[0] == '\0') || (tail[0] == '\n' && tail[1] == '\0')) {
159 160 161 162 163 164 165
		*res = val;
		return 0;
	}

	return -EINVAL;
}
EXPORT_SYMBOL(strict_strtoul);
166 167 168 169 170 171 172 173 174 175 176 177 178

/**
 * strict_strtol - convert a string to a long strictly
 * @cp: The string to be converted
 * @base: The number base to use
 * @res: The converted result value
 *
 * strict_strtol is similiar to strict_strtoul, but it allows the first
 * character of a string is '-'.
 *
 * It returns 0 if conversion is successful and *res is set to the converted
 * value, otherwise it returns -EINVAL and *res is set to 0.
 */
179 180 181 182 183 184 185 186 187 188 189 190 191 192
int strict_strtol(const char *cp, unsigned int base, long *res)
{
	int ret;
	if (*cp == '-') {
		ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
		if (!ret)
			*res = -(*res);
	} else {
		ret = strict_strtoul(cp, base, (unsigned long *)res);
	}

	return ret;
}
EXPORT_SYMBOL(strict_strtol);
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215

/**
 * strict_strtoull - convert a string to an unsigned long long strictly
 * @cp: The string to be converted
 * @base: The number base to use
 * @res: The converted result value
 *
 * strict_strtoull converts a string to an unsigned long long only if the
 * string is really an unsigned long long string, any string containing
 * any invalid char at the tail will be rejected and -EINVAL is returned,
 * only a newline char at the tail is acceptible because people generally
 * change a module parameter in the following way:
 *
 * 	echo 1024 > /sys/module/e1000/parameters/copybreak
 *
 * echo will append a newline to the tail of the string.
 *
 * It returns 0 if conversion is successful and *res is set to the converted
 * value, otherwise it returns -EINVAL and *res is set to 0.
 *
 * simple_strtoull just ignores the successive invalid characters and
 * return the converted value of prefix part of the string.
 */
216 217 218 219 220 221
int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
{
	char *tail;
	unsigned long long val;

	*res = 0;
222
	if (!*cp)
223 224 225
		return -EINVAL;

	val = simple_strtoull(cp, &tail, base);
226 227
	if (tail == cp)
		return -EINVAL;
228
	if ((tail[0] == '\0') || (tail[0] == '\n' && tail[1] == '\0')) {
229 230 231 232 233 234 235
		*res = val;
		return 0;
	}

	return -EINVAL;
}
EXPORT_SYMBOL(strict_strtoull);
236 237 238 239 240 241 242 243 244 245 246 247 248

/**
 * strict_strtoll - convert a string to a long long strictly
 * @cp: The string to be converted
 * @base: The number base to use
 * @res: The converted result value
 *
 * strict_strtoll is similiar to strict_strtoull, but it allows the first
 * character of a string is '-'.
 *
 * It returns 0 if conversion is successful and *res is set to the converted
 * value, otherwise it returns -EINVAL and *res is set to 0.
 */
249 250 251 252 253 254 255 256 257 258
int strict_strtoll(const char *cp, unsigned int base, long long *res)
{
	int ret;
	if (*cp == '-') {
		ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
		if (!ret)
			*res = -(*res);
	} else {
		ret = strict_strtoull(cp, base, (unsigned long long *)res);
	}
259

260 261
	return ret;
}
262 263
EXPORT_SYMBOL(strict_strtoll);

J
Joe Perches 已提交
264 265
static noinline_for_stack
int skip_atoi(const char **s)
L
Linus Torvalds 已提交
266
{
267
	int i = 0;
L
Linus Torvalds 已提交
268 269 270

	while (isdigit(**s))
		i = i*10 + *((*s)++) - '0';
271

L
Linus Torvalds 已提交
272 273 274
	return i;
}

275 276 277 278 279 280 281 282 283 284
/* 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
 * using code from
 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
 * (with permission from the author, Douglas W. Jones). */

/* Formats correctly any integer in [0,99999].
 * Outputs from one to five digits depending on input.
 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
J
Joe Perches 已提交
285 286
static noinline_for_stack
char *put_dec_trunc(char *buf, unsigned q)
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
{
	unsigned d3, d2, d1, d0;
	d1 = (q>>4) & 0xf;
	d2 = (q>>8) & 0xf;
	d3 = (q>>12);

	d0 = 6*(d3 + d2 + d1) + (q & 0xf);
	q = (d0 * 0xcd) >> 11;
	d0 = d0 - 10*q;
	*buf++ = d0 + '0'; /* least significant digit */
	d1 = q + 9*d3 + 5*d2 + d1;
	if (d1 != 0) {
		q = (d1 * 0xcd) >> 11;
		d1 = d1 - 10*q;
		*buf++ = d1 + '0'; /* next digit */

		d2 = q + 2*d2;
		if ((d2 != 0) || (d3 != 0)) {
			q = (d2 * 0xd) >> 7;
			d2 = d2 - 10*q;
			*buf++ = d2 + '0'; /* next digit */

			d3 = q + 4*d3;
			if (d3 != 0) {
				q = (d3 * 0xcd) >> 11;
				d3 = d3 - 10*q;
				*buf++ = d3 + '0';  /* next digit */
				if (q != 0)
315
					*buf++ = q + '0'; /* most sign. digit */
316 317 318
			}
		}
	}
319

320 321 322
	return buf;
}
/* Same with if's removed. Always emits five digits */
J
Joe Perches 已提交
323 324
static noinline_for_stack
char *put_dec_full(char *buf, unsigned q)
325 326 327 328 329 330 331 332
{
	/* BTW, if q is in [0,9999], 8-bit ints will be enough, */
	/* but anyway, gcc produces better code with full-sized ints */
	unsigned d3, d2, d1, d0;
	d1 = (q>>4) & 0xf;
	d2 = (q>>8) & 0xf;
	d3 = (q>>12);

333 334 335 336 337 338 339 340 341
	/*
	 * Possible ways to approx. divide by 10
	 * gcc -O2 replaces multiply with shifts and adds
	 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
	 * (x * 0x67) >> 10:  1100111
	 * (x * 0x34) >> 9:    110100 - same
	 * (x * 0x1a) >> 8:     11010 - same
	 * (x * 0x0d) >> 7:      1101 - same, shortest code (on i386)
	 */
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
	d0 = 6*(d3 + d2 + d1) + (q & 0xf);
	q = (d0 * 0xcd) >> 11;
	d0 = d0 - 10*q;
	*buf++ = d0 + '0';
	d1 = q + 9*d3 + 5*d2 + d1;
		q = (d1 * 0xcd) >> 11;
		d1 = d1 - 10*q;
		*buf++ = d1 + '0';

		d2 = q + 2*d2;
			q = (d2 * 0xd) >> 7;
			d2 = d2 - 10*q;
			*buf++ = d2 + '0';

			d3 = q + 4*d3;
				q = (d3 * 0xcd) >> 11; /* - shorter code */
				/* q = (d3 * 0x67) >> 10; - would also work */
				d3 = d3 - 10*q;
				*buf++ = d3 + '0';
					*buf++ = q + '0';
362

363 364 365
	return buf;
}
/* No inlining helps gcc to use registers better */
J
Joe Perches 已提交
366 367
static noinline_for_stack
char *put_dec(char *buf, unsigned long long num)
368 369 370 371 372 373 374 375 376 377
{
	while (1) {
		unsigned rem;
		if (num < 100000)
			return put_dec_trunc(buf, num);
		rem = do_div(num, 100000);
		buf = put_dec_full(buf, rem);
	}
}

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

386 387
enum format_type {
	FORMAT_TYPE_NONE, /* Just a string part */
388
	FORMAT_TYPE_WIDTH,
389 390 391 392 393 394 395 396 397
	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,
398 399
	FORMAT_TYPE_UBYTE,
	FORMAT_TYPE_BYTE,
400 401 402 403 404 405 406 407 408 409
	FORMAT_TYPE_USHORT,
	FORMAT_TYPE_SHORT,
	FORMAT_TYPE_UINT,
	FORMAT_TYPE_INT,
	FORMAT_TYPE_NRCHARS,
	FORMAT_TYPE_SIZE_T,
	FORMAT_TYPE_PTRDIFF
};

struct printf_spec {
410
	u8	type;		/* format_type enum */
411
	u8	flags;		/* flags to number() */
412 413 414 415
	u8	base;		/* number base, 8, 10 or 16 only */
	u8	qualifier;	/* number qualifier, one of 'hHlLtzZ' */
	s16	field_width;	/* width of output field */
	s16	precision;	/* # of digits/chars */
416 417
};

J
Joe Perches 已提交
418 419 420
static noinline_for_stack
char *number(char *buf, char *end, unsigned long long num,
	     struct printf_spec spec)
L
Linus Torvalds 已提交
421
{
422 423 424 425 426 427
	/* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
	static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */

	char tmp[66];
	char sign;
	char locase;
428
	int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
L
Linus Torvalds 已提交
429 430
	int i;

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

	/* generate full string in tmp[], in reverse order */
L
Linus Torvalds 已提交
457 458
	i = 0;
	if (num == 0)
459
		tmp[i++] = '0';
460 461
	/* Generic code, for any base:
	else do {
462
		tmp[i++] = (digits[do_div(num,base)] | locase);
463 464
	} while (num != 0);
	*/
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++] = (digits[((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 > spec.precision)
		spec.precision = i;
482
	/* leading space padding */
483 484
	spec.field_width -= spec.precision;
	if (!(spec.flags & (ZEROPAD+LEFT))) {
485
		while (--spec.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 499 500 501
	/* "0x" / "0" prefix */
	if (need_pfx) {
		if (buf < end)
			*buf = '0';
		++buf;
502
		if (spec.base == 16) {
503
			if (buf < end)
504
				*buf = ('X' | locase);
L
Linus Torvalds 已提交
505 506 507
			++buf;
		}
	}
508
	/* zero or space padding */
509 510 511
	if (!(spec.flags & LEFT)) {
		char c = (spec.flags & ZEROPAD) ? '0' : ' ';
		while (--spec.field_width >= 0) {
512
			if (buf < end)
L
Linus Torvalds 已提交
513 514 515 516
				*buf = c;
			++buf;
		}
	}
517
	/* hmm even more zero padding? */
518
	while (i <= --spec.precision) {
519
		if (buf < end)
L
Linus Torvalds 已提交
520 521 522
			*buf = '0';
		++buf;
	}
523 524
	/* actual digits of result */
	while (--i >= 0) {
525
		if (buf < end)
L
Linus Torvalds 已提交
526 527 528
			*buf = tmp[i];
		++buf;
	}
529
	/* trailing space padding */
530
	while (--spec.field_width >= 0) {
531
		if (buf < end)
L
Linus Torvalds 已提交
532 533 534
			*buf = ' ';
		++buf;
	}
535

L
Linus Torvalds 已提交
536 537 538
	return buf;
}

J
Joe Perches 已提交
539 540
static noinline_for_stack
char *string(char *buf, char *end, const char *s, struct printf_spec spec)
541 542 543 544
{
	int len, i;

	if ((unsigned long)s < PAGE_SIZE)
545
		s = "(null)";
546

547
	len = strnlen(s, spec.precision);
548

549 550
	if (!(spec.flags & LEFT)) {
		while (len < spec.field_width--) {
551 552 553 554 555 556 557 558 559 560
			if (buf < end)
				*buf = ' ';
			++buf;
		}
	}
	for (i = 0; i < len; ++i) {
		if (buf < end)
			*buf = *s;
		++buf; ++s;
	}
561
	while (len < spec.field_width--) {
562 563 564 565
		if (buf < end)
			*buf = ' ';
		++buf;
	}
566

567 568 569
	return buf;
}

J
Joe Perches 已提交
570 571 572
static noinline_for_stack
char *symbol_string(char *buf, char *end, void *ptr,
		    struct printf_spec spec, char ext)
573 574 575 576
{
	unsigned long value = (unsigned long) ptr;
#ifdef CONFIG_KALLSYMS
	char sym[KSYM_SYMBOL_LEN];
577
	if (ext != 'f' && ext != 's')
578 579 580
		sprint_symbol(sym, value);
	else
		kallsyms_lookup(value, NULL, NULL, NULL, sym);
581

582
	return string(buf, end, sym, spec);
583
#else
584
	spec.field_width = 2 * sizeof(void *);
585 586
	spec.flags |= SPECIAL | SMALL | ZEROPAD;
	spec.base = 16;
587

588
	return number(buf, end, value, spec);
589 590 591
#endif
}

J
Joe Perches 已提交
592 593 594
static noinline_for_stack
char *resource_string(char *buf, char *end, struct resource *res,
		      struct printf_spec spec, const char *fmt)
595 596
{
#ifndef IO_RSRC_PRINTK_SIZE
597
#define IO_RSRC_PRINTK_SIZE	6
598 599 600
#endif

#ifndef MEM_RSRC_PRINTK_SIZE
601
#define MEM_RSRC_PRINTK_SIZE	10
602
#endif
603
	static const struct printf_spec io_spec = {
604
		.base = 16,
605
		.field_width = IO_RSRC_PRINTK_SIZE,
606 607 608
		.precision = -1,
		.flags = SPECIAL | SMALL | ZEROPAD,
	};
609 610 611 612 613 614
	static const struct printf_spec mem_spec = {
		.base = 16,
		.field_width = MEM_RSRC_PRINTK_SIZE,
		.precision = -1,
		.flags = SPECIAL | SMALL | ZEROPAD,
	};
B
Bjorn Helgaas 已提交
615 616 617 618 619 620
	static const struct printf_spec bus_spec = {
		.base = 16,
		.field_width = 2,
		.precision = -1,
		.flags = SMALL | ZEROPAD,
	};
621
	static const struct printf_spec dec_spec = {
622 623 624 625
		.base = 10,
		.precision = -1,
		.flags = 0,
	};
626
	static const struct printf_spec str_spec = {
627 628 629 630
		.field_width = -1,
		.precision = 10,
		.flags = LEFT,
	};
631
	static const struct printf_spec flag_spec = {
632 633 634 635
		.base = 16,
		.precision = -1,
		.flags = SPECIAL | SMALL,
	};
636 637 638 639 640

	/* 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 已提交
641
#define DECODED_BUF_SIZE	sizeof("[mem - 64bit pref window disabled]")
642 643 644 645
#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)];

646
	char *p = sym, *pend = sym + sizeof(sym);
647
	int decode = (fmt[0] == 'R') ? 1 : 0;
648
	const struct printf_spec *specp;
649 650

	*p++ = '[';
651
	if (res->flags & IORESOURCE_IO) {
652
		p = string(p, pend, "io  ", str_spec);
653 654
		specp = &io_spec;
	} else if (res->flags & IORESOURCE_MEM) {
655
		p = string(p, pend, "mem ", str_spec);
656 657
		specp = &mem_spec;
	} else if (res->flags & IORESOURCE_IRQ) {
658
		p = string(p, pend, "irq ", str_spec);
659 660
		specp = &dec_spec;
	} else if (res->flags & IORESOURCE_DMA) {
661
		p = string(p, pend, "dma ", str_spec);
662
		specp = &dec_spec;
B
Bjorn Helgaas 已提交
663 664 665
	} else if (res->flags & IORESOURCE_BUS) {
		p = string(p, pend, "bus ", str_spec);
		specp = &bus_spec;
666
	} else {
667
		p = string(p, pend, "??? ", str_spec);
668
		specp = &mem_spec;
669
		decode = 0;
670
	}
671
	p = number(p, pend, res->start, *specp);
672 673
	if (res->start != res->end) {
		*p++ = '-';
674
		p = number(p, pend, res->end, *specp);
675
	}
676
	if (decode) {
677 678 679 680
		if (res->flags & IORESOURCE_MEM_64)
			p = string(p, pend, " 64bit", str_spec);
		if (res->flags & IORESOURCE_PREFETCH)
			p = string(p, pend, " pref", str_spec);
B
Bjorn Helgaas 已提交
681 682
		if (res->flags & IORESOURCE_WINDOW)
			p = string(p, pend, " window", str_spec);
683 684
		if (res->flags & IORESOURCE_DISABLED)
			p = string(p, pend, " disabled", str_spec);
685 686 687
	} else {
		p = string(p, pend, " flags ", str_spec);
		p = number(p, pend, res->flags, flag_spec);
688
	}
689
	*p++ = ']';
690
	*p = '\0';
691

692
	return string(buf, end, sym, spec);
693 694
}

J
Joe Perches 已提交
695 696 697
static noinline_for_stack
char *mac_address_string(char *buf, char *end, u8 *addr,
			 struct printf_spec spec, const char *fmt)
698
{
699
	char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
700 701
	char *p = mac_addr;
	int i;
702 703 704 705 706 707 708
	char separator;

	if (fmt[1] == 'F') {		/* FDDI canonical format */
		separator = '-';
	} else {
		separator = ':';
	}
709 710

	for (i = 0; i < 6; i++) {
711
		p = pack_hex_byte(p, addr[i]);
712
		if (fmt[0] == 'M' && i != 5)
713
			*p++ = separator;
714 715 716
	}
	*p = '\0';

717
	return string(buf, end, mac_addr, spec);
718 719
}

J
Joe Perches 已提交
720 721
static noinline_for_stack
char *ip4_string(char *p, const u8 *addr, const char *fmt)
722 723
{
	int i;
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
	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;
	}
749 750
	for (i = 0; i < 4; i++) {
		char temp[3];	/* hold each IP quad in reverse order */
751
		int digits = put_dec_trunc(temp, addr[index]) - temp;
752 753 754 755 756 757 758 759 760 761 762
		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++ = '.';
763
		index += step;
764 765
	}
	*p = '\0';
766

767 768 769
	return p;
}

J
Joe Perches 已提交
770 771
static noinline_for_stack
char *ip6_compressed_string(char *p, const char *addr)
772
{
773
	int i, j, range;
774 775 776 777
	unsigned char zerolength[8];
	int longest = 1;
	int colonpos = -1;
	u16 word;
778
	u8 hi, lo;
779
	bool needcolon = false;
780 781 782 783 784 785
	bool useIPv4;
	struct in6_addr in6;

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

	useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
786 787 788 789 790 791 792 793 794 795 796

	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++) {
797
			if (in6.s6_addr16[j] != 0)
798 799 800 801 802 803 804 805 806 807
				break;
			zerolength[i]++;
		}
	}
	for (i = 0; i < range; i++) {
		if (zerolength[i] > longest) {
			longest = zerolength[i];
			colonpos = i;
		}
	}
808

809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
	/* 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 */
824
		word = ntohs(in6.s6_addr16[i]);
825 826 827 828 829 830 831
		hi = word >> 8;
		lo = word & 0xff;
		if (hi) {
			if (hi > 0x0f)
				p = pack_hex_byte(p, hi);
			else
				*p++ = hex_asc_lo(hi);
832
			p = pack_hex_byte(p, lo);
833
		}
834
		else if (lo > 0x0f)
835 836 837 838 839 840 841 842 843
			p = pack_hex_byte(p, lo);
		else
			*p++ = hex_asc_lo(lo);
		needcolon = true;
	}

	if (useIPv4) {
		if (needcolon)
			*p++ = ':';
844
		p = ip4_string(p, &in6.s6_addr[12], "I4");
845 846
	}
	*p = '\0';
847

848 849 850
	return p;
}

J
Joe Perches 已提交
851 852
static noinline_for_stack
char *ip6_string(char *p, const char *addr, const char *fmt)
853 854
{
	int i;
855

856
	for (i = 0; i < 8; i++) {
857 858
		p = pack_hex_byte(p, *addr++);
		p = pack_hex_byte(p, *addr++);
859
		if (fmt[0] == 'I' && i != 7)
860 861 862
			*p++ = ':';
	}
	*p = '\0';
863

864 865 866
	return p;
}

J
Joe Perches 已提交
867 868 869
static noinline_for_stack
char *ip6_addr_string(char *buf, char *end, const u8 *addr,
		      struct printf_spec spec, const char *fmt)
870 871 872 873
{
	char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];

	if (fmt[0] == 'I' && fmt[2] == 'c')
874
		ip6_compressed_string(ip6_addr, addr);
875
	else
876
		ip6_string(ip6_addr, addr, fmt);
877

878
	return string(buf, end, ip6_addr, spec);
879 880
}

J
Joe Perches 已提交
881 882 883
static noinline_for_stack
char *ip4_addr_string(char *buf, char *end, const u8 *addr,
		      struct printf_spec spec, const char *fmt)
884
{
885
	char ip4_addr[sizeof("255.255.255.255")];
886

887
	ip4_string(ip4_addr, addr, fmt);
888

889
	return string(buf, end, ip4_addr, spec);
890 891
}

J
Joe Perches 已提交
892 893 894
static noinline_for_stack
char *uuid_string(char *buf, char *end, const u8 *addr,
		  struct printf_spec spec, const char *fmt)
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
{
	char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
	char *p = uuid;
	int i;
	static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
	static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
	const u8 *index = be;
	bool uc = false;

	switch (*(++fmt)) {
	case 'L':
		uc = true;		/* fall-through */
	case 'l':
		index = le;
		break;
	case 'B':
		uc = true;
		break;
	}

	for (i = 0; i < 16; i++) {
		p = pack_hex_byte(p, addr[index[i]]);
		switch (i) {
		case 3:
		case 5:
		case 7:
		case 9:
			*p++ = '-';
			break;
		}
	}

	*p = 0;

	if (uc) {
		p = uuid;
		do {
			*p = toupper(*p);
		} while (*(++p));
	}

	return string(buf, end, uuid, spec);
}

939 940
int kptr_restrict = 1;

941 942 943 944 945
/*
 * 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.
 *
946 947
 * Right now we handle:
 *
948 949
 * - 'F' For symbolic function descriptor pointers with offset
 * - 'f' For simple symbolic function names without offset
950 951
 * - 'S' For symbolic direct pointers with offset
 * - 's' For symbolic direct pointers without offset
952 953
 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
954 955
 * - 'M' For a 6-byte MAC address, it prints the address in the
 *       usual colon-separated hex notation
956
 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
957
 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
958
 *       with a dash-separated hex notation
959 960 961 962 963 964
 * - '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
 * - '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)
965
 * - '[Ii]4[hnbl]' IPv4 addresses in host, network, big or little endian order
966
 * - 'I6c' for IPv6 addresses printed as specified by
967
 *       http://tools.ietf.org/html/draft-ietf-6man-text-addr-representation-00
968 969 970 971 972 973 974 975 976 977 978
 * - '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]
979 980 981 982 983
 * - '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.
984
 * - 'K' For a kernel pointer that should be hidden from unprivileged users
985
 *
986 987 988
 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
 * function pointers are really function descriptors, which contain a
 * pointer to the real address.
989
 */
J
Joe Perches 已提交
990 991 992
static noinline_for_stack
char *pointer(const char *fmt, char *buf, char *end, void *ptr,
	      struct printf_spec spec)
993
{
994 995 996 997 998 999 1000
	if (!ptr) {
		/*
		 * Print (null) with the same width as a pointer so it makes
		 * tabular output look nice.
		 */
		if (spec.field_width == -1)
			spec.field_width = 2 * sizeof(void *);
1001
		return string(buf, end, "(null)", spec);
1002
	}
1003

1004 1005
	switch (*fmt) {
	case 'F':
1006
	case 'f':
1007 1008 1009
		ptr = dereference_function_descriptor(ptr);
		/* Fallthrough */
	case 'S':
1010
	case 's':
1011
		return symbol_string(buf, end, ptr, spec, *fmt);
1012
	case 'R':
1013
	case 'r':
1014
		return resource_string(buf, end, ptr, spec, fmt);
1015 1016
	case 'M':			/* Colon separated: 00:01:02:03:04:05 */
	case 'm':			/* Contiguous: 000102030405 */
1017
					/* [mM]F (FDDI, bit reversed) */
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
		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
					 */
		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);
		}
1034
		break;
1035 1036
	case 'U':
		return uuid_string(buf, end, ptr, spec, fmt);
1037 1038 1039 1040
	case 'V':
		return buf + vsnprintf(buf, end - buf,
				       ((struct va_format *)ptr)->fmt,
				       *(((struct va_format *)ptr)->va));
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
	case 'K':
		/*
		 * %pK 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(void *);
			return string(buf, end, "pK-error", spec);
		} else if ((kptr_restrict == 0) ||
			 (kptr_restrict == 1 &&
			  has_capability_noaudit(current, CAP_SYSLOG)))
			break;

		if (spec.field_width == -1) {
			spec.field_width = 2 * sizeof(void *);
			spec.flags |= ZEROPAD;
		}
		return number(buf, end, 0, spec);
1060 1061 1062
	}
	spec.flags |= SMALL;
	if (spec.field_width == -1) {
1063
		spec.field_width = 2 * sizeof(void *);
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
		spec.flags |= ZEROPAD;
	}
	spec.base = 16;

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

/*
 * 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
 * '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 已提交
1091 1092
static noinline_for_stack
int format_decode(const char *fmt, struct printf_spec *spec)
1093 1094 1095 1096
{
	const char *start = fmt;

	/* we finished early by reading the field width */
1097
	if (spec->type == FORMAT_TYPE_WIDTH) {
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
		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 */
1155
		spec->type = FORMAT_TYPE_WIDTH;
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
		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 */
1170
			spec->type = FORMAT_TYPE_PRECISION;
1171 1172 1173 1174 1175 1176 1177
			return ++fmt - start;
		}
	}

qualifier:
	/* get the conversion qualifier */
	spec->qualifier = -1;
1178 1179
	if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
	    TOLOWER(*fmt) == 'z' || *fmt == 't') {
1180 1181 1182 1183 1184 1185 1186 1187 1188
		spec->qualifier = *fmt++;
		if (unlikely(spec->qualifier == *fmt)) {
			if (spec->qualifier == 'l') {
				spec->qualifier = 'L';
				++fmt;
			} else if (spec->qualifier == 'h') {
				spec->qualifier = 'H';
				++fmt;
			}
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 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
		}
	}

	/* 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;
		return fmt - start;
		/* skip alnum */

	case 'n':
		spec->type = FORMAT_TYPE_NRCHARS;
		return ++fmt - start;

	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;

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

	case 'd':
	case 'i':
1230
		spec->flags |= SIGN;
1231
	case 'u':
1232
		break;
1233 1234 1235 1236

	default:
		spec->type = FORMAT_TYPE_INVALID;
		return fmt - start;
1237
	}
1238 1239 1240 1241

	if (spec->qualifier == 'L')
		spec->type = FORMAT_TYPE_LONG_LONG;
	else if (spec->qualifier == 'l') {
1242
		if (spec->flags & SIGN)
1243 1244 1245
			spec->type = FORMAT_TYPE_LONG;
		else
			spec->type = FORMAT_TYPE_ULONG;
1246
	} else if (TOLOWER(spec->qualifier) == 'z') {
1247 1248 1249
		spec->type = FORMAT_TYPE_SIZE_T;
	} else if (spec->qualifier == 't') {
		spec->type = FORMAT_TYPE_PTRDIFF;
1250 1251 1252 1253 1254
	} else if (spec->qualifier == 'H') {
		if (spec->flags & SIGN)
			spec->type = FORMAT_TYPE_BYTE;
		else
			spec->type = FORMAT_TYPE_UBYTE;
1255
	} else if (spec->qualifier == 'h') {
1256
		if (spec->flags & SIGN)
1257 1258 1259 1260
			spec->type = FORMAT_TYPE_SHORT;
		else
			spec->type = FORMAT_TYPE_USHORT;
	} else {
1261
		if (spec->flags & SIGN)
1262 1263 1264
			spec->type = FORMAT_TYPE_INT;
		else
			spec->type = FORMAT_TYPE_UINT;
1265
	}
1266 1267

	return ++fmt - start;
1268 1269
}

L
Linus Torvalds 已提交
1270 1271 1272 1273 1274 1275 1276
/**
 * 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
 *
1277
 * This function follows C99 vsnprintf, but has some extensions:
1278 1279
 * %pS output the name of a text symbol with offset
 * %ps output the name of a text symbol without offset
1280 1281
 * %pF output the name of a function pointer with its offset
 * %pf output the name of a function pointer without its offset
1282 1283 1284 1285 1286 1287 1288 1289 1290
 * %pR output the address range in a struct resource with decoded flags
 * %pr output the address range in a struct resource with raw flags
 * %pM output a 6-byte MAC address with colons
 * %pm output a 6-byte MAC address without colons
 * %pI4 print an IPv4 address without leading zeros
 * %pi4 print an IPv4 address with leading zeros
 * %pI6 print an IPv6 address with colons
 * %pi6 print an IPv6 address without colons
 * %pI6c print an IPv6 address as specified by
1291
 *   http://tools.ietf.org/html/draft-ietf-6man-text-addr-representation-00
1292 1293
 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
 *   case.
1294
 * %n is ignored
1295
 *
L
Linus Torvalds 已提交
1296 1297 1298 1299
 * 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
1300
 * (not including the trailing '\0'), use vscnprintf(). If the
L
Linus Torvalds 已提交
1301 1302 1303 1304
 * return is greater than or equal to @size, the resulting
 * string is truncated.
 *
 * Call this function if you are already dealing with a va_list.
1305
 * You probably want snprintf() instead.
L
Linus Torvalds 已提交
1306 1307 1308 1309
 */
int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
{
	unsigned long long num;
1310
	char *str, *end;
1311
	struct printf_spec spec = {0};
L
Linus Torvalds 已提交
1312

1313 1314
	/* Reject out-of-range values early.  Large positive sizes are
	   used for unknown buffer sizes. */
M
Marcin Slusarz 已提交
1315
	if (WARN_ON_ONCE((int) size < 0))
L
Linus Torvalds 已提交
1316 1317 1318
		return 0;

	str = buf;
1319
	end = buf + size;
L
Linus Torvalds 已提交
1320

1321 1322 1323 1324
	/* Make sure end is always >= buf */
	if (end < buf) {
		end = ((void *)-1);
		size = end - buf;
L
Linus Torvalds 已提交
1325 1326
	}

1327 1328
	while (*fmt) {
		const char *old_fmt = fmt;
1329
		int read = format_decode(fmt, &spec);
L
Linus Torvalds 已提交
1330

1331
		fmt += read;
L
Linus Torvalds 已提交
1332

1333 1334 1335 1336 1337 1338 1339
		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 已提交
1340
			}
1341 1342
			str += read;
			break;
L
Linus Torvalds 已提交
1343 1344
		}

1345
		case FORMAT_TYPE_WIDTH:
1346 1347
			spec.field_width = va_arg(args, int);
			break;
L
Linus Torvalds 已提交
1348

1349 1350 1351
		case FORMAT_TYPE_PRECISION:
			spec.precision = va_arg(args, int);
			break;
L
Linus Torvalds 已提交
1352

1353 1354 1355
		case FORMAT_TYPE_CHAR: {
			char c;

1356 1357
			if (!(spec.flags & LEFT)) {
				while (--spec.field_width > 0) {
1358
					if (str < end)
L
Linus Torvalds 已提交
1359 1360 1361
						*str = ' ';
					++str;

1362 1363 1364 1365 1366 1367 1368
				}
			}
			c = (unsigned char) va_arg(args, int);
			if (str < end)
				*str = c;
			++str;
			while (--spec.field_width > 0) {
1369
				if (str < end)
1370
					*str = ' ';
L
Linus Torvalds 已提交
1371
				++str;
1372 1373
			}
			break;
1374
		}
L
Linus Torvalds 已提交
1375

1376 1377 1378
		case FORMAT_TYPE_STR:
			str = string(str, end, va_arg(args, char *), spec);
			break;
L
Linus Torvalds 已提交
1379

1380 1381 1382 1383 1384 1385
		case FORMAT_TYPE_PTR:
			str = pointer(fmt+1, str, end, va_arg(args, void *),
				      spec);
			while (isalnum(*fmt))
				fmt++;
			break;
L
Linus Torvalds 已提交
1386

1387 1388 1389 1390 1391
		case FORMAT_TYPE_PERCENT_CHAR:
			if (str < end)
				*str = '%';
			++str;
			break;
L
Linus Torvalds 已提交
1392

1393 1394 1395 1396 1397 1398 1399
		case FORMAT_TYPE_INVALID:
			if (str < end)
				*str = '%';
			++str;
			break;

		case FORMAT_TYPE_NRCHARS: {
1400
			u8 qualifier = spec.qualifier;
1401 1402 1403 1404

			if (qualifier == 'l') {
				long *ip = va_arg(args, long *);
				*ip = (str - buf);
1405
			} else if (TOLOWER(qualifier) == 'z') {
1406 1407 1408 1409 1410 1411 1412
				size_t *ip = va_arg(args, size_t *);
				*ip = (str - buf);
			} else {
				int *ip = va_arg(args, int *);
				*ip = (str - buf);
			}
			break;
L
Linus Torvalds 已提交
1413
		}
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431

		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:
				num = va_arg(args, size_t);
				break;
			case FORMAT_TYPE_PTRDIFF:
				num = va_arg(args, ptrdiff_t);
				break;
1432 1433 1434 1435 1436 1437
			case FORMAT_TYPE_UBYTE:
				num = (unsigned char) va_arg(args, int);
				break;
			case FORMAT_TYPE_BYTE:
				num = (signed char) va_arg(args, int);
				break;
1438 1439 1440 1441 1442 1443
			case FORMAT_TYPE_USHORT:
				num = (unsigned short) va_arg(args, int);
				break;
			case FORMAT_TYPE_SHORT:
				num = (short) va_arg(args, int);
				break;
1444 1445
			case FORMAT_TYPE_INT:
				num = (int) va_arg(args, int);
1446 1447 1448 1449 1450 1451
				break;
			default:
				num = va_arg(args, unsigned int);
			}

			str = number(str, end, num, spec);
L
Linus Torvalds 已提交
1452 1453
		}
	}
1454

1455 1456 1457 1458
	if (size > 0) {
		if (str < end)
			*str = '\0';
		else
L
Linus Torvalds 已提交
1459
			end[-1] = '\0';
1460
	}
1461

1462
	/* the trailing null byte doesn't count towards the total */
L
Linus Torvalds 已提交
1463
	return str-buf;
1464

L
Linus Torvalds 已提交
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
}
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
 * the @buf not including the trailing '\0'. If @size is <= 0 the function
 * returns 0.
 *
 * Call this function if you are already dealing with a va_list.
1480
 * You probably want scnprintf() instead.
1481 1482
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1483 1484 1485 1486 1487
 */
int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
{
	int i;

1488 1489
	i = vsnprintf(buf, size, fmt, args);

L
Linus Torvalds 已提交
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
	return (i >= size) ? (size - 1) : i;
}
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.
1505 1506
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1507
 */
1508
int snprintf(char *buf, size_t size, const char *fmt, ...)
L
Linus Torvalds 已提交
1509 1510 1511 1512 1513
{
	va_list args;
	int i;

	va_start(args, fmt);
1514
	i = vsnprintf(buf, size, fmt, args);
L
Linus Torvalds 已提交
1515
	va_end(args);
1516

L
Linus Torvalds 已提交
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
	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
1529
 * the trailing '\0'. If @size is == 0 the function returns 0.
L
Linus Torvalds 已提交
1530 1531
 */

1532
int scnprintf(char *buf, size_t size, const char *fmt, ...)
L
Linus Torvalds 已提交
1533 1534 1535 1536 1537 1538 1539
{
	va_list args;
	int i;

	va_start(args, fmt);
	i = vsnprintf(buf, size, fmt, args);
	va_end(args);
1540

1541 1542 1543 1544 1545
	if (likely(i < size))
		return i;
	if (size != 0)
		return size - 1;
	return 0;
L
Linus Torvalds 已提交
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
}
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
1556
 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
L
Linus Torvalds 已提交
1557 1558 1559
 * buffer overflows.
 *
 * Call this function if you are already dealing with a va_list.
1560
 * You probably want sprintf() instead.
1561 1562
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
 */
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
1577
 * into @buf. Use snprintf() or scnprintf() in order to avoid
L
Linus Torvalds 已提交
1578
 * buffer overflows.
1579 1580
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1581
 */
1582
int sprintf(char *buf, const char *fmt, ...)
L
Linus Torvalds 已提交
1583 1584 1585 1586 1587
{
	va_list args;
	int i;

	va_start(args, fmt);
1588
	i = vsnprintf(buf, INT_MAX, fmt, args);
L
Linus Torvalds 已提交
1589
	va_end(args);
1590

L
Linus Torvalds 已提交
1591 1592 1593 1594
	return i;
}
EXPORT_SYMBOL(sprintf);

L
Lai Jiangshan 已提交
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
#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
 * is skiped.
 *
 * 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)
{
1621
	struct printf_spec spec = {0};
L
Lai Jiangshan 已提交
1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
	char *str, *end;

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

#define save_arg(type)							\
do {									\
	if (sizeof(type) == 8) {					\
		unsigned long long value;				\
		str = PTR_ALIGN(str, sizeof(u32));			\
		value = va_arg(args, unsigned long long);		\
		if (str + sizeof(type) <= end) {			\
			*(u32 *)str = *(u32 *)&value;			\
			*(u32 *)(str + 4) = *((u32 *)&value + 1);	\
		}							\
	} else {							\
		unsigned long value;					\
		str = PTR_ALIGN(str, sizeof(type));			\
		value = va_arg(args, int);				\
		if (str + sizeof(type) <= end)				\
			*(typeof(type) *)str = (type)value;		\
	}								\
	str += sizeof(type);						\
} while (0)

1647
	while (*fmt) {
1648
		int read = format_decode(fmt, &spec);
L
Lai Jiangshan 已提交
1649

1650
		fmt += read;
L
Lai Jiangshan 已提交
1651

1652 1653
		switch (spec.type) {
		case FORMAT_TYPE_NONE:
1654 1655
		case FORMAT_TYPE_INVALID:
		case FORMAT_TYPE_PERCENT_CHAR:
1656 1657
			break;

1658
		case FORMAT_TYPE_WIDTH:
1659 1660 1661 1662 1663
		case FORMAT_TYPE_PRECISION:
			save_arg(int);
			break;

		case FORMAT_TYPE_CHAR:
L
Lai Jiangshan 已提交
1664
			save_arg(char);
1665 1666 1667
			break;

		case FORMAT_TYPE_STR: {
L
Lai Jiangshan 已提交
1668 1669
			const char *save_str = va_arg(args, char *);
			size_t len;
1670

L
Lai Jiangshan 已提交
1671 1672
			if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
					|| (unsigned long)save_str < PAGE_SIZE)
1673
				save_str = "(null)";
1674 1675 1676 1677
			len = strlen(save_str) + 1;
			if (str + len < end)
				memcpy(str, save_str, len);
			str += len;
1678
			break;
L
Lai Jiangshan 已提交
1679
		}
1680 1681

		case FORMAT_TYPE_PTR:
L
Lai Jiangshan 已提交
1682 1683
			save_arg(void *);
			/* skip all alphanumeric pointer suffixes */
1684
			while (isalnum(*fmt))
L
Lai Jiangshan 已提交
1685
				fmt++;
1686 1687 1688
			break;

		case FORMAT_TYPE_NRCHARS: {
L
Lai Jiangshan 已提交
1689
			/* skip %n 's argument */
1690
			u8 qualifier = spec.qualifier;
L
Lai Jiangshan 已提交
1691 1692 1693
			void *skip_arg;
			if (qualifier == 'l')
				skip_arg = va_arg(args, long *);
1694
			else if (TOLOWER(qualifier) == 'z')
L
Lai Jiangshan 已提交
1695 1696 1697
				skip_arg = va_arg(args, size_t *);
			else
				skip_arg = va_arg(args, int *);
1698
			break;
L
Lai Jiangshan 已提交
1699
		}
1700 1701 1702 1703 1704

		default:
			switch (spec.type) {

			case FORMAT_TYPE_LONG_LONG:
L
Lai Jiangshan 已提交
1705
				save_arg(long long);
1706 1707 1708
				break;
			case FORMAT_TYPE_ULONG:
			case FORMAT_TYPE_LONG:
L
Lai Jiangshan 已提交
1709
				save_arg(unsigned long);
1710 1711
				break;
			case FORMAT_TYPE_SIZE_T:
L
Lai Jiangshan 已提交
1712
				save_arg(size_t);
1713 1714
				break;
			case FORMAT_TYPE_PTRDIFF:
L
Lai Jiangshan 已提交
1715
				save_arg(ptrdiff_t);
1716
				break;
1717 1718 1719 1720
			case FORMAT_TYPE_UBYTE:
			case FORMAT_TYPE_BYTE:
				save_arg(char);
				break;
1721 1722
			case FORMAT_TYPE_USHORT:
			case FORMAT_TYPE_SHORT:
L
Lai Jiangshan 已提交
1723
				save_arg(short);
1724 1725
				break;
			default:
L
Lai Jiangshan 已提交
1726
				save_arg(int);
1727
			}
L
Lai Jiangshan 已提交
1728 1729
		}
	}
1730

1731
	return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1732
#undef save_arg
L
Lai Jiangshan 已提交
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747
}
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:
1748
 *  see vsnprintf comment for details.
L
Lai Jiangshan 已提交
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759
 *
 * 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)
{
1760
	struct printf_spec spec = {0};
1761 1762
	char *str, *end;
	const char *args = (const char *)bin_buf;
L
Lai Jiangshan 已提交
1763

M
Marcin Slusarz 已提交
1764
	if (WARN_ON_ONCE((int) size < 0))
L
Lai Jiangshan 已提交
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
		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;
	}

1791 1792
	while (*fmt) {
		const char *old_fmt = fmt;
1793
		int read = format_decode(fmt, &spec);
L
Lai Jiangshan 已提交
1794

1795
		fmt += read;
L
Lai Jiangshan 已提交
1796

1797 1798 1799 1800 1801 1802 1803
		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 已提交
1804
			}
1805 1806
			str += read;
			break;
L
Lai Jiangshan 已提交
1807 1808
		}

1809
		case FORMAT_TYPE_WIDTH:
1810 1811
			spec.field_width = get_arg(int);
			break;
L
Lai Jiangshan 已提交
1812

1813 1814 1815
		case FORMAT_TYPE_PRECISION:
			spec.precision = get_arg(int);
			break;
L
Lai Jiangshan 已提交
1816

1817 1818 1819
		case FORMAT_TYPE_CHAR: {
			char c;

1820 1821
			if (!(spec.flags & LEFT)) {
				while (--spec.field_width > 0) {
L
Lai Jiangshan 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830
					if (str < end)
						*str = ' ';
					++str;
				}
			}
			c = (unsigned char) get_arg(char);
			if (str < end)
				*str = c;
			++str;
1831
			while (--spec.field_width > 0) {
L
Lai Jiangshan 已提交
1832 1833 1834 1835
				if (str < end)
					*str = ' ';
				++str;
			}
1836
			break;
1837
		}
L
Lai Jiangshan 已提交
1838

1839
		case FORMAT_TYPE_STR: {
L
Lai Jiangshan 已提交
1840
			const char *str_arg = args;
1841
			args += strlen(str_arg) + 1;
1842 1843
			str = string(str, end, (char *)str_arg, spec);
			break;
L
Lai Jiangshan 已提交
1844 1845
		}

1846 1847 1848
		case FORMAT_TYPE_PTR:
			str = pointer(fmt+1, str, end, get_arg(void *), spec);
			while (isalnum(*fmt))
L
Lai Jiangshan 已提交
1849
				fmt++;
1850
			break;
L
Lai Jiangshan 已提交
1851

1852 1853
		case FORMAT_TYPE_PERCENT_CHAR:
		case FORMAT_TYPE_INVALID:
L
Lai Jiangshan 已提交
1854 1855 1856
			if (str < end)
				*str = '%';
			++str;
1857 1858 1859 1860 1861 1862
			break;

		case FORMAT_TYPE_NRCHARS:
			/* skip */
			break;

1863 1864 1865
		default: {
			unsigned long long num;

1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880
			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;
1881 1882 1883 1884 1885 1886
			case FORMAT_TYPE_UBYTE:
				num = get_arg(unsigned char);
				break;
			case FORMAT_TYPE_BYTE:
				num = get_arg(signed char);
				break;
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900
			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);
1901 1902 1903
		} /* default: */
		} /* switch(spec.type) */
	} /* while(*fmt) */
1904

L
Lai Jiangshan 已提交
1905 1906 1907 1908 1909 1910
	if (size > 0) {
		if (str < end)
			*str = '\0';
		else
			end[-1] = '\0';
	}
1911

L
Lai Jiangshan 已提交
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936
#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);
1937

L
Lai Jiangshan 已提交
1938 1939 1940 1941 1942 1943
	return ret;
}
EXPORT_SYMBOL_GPL(bprintf);

#endif /* CONFIG_BINARY_PRINTF */

L
Linus Torvalds 已提交
1944 1945 1946 1947 1948 1949
/**
 * vsscanf - Unformat a buffer into a list of arguments
 * @buf:	input buffer
 * @fmt:	format of buffer
 * @args:	arguments
 */
1950
int vsscanf(const char *buf, const char *fmt, va_list args)
L
Linus Torvalds 已提交
1951 1952 1953 1954 1955
{
	const char *str = buf;
	char *next;
	char digit;
	int num = 0;
1956 1957 1958
	u8 qualifier;
	u8 base;
	s16 field_width;
1959
	bool is_sign;
L
Linus Torvalds 已提交
1960

1961
	while (*fmt && *str) {
L
Linus Torvalds 已提交
1962 1963 1964 1965 1966
		/* skip any white space in format */
		/* white space in format matchs any amount of
		 * white space, including none, in the input.
		 */
		if (isspace(*fmt)) {
1967 1968
			fmt = skip_spaces(++fmt);
			str = skip_spaces(str);
L
Linus Torvalds 已提交
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980
		}

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

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

L
Linus Torvalds 已提交
1982 1983 1984 1985
		/* skip this conversion.
		 * advance both strings to next white space
		 */
		if (*fmt == '*') {
A
Andy Spencer 已提交
1986
			while (!isspace(*fmt) && *fmt != '%' && *fmt)
L
Linus Torvalds 已提交
1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
				fmt++;
			while (!isspace(*str) && *str)
				str++;
			continue;
		}

		/* get field width */
		field_width = -1;
		if (isdigit(*fmt))
			field_width = skip_atoi(&fmt);

		/* get conversion qualifier */
		qualifier = -1;
2000 2001
		if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
		    TOLOWER(*fmt) == 'z') {
L
Linus Torvalds 已提交
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016
			qualifier = *fmt++;
			if (unlikely(qualifier == *fmt)) {
				if (qualifier == 'h') {
					qualifier = 'H';
					fmt++;
				} else if (qualifier == 'l') {
					qualifier = 'L';
					fmt++;
				}
			}
		}

		if (!*fmt || !*str)
			break;

2017 2018 2019
		base = 10;
		is_sign = 0;

2020
		switch (*fmt++) {
L
Linus Torvalds 已提交
2021 2022
		case 'c':
		{
2023
			char *s = (char *)va_arg(args, char*);
L
Linus Torvalds 已提交
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033
			if (field_width == -1)
				field_width = 1;
			do {
				*s++ = *str++;
			} while (--field_width > 0 && *str);
			num++;
		}
		continue;
		case 's':
		{
2034 2035
			char *s = (char *)va_arg(args, char *);
			if (field_width == -1)
2036
				field_width = SHRT_MAX;
L
Linus Torvalds 已提交
2037
			/* first, skip leading white space in buffer */
2038
			str = skip_spaces(str);
L
Linus Torvalds 已提交
2039 2040

			/* now copy until next white space */
2041
			while (*str && !isspace(*str) && field_width--)
L
Linus Torvalds 已提交
2042 2043 2044 2045 2046 2047 2048 2049
				*s++ = *str++;
			*s = '\0';
			num++;
		}
		continue;
		case 'n':
			/* return number of characters read so far */
		{
2050
			int *i = (int *)va_arg(args, int*);
L
Linus Torvalds 已提交
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
			*i = str - buf;
		}
		continue;
		case 'o':
			base = 8;
			break;
		case 'x':
		case 'X':
			base = 16;
			break;
		case 'i':
2062
			base = 0;
L
Linus Torvalds 已提交
2063 2064 2065 2066 2067 2068
		case 'd':
			is_sign = 1;
		case 'u':
			break;
		case '%':
			/* looking for '%' in str */
2069
			if (*str++ != '%')
L
Linus Torvalds 已提交
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
				return num;
			continue;
		default:
			/* invalid format; stop here */
			return num;
		}

		/* have some sort of integer conversion.
		 * first, skip white space in buffer.
		 */
2080
		str = skip_spaces(str);
L
Linus Torvalds 已提交
2081 2082 2083 2084 2085 2086

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

		if (!digit
2087 2088 2089 2090 2091
		    || (base == 16 && !isxdigit(digit))
		    || (base == 10 && !isdigit(digit))
		    || (base == 8 && (!isdigit(digit) || digit > '7'))
		    || (base == 0 && !isdigit(digit)))
			break;
L
Linus Torvalds 已提交
2092

2093
		switch (qualifier) {
L
Linus Torvalds 已提交
2094 2095
		case 'H':	/* that's 'hh' in format */
			if (is_sign) {
2096 2097
				signed char *s = (signed char *)va_arg(args, signed char *);
				*s = (signed char)simple_strtol(str, &next, base);
L
Linus Torvalds 已提交
2098
			} else {
2099 2100
				unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
				*s = (unsigned char)simple_strtoul(str, &next, base);
L
Linus Torvalds 已提交
2101 2102 2103 2104
			}
			break;
		case 'h':
			if (is_sign) {
2105 2106
				short *s = (short *)va_arg(args, short *);
				*s = (short)simple_strtol(str, &next, base);
L
Linus Torvalds 已提交
2107
			} else {
2108 2109
				unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
				*s = (unsigned short)simple_strtoul(str, &next, base);
L
Linus Torvalds 已提交
2110 2111 2112 2113
			}
			break;
		case 'l':
			if (is_sign) {
2114 2115
				long *l = (long *)va_arg(args, long *);
				*l = simple_strtol(str, &next, base);
L
Linus Torvalds 已提交
2116
			} else {
2117 2118
				unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
				*l = simple_strtoul(str, &next, base);
L
Linus Torvalds 已提交
2119 2120 2121 2122
			}
			break;
		case 'L':
			if (is_sign) {
2123 2124
				long long *l = (long long *)va_arg(args, long long *);
				*l = simple_strtoll(str, &next, base);
L
Linus Torvalds 已提交
2125
			} else {
2126 2127
				unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
				*l = simple_strtoull(str, &next, base);
L
Linus Torvalds 已提交
2128 2129 2130 2131 2132
			}
			break;
		case 'Z':
		case 'z':
		{
2133 2134
			size_t *s = (size_t *)va_arg(args, size_t *);
			*s = (size_t)simple_strtoul(str, &next, base);
L
Linus Torvalds 已提交
2135 2136 2137 2138
		}
		break;
		default:
			if (is_sign) {
2139 2140
				int *i = (int *)va_arg(args, int *);
				*i = (int)simple_strtol(str, &next, base);
L
Linus Torvalds 已提交
2141
			} else {
2142 2143
				unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
				*i = (unsigned int)simple_strtoul(str, &next, base);
L
Linus Torvalds 已提交
2144 2145 2146 2147 2148 2149 2150 2151 2152
			}
			break;
		}
		num++;

		if (!next)
			break;
		str = next;
	}
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163

	/*
	 * Now we've come all the way through so either the input string or the
	 * format ended. In the former case, there can be a %n at the current
	 * position in the format that needs to be filled.
	 */
	if (*fmt == '%' && *(fmt + 1) == 'n') {
		int *p = (int *)va_arg(args, int *);
		*p = str - buf;
	}

L
Linus Torvalds 已提交
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
	return num;
}
EXPORT_SYMBOL(vsscanf);

/**
 * sscanf - Unformat a buffer into a list of arguments
 * @buf:	input buffer
 * @fmt:	formatting of buffer
 * @...:	resulting arguments
 */
2174
int sscanf(const char *buf, const char *fmt, ...)
L
Linus Torvalds 已提交
2175 2176 2177 2178
{
	va_list args;
	int i;

2179 2180
	va_start(args, fmt);
	i = vsscanf(buf, fmt, args);
L
Linus Torvalds 已提交
2181
	va_end(args);
2182

L
Linus Torvalds 已提交
2183 2184 2185
	return i;
}
EXPORT_SYMBOL(sscanf);