vsprintf.c 45.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 *  linux/lib/vsprintf.c
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 */

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

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

	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
		cp++;
	}
74

L
Linus Torvalds 已提交
75 76 77 78 79 80 81 82 83 84 85 86
	if (endp)
		*endp = (char *)cp;
	return result;
}
EXPORT_SYMBOL(simple_strtoul);

/**
 * simple_strtol - convert a string to a signed 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 已提交
87
long simple_strtol(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
88
{
H
Harvey Harrison 已提交
89 90 91
	if(*cp == '-')
		return -simple_strtoul(cp + 1, endp, base);
	return simple_strtoul(cp, endp, base);
L
Linus Torvalds 已提交
92 93 94 95 96 97 98 99 100
}
EXPORT_SYMBOL(simple_strtol);

/**
 * simple_strtoull - convert a string to an unsigned 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 已提交
101
unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
102
{
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
	unsigned long long result = 0;

	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 已提交
118 119
		cp++;
	}
120

L
Linus Torvalds 已提交
121 122 123 124 125 126 127 128 129 130 131 132
	if (endp)
		*endp = (char *)cp;
	return result;
}
EXPORT_SYMBOL(simple_strtoull);

/**
 * 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 已提交
133
long long simple_strtoll(const char *cp, char **endp, unsigned int base)
L
Linus Torvalds 已提交
134 135
{
	if(*cp=='-')
H
Harvey Harrison 已提交
136 137
		return -simple_strtoull(cp + 1, endp, base);
	return simple_strtoull(cp, endp, base);
L
Linus Torvalds 已提交
138 139
}

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
/**
 * 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.
 */
162 163 164 165 166 167 168 169 170 171 172 173
int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
{
	char *tail;
	unsigned long val;
	size_t len;

	*res = 0;
	len = strlen(cp);
	if (len == 0)
		return -EINVAL;

	val = simple_strtoul(cp, &tail, base);
174 175
	if (tail == cp)
		return -EINVAL;
176 177 178 179 180 181 182 183 184
	if ((*tail == '\0') ||
		((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
		*res = val;
		return 0;
	}

	return -EINVAL;
}
EXPORT_SYMBOL(strict_strtoul);
185 186 187 188 189 190 191 192 193 194 195 196 197

/**
 * 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.
 */
198 199 200 201 202 203 204 205 206 207 208 209 210 211
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);
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

/**
 * 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.
 */
235 236 237 238 239 240 241 242 243 244 245 246
int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
{
	char *tail;
	unsigned long long val;
	size_t len;

	*res = 0;
	len = strlen(cp);
	if (len == 0)
		return -EINVAL;

	val = simple_strtoull(cp, &tail, base);
247 248
	if (tail == cp)
		return -EINVAL;
249 250 251 252 253 254 255 256 257
	if ((*tail == '\0') ||
		((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
		*res = val;
		return 0;
	}

	return -EINVAL;
}
EXPORT_SYMBOL(strict_strtoull);
258 259 260 261 262 263 264 265 266 267 268 269 270

/**
 * 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.
 */
271 272 273 274 275 276 277 278 279 280
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);
	}
281

282 283
	return ret;
}
284 285
EXPORT_SYMBOL(strict_strtoll);

L
Linus Torvalds 已提交
286 287 288 289 290 291 292 293 294
static int skip_atoi(const char **s)
{
	int i=0;

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

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
/* 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. */
static char* put_dec_trunc(char *buf, unsigned q)
{
	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)
					*buf++ = q + '0';  /* most sign. digit */
			}
		}
	}
	return buf;
}
/* Same with if's removed. Always emits five digits */
static char* put_dec_full(char *buf, unsigned q)
{
	/* 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);

	/* 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)

	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';
	return buf;
}
/* No inlining helps gcc to use registers better */
static noinline char* put_dec(char *buf, unsigned long long num)
{
	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 已提交
392 393 394 395 396
#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 */
397 398
#define SMALL	32		/* Must be 32 == 0x20 */
#define SPECIAL	64		/* 0x */
L
Linus Torvalds 已提交
399

400 401
enum format_type {
	FORMAT_TYPE_NONE, /* Just a string part */
402
	FORMAT_TYPE_WIDTH,
403 404 405 406 407 408 409 410 411
	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,
412 413
	FORMAT_TYPE_UBYTE,
	FORMAT_TYPE_BYTE,
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
	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 {
	enum format_type	type;
	int			flags;		/* flags to number() */
	int			field_width;	/* width of output field */
	int			base;
	int			precision;	/* # of digits/chars */
	int			qualifier;
};

static char *number(char *buf, char *end, unsigned long long num,
			struct printf_spec spec)
L
Linus Torvalds 已提交
434
{
435 436 437 438 439 440
	/* 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;
441
	int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
L
Linus Torvalds 已提交
442 443
	int i;

444 445
	/* locase = 0 or 0x20. ORing digits or letters with 'locase'
	 * produces same digits or (maybe lowercased) letters */
446 447 448
	locase = (spec.flags & SMALL);
	if (spec.flags & LEFT)
		spec.flags &= ~ZEROPAD;
L
Linus Torvalds 已提交
449
	sign = 0;
450
	if (spec.flags & SIGN) {
L
Linus Torvalds 已提交
451 452 453
		if ((signed long long) num < 0) {
			sign = '-';
			num = - (signed long long) num;
454 455
			spec.field_width--;
		} else if (spec.flags & PLUS) {
L
Linus Torvalds 已提交
456
			sign = '+';
457 458
			spec.field_width--;
		} else if (spec.flags & SPACE) {
L
Linus Torvalds 已提交
459
			sign = ' ';
460
			spec.field_width--;
L
Linus Torvalds 已提交
461 462
		}
	}
463
	if (need_pfx) {
464 465 466
		spec.field_width--;
		if (spec.base == 16)
			spec.field_width--;
L
Linus Torvalds 已提交
467
	}
468 469

	/* generate full string in tmp[], in reverse order */
L
Linus Torvalds 已提交
470 471
	i = 0;
	if (num == 0)
472
		tmp[i++] = '0';
473 474
	/* Generic code, for any base:
	else do {
475
		tmp[i++] = (digits[do_div(num,base)] | locase);
476 477
	} while (num != 0);
	*/
478 479
	else if (spec.base != 10) { /* 8 or 16 */
		int mask = spec.base - 1;
480
		int shift = 3;
481
		if (spec.base == 16) shift = 4;
482
		do {
483
			tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
484 485
			num >>= shift;
		} while (num);
486 487 488
	} else { /* base 10 */
		i = put_dec(tmp, num) - tmp;
	}
489 490

	/* printing 100 using %2d gives "100", not "00" */
491 492
	if (i > spec.precision)
		spec.precision = i;
493
	/* leading space padding */
494 495 496
	spec.field_width -= spec.precision;
	if (!(spec.flags & (ZEROPAD+LEFT))) {
		while(--spec.field_width >= 0) {
497
			if (buf < end)
L
Linus Torvalds 已提交
498 499 500 501
				*buf = ' ';
			++buf;
		}
	}
502
	/* sign */
L
Linus Torvalds 已提交
503
	if (sign) {
504
		if (buf < end)
L
Linus Torvalds 已提交
505 506 507
			*buf = sign;
		++buf;
	}
508 509 510 511 512
	/* "0x" / "0" prefix */
	if (need_pfx) {
		if (buf < end)
			*buf = '0';
		++buf;
513
		if (spec.base == 16) {
514
			if (buf < end)
515
				*buf = ('X' | locase);
L
Linus Torvalds 已提交
516 517 518
			++buf;
		}
	}
519
	/* zero or space padding */
520 521 522
	if (!(spec.flags & LEFT)) {
		char c = (spec.flags & ZEROPAD) ? '0' : ' ';
		while (--spec.field_width >= 0) {
523
			if (buf < end)
L
Linus Torvalds 已提交
524 525 526 527
				*buf = c;
			++buf;
		}
	}
528
	/* hmm even more zero padding? */
529
	while (i <= --spec.precision) {
530
		if (buf < end)
L
Linus Torvalds 已提交
531 532 533
			*buf = '0';
		++buf;
	}
534 535
	/* actual digits of result */
	while (--i >= 0) {
536
		if (buf < end)
L
Linus Torvalds 已提交
537 538 539
			*buf = tmp[i];
		++buf;
	}
540
	/* trailing space padding */
541
	while (--spec.field_width >= 0) {
542
		if (buf < end)
L
Linus Torvalds 已提交
543 544 545 546 547 548
			*buf = ' ';
		++buf;
	}
	return buf;
}

549
static char *string(char *buf, char *end, char *s, struct printf_spec spec)
550 551 552 553 554 555
{
	int len, i;

	if ((unsigned long)s < PAGE_SIZE)
		s = "<NULL>";

556
	len = strnlen(s, spec.precision);
557

558 559
	if (!(spec.flags & LEFT)) {
		while (len < spec.field_width--) {
560 561 562 563 564 565 566 567 568 569
			if (buf < end)
				*buf = ' ';
			++buf;
		}
	}
	for (i = 0; i < len; ++i) {
		if (buf < end)
			*buf = *s;
		++buf; ++s;
	}
570
	while (len < spec.field_width--) {
571 572 573 574 575 576 577
		if (buf < end)
			*buf = ' ';
		++buf;
	}
	return buf;
}

578
static char *symbol_string(char *buf, char *end, void *ptr,
579
				struct printf_spec spec, char ext)
580 581 582 583
{
	unsigned long value = (unsigned long) ptr;
#ifdef CONFIG_KALLSYMS
	char sym[KSYM_SYMBOL_LEN];
584
	if (ext != 'f' && ext != 's')
585 586 587
		sprint_symbol(sym, value);
	else
		kallsyms_lookup(value, NULL, NULL, NULL, sym);
588
	return string(buf, end, sym, spec);
589
#else
590 591 592 593
	spec.field_width = 2*sizeof(void *);
	spec.flags |= SPECIAL | SMALL | ZEROPAD;
	spec.base = 16;
	return number(buf, end, value, spec);
594 595 596
#endif
}

597 598
static char *resource_string(char *buf, char *end, struct resource *res,
				struct printf_spec spec)
599 600
{
#ifndef IO_RSRC_PRINTK_SIZE
601
#define IO_RSRC_PRINTK_SIZE	6
602 603 604
#endif

#ifndef MEM_RSRC_PRINTK_SIZE
605
#define MEM_RSRC_PRINTK_SIZE	10
606
#endif
607
	struct printf_spec hex_spec = {
608 609 610 611
		.base = 16,
		.precision = -1,
		.flags = SPECIAL | SMALL | ZEROPAD,
	};
612 613 614 615 616 617 618 619
	struct printf_spec dec_spec = {
		.base = 10,
		.precision = -1,
		.flags = 0,
	};
	/* room for two actual numbers (decimal or hex), the two "0x", -, [, ]
	 * and the final zero */
	char sym[2*3*sizeof(resource_size_t) + 8];
620
	char *p = sym, *pend = sym + sizeof(sym);
621
	int size = -1, addr = 0;
622

623
	if (res->flags & IORESOURCE_IO) {
624
		size = IO_RSRC_PRINTK_SIZE;
625 626
		addr = 1;
	} else if (res->flags & IORESOURCE_MEM) {
627
		size = MEM_RSRC_PRINTK_SIZE;
628 629
		addr = 1;
	}
630 631

	*p++ = '[';
632 633 634 635 636 637
	hex_spec.field_width = size;
	p = number(p, pend, res->start, addr ? hex_spec : dec_spec);
	if (res->start != res->end) {
		*p++ = '-';
		p = number(p, pend, res->end, addr ? hex_spec : dec_spec);
	}
638 639 640
	*p++ = ']';
	*p = 0;

641
	return string(buf, end, sym, spec);
642 643
}

644
static char *mac_address_string(char *buf, char *end, u8 *addr,
645
				struct printf_spec spec, const char *fmt)
646
{
647
	char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
648 649 650 651 652
	char *p = mac_addr;
	int i;

	for (i = 0; i < 6; i++) {
		p = pack_hex_byte(p, addr[i]);
653
		if (fmt[0] == 'M' && i != 5)
654 655 656 657
			*p++ = ':';
	}
	*p = '\0';

658
	return string(buf, end, mac_addr, spec);
659 660
}

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
static char *ip4_string(char *p, const u8 *addr, bool leading_zeros)
{
	int i;

	for (i = 0; i < 4; i++) {
		char temp[3];	/* hold each IP quad in reverse order */
		int digits = put_dec_trunc(temp, addr[i]) - temp;
		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++ = '.';
	}

	*p = '\0';
	return p;
}

685
static char *ip6_compressed_string(char *p, const char *addr)
686 687
{
	int i;
688 689 690 691 692 693 694 695 696
	int j;
	int range;
	unsigned char zerolength[8];
	int longest = 1;
	int colonpos = -1;
	u16 word;
	u8 hi;
	u8 lo;
	bool needcolon = false;
697 698 699 700 701 702
	bool useIPv4;
	struct in6_addr in6;

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

	useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
703 704 705 706 707 708 709 710 711 712 713

	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++) {
714
			if (in6.s6_addr16[j] != 0)
715 716 717 718 719 720 721 722 723 724
				break;
			zerolength[i]++;
		}
	}
	for (i = 0; i < range; i++) {
		if (zerolength[i] > longest) {
			longest = zerolength[i];
			colonpos = i;
		}
	}
725

726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
	/* 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 */
741
		word = ntohs(in6.s6_addr16[i]);
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
		hi = word >> 8;
		lo = word & 0xff;
		if (hi) {
			if (hi > 0x0f)
				p = pack_hex_byte(p, hi);
			else
				*p++ = hex_asc_lo(hi);
		}
		if (hi || lo > 0x0f)
			p = pack_hex_byte(p, lo);
		else
			*p++ = hex_asc_lo(lo);
		needcolon = true;
	}

	if (useIPv4) {
		if (needcolon)
			*p++ = ':';
760
		p = ip4_string(p, &in6.s6_addr[12], false);
761 762 763 764 765 766
	}

	*p = '\0';
	return p;
}

767
static char *ip6_string(char *p, const char *addr, const char *fmt)
768 769
{
	int i;
770
	for (i = 0; i < 8; i++) {
771 772
		p = pack_hex_byte(p, *addr++);
		p = pack_hex_byte(p, *addr++);
773
		if (fmt[0] == 'I' && i != 7)
774 775
			*p++ = ':';
	}
776

777
	*p = '\0';
778 779 780 781 782 783 784 785 786
	return p;
}

static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
			     struct printf_spec spec, const char *fmt)
{
	char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];

	if (fmt[0] == 'I' && fmt[2] == 'c')
787
		ip6_compressed_string(ip6_addr, addr);
788
	else
789
		ip6_string(ip6_addr, addr, fmt);
790

791
	return string(buf, end, ip6_addr, spec);
792 793
}

794 795
static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
			     struct printf_spec spec, const char *fmt)
796
{
797
	char ip4_addr[sizeof("255.255.255.255")];
798

799
	ip4_string(ip4_addr, addr, fmt[0] == 'i');
800

801
	return string(buf, end, ip4_addr, spec);
802 803
}

804 805 806 807 808
/*
 * 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.
 *
809 810
 * Right now we handle:
 *
811 812
 * - 'F' For symbolic function descriptor pointers with offset
 * - 'f' For simple symbolic function names without offset
813 814
 * - 'S' For symbolic direct pointers with offset
 * - 's' For symbolic direct pointers without offset
815 816
 * - 'R' For a struct resource pointer, it prints the range of
 *       addresses (not the name nor the flags)
817 818
 * - 'M' For a 6-byte MAC address, it prints the address in the
 *       usual colon-separated hex notation
819 820 821 822 823 824 825 826 827
 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
 * - '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)
 * - 'I6c' for IPv6 addresses printed as specified by
 *       http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
828 829 830
 * 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.
831
 */
832 833
static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
			struct printf_spec spec)
834
{
835
	if (!ptr)
836
		return string(buf, end, "(null)", spec);
837

838 839
	switch (*fmt) {
	case 'F':
840
	case 'f':
841
		ptr = dereference_function_descriptor(ptr);
842
	case 's':
843 844
		/* Fallthrough */
	case 'S':
845
		return symbol_string(buf, end, ptr, spec, *fmt);
846
	case 'R':
847
		return resource_string(buf, end, ptr, spec);
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
	case 'M':			/* Colon separated: 00:01:02:03:04:05 */
	case 'm':			/* Contiguous: 000102030405 */
		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);
		}
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
		break;
	}
	spec.flags |= SMALL;
	if (spec.field_width == -1) {
		spec.field_width = 2*sizeof(void *);
		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, ...)
 */
static int format_decode(const char *fmt, struct printf_spec *spec)
{
	const char *start = fmt;

	/* we finished early by reading the field width */
903
	if (spec->type == FORMAT_TYPE_WIDTH) {
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 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
		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 */
961
		spec->type = FORMAT_TYPE_WIDTH;
962 963 964 965 966 967 968 969 970 971 972 973 974 975
		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 */
976
			spec->type = FORMAT_TYPE_PRECISION;
977 978 979 980 981 982 983 984 985
			return ++fmt - start;
		}
	}

qualifier:
	/* get the conversion qualifier */
	spec->qualifier = -1;
	if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
	    *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
986 987 988 989 990 991 992 993 994
		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;
			}
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
		}
	}

	/* 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':
1036
		spec->flags |= SIGN;
1037
	case 'u':
1038
		break;
1039 1040 1041 1042

	default:
		spec->type = FORMAT_TYPE_INVALID;
		return fmt - start;
1043
	}
1044 1045 1046 1047

	if (spec->qualifier == 'L')
		spec->type = FORMAT_TYPE_LONG_LONG;
	else if (spec->qualifier == 'l') {
1048
		if (spec->flags & SIGN)
1049 1050 1051 1052 1053 1054 1055
			spec->type = FORMAT_TYPE_LONG;
		else
			spec->type = FORMAT_TYPE_ULONG;
	} else if (spec->qualifier == 'Z' || spec->qualifier == 'z') {
		spec->type = FORMAT_TYPE_SIZE_T;
	} else if (spec->qualifier == 't') {
		spec->type = FORMAT_TYPE_PTRDIFF;
1056 1057 1058 1059 1060
	} else if (spec->qualifier == 'H') {
		if (spec->flags & SIGN)
			spec->type = FORMAT_TYPE_BYTE;
		else
			spec->type = FORMAT_TYPE_UBYTE;
1061
	} else if (spec->qualifier == 'h') {
1062
		if (spec->flags & SIGN)
1063 1064 1065 1066
			spec->type = FORMAT_TYPE_SHORT;
		else
			spec->type = FORMAT_TYPE_USHORT;
	} else {
1067
		if (spec->flags & SIGN)
1068 1069 1070
			spec->type = FORMAT_TYPE_INT;
		else
			spec->type = FORMAT_TYPE_UINT;
1071
	}
1072 1073

	return ++fmt - start;
1074 1075
}

L
Linus Torvalds 已提交
1076 1077 1078 1079 1080 1081 1082
/**
 * 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
 *
1083
 * This function follows C99 vsnprintf, but has some extensions:
1084 1085
 * %pS output the name of a text symbol with offset
 * %ps output the name of a text symbol without offset
1086 1087
 * %pF output the name of a function pointer with its offset
 * %pf output the name of a function pointer without its offset
1088
 * %pR output the address range in a struct resource
1089
 * %n is ignored
1090
 *
L
Linus Torvalds 已提交
1091 1092 1093 1094
 * 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
1095
 * (not including the trailing '\0'), use vscnprintf(). If the
L
Linus Torvalds 已提交
1096 1097 1098 1099
 * 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.
1100
 * You probably want snprintf() instead.
L
Linus Torvalds 已提交
1101 1102 1103 1104 1105
 */
int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
{
	unsigned long long num;
	char *str, *end, c;
1106 1107
	int read;
	struct printf_spec spec = {0};
L
Linus Torvalds 已提交
1108

1109 1110
	/* Reject out-of-range values early.  Large positive sizes are
	   used for unknown buffer sizes. */
M
Marcin Slusarz 已提交
1111
	if (WARN_ON_ONCE((int) size < 0))
L
Linus Torvalds 已提交
1112 1113 1114
		return 0;

	str = buf;
1115
	end = buf + size;
L
Linus Torvalds 已提交
1116

1117 1118 1119 1120
	/* Make sure end is always >= buf */
	if (end < buf) {
		end = ((void *)-1);
		size = end - buf;
L
Linus Torvalds 已提交
1121 1122
	}

1123 1124
	while (*fmt) {
		const char *old_fmt = fmt;
L
Linus Torvalds 已提交
1125

1126
		read = format_decode(fmt, &spec);
L
Linus Torvalds 已提交
1127

1128
		fmt += read;
L
Linus Torvalds 已提交
1129

1130 1131 1132 1133 1134 1135 1136
		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 已提交
1137
			}
1138 1139
			str += read;
			break;
L
Linus Torvalds 已提交
1140 1141
		}

1142
		case FORMAT_TYPE_WIDTH:
1143 1144
			spec.field_width = va_arg(args, int);
			break;
L
Linus Torvalds 已提交
1145

1146 1147 1148
		case FORMAT_TYPE_PRECISION:
			spec.precision = va_arg(args, int);
			break;
L
Linus Torvalds 已提交
1149

1150 1151 1152
		case FORMAT_TYPE_CHAR:
			if (!(spec.flags & LEFT)) {
				while (--spec.field_width > 0) {
1153
					if (str < end)
L
Linus Torvalds 已提交
1154 1155 1156
						*str = ' ';
					++str;

1157 1158 1159 1160 1161 1162 1163
				}
			}
			c = (unsigned char) va_arg(args, int);
			if (str < end)
				*str = c;
			++str;
			while (--spec.field_width > 0) {
1164
				if (str < end)
1165
					*str = ' ';
L
Linus Torvalds 已提交
1166
				++str;
1167 1168
			}
			break;
L
Linus Torvalds 已提交
1169

1170 1171 1172
		case FORMAT_TYPE_STR:
			str = string(str, end, va_arg(args, char *), spec);
			break;
L
Linus Torvalds 已提交
1173

1174 1175 1176 1177 1178 1179
		case FORMAT_TYPE_PTR:
			str = pointer(fmt+1, str, end, va_arg(args, void *),
				      spec);
			while (isalnum(*fmt))
				fmt++;
			break;
L
Linus Torvalds 已提交
1180

1181 1182 1183 1184 1185
		case FORMAT_TYPE_PERCENT_CHAR:
			if (str < end)
				*str = '%';
			++str;
			break;
L
Linus Torvalds 已提交
1186

1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
		case FORMAT_TYPE_INVALID:
			if (str < end)
				*str = '%';
			++str;
			break;

		case FORMAT_TYPE_NRCHARS: {
			int qualifier = spec.qualifier;

			if (qualifier == 'l') {
				long *ip = va_arg(args, long *);
				*ip = (str - buf);
			} else if (qualifier == 'Z' ||
					qualifier == 'z') {
				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 已提交
1208
		}
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226

		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;
1227 1228 1229 1230 1231 1232
			case FORMAT_TYPE_UBYTE:
				num = (unsigned char) va_arg(args, int);
				break;
			case FORMAT_TYPE_BYTE:
				num = (signed char) va_arg(args, int);
				break;
1233 1234 1235 1236 1237 1238
			case FORMAT_TYPE_USHORT:
				num = (unsigned short) va_arg(args, int);
				break;
			case FORMAT_TYPE_SHORT:
				num = (short) va_arg(args, int);
				break;
1239 1240
			case FORMAT_TYPE_INT:
				num = (int) va_arg(args, int);
1241 1242 1243 1244 1245 1246
				break;
			default:
				num = va_arg(args, unsigned int);
			}

			str = number(str, end, num, spec);
L
Linus Torvalds 已提交
1247 1248
		}
	}
1249

1250 1251 1252 1253
	if (size > 0) {
		if (str < end)
			*str = '\0';
		else
L
Linus Torvalds 已提交
1254
			end[-1] = '\0';
1255
	}
1256

1257
	/* the trailing null byte doesn't count towards the total */
L
Linus Torvalds 已提交
1258
	return str-buf;
1259

L
Linus Torvalds 已提交
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
}
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.
1275
 * You probably want scnprintf() instead.
1276 1277
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
 */
int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
{
	int i;

	i=vsnprintf(buf,size,fmt,args);
	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.
1299 1300
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
 */
int snprintf(char * buf, size_t size, const char *fmt, ...)
{
	va_list args;
	int i;

	va_start(args, fmt);
	i=vsnprintf(buf,size,fmt,args);
	va_end(args);
	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
1322
 * the trailing '\0'. If @size is <= 0 the function returns 0.
L
Linus Torvalds 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
 */

int scnprintf(char * buf, size_t size, const char *fmt, ...)
{
	va_list args;
	int i;

	va_start(args, fmt);
	i = vsnprintf(buf, size, fmt, args);
	va_end(args);
	return (i >= size) ? (size - 1) : i;
}
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
1344
 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
L
Linus Torvalds 已提交
1345 1346 1347
 * buffer overflows.
 *
 * Call this function if you are already dealing with a va_list.
1348
 * You probably want sprintf() instead.
1349 1350
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
 */
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
1365
 * into @buf. Use snprintf() or scnprintf() in order to avoid
L
Linus Torvalds 已提交
1366
 * buffer overflows.
1367 1368
 *
 * See the vsnprintf() documentation for format string extensions over C99.
L
Linus Torvalds 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
 */
int sprintf(char * buf, const char *fmt, ...)
{
	va_list args;
	int i;

	va_start(args, fmt);
	i=vsnprintf(buf, INT_MAX, fmt, args);
	va_end(args);
	return i;
}
EXPORT_SYMBOL(sprintf);

L
Lai Jiangshan 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
#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)
{
1408
	struct printf_spec spec = {0};
L
Lai Jiangshan 已提交
1409
	char *str, *end;
1410
	int read;
L
Lai Jiangshan 已提交
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435

	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)


1436 1437
	while (*fmt) {
		read = format_decode(fmt, &spec);
L
Lai Jiangshan 已提交
1438

1439
		fmt += read;
L
Lai Jiangshan 已提交
1440

1441 1442 1443 1444
		switch (spec.type) {
		case FORMAT_TYPE_NONE:
			break;

1445
		case FORMAT_TYPE_WIDTH:
1446 1447 1448 1449 1450
		case FORMAT_TYPE_PRECISION:
			save_arg(int);
			break;

		case FORMAT_TYPE_CHAR:
L
Lai Jiangshan 已提交
1451
			save_arg(char);
1452 1453 1454
			break;

		case FORMAT_TYPE_STR: {
L
Lai Jiangshan 已提交
1455 1456 1457 1458 1459 1460 1461 1462 1463
			const char *save_str = va_arg(args, char *);
			size_t len;
			if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
					|| (unsigned long)save_str < PAGE_SIZE)
				save_str = "<NULL>";
			len = strlen(save_str);
			if (str + len + 1 < end)
				memcpy(str, save_str, len + 1);
			str += len + 1;
1464
			break;
L
Lai Jiangshan 已提交
1465
		}
1466 1467

		case FORMAT_TYPE_PTR:
L
Lai Jiangshan 已提交
1468 1469
			save_arg(void *);
			/* skip all alphanumeric pointer suffixes */
1470
			while (isalnum(*fmt))
L
Lai Jiangshan 已提交
1471
				fmt++;
1472 1473 1474 1475 1476 1477 1478 1479 1480
			break;

		case FORMAT_TYPE_PERCENT_CHAR:
			break;

		case FORMAT_TYPE_INVALID:
			break;

		case FORMAT_TYPE_NRCHARS: {
L
Lai Jiangshan 已提交
1481
			/* skip %n 's argument */
1482
			int qualifier = spec.qualifier;
L
Lai Jiangshan 已提交
1483 1484 1485 1486 1487 1488 1489
			void *skip_arg;
			if (qualifier == 'l')
				skip_arg = va_arg(args, long *);
			else if (qualifier == 'Z' || qualifier == 'z')
				skip_arg = va_arg(args, size_t *);
			else
				skip_arg = va_arg(args, int *);
1490
			break;
L
Lai Jiangshan 已提交
1491
		}
1492 1493 1494 1495 1496

		default:
			switch (spec.type) {

			case FORMAT_TYPE_LONG_LONG:
L
Lai Jiangshan 已提交
1497
				save_arg(long long);
1498 1499 1500
				break;
			case FORMAT_TYPE_ULONG:
			case FORMAT_TYPE_LONG:
L
Lai Jiangshan 已提交
1501
				save_arg(unsigned long);
1502 1503
				break;
			case FORMAT_TYPE_SIZE_T:
L
Lai Jiangshan 已提交
1504
				save_arg(size_t);
1505 1506
				break;
			case FORMAT_TYPE_PTRDIFF:
L
Lai Jiangshan 已提交
1507
				save_arg(ptrdiff_t);
1508
				break;
1509 1510 1511 1512
			case FORMAT_TYPE_UBYTE:
			case FORMAT_TYPE_BYTE:
				save_arg(char);
				break;
1513 1514
			case FORMAT_TYPE_USHORT:
			case FORMAT_TYPE_SHORT:
L
Lai Jiangshan 已提交
1515
				save_arg(short);
1516 1517
				break;
			default:
L
Lai Jiangshan 已提交
1518
				save_arg(int);
1519
			}
L
Lai Jiangshan 已提交
1520 1521 1522
		}
	}
	return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1523 1524

#undef save_arg
L
Lai Jiangshan 已提交
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
}
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:
1540
 *  see vsnprintf comment for details.
L
Lai Jiangshan 已提交
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
 *
 * 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)
{
	unsigned long long num;
	char *str, *end, c;
	const char *args = (const char *)bin_buf;

1556
	struct printf_spec spec = {0};
L
Lai Jiangshan 已提交
1557

M
Marcin Slusarz 已提交
1558
	if (WARN_ON_ONCE((int) size < 0))
L
Lai Jiangshan 已提交
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
		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;
	}

1585 1586 1587
	while (*fmt) {
		int read;
		const char *old_fmt = fmt;
L
Lai Jiangshan 已提交
1588

1589
		read = format_decode(fmt, &spec);
L
Lai Jiangshan 已提交
1590

1591
		fmt += read;
L
Lai Jiangshan 已提交
1592

1593 1594 1595 1596 1597 1598 1599
		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 已提交
1600
			}
1601 1602
			str += read;
			break;
L
Lai Jiangshan 已提交
1603 1604
		}

1605
		case FORMAT_TYPE_WIDTH:
1606 1607
			spec.field_width = get_arg(int);
			break;
L
Lai Jiangshan 已提交
1608

1609 1610 1611
		case FORMAT_TYPE_PRECISION:
			spec.precision = get_arg(int);
			break;
L
Lai Jiangshan 已提交
1612

1613 1614 1615
		case FORMAT_TYPE_CHAR:
			if (!(spec.flags & LEFT)) {
				while (--spec.field_width > 0) {
L
Lai Jiangshan 已提交
1616 1617 1618 1619 1620 1621 1622 1623 1624
					if (str < end)
						*str = ' ';
					++str;
				}
			}
			c = (unsigned char) get_arg(char);
			if (str < end)
				*str = c;
			++str;
1625
			while (--spec.field_width > 0) {
L
Lai Jiangshan 已提交
1626 1627 1628 1629
				if (str < end)
					*str = ' ';
				++str;
			}
1630
			break;
L
Lai Jiangshan 已提交
1631

1632
		case FORMAT_TYPE_STR: {
L
Lai Jiangshan 已提交
1633 1634 1635
			const char *str_arg = args;
			size_t len = strlen(str_arg);
			args += len + 1;
1636 1637
			str = string(str, end, (char *)str_arg, spec);
			break;
L
Lai Jiangshan 已提交
1638 1639
		}

1640 1641 1642
		case FORMAT_TYPE_PTR:
			str = pointer(fmt+1, str, end, get_arg(void *), spec);
			while (isalnum(*fmt))
L
Lai Jiangshan 已提交
1643
				fmt++;
1644
			break;
L
Lai Jiangshan 已提交
1645

1646
		case FORMAT_TYPE_PERCENT_CHAR:
L
Lai Jiangshan 已提交
1647 1648 1649 1650 1651
			if (str < end)
				*str = '%';
			++str;
			break;

1652
		case FORMAT_TYPE_INVALID:
L
Lai Jiangshan 已提交
1653 1654 1655
			if (str < end)
				*str = '%';
			++str;
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
			break;

		case FORMAT_TYPE_NRCHARS:
			/* skip */
			break;

		default:
			switch (spec.type) {

			case FORMAT_TYPE_LONG_LONG:
				num = get_arg(long long);
				break;
			case FORMAT_TYPE_ULONG:
				num = get_arg(unsigned long);
				break;
			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;
1680 1681 1682 1683 1684 1685
			case FORMAT_TYPE_UBYTE:
				num = get_arg(unsigned char);
				break;
			case FORMAT_TYPE_BYTE:
				num = get_arg(signed char);
				break;
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
			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);
L
Lai Jiangshan 已提交
1700 1701
		}
	}
1702

L
Lai Jiangshan 已提交
1703 1704 1705 1706 1707 1708
	if (size > 0) {
		if (str < end)
			*str = '\0';
		else
			end[-1] = '\0';
	}
1709

L
Lai Jiangshan 已提交
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
#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);
	return ret;
}
EXPORT_SYMBOL_GPL(bprintf);

#endif /* CONFIG_BINARY_PRINTF */

L
Linus Torvalds 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 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
/**
 * vsscanf - Unformat a buffer into a list of arguments
 * @buf:	input buffer
 * @fmt:	format of buffer
 * @args:	arguments
 */
int vsscanf(const char * buf, const char * fmt, va_list args)
{
	const char *str = buf;
	char *next;
	char digit;
	int num = 0;
	int qualifier;
	int base;
	int field_width;
	int is_sign = 0;

	while(*fmt && *str) {
		/* skip any white space in format */
		/* white space in format matchs any amount of
		 * white space, including none, in the input.
		 */
		if (isspace(*fmt)) {
			while (isspace(*fmt))
				++fmt;
			while (isspace(*str))
				++str;
		}

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

		if (!*fmt)
			break;
		++fmt;
		
		/* skip this conversion.
		 * advance both strings to next white space
		 */
		if (*fmt == '*') {
A
Andy Spencer 已提交
1785
			while (!isspace(*fmt) && *fmt != '%' && *fmt)
L
Linus Torvalds 已提交
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 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 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 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 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
				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;
		if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
		    *fmt == 'Z' || *fmt == 'z') {
			qualifier = *fmt++;
			if (unlikely(qualifier == *fmt)) {
				if (qualifier == 'h') {
					qualifier = 'H';
					fmt++;
				} else if (qualifier == 'l') {
					qualifier = 'L';
					fmt++;
				}
			}
		}
		base = 10;
		is_sign = 0;

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

		switch(*fmt++) {
		case 'c':
		{
			char *s = (char *) va_arg(args,char*);
			if (field_width == -1)
				field_width = 1;
			do {
				*s++ = *str++;
			} while (--field_width > 0 && *str);
			num++;
		}
		continue;
		case 's':
		{
			char *s = (char *) va_arg(args, char *);
			if(field_width == -1)
				field_width = INT_MAX;
			/* first, skip leading white space in buffer */
			while (isspace(*str))
				str++;

			/* now copy until next white space */
			while (*str && !isspace(*str) && field_width--) {
				*s++ = *str++;
			}
			*s = '\0';
			num++;
		}
		continue;
		case 'n':
			/* return number of characters read so far */
		{
			int *i = (int *)va_arg(args,int*);
			*i = str - buf;
		}
		continue;
		case 'o':
			base = 8;
			break;
		case 'x':
		case 'X':
			base = 16;
			break;
		case 'i':
                        base = 0;
		case 'd':
			is_sign = 1;
		case 'u':
			break;
		case '%':
			/* looking for '%' in str */
			if (*str++ != '%') 
				return num;
			continue;
		default:
			/* invalid format; stop here */
			return num;
		}

		/* have some sort of integer conversion.
		 * first, skip white space in buffer.
		 */
		while (isspace(*str))
			str++;

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

		if (!digit
                    || (base == 16 && !isxdigit(digit))
                    || (base == 10 && !isdigit(digit))
                    || (base == 8 && (!isdigit(digit) || digit > '7'))
                    || (base == 0 && !isdigit(digit)))
				break;

		switch(qualifier) {
		case 'H':	/* that's 'hh' in format */
			if (is_sign) {
				signed char *s = (signed char *) va_arg(args,signed char *);
				*s = (signed char) simple_strtol(str,&next,base);
			} else {
				unsigned char *s = (unsigned char *) va_arg(args, unsigned char *);
				*s = (unsigned char) simple_strtoul(str, &next, base);
			}
			break;
		case 'h':
			if (is_sign) {
				short *s = (short *) va_arg(args,short *);
				*s = (short) simple_strtol(str,&next,base);
			} else {
				unsigned short *s = (unsigned short *) va_arg(args, unsigned short *);
				*s = (unsigned short) simple_strtoul(str, &next, base);
			}
			break;
		case 'l':
			if (is_sign) {
				long *l = (long *) va_arg(args,long *);
				*l = simple_strtol(str,&next,base);
			} else {
				unsigned long *l = (unsigned long*) va_arg(args,unsigned long*);
				*l = simple_strtoul(str,&next,base);
			}
			break;
		case 'L':
			if (is_sign) {
				long long *l = (long long*) va_arg(args,long long *);
				*l = simple_strtoll(str,&next,base);
			} else {
				unsigned long long *l = (unsigned long long*) va_arg(args,unsigned long long*);
				*l = simple_strtoull(str,&next,base);
			}
			break;
		case 'Z':
		case 'z':
		{
			size_t *s = (size_t*) va_arg(args,size_t*);
			*s = (size_t) simple_strtoul(str,&next,base);
		}
		break;
		default:
			if (is_sign) {
				int *i = (int *) va_arg(args, int*);
				*i = (int) simple_strtol(str,&next,base);
			} else {
				unsigned int *i = (unsigned int*) va_arg(args, unsigned int*);
				*i = (unsigned int) simple_strtoul(str,&next,base);
			}
			break;
		}
		num++;

		if (!next)
			break;
		str = next;
	}
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964

	/*
	 * 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 已提交
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
	return num;
}
EXPORT_SYMBOL(vsscanf);

/**
 * sscanf - Unformat a buffer into a list of arguments
 * @buf:	input buffer
 * @fmt:	formatting of buffer
 * @...:	resulting arguments
 */
int sscanf(const char * buf, const char * fmt, ...)
{
	va_list args;
	int i;

	va_start(args,fmt);
	i = vsscanf(buf,fmt,args);
	va_end(args);
	return i;
}
EXPORT_SYMBOL(sscanf);