vsprintf: add %pMR for Bluetooth MAC address
[linux-2.6-block.git] / lib / vsprintf.c
CommitLineData
1da177e4
LT
1/*
2 * linux/lib/vsprintf.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
6
7/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
8/*
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
10 */
11
7b9186f5 12/*
1da177e4
LT
13 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
14 * - changed to provide snprintf and vsnprintf functions
15 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
16 * - scnprintf and vscnprintf
17 */
18
19#include <stdarg.h>
8bc3bcc9 20#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
1da177e4
LT
21#include <linux/types.h>
22#include <linux/string.h>
23#include <linux/ctype.h>
24#include <linux/kernel.h>
0fe1ef24
LT
25#include <linux/kallsyms.h>
26#include <linux/uaccess.h>
332d2e78 27#include <linux/ioport.h>
8a27f7c9 28#include <net/addrconf.h>
1da177e4 29
4e57b681 30#include <asm/page.h> /* for PAGE_SIZE */
1da177e4 31#include <asm/div64.h>
deac93df 32#include <asm/sections.h> /* for dereference_function_descriptor() */
1da177e4 33
1dff46d6 34#include "kstrtox.h"
aa46a63e 35
1da177e4 36/**
922ac25c 37 * simple_strtoull - convert a string to an unsigned long long
1da177e4
LT
38 * @cp: The start of the string
39 * @endp: A pointer to the end of the parsed string will be placed here
40 * @base: The number base to use
41 */
922ac25c 42unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
1da177e4 43{
1dff46d6
AD
44 unsigned long long result;
45 unsigned int rv;
aa46a63e 46
1dff46d6
AD
47 cp = _parse_integer_fixup_radix(cp, &base);
48 rv = _parse_integer(cp, base, &result);
49 /* FIXME */
50 cp += (rv & ~KSTRTOX_OVERFLOW);
aa46a63e 51
1da177e4
LT
52 if (endp)
53 *endp = (char *)cp;
7b9186f5 54
1da177e4
LT
55 return result;
56}
922ac25c 57EXPORT_SYMBOL(simple_strtoull);
1da177e4
LT
58
59/**
922ac25c 60 * simple_strtoul - convert a string to an unsigned long
1da177e4
LT
61 * @cp: The start of the string
62 * @endp: A pointer to the end of the parsed string will be placed here
63 * @base: The number base to use
64 */
922ac25c 65unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
1da177e4 66{
922ac25c 67 return simple_strtoull(cp, endp, base);
1da177e4 68}
922ac25c 69EXPORT_SYMBOL(simple_strtoul);
1da177e4
LT
70
71/**
922ac25c 72 * simple_strtol - convert a string to a signed long
1da177e4
LT
73 * @cp: The start of the string
74 * @endp: A pointer to the end of the parsed string will be placed here
75 * @base: The number base to use
76 */
922ac25c 77long simple_strtol(const char *cp, char **endp, unsigned int base)
1da177e4 78{
922ac25c
AGR
79 if (*cp == '-')
80 return -simple_strtoul(cp + 1, endp, base);
7b9186f5 81
922ac25c 82 return simple_strtoul(cp, endp, base);
1da177e4 83}
922ac25c 84EXPORT_SYMBOL(simple_strtol);
1da177e4
LT
85
86/**
87 * simple_strtoll - convert a string to a signed long long
88 * @cp: The start of the string
89 * @endp: A pointer to the end of the parsed string will be placed here
90 * @base: The number base to use
91 */
22d27051 92long long simple_strtoll(const char *cp, char **endp, unsigned int base)
1da177e4 93{
7b9186f5 94 if (*cp == '-')
22d27051 95 return -simple_strtoull(cp + 1, endp, base);
7b9186f5 96
22d27051 97 return simple_strtoull(cp, endp, base);
1da177e4 98}
98d5ce0d 99EXPORT_SYMBOL(simple_strtoll);
1da177e4 100
cf3b429b
JP
101static noinline_for_stack
102int skip_atoi(const char **s)
1da177e4 103{
7b9186f5 104 int i = 0;
1da177e4
LT
105
106 while (isdigit(**s))
107 i = i*10 + *((*s)++) - '0';
7b9186f5 108
1da177e4
LT
109 return i;
110}
111
4277eedd
DV
112/* Decimal conversion is by far the most typical, and is used
113 * for /proc and /sys data. This directly impacts e.g. top performance
114 * with many processes running. We optimize it for speed
133fd9f5
DV
115 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
116 * (with permission from the author, Douglas W. Jones).
117 */
4277eedd 118
133fd9f5
DV
119#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
120/* Formats correctly any integer in [0, 999999999] */
cf3b429b 121static noinline_for_stack
133fd9f5 122char *put_dec_full9(char *buf, unsigned q)
4277eedd 123{
133fd9f5 124 unsigned r;
7b9186f5 125
133fd9f5
DV
126 /*
127 * Possible ways to approx. divide by 10
128 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
129 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
130 * (x * 0x6667) >> 18 x < 43699
131 * (x * 0x3334) >> 17 x < 16389
132 * (x * 0x199a) >> 16 x < 16389
133 * (x * 0x0ccd) >> 15 x < 16389
134 * (x * 0x0667) >> 14 x < 2739
135 * (x * 0x0334) >> 13 x < 1029
136 * (x * 0x019a) >> 12 x < 1029
137 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
138 * (x * 0x0067) >> 10 x < 179
139 * (x * 0x0034) >> 9 x < 69 same
140 * (x * 0x001a) >> 8 x < 69 same
141 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
142 * (x * 0x0007) >> 6 x < 19
143 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
144 */
145 r = (q * (uint64_t)0x1999999a) >> 32;
146 *buf++ = (q - 10 * r) + '0'; /* 1 */
147 q = (r * (uint64_t)0x1999999a) >> 32;
148 *buf++ = (r - 10 * q) + '0'; /* 2 */
149 r = (q * (uint64_t)0x1999999a) >> 32;
150 *buf++ = (q - 10 * r) + '0'; /* 3 */
151 q = (r * (uint64_t)0x1999999a) >> 32;
152 *buf++ = (r - 10 * q) + '0'; /* 4 */
153 r = (q * (uint64_t)0x1999999a) >> 32;
154 *buf++ = (q - 10 * r) + '0'; /* 5 */
155 /* Now value is under 10000, can avoid 64-bit multiply */
156 q = (r * 0x199a) >> 16;
157 *buf++ = (r - 10 * q) + '0'; /* 6 */
158 r = (q * 0xcd) >> 11;
159 *buf++ = (q - 10 * r) + '0'; /* 7 */
160 q = (r * 0xcd) >> 11;
161 *buf++ = (r - 10 * q) + '0'; /* 8 */
162 *buf++ = q + '0'; /* 9 */
4277eedd
DV
163 return buf;
164}
133fd9f5
DV
165#endif
166
167/* Similar to above but do not pad with zeros.
168 * Code can be easily arranged to print 9 digits too, but our callers
169 * always call put_dec_full9() instead when the number has 9 decimal digits.
170 */
cf3b429b 171static noinline_for_stack
133fd9f5 172char *put_dec_trunc8(char *buf, unsigned r)
4277eedd 173{
133fd9f5
DV
174 unsigned q;
175
176 /* Copy of previous function's body with added early returns */
177 q = (r * (uint64_t)0x1999999a) >> 32;
178 *buf++ = (r - 10 * q) + '0'; /* 2 */
179 if (q == 0)
180 return buf;
181 r = (q * (uint64_t)0x1999999a) >> 32;
182 *buf++ = (q - 10 * r) + '0'; /* 3 */
183 if (r == 0)
184 return buf;
185 q = (r * (uint64_t)0x1999999a) >> 32;
186 *buf++ = (r - 10 * q) + '0'; /* 4 */
187 if (q == 0)
188 return buf;
189 r = (q * (uint64_t)0x1999999a) >> 32;
190 *buf++ = (q - 10 * r) + '0'; /* 5 */
191 if (r == 0)
192 return buf;
193 q = (r * 0x199a) >> 16;
194 *buf++ = (r - 10 * q) + '0'; /* 6 */
195 if (q == 0)
196 return buf;
197 r = (q * 0xcd) >> 11;
198 *buf++ = (q - 10 * r) + '0'; /* 7 */
199 if (r == 0)
200 return buf;
201 q = (r * 0xcd) >> 11;
202 *buf++ = (r - 10 * q) + '0'; /* 8 */
203 if (q == 0)
204 return buf;
205 *buf++ = q + '0'; /* 9 */
206 return buf;
207}
4277eedd 208
133fd9f5
DV
209/* There are two algorithms to print larger numbers.
210 * One is generic: divide by 1000000000 and repeatedly print
211 * groups of (up to) 9 digits. It's conceptually simple,
212 * but requires a (unsigned long long) / 1000000000 division.
213 *
214 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
215 * manipulates them cleverly and generates groups of 4 decimal digits.
216 * It so happens that it does NOT require long long division.
217 *
218 * If long is > 32 bits, division of 64-bit values is relatively easy,
219 * and we will use the first algorithm.
220 * If long long is > 64 bits (strange architecture with VERY large long long),
221 * second algorithm can't be used, and we again use the first one.
222 *
223 * Else (if long is 32 bits and long long is 64 bits) we use second one.
224 */
7b9186f5 225
133fd9f5
DV
226#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
227
228/* First algorithm: generic */
229
230static
231char *put_dec(char *buf, unsigned long long n)
232{
233 if (n >= 100*1000*1000) {
234 while (n >= 1000*1000*1000)
235 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
236 if (n >= 100*1000*1000)
237 return put_dec_full9(buf, n);
238 }
239 return put_dec_trunc8(buf, n);
4277eedd 240}
133fd9f5
DV
241
242#else
243
244/* Second algorithm: valid only for 64-bit long longs */
245
cf3b429b 246static noinline_for_stack
133fd9f5 247char *put_dec_full4(char *buf, unsigned q)
4277eedd 248{
133fd9f5
DV
249 unsigned r;
250 r = (q * 0xcccd) >> 19;
251 *buf++ = (q - 10 * r) + '0';
252 q = (r * 0x199a) >> 16;
253 *buf++ = (r - 10 * q) + '0';
254 r = (q * 0xcd) >> 11;
255 *buf++ = (q - 10 * r) + '0';
256 *buf++ = r + '0';
257 return buf;
4277eedd
DV
258}
259
133fd9f5
DV
260/* Based on code by Douglas W. Jones found at
261 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
262 * (with permission from the author).
263 * Performs no 64-bit division and hence should be fast on 32-bit machines.
264 */
265static
266char *put_dec(char *buf, unsigned long long n)
267{
268 uint32_t d3, d2, d1, q, h;
269
270 if (n < 100*1000*1000)
271 return put_dec_trunc8(buf, n);
272
273 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
274 h = (n >> 32);
275 d2 = (h ) & 0xffff;
276 d3 = (h >> 16); /* implicit "& 0xffff" */
277
278 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
279
280 buf = put_dec_full4(buf, q % 10000);
281 q = q / 10000;
282
283 d1 = q + 7671 * d3 + 9496 * d2 + 6 * d1;
284 buf = put_dec_full4(buf, d1 % 10000);
285 q = d1 / 10000;
286
287 d2 = q + 4749 * d3 + 42 * d2;
288 buf = put_dec_full4(buf, d2 % 10000);
289 q = d2 / 10000;
290
291 d3 = q + 281 * d3;
292 if (!d3)
293 goto done;
294 buf = put_dec_full4(buf, d3 % 10000);
295 q = d3 / 10000;
296 if (!q)
297 goto done;
298 buf = put_dec_full4(buf, q);
299 done:
300 while (buf[-1] == '0')
301 --buf;
302
303 return buf;
304}
305
306#endif
307
1ac101a5
KH
308/*
309 * Convert passed number to decimal string.
310 * Returns the length of string. On buffer overflow, returns 0.
311 *
312 * If speed is not important, use snprintf(). It's easy to read the code.
313 */
314int num_to_str(char *buf, int size, unsigned long long num)
315{
133fd9f5 316 char tmp[sizeof(num) * 3];
1ac101a5
KH
317 int idx, len;
318
133fd9f5
DV
319 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
320 if (num <= 9) {
321 tmp[0] = '0' + num;
322 len = 1;
323 } else {
324 len = put_dec(tmp, num) - tmp;
325 }
1ac101a5
KH
326
327 if (len > size)
328 return 0;
329 for (idx = 0; idx < len; ++idx)
330 buf[idx] = tmp[len - idx - 1];
133fd9f5 331 return len;
1ac101a5
KH
332}
333
1da177e4
LT
334#define ZEROPAD 1 /* pad with zero */
335#define SIGN 2 /* unsigned/signed long */
336#define PLUS 4 /* show plus */
337#define SPACE 8 /* space if plus */
338#define LEFT 16 /* left justified */
b89dc5d6
BH
339#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
340#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
1da177e4 341
fef20d9c
FW
342enum format_type {
343 FORMAT_TYPE_NONE, /* Just a string part */
ed681a91 344 FORMAT_TYPE_WIDTH,
fef20d9c
FW
345 FORMAT_TYPE_PRECISION,
346 FORMAT_TYPE_CHAR,
347 FORMAT_TYPE_STR,
348 FORMAT_TYPE_PTR,
349 FORMAT_TYPE_PERCENT_CHAR,
350 FORMAT_TYPE_INVALID,
351 FORMAT_TYPE_LONG_LONG,
352 FORMAT_TYPE_ULONG,
353 FORMAT_TYPE_LONG,
a4e94ef0
Z
354 FORMAT_TYPE_UBYTE,
355 FORMAT_TYPE_BYTE,
fef20d9c
FW
356 FORMAT_TYPE_USHORT,
357 FORMAT_TYPE_SHORT,
358 FORMAT_TYPE_UINT,
359 FORMAT_TYPE_INT,
360 FORMAT_TYPE_NRCHARS,
361 FORMAT_TYPE_SIZE_T,
362 FORMAT_TYPE_PTRDIFF
363};
364
365struct printf_spec {
4e310fda 366 u8 type; /* format_type enum */
ef0658f3 367 u8 flags; /* flags to number() */
4e310fda
JP
368 u8 base; /* number base, 8, 10 or 16 only */
369 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
370 s16 field_width; /* width of output field */
371 s16 precision; /* # of digits/chars */
fef20d9c
FW
372};
373
cf3b429b
JP
374static noinline_for_stack
375char *number(char *buf, char *end, unsigned long long num,
376 struct printf_spec spec)
1da177e4 377{
9b706aee
DV
378 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
379 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
380
381 char tmp[66];
382 char sign;
383 char locase;
fef20d9c 384 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
1da177e4 385 int i;
7c203422 386 bool is_zero = num == 0LL;
1da177e4 387
9b706aee
DV
388 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
389 * produces same digits or (maybe lowercased) letters */
fef20d9c
FW
390 locase = (spec.flags & SMALL);
391 if (spec.flags & LEFT)
392 spec.flags &= ~ZEROPAD;
1da177e4 393 sign = 0;
fef20d9c 394 if (spec.flags & SIGN) {
7b9186f5 395 if ((signed long long)num < 0) {
1da177e4 396 sign = '-';
7b9186f5 397 num = -(signed long long)num;
fef20d9c
FW
398 spec.field_width--;
399 } else if (spec.flags & PLUS) {
1da177e4 400 sign = '+';
fef20d9c
FW
401 spec.field_width--;
402 } else if (spec.flags & SPACE) {
1da177e4 403 sign = ' ';
fef20d9c 404 spec.field_width--;
1da177e4
LT
405 }
406 }
b39a7340 407 if (need_pfx) {
fef20d9c 408 if (spec.base == 16)
7c203422
PC
409 spec.field_width -= 2;
410 else if (!is_zero)
fef20d9c 411 spec.field_width--;
1da177e4 412 }
b39a7340
DV
413
414 /* generate full string in tmp[], in reverse order */
1da177e4 415 i = 0;
133fd9f5
DV
416 if (num < spec.base)
417 tmp[i++] = digits[num] | locase;
4277eedd
DV
418 /* Generic code, for any base:
419 else do {
9b706aee 420 tmp[i++] = (digits[do_div(num,base)] | locase);
4277eedd
DV
421 } while (num != 0);
422 */
fef20d9c
FW
423 else if (spec.base != 10) { /* 8 or 16 */
424 int mask = spec.base - 1;
b39a7340 425 int shift = 3;
7b9186f5
AGR
426
427 if (spec.base == 16)
428 shift = 4;
b39a7340 429 do {
9b706aee 430 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
b39a7340
DV
431 num >>= shift;
432 } while (num);
4277eedd
DV
433 } else { /* base 10 */
434 i = put_dec(tmp, num) - tmp;
435 }
b39a7340
DV
436
437 /* printing 100 using %2d gives "100", not "00" */
fef20d9c
FW
438 if (i > spec.precision)
439 spec.precision = i;
b39a7340 440 /* leading space padding */
fef20d9c
FW
441 spec.field_width -= spec.precision;
442 if (!(spec.flags & (ZEROPAD+LEFT))) {
7b9186f5 443 while (--spec.field_width >= 0) {
f796937a 444 if (buf < end)
1da177e4
LT
445 *buf = ' ';
446 ++buf;
447 }
448 }
b39a7340 449 /* sign */
1da177e4 450 if (sign) {
f796937a 451 if (buf < end)
1da177e4
LT
452 *buf = sign;
453 ++buf;
454 }
b39a7340
DV
455 /* "0x" / "0" prefix */
456 if (need_pfx) {
7c203422
PC
457 if (spec.base == 16 || !is_zero) {
458 if (buf < end)
459 *buf = '0';
460 ++buf;
461 }
fef20d9c 462 if (spec.base == 16) {
f796937a 463 if (buf < end)
9b706aee 464 *buf = ('X' | locase);
1da177e4
LT
465 ++buf;
466 }
467 }
b39a7340 468 /* zero or space padding */
fef20d9c
FW
469 if (!(spec.flags & LEFT)) {
470 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
471 while (--spec.field_width >= 0) {
f796937a 472 if (buf < end)
1da177e4
LT
473 *buf = c;
474 ++buf;
475 }
476 }
b39a7340 477 /* hmm even more zero padding? */
fef20d9c 478 while (i <= --spec.precision) {
f796937a 479 if (buf < end)
1da177e4
LT
480 *buf = '0';
481 ++buf;
482 }
b39a7340
DV
483 /* actual digits of result */
484 while (--i >= 0) {
f796937a 485 if (buf < end)
1da177e4
LT
486 *buf = tmp[i];
487 ++buf;
488 }
b39a7340 489 /* trailing space padding */
fef20d9c 490 while (--spec.field_width >= 0) {
f796937a 491 if (buf < end)
1da177e4
LT
492 *buf = ' ';
493 ++buf;
494 }
7b9186f5 495
1da177e4
LT
496 return buf;
497}
498
cf3b429b
JP
499static noinline_for_stack
500char *string(char *buf, char *end, const char *s, struct printf_spec spec)
0f9bfa56
LT
501{
502 int len, i;
503
504 if ((unsigned long)s < PAGE_SIZE)
0f4f81dc 505 s = "(null)";
0f9bfa56 506
fef20d9c 507 len = strnlen(s, spec.precision);
0f9bfa56 508
fef20d9c
FW
509 if (!(spec.flags & LEFT)) {
510 while (len < spec.field_width--) {
0f9bfa56
LT
511 if (buf < end)
512 *buf = ' ';
513 ++buf;
514 }
515 }
516 for (i = 0; i < len; ++i) {
517 if (buf < end)
518 *buf = *s;
519 ++buf; ++s;
520 }
fef20d9c 521 while (len < spec.field_width--) {
0f9bfa56
LT
522 if (buf < end)
523 *buf = ' ';
524 ++buf;
525 }
7b9186f5 526
0f9bfa56
LT
527 return buf;
528}
529
cf3b429b
JP
530static noinline_for_stack
531char *symbol_string(char *buf, char *end, void *ptr,
532 struct printf_spec spec, char ext)
0fe1ef24
LT
533{
534 unsigned long value = (unsigned long) ptr;
535#ifdef CONFIG_KALLSYMS
536 char sym[KSYM_SYMBOL_LEN];
0f77a8d3
NK
537 if (ext == 'B')
538 sprint_backtrace(sym, value);
539 else if (ext != 'f' && ext != 's')
0c8b946e
FW
540 sprint_symbol(sym, value);
541 else
4796dd20 542 sprint_symbol_no_offset(sym, value);
7b9186f5 543
fef20d9c 544 return string(buf, end, sym, spec);
0fe1ef24 545#else
7b9186f5 546 spec.field_width = 2 * sizeof(void *);
fef20d9c
FW
547 spec.flags |= SPECIAL | SMALL | ZEROPAD;
548 spec.base = 16;
7b9186f5 549
fef20d9c 550 return number(buf, end, value, spec);
0fe1ef24
LT
551#endif
552}
553
cf3b429b
JP
554static noinline_for_stack
555char *resource_string(char *buf, char *end, struct resource *res,
556 struct printf_spec spec, const char *fmt)
332d2e78
LT
557{
558#ifndef IO_RSRC_PRINTK_SIZE
28405372 559#define IO_RSRC_PRINTK_SIZE 6
332d2e78
LT
560#endif
561
562#ifndef MEM_RSRC_PRINTK_SIZE
28405372 563#define MEM_RSRC_PRINTK_SIZE 10
332d2e78 564#endif
4da0b66c 565 static const struct printf_spec io_spec = {
fef20d9c 566 .base = 16,
4da0b66c 567 .field_width = IO_RSRC_PRINTK_SIZE,
fef20d9c
FW
568 .precision = -1,
569 .flags = SPECIAL | SMALL | ZEROPAD,
570 };
4da0b66c
BH
571 static const struct printf_spec mem_spec = {
572 .base = 16,
573 .field_width = MEM_RSRC_PRINTK_SIZE,
574 .precision = -1,
575 .flags = SPECIAL | SMALL | ZEROPAD,
576 };
0f4050c7
BH
577 static const struct printf_spec bus_spec = {
578 .base = 16,
579 .field_width = 2,
580 .precision = -1,
581 .flags = SMALL | ZEROPAD,
582 };
4da0b66c 583 static const struct printf_spec dec_spec = {
c91d3376
BH
584 .base = 10,
585 .precision = -1,
586 .flags = 0,
587 };
4da0b66c 588 static const struct printf_spec str_spec = {
fd95541e
BH
589 .field_width = -1,
590 .precision = 10,
591 .flags = LEFT,
592 };
4da0b66c 593 static const struct printf_spec flag_spec = {
fd95541e
BH
594 .base = 16,
595 .precision = -1,
596 .flags = SPECIAL | SMALL,
597 };
c7dabef8
BH
598
599 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
600 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
601#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
602#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
9d7cca04 603#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
c7dabef8
BH
604#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
605 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
606 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
607
332d2e78 608 char *p = sym, *pend = sym + sizeof(sym);
c7dabef8 609 int decode = (fmt[0] == 'R') ? 1 : 0;
4da0b66c 610 const struct printf_spec *specp;
332d2e78
LT
611
612 *p++ = '[';
4da0b66c 613 if (res->flags & IORESOURCE_IO) {
c7dabef8 614 p = string(p, pend, "io ", str_spec);
4da0b66c
BH
615 specp = &io_spec;
616 } else if (res->flags & IORESOURCE_MEM) {
c7dabef8 617 p = string(p, pend, "mem ", str_spec);
4da0b66c
BH
618 specp = &mem_spec;
619 } else if (res->flags & IORESOURCE_IRQ) {
c7dabef8 620 p = string(p, pend, "irq ", str_spec);
4da0b66c
BH
621 specp = &dec_spec;
622 } else if (res->flags & IORESOURCE_DMA) {
c7dabef8 623 p = string(p, pend, "dma ", str_spec);
4da0b66c 624 specp = &dec_spec;
0f4050c7
BH
625 } else if (res->flags & IORESOURCE_BUS) {
626 p = string(p, pend, "bus ", str_spec);
627 specp = &bus_spec;
4da0b66c 628 } else {
c7dabef8 629 p = string(p, pend, "??? ", str_spec);
4da0b66c 630 specp = &mem_spec;
c7dabef8 631 decode = 0;
fd95541e 632 }
4da0b66c 633 p = number(p, pend, res->start, *specp);
c91d3376
BH
634 if (res->start != res->end) {
635 *p++ = '-';
4da0b66c 636 p = number(p, pend, res->end, *specp);
c91d3376 637 }
c7dabef8 638 if (decode) {
fd95541e
BH
639 if (res->flags & IORESOURCE_MEM_64)
640 p = string(p, pend, " 64bit", str_spec);
641 if (res->flags & IORESOURCE_PREFETCH)
642 p = string(p, pend, " pref", str_spec);
9d7cca04
BH
643 if (res->flags & IORESOURCE_WINDOW)
644 p = string(p, pend, " window", str_spec);
fd95541e
BH
645 if (res->flags & IORESOURCE_DISABLED)
646 p = string(p, pend, " disabled", str_spec);
c7dabef8
BH
647 } else {
648 p = string(p, pend, " flags ", str_spec);
649 p = number(p, pend, res->flags, flag_spec);
fd95541e 650 }
332d2e78 651 *p++ = ']';
c7dabef8 652 *p = '\0';
332d2e78 653
fef20d9c 654 return string(buf, end, sym, spec);
332d2e78
LT
655}
656
cf3b429b
JP
657static noinline_for_stack
658char *mac_address_string(char *buf, char *end, u8 *addr,
659 struct printf_spec spec, const char *fmt)
dd45c9cf 660{
8a27f7c9 661 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
dd45c9cf
HH
662 char *p = mac_addr;
663 int i;
bc7259a2 664 char separator;
76597ff9 665 bool reversed = false;
bc7259a2 666
76597ff9
AE
667 switch (fmt[1]) {
668 case 'F':
bc7259a2 669 separator = '-';
76597ff9
AE
670 break;
671
672 case 'R':
673 reversed = true;
674 /* fall through */
675
676 default:
bc7259a2 677 separator = ':';
76597ff9 678 break;
bc7259a2 679 }
dd45c9cf
HH
680
681 for (i = 0; i < 6; i++) {
76597ff9
AE
682 if (reversed)
683 p = hex_byte_pack(p, addr[5 - i]);
684 else
685 p = hex_byte_pack(p, addr[i]);
686
8a27f7c9 687 if (fmt[0] == 'M' && i != 5)
bc7259a2 688 *p++ = separator;
dd45c9cf
HH
689 }
690 *p = '\0';
691
fef20d9c 692 return string(buf, end, mac_addr, spec);
dd45c9cf
HH
693}
694
cf3b429b
JP
695static noinline_for_stack
696char *ip4_string(char *p, const u8 *addr, const char *fmt)
8a27f7c9
JP
697{
698 int i;
0159f24e
JP
699 bool leading_zeros = (fmt[0] == 'i');
700 int index;
701 int step;
702
703 switch (fmt[2]) {
704 case 'h':
705#ifdef __BIG_ENDIAN
706 index = 0;
707 step = 1;
708#else
709 index = 3;
710 step = -1;
711#endif
712 break;
713 case 'l':
714 index = 3;
715 step = -1;
716 break;
717 case 'n':
718 case 'b':
719 default:
720 index = 0;
721 step = 1;
722 break;
723 }
8a27f7c9
JP
724 for (i = 0; i < 4; i++) {
725 char temp[3]; /* hold each IP quad in reverse order */
133fd9f5 726 int digits = put_dec_trunc8(temp, addr[index]) - temp;
8a27f7c9
JP
727 if (leading_zeros) {
728 if (digits < 3)
729 *p++ = '0';
730 if (digits < 2)
731 *p++ = '0';
732 }
733 /* reverse the digits in the quad */
734 while (digits--)
735 *p++ = temp[digits];
736 if (i < 3)
737 *p++ = '.';
0159f24e 738 index += step;
8a27f7c9 739 }
8a27f7c9 740 *p = '\0';
7b9186f5 741
8a27f7c9
JP
742 return p;
743}
744
cf3b429b
JP
745static noinline_for_stack
746char *ip6_compressed_string(char *p, const char *addr)
689afa7d 747{
7b9186f5 748 int i, j, range;
8a27f7c9
JP
749 unsigned char zerolength[8];
750 int longest = 1;
751 int colonpos = -1;
752 u16 word;
7b9186f5 753 u8 hi, lo;
8a27f7c9 754 bool needcolon = false;
eb78cd26
JP
755 bool useIPv4;
756 struct in6_addr in6;
757
758 memcpy(&in6, addr, sizeof(struct in6_addr));
759
760 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
8a27f7c9
JP
761
762 memset(zerolength, 0, sizeof(zerolength));
763
764 if (useIPv4)
765 range = 6;
766 else
767 range = 8;
768
769 /* find position of longest 0 run */
770 for (i = 0; i < range; i++) {
771 for (j = i; j < range; j++) {
eb78cd26 772 if (in6.s6_addr16[j] != 0)
8a27f7c9
JP
773 break;
774 zerolength[i]++;
775 }
776 }
777 for (i = 0; i < range; i++) {
778 if (zerolength[i] > longest) {
779 longest = zerolength[i];
780 colonpos = i;
781 }
782 }
29cf519e
JP
783 if (longest == 1) /* don't compress a single 0 */
784 colonpos = -1;
689afa7d 785
8a27f7c9
JP
786 /* emit address */
787 for (i = 0; i < range; i++) {
788 if (i == colonpos) {
789 if (needcolon || i == 0)
790 *p++ = ':';
791 *p++ = ':';
792 needcolon = false;
793 i += longest - 1;
794 continue;
795 }
796 if (needcolon) {
797 *p++ = ':';
798 needcolon = false;
799 }
800 /* hex u16 without leading 0s */
eb78cd26 801 word = ntohs(in6.s6_addr16[i]);
8a27f7c9
JP
802 hi = word >> 8;
803 lo = word & 0xff;
804 if (hi) {
805 if (hi > 0x0f)
55036ba7 806 p = hex_byte_pack(p, hi);
8a27f7c9
JP
807 else
808 *p++ = hex_asc_lo(hi);
55036ba7 809 p = hex_byte_pack(p, lo);
8a27f7c9 810 }
b5ff992b 811 else if (lo > 0x0f)
55036ba7 812 p = hex_byte_pack(p, lo);
8a27f7c9
JP
813 else
814 *p++ = hex_asc_lo(lo);
815 needcolon = true;
816 }
817
818 if (useIPv4) {
819 if (needcolon)
820 *p++ = ':';
0159f24e 821 p = ip4_string(p, &in6.s6_addr[12], "I4");
8a27f7c9 822 }
8a27f7c9 823 *p = '\0';
7b9186f5 824
8a27f7c9
JP
825 return p;
826}
827
cf3b429b
JP
828static noinline_for_stack
829char *ip6_string(char *p, const char *addr, const char *fmt)
8a27f7c9
JP
830{
831 int i;
7b9186f5 832
689afa7d 833 for (i = 0; i < 8; i++) {
55036ba7
AS
834 p = hex_byte_pack(p, *addr++);
835 p = hex_byte_pack(p, *addr++);
8a27f7c9 836 if (fmt[0] == 'I' && i != 7)
689afa7d
HH
837 *p++ = ':';
838 }
839 *p = '\0';
7b9186f5 840
8a27f7c9
JP
841 return p;
842}
843
cf3b429b
JP
844static noinline_for_stack
845char *ip6_addr_string(char *buf, char *end, const u8 *addr,
846 struct printf_spec spec, const char *fmt)
8a27f7c9
JP
847{
848 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
849
850 if (fmt[0] == 'I' && fmt[2] == 'c')
eb78cd26 851 ip6_compressed_string(ip6_addr, addr);
8a27f7c9 852 else
eb78cd26 853 ip6_string(ip6_addr, addr, fmt);
689afa7d 854
fef20d9c 855 return string(buf, end, ip6_addr, spec);
689afa7d
HH
856}
857
cf3b429b
JP
858static noinline_for_stack
859char *ip4_addr_string(char *buf, char *end, const u8 *addr,
860 struct printf_spec spec, const char *fmt)
4aa99606 861{
8a27f7c9 862 char ip4_addr[sizeof("255.255.255.255")];
4aa99606 863
0159f24e 864 ip4_string(ip4_addr, addr, fmt);
4aa99606 865
fef20d9c 866 return string(buf, end, ip4_addr, spec);
4aa99606
HH
867}
868
cf3b429b
JP
869static noinline_for_stack
870char *uuid_string(char *buf, char *end, const u8 *addr,
871 struct printf_spec spec, const char *fmt)
9ac6e44e
JP
872{
873 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
874 char *p = uuid;
875 int i;
876 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
877 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
878 const u8 *index = be;
879 bool uc = false;
880
881 switch (*(++fmt)) {
882 case 'L':
883 uc = true; /* fall-through */
884 case 'l':
885 index = le;
886 break;
887 case 'B':
888 uc = true;
889 break;
890 }
891
892 for (i = 0; i < 16; i++) {
55036ba7 893 p = hex_byte_pack(p, addr[index[i]]);
9ac6e44e
JP
894 switch (i) {
895 case 3:
896 case 5:
897 case 7:
898 case 9:
899 *p++ = '-';
900 break;
901 }
902 }
903
904 *p = 0;
905
906 if (uc) {
907 p = uuid;
908 do {
909 *p = toupper(*p);
910 } while (*(++p));
911 }
912
913 return string(buf, end, uuid, spec);
914}
915
c8f44aff
MM
916static
917char *netdev_feature_string(char *buf, char *end, const u8 *addr,
918 struct printf_spec spec)
919{
920 spec.flags |= SPECIAL | SMALL | ZEROPAD;
921 if (spec.field_width == -1)
922 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
923 spec.base = 16;
924
925 return number(buf, end, *(const netdev_features_t *)addr, spec);
926}
927
411f05f1 928int kptr_restrict __read_mostly;
455cd5ab 929
4d8a743c
LT
930/*
931 * Show a '%p' thing. A kernel extension is that the '%p' is followed
932 * by an extra set of alphanumeric characters that are extended format
933 * specifiers.
934 *
332d2e78
LT
935 * Right now we handle:
936 *
0c8b946e
FW
937 * - 'F' For symbolic function descriptor pointers with offset
938 * - 'f' For simple symbolic function names without offset
0efb4d20
SR
939 * - 'S' For symbolic direct pointers with offset
940 * - 's' For symbolic direct pointers without offset
0f77a8d3 941 * - 'B' For backtraced symbolic direct pointers with offset
c7dabef8
BH
942 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
943 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
dd45c9cf
HH
944 * - 'M' For a 6-byte MAC address, it prints the address in the
945 * usual colon-separated hex notation
8a27f7c9 946 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
bc7259a2 947 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
c8e00060 948 * with a dash-separated hex notation
76597ff9 949 * - '[mM]R For a 6-byte MAC address, Reverse order (Bluetooth)
8a27f7c9
JP
950 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
951 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
952 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
953 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
954 * IPv6 omits the colons (01020304...0f)
955 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
0159f24e 956 * - '[Ii]4[hnbl]' IPv4 addresses in host, network, big or little endian order
8a27f7c9 957 * - 'I6c' for IPv6 addresses printed as specified by
29cf519e 958 * http://tools.ietf.org/html/rfc5952
9ac6e44e
JP
959 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
960 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
961 * Options for %pU are:
962 * b big endian lower case hex (default)
963 * B big endian UPPER case hex
964 * l little endian lower case hex
965 * L little endian UPPER case hex
966 * big endian output byte order is:
967 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
968 * little endian output byte order is:
969 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
7db6f5fb
JP
970 * - 'V' For a struct va_format which contains a format string * and va_list *,
971 * call vsnprintf(->format, *->va_list).
972 * Implements a "recursive vsnprintf".
973 * Do not use this feature without some mechanism to verify the
974 * correctness of the format string and va_list arguments.
455cd5ab 975 * - 'K' For a kernel pointer that should be hidden from unprivileged users
c8f44aff 976 * - 'NF' For a netdev_features_t
9ac6e44e 977 *
332d2e78
LT
978 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
979 * function pointers are really function descriptors, which contain a
980 * pointer to the real address.
4d8a743c 981 */
cf3b429b
JP
982static noinline_for_stack
983char *pointer(const char *fmt, char *buf, char *end, void *ptr,
984 struct printf_spec spec)
78a8bf69 985{
725fe002
GL
986 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
987
9f36e2c4 988 if (!ptr && *fmt != 'K') {
5e057981
JP
989 /*
990 * Print (null) with the same width as a pointer so it makes
991 * tabular output look nice.
992 */
993 if (spec.field_width == -1)
725fe002 994 spec.field_width = default_width;
fef20d9c 995 return string(buf, end, "(null)", spec);
5e057981 996 }
d97106ab 997
0fe1ef24
LT
998 switch (*fmt) {
999 case 'F':
0c8b946e 1000 case 'f':
0fe1ef24
LT
1001 ptr = dereference_function_descriptor(ptr);
1002 /* Fallthrough */
1003 case 'S':
9ac6e44e 1004 case 's':
0f77a8d3 1005 case 'B':
0c8b946e 1006 return symbol_string(buf, end, ptr, spec, *fmt);
332d2e78 1007 case 'R':
c7dabef8 1008 case 'r':
fd95541e 1009 return resource_string(buf, end, ptr, spec, fmt);
8a27f7c9
JP
1010 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1011 case 'm': /* Contiguous: 000102030405 */
76597ff9
AE
1012 /* [mM]F (FDDI) */
1013 /* [mM]R (Reverse order; Bluetooth) */
8a27f7c9
JP
1014 return mac_address_string(buf, end, ptr, spec, fmt);
1015 case 'I': /* Formatted IP supported
1016 * 4: 1.2.3.4
1017 * 6: 0001:0203:...:0708
1018 * 6c: 1::708 or 1::1.2.3.4
1019 */
1020 case 'i': /* Contiguous:
1021 * 4: 001.002.003.004
1022 * 6: 000102...0f
1023 */
1024 switch (fmt[1]) {
1025 case '6':
1026 return ip6_addr_string(buf, end, ptr, spec, fmt);
1027 case '4':
1028 return ip4_addr_string(buf, end, ptr, spec, fmt);
1029 }
fef20d9c 1030 break;
9ac6e44e
JP
1031 case 'U':
1032 return uuid_string(buf, end, ptr, spec, fmt);
7db6f5fb 1033 case 'V':
5756b76e
JB
1034 {
1035 va_list va;
1036
1037 va_copy(va, *((struct va_format *)ptr)->va);
1038 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1039 ((struct va_format *)ptr)->fmt, va);
1040 va_end(va);
1041 return buf;
1042 }
455cd5ab
DR
1043 case 'K':
1044 /*
1045 * %pK cannot be used in IRQ context because its test
1046 * for CAP_SYSLOG would be meaningless.
1047 */
1048 if (in_irq() || in_serving_softirq() || in_nmi()) {
1049 if (spec.field_width == -1)
725fe002 1050 spec.field_width = default_width;
455cd5ab 1051 return string(buf, end, "pK-error", spec);
455cd5ab 1052 }
26297607
JP
1053 if (!((kptr_restrict == 0) ||
1054 (kptr_restrict == 1 &&
1055 has_capability_noaudit(current, CAP_SYSLOG))))
1056 ptr = NULL;
1057 break;
c8f44aff
MM
1058 case 'N':
1059 switch (fmt[1]) {
1060 case 'F':
1061 return netdev_feature_string(buf, end, ptr, spec);
1062 }
1063 break;
fef20d9c
FW
1064 }
1065 spec.flags |= SMALL;
1066 if (spec.field_width == -1) {
725fe002 1067 spec.field_width = default_width;
fef20d9c
FW
1068 spec.flags |= ZEROPAD;
1069 }
1070 spec.base = 16;
1071
1072 return number(buf, end, (unsigned long) ptr, spec);
1073}
1074
1075/*
1076 * Helper function to decode printf style format.
1077 * Each call decode a token from the format and return the
1078 * number of characters read (or likely the delta where it wants
1079 * to go on the next call).
1080 * The decoded token is returned through the parameters
1081 *
1082 * 'h', 'l', or 'L' for integer fields
1083 * 'z' support added 23/7/1999 S.H.
1084 * 'z' changed to 'Z' --davidm 1/25/99
1085 * 't' added for ptrdiff_t
1086 *
1087 * @fmt: the format string
1088 * @type of the token returned
1089 * @flags: various flags such as +, -, # tokens..
1090 * @field_width: overwritten width
1091 * @base: base of the number (octal, hex, ...)
1092 * @precision: precision of a number
1093 * @qualifier: qualifier of a number (long, size_t, ...)
1094 */
cf3b429b
JP
1095static noinline_for_stack
1096int format_decode(const char *fmt, struct printf_spec *spec)
fef20d9c
FW
1097{
1098 const char *start = fmt;
fef20d9c
FW
1099
1100 /* we finished early by reading the field width */
ed681a91 1101 if (spec->type == FORMAT_TYPE_WIDTH) {
fef20d9c
FW
1102 if (spec->field_width < 0) {
1103 spec->field_width = -spec->field_width;
1104 spec->flags |= LEFT;
1105 }
1106 spec->type = FORMAT_TYPE_NONE;
1107 goto precision;
1108 }
1109
1110 /* we finished early by reading the precision */
1111 if (spec->type == FORMAT_TYPE_PRECISION) {
1112 if (spec->precision < 0)
1113 spec->precision = 0;
1114
1115 spec->type = FORMAT_TYPE_NONE;
1116 goto qualifier;
1117 }
1118
1119 /* By default */
1120 spec->type = FORMAT_TYPE_NONE;
1121
1122 for (; *fmt ; ++fmt) {
1123 if (*fmt == '%')
1124 break;
1125 }
1126
1127 /* Return the current non-format string */
1128 if (fmt != start || !*fmt)
1129 return fmt - start;
1130
1131 /* Process flags */
1132 spec->flags = 0;
1133
1134 while (1) { /* this also skips first '%' */
1135 bool found = true;
1136
1137 ++fmt;
1138
1139 switch (*fmt) {
1140 case '-': spec->flags |= LEFT; break;
1141 case '+': spec->flags |= PLUS; break;
1142 case ' ': spec->flags |= SPACE; break;
1143 case '#': spec->flags |= SPECIAL; break;
1144 case '0': spec->flags |= ZEROPAD; break;
1145 default: found = false;
1146 }
1147
1148 if (!found)
1149 break;
1150 }
1151
1152 /* get field width */
1153 spec->field_width = -1;
1154
1155 if (isdigit(*fmt))
1156 spec->field_width = skip_atoi(&fmt);
1157 else if (*fmt == '*') {
1158 /* it's the next argument */
ed681a91 1159 spec->type = FORMAT_TYPE_WIDTH;
fef20d9c
FW
1160 return ++fmt - start;
1161 }
1162
1163precision:
1164 /* get the precision */
1165 spec->precision = -1;
1166 if (*fmt == '.') {
1167 ++fmt;
1168 if (isdigit(*fmt)) {
1169 spec->precision = skip_atoi(&fmt);
1170 if (spec->precision < 0)
1171 spec->precision = 0;
1172 } else if (*fmt == '*') {
1173 /* it's the next argument */
adf26f84 1174 spec->type = FORMAT_TYPE_PRECISION;
fef20d9c
FW
1175 return ++fmt - start;
1176 }
1177 }
1178
1179qualifier:
1180 /* get the conversion qualifier */
1181 spec->qualifier = -1;
75fb8f26
AS
1182 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1183 _tolower(*fmt) == 'z' || *fmt == 't') {
a4e94ef0
Z
1184 spec->qualifier = *fmt++;
1185 if (unlikely(spec->qualifier == *fmt)) {
1186 if (spec->qualifier == 'l') {
1187 spec->qualifier = 'L';
1188 ++fmt;
1189 } else if (spec->qualifier == 'h') {
1190 spec->qualifier = 'H';
1191 ++fmt;
1192 }
fef20d9c
FW
1193 }
1194 }
1195
1196 /* default base */
1197 spec->base = 10;
1198 switch (*fmt) {
1199 case 'c':
1200 spec->type = FORMAT_TYPE_CHAR;
1201 return ++fmt - start;
1202
1203 case 's':
1204 spec->type = FORMAT_TYPE_STR;
1205 return ++fmt - start;
1206
1207 case 'p':
1208 spec->type = FORMAT_TYPE_PTR;
1209 return fmt - start;
1210 /* skip alnum */
1211
1212 case 'n':
1213 spec->type = FORMAT_TYPE_NRCHARS;
1214 return ++fmt - start;
1215
1216 case '%':
1217 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1218 return ++fmt - start;
1219
1220 /* integer number formats - set up the flags and "break" */
1221 case 'o':
1222 spec->base = 8;
1223 break;
1224
1225 case 'x':
1226 spec->flags |= SMALL;
1227
1228 case 'X':
1229 spec->base = 16;
1230 break;
1231
1232 case 'd':
1233 case 'i':
39e874f8 1234 spec->flags |= SIGN;
fef20d9c 1235 case 'u':
4aa99606 1236 break;
fef20d9c
FW
1237
1238 default:
1239 spec->type = FORMAT_TYPE_INVALID;
1240 return fmt - start;
0fe1ef24 1241 }
fef20d9c
FW
1242
1243 if (spec->qualifier == 'L')
1244 spec->type = FORMAT_TYPE_LONG_LONG;
1245 else if (spec->qualifier == 'l') {
39e874f8 1246 if (spec->flags & SIGN)
fef20d9c
FW
1247 spec->type = FORMAT_TYPE_LONG;
1248 else
1249 spec->type = FORMAT_TYPE_ULONG;
75fb8f26 1250 } else if (_tolower(spec->qualifier) == 'z') {
fef20d9c
FW
1251 spec->type = FORMAT_TYPE_SIZE_T;
1252 } else if (spec->qualifier == 't') {
1253 spec->type = FORMAT_TYPE_PTRDIFF;
a4e94ef0
Z
1254 } else if (spec->qualifier == 'H') {
1255 if (spec->flags & SIGN)
1256 spec->type = FORMAT_TYPE_BYTE;
1257 else
1258 spec->type = FORMAT_TYPE_UBYTE;
fef20d9c 1259 } else if (spec->qualifier == 'h') {
39e874f8 1260 if (spec->flags & SIGN)
fef20d9c
FW
1261 spec->type = FORMAT_TYPE_SHORT;
1262 else
1263 spec->type = FORMAT_TYPE_USHORT;
1264 } else {
39e874f8 1265 if (spec->flags & SIGN)
fef20d9c
FW
1266 spec->type = FORMAT_TYPE_INT;
1267 else
1268 spec->type = FORMAT_TYPE_UINT;
78a8bf69 1269 }
fef20d9c
FW
1270
1271 return ++fmt - start;
78a8bf69
LT
1272}
1273
1da177e4
LT
1274/**
1275 * vsnprintf - Format a string and place it in a buffer
1276 * @buf: The buffer to place the result into
1277 * @size: The size of the buffer, including the trailing null space
1278 * @fmt: The format string to use
1279 * @args: Arguments for the format string
1280 *
20036fdc 1281 * This function follows C99 vsnprintf, but has some extensions:
91adcd2c
SR
1282 * %pS output the name of a text symbol with offset
1283 * %ps output the name of a text symbol without offset
0c8b946e
FW
1284 * %pF output the name of a function pointer with its offset
1285 * %pf output the name of a function pointer without its offset
0f77a8d3 1286 * %pB output the name of a backtrace symbol with its offset
8a79503a
UKK
1287 * %pR output the address range in a struct resource with decoded flags
1288 * %pr output the address range in a struct resource with raw flags
1289 * %pM output a 6-byte MAC address with colons
1290 * %pm output a 6-byte MAC address without colons
1291 * %pI4 print an IPv4 address without leading zeros
1292 * %pi4 print an IPv4 address with leading zeros
1293 * %pI6 print an IPv6 address with colons
1294 * %pi6 print an IPv6 address without colons
f996f208 1295 * %pI6c print an IPv6 address as specified by RFC 5952
8a79503a
UKK
1296 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1297 * case.
0efb4d20 1298 * %n is ignored
20036fdc 1299 *
1da177e4
LT
1300 * The return value is the number of characters which would
1301 * be generated for the given input, excluding the trailing
1302 * '\0', as per ISO C99. If you want to have the exact
1303 * number of characters written into @buf as return value
72fd4a35 1304 * (not including the trailing '\0'), use vscnprintf(). If the
1da177e4
LT
1305 * return is greater than or equal to @size, the resulting
1306 * string is truncated.
1307 *
ba1835eb 1308 * If you're not already dealing with a va_list consider using snprintf().
1da177e4
LT
1309 */
1310int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1311{
1da177e4 1312 unsigned long long num;
d4be151b 1313 char *str, *end;
fef20d9c 1314 struct printf_spec spec = {0};
1da177e4 1315
f796937a
JF
1316 /* Reject out-of-range values early. Large positive sizes are
1317 used for unknown buffer sizes. */
2f30b1f9 1318 if (WARN_ON_ONCE((int) size < 0))
1da177e4 1319 return 0;
1da177e4
LT
1320
1321 str = buf;
f796937a 1322 end = buf + size;
1da177e4 1323
f796937a
JF
1324 /* Make sure end is always >= buf */
1325 if (end < buf) {
1326 end = ((void *)-1);
1327 size = end - buf;
1da177e4
LT
1328 }
1329
fef20d9c
FW
1330 while (*fmt) {
1331 const char *old_fmt = fmt;
d4be151b 1332 int read = format_decode(fmt, &spec);
1da177e4 1333
fef20d9c 1334 fmt += read;
1da177e4 1335
fef20d9c
FW
1336 switch (spec.type) {
1337 case FORMAT_TYPE_NONE: {
1338 int copy = read;
1339 if (str < end) {
1340 if (copy > end - str)
1341 copy = end - str;
1342 memcpy(str, old_fmt, copy);
1da177e4 1343 }
fef20d9c
FW
1344 str += read;
1345 break;
1da177e4
LT
1346 }
1347
ed681a91 1348 case FORMAT_TYPE_WIDTH:
fef20d9c
FW
1349 spec.field_width = va_arg(args, int);
1350 break;
1da177e4 1351
fef20d9c
FW
1352 case FORMAT_TYPE_PRECISION:
1353 spec.precision = va_arg(args, int);
1354 break;
1da177e4 1355
d4be151b
AGR
1356 case FORMAT_TYPE_CHAR: {
1357 char c;
1358
fef20d9c
FW
1359 if (!(spec.flags & LEFT)) {
1360 while (--spec.field_width > 0) {
f796937a 1361 if (str < end)
1da177e4
LT
1362 *str = ' ';
1363 ++str;
1da177e4 1364
fef20d9c
FW
1365 }
1366 }
1367 c = (unsigned char) va_arg(args, int);
1368 if (str < end)
1369 *str = c;
1370 ++str;
1371 while (--spec.field_width > 0) {
f796937a 1372 if (str < end)
fef20d9c 1373 *str = ' ';
1da177e4 1374 ++str;
fef20d9c
FW
1375 }
1376 break;
d4be151b 1377 }
1da177e4 1378
fef20d9c
FW
1379 case FORMAT_TYPE_STR:
1380 str = string(str, end, va_arg(args, char *), spec);
1381 break;
1da177e4 1382
fef20d9c
FW
1383 case FORMAT_TYPE_PTR:
1384 str = pointer(fmt+1, str, end, va_arg(args, void *),
1385 spec);
1386 while (isalnum(*fmt))
1387 fmt++;
1388 break;
1da177e4 1389
fef20d9c
FW
1390 case FORMAT_TYPE_PERCENT_CHAR:
1391 if (str < end)
1392 *str = '%';
1393 ++str;
1394 break;
1da177e4 1395
fef20d9c
FW
1396 case FORMAT_TYPE_INVALID:
1397 if (str < end)
1398 *str = '%';
1399 ++str;
fef20d9c
FW
1400 break;
1401
1402 case FORMAT_TYPE_NRCHARS: {
ef0658f3 1403 u8 qualifier = spec.qualifier;
fef20d9c
FW
1404
1405 if (qualifier == 'l') {
1406 long *ip = va_arg(args, long *);
1407 *ip = (str - buf);
75fb8f26 1408 } else if (_tolower(qualifier) == 'z') {
fef20d9c
FW
1409 size_t *ip = va_arg(args, size_t *);
1410 *ip = (str - buf);
1411 } else {
1412 int *ip = va_arg(args, int *);
1413 *ip = (str - buf);
1414 }
1415 break;
1da177e4 1416 }
fef20d9c
FW
1417
1418 default:
1419 switch (spec.type) {
1420 case FORMAT_TYPE_LONG_LONG:
1421 num = va_arg(args, long long);
1422 break;
1423 case FORMAT_TYPE_ULONG:
1424 num = va_arg(args, unsigned long);
1425 break;
1426 case FORMAT_TYPE_LONG:
1427 num = va_arg(args, long);
1428 break;
1429 case FORMAT_TYPE_SIZE_T:
1430 num = va_arg(args, size_t);
1431 break;
1432 case FORMAT_TYPE_PTRDIFF:
1433 num = va_arg(args, ptrdiff_t);
1434 break;
a4e94ef0
Z
1435 case FORMAT_TYPE_UBYTE:
1436 num = (unsigned char) va_arg(args, int);
1437 break;
1438 case FORMAT_TYPE_BYTE:
1439 num = (signed char) va_arg(args, int);
1440 break;
fef20d9c
FW
1441 case FORMAT_TYPE_USHORT:
1442 num = (unsigned short) va_arg(args, int);
1443 break;
1444 case FORMAT_TYPE_SHORT:
1445 num = (short) va_arg(args, int);
1446 break;
39e874f8
FW
1447 case FORMAT_TYPE_INT:
1448 num = (int) va_arg(args, int);
fef20d9c
FW
1449 break;
1450 default:
1451 num = va_arg(args, unsigned int);
1452 }
1453
1454 str = number(str, end, num, spec);
1da177e4 1455 }
1da177e4 1456 }
fef20d9c 1457
f796937a
JF
1458 if (size > 0) {
1459 if (str < end)
1460 *str = '\0';
1461 else
0a6047ee 1462 end[-1] = '\0';
f796937a 1463 }
fef20d9c 1464
f796937a 1465 /* the trailing null byte doesn't count towards the total */
1da177e4 1466 return str-buf;
fef20d9c 1467
1da177e4 1468}
1da177e4
LT
1469EXPORT_SYMBOL(vsnprintf);
1470
1471/**
1472 * vscnprintf - Format a string and place it in a buffer
1473 * @buf: The buffer to place the result into
1474 * @size: The size of the buffer, including the trailing null space
1475 * @fmt: The format string to use
1476 * @args: Arguments for the format string
1477 *
1478 * The return value is the number of characters which have been written into
b921c69f 1479 * the @buf not including the trailing '\0'. If @size is == 0 the function
1da177e4
LT
1480 * returns 0.
1481 *
ba1835eb 1482 * If you're not already dealing with a va_list consider using scnprintf().
20036fdc
AK
1483 *
1484 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4
LT
1485 */
1486int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1487{
1488 int i;
1489
7b9186f5
AGR
1490 i = vsnprintf(buf, size, fmt, args);
1491
b921c69f
AA
1492 if (likely(i < size))
1493 return i;
1494 if (size != 0)
1495 return size - 1;
1496 return 0;
1da177e4 1497}
1da177e4
LT
1498EXPORT_SYMBOL(vscnprintf);
1499
1500/**
1501 * snprintf - Format a string and place it in a buffer
1502 * @buf: The buffer to place the result into
1503 * @size: The size of the buffer, including the trailing null space
1504 * @fmt: The format string to use
1505 * @...: Arguments for the format string
1506 *
1507 * The return value is the number of characters which would be
1508 * generated for the given input, excluding the trailing null,
1509 * as per ISO C99. If the return is greater than or equal to
1510 * @size, the resulting string is truncated.
20036fdc
AK
1511 *
1512 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 1513 */
7b9186f5 1514int snprintf(char *buf, size_t size, const char *fmt, ...)
1da177e4
LT
1515{
1516 va_list args;
1517 int i;
1518
1519 va_start(args, fmt);
7b9186f5 1520 i = vsnprintf(buf, size, fmt, args);
1da177e4 1521 va_end(args);
7b9186f5 1522
1da177e4
LT
1523 return i;
1524}
1da177e4
LT
1525EXPORT_SYMBOL(snprintf);
1526
1527/**
1528 * scnprintf - Format a string and place it in a buffer
1529 * @buf: The buffer to place the result into
1530 * @size: The size of the buffer, including the trailing null space
1531 * @fmt: The format string to use
1532 * @...: Arguments for the format string
1533 *
1534 * The return value is the number of characters written into @buf not including
b903c0b8 1535 * the trailing '\0'. If @size is == 0 the function returns 0.
1da177e4
LT
1536 */
1537
7b9186f5 1538int scnprintf(char *buf, size_t size, const char *fmt, ...)
1da177e4
LT
1539{
1540 va_list args;
1541 int i;
1542
1543 va_start(args, fmt);
b921c69f 1544 i = vscnprintf(buf, size, fmt, args);
1da177e4 1545 va_end(args);
7b9186f5 1546
b921c69f 1547 return i;
1da177e4
LT
1548}
1549EXPORT_SYMBOL(scnprintf);
1550
1551/**
1552 * vsprintf - Format a string and place it in a buffer
1553 * @buf: The buffer to place the result into
1554 * @fmt: The format string to use
1555 * @args: Arguments for the format string
1556 *
1557 * The function returns the number of characters written
72fd4a35 1558 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1da177e4
LT
1559 * buffer overflows.
1560 *
ba1835eb 1561 * If you're not already dealing with a va_list consider using sprintf().
20036fdc
AK
1562 *
1563 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4
LT
1564 */
1565int vsprintf(char *buf, const char *fmt, va_list args)
1566{
1567 return vsnprintf(buf, INT_MAX, fmt, args);
1568}
1da177e4
LT
1569EXPORT_SYMBOL(vsprintf);
1570
1571/**
1572 * sprintf - Format a string and place it in a buffer
1573 * @buf: The buffer to place the result into
1574 * @fmt: The format string to use
1575 * @...: Arguments for the format string
1576 *
1577 * The function returns the number of characters written
72fd4a35 1578 * into @buf. Use snprintf() or scnprintf() in order to avoid
1da177e4 1579 * buffer overflows.
20036fdc
AK
1580 *
1581 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 1582 */
7b9186f5 1583int sprintf(char *buf, const char *fmt, ...)
1da177e4
LT
1584{
1585 va_list args;
1586 int i;
1587
1588 va_start(args, fmt);
7b9186f5 1589 i = vsnprintf(buf, INT_MAX, fmt, args);
1da177e4 1590 va_end(args);
7b9186f5 1591
1da177e4
LT
1592 return i;
1593}
1da177e4
LT
1594EXPORT_SYMBOL(sprintf);
1595
4370aa4a
LJ
1596#ifdef CONFIG_BINARY_PRINTF
1597/*
1598 * bprintf service:
1599 * vbin_printf() - VA arguments to binary data
1600 * bstr_printf() - Binary data to text string
1601 */
1602
1603/**
1604 * vbin_printf - Parse a format string and place args' binary value in a buffer
1605 * @bin_buf: The buffer to place args' binary value
1606 * @size: The size of the buffer(by words(32bits), not characters)
1607 * @fmt: The format string to use
1608 * @args: Arguments for the format string
1609 *
1610 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1611 * is skiped.
1612 *
1613 * The return value is the number of words(32bits) which would be generated for
1614 * the given input.
1615 *
1616 * NOTE:
1617 * If the return value is greater than @size, the resulting bin_buf is NOT
1618 * valid for bstr_printf().
1619 */
1620int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1621{
fef20d9c 1622 struct printf_spec spec = {0};
4370aa4a 1623 char *str, *end;
4370aa4a
LJ
1624
1625 str = (char *)bin_buf;
1626 end = (char *)(bin_buf + size);
1627
1628#define save_arg(type) \
1629do { \
1630 if (sizeof(type) == 8) { \
1631 unsigned long long value; \
1632 str = PTR_ALIGN(str, sizeof(u32)); \
1633 value = va_arg(args, unsigned long long); \
1634 if (str + sizeof(type) <= end) { \
1635 *(u32 *)str = *(u32 *)&value; \
1636 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1637 } \
1638 } else { \
1639 unsigned long value; \
1640 str = PTR_ALIGN(str, sizeof(type)); \
1641 value = va_arg(args, int); \
1642 if (str + sizeof(type) <= end) \
1643 *(typeof(type) *)str = (type)value; \
1644 } \
1645 str += sizeof(type); \
1646} while (0)
1647
fef20d9c 1648 while (*fmt) {
d4be151b 1649 int read = format_decode(fmt, &spec);
4370aa4a 1650
fef20d9c 1651 fmt += read;
4370aa4a 1652
fef20d9c
FW
1653 switch (spec.type) {
1654 case FORMAT_TYPE_NONE:
d4be151b
AGR
1655 case FORMAT_TYPE_INVALID:
1656 case FORMAT_TYPE_PERCENT_CHAR:
fef20d9c
FW
1657 break;
1658
ed681a91 1659 case FORMAT_TYPE_WIDTH:
fef20d9c
FW
1660 case FORMAT_TYPE_PRECISION:
1661 save_arg(int);
1662 break;
1663
1664 case FORMAT_TYPE_CHAR:
4370aa4a 1665 save_arg(char);
fef20d9c
FW
1666 break;
1667
1668 case FORMAT_TYPE_STR: {
4370aa4a
LJ
1669 const char *save_str = va_arg(args, char *);
1670 size_t len;
6c356634 1671
4370aa4a
LJ
1672 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1673 || (unsigned long)save_str < PAGE_SIZE)
0f4f81dc 1674 save_str = "(null)";
6c356634
AGR
1675 len = strlen(save_str) + 1;
1676 if (str + len < end)
1677 memcpy(str, save_str, len);
1678 str += len;
fef20d9c 1679 break;
4370aa4a 1680 }
fef20d9c
FW
1681
1682 case FORMAT_TYPE_PTR:
4370aa4a
LJ
1683 save_arg(void *);
1684 /* skip all alphanumeric pointer suffixes */
fef20d9c 1685 while (isalnum(*fmt))
4370aa4a 1686 fmt++;
fef20d9c
FW
1687 break;
1688
fef20d9c 1689 case FORMAT_TYPE_NRCHARS: {
4370aa4a 1690 /* skip %n 's argument */
ef0658f3 1691 u8 qualifier = spec.qualifier;
4370aa4a
LJ
1692 void *skip_arg;
1693 if (qualifier == 'l')
1694 skip_arg = va_arg(args, long *);
75fb8f26 1695 else if (_tolower(qualifier) == 'z')
4370aa4a
LJ
1696 skip_arg = va_arg(args, size_t *);
1697 else
1698 skip_arg = va_arg(args, int *);
fef20d9c 1699 break;
4370aa4a 1700 }
fef20d9c
FW
1701
1702 default:
1703 switch (spec.type) {
1704
1705 case FORMAT_TYPE_LONG_LONG:
4370aa4a 1706 save_arg(long long);
fef20d9c
FW
1707 break;
1708 case FORMAT_TYPE_ULONG:
1709 case FORMAT_TYPE_LONG:
4370aa4a 1710 save_arg(unsigned long);
fef20d9c
FW
1711 break;
1712 case FORMAT_TYPE_SIZE_T:
4370aa4a 1713 save_arg(size_t);
fef20d9c
FW
1714 break;
1715 case FORMAT_TYPE_PTRDIFF:
4370aa4a 1716 save_arg(ptrdiff_t);
fef20d9c 1717 break;
a4e94ef0
Z
1718 case FORMAT_TYPE_UBYTE:
1719 case FORMAT_TYPE_BYTE:
1720 save_arg(char);
1721 break;
fef20d9c
FW
1722 case FORMAT_TYPE_USHORT:
1723 case FORMAT_TYPE_SHORT:
4370aa4a 1724 save_arg(short);
fef20d9c
FW
1725 break;
1726 default:
4370aa4a 1727 save_arg(int);
fef20d9c 1728 }
4370aa4a
LJ
1729 }
1730 }
fef20d9c 1731
7b9186f5 1732 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
fef20d9c 1733#undef save_arg
4370aa4a
LJ
1734}
1735EXPORT_SYMBOL_GPL(vbin_printf);
1736
1737/**
1738 * bstr_printf - Format a string from binary arguments and place it in a buffer
1739 * @buf: The buffer to place the result into
1740 * @size: The size of the buffer, including the trailing null space
1741 * @fmt: The format string to use
1742 * @bin_buf: Binary arguments for the format string
1743 *
1744 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1745 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1746 * a binary buffer that generated by vbin_printf.
1747 *
1748 * The format follows C99 vsnprintf, but has some extensions:
0efb4d20 1749 * see vsnprintf comment for details.
4370aa4a
LJ
1750 *
1751 * The return value is the number of characters which would
1752 * be generated for the given input, excluding the trailing
1753 * '\0', as per ISO C99. If you want to have the exact
1754 * number of characters written into @buf as return value
1755 * (not including the trailing '\0'), use vscnprintf(). If the
1756 * return is greater than or equal to @size, the resulting
1757 * string is truncated.
1758 */
1759int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1760{
fef20d9c 1761 struct printf_spec spec = {0};
d4be151b
AGR
1762 char *str, *end;
1763 const char *args = (const char *)bin_buf;
4370aa4a 1764
2f30b1f9 1765 if (WARN_ON_ONCE((int) size < 0))
4370aa4a 1766 return 0;
4370aa4a
LJ
1767
1768 str = buf;
1769 end = buf + size;
1770
1771#define get_arg(type) \
1772({ \
1773 typeof(type) value; \
1774 if (sizeof(type) == 8) { \
1775 args = PTR_ALIGN(args, sizeof(u32)); \
1776 *(u32 *)&value = *(u32 *)args; \
1777 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1778 } else { \
1779 args = PTR_ALIGN(args, sizeof(type)); \
1780 value = *(typeof(type) *)args; \
1781 } \
1782 args += sizeof(type); \
1783 value; \
1784})
1785
1786 /* Make sure end is always >= buf */
1787 if (end < buf) {
1788 end = ((void *)-1);
1789 size = end - buf;
1790 }
1791
fef20d9c 1792 while (*fmt) {
fef20d9c 1793 const char *old_fmt = fmt;
d4be151b 1794 int read = format_decode(fmt, &spec);
4370aa4a 1795
fef20d9c 1796 fmt += read;
4370aa4a 1797
fef20d9c
FW
1798 switch (spec.type) {
1799 case FORMAT_TYPE_NONE: {
1800 int copy = read;
1801 if (str < end) {
1802 if (copy > end - str)
1803 copy = end - str;
1804 memcpy(str, old_fmt, copy);
4370aa4a 1805 }
fef20d9c
FW
1806 str += read;
1807 break;
4370aa4a
LJ
1808 }
1809
ed681a91 1810 case FORMAT_TYPE_WIDTH:
fef20d9c
FW
1811 spec.field_width = get_arg(int);
1812 break;
4370aa4a 1813
fef20d9c
FW
1814 case FORMAT_TYPE_PRECISION:
1815 spec.precision = get_arg(int);
1816 break;
4370aa4a 1817
d4be151b
AGR
1818 case FORMAT_TYPE_CHAR: {
1819 char c;
1820
fef20d9c
FW
1821 if (!(spec.flags & LEFT)) {
1822 while (--spec.field_width > 0) {
4370aa4a
LJ
1823 if (str < end)
1824 *str = ' ';
1825 ++str;
1826 }
1827 }
1828 c = (unsigned char) get_arg(char);
1829 if (str < end)
1830 *str = c;
1831 ++str;
fef20d9c 1832 while (--spec.field_width > 0) {
4370aa4a
LJ
1833 if (str < end)
1834 *str = ' ';
1835 ++str;
1836 }
fef20d9c 1837 break;
d4be151b 1838 }
4370aa4a 1839
fef20d9c 1840 case FORMAT_TYPE_STR: {
4370aa4a 1841 const char *str_arg = args;
d4be151b 1842 args += strlen(str_arg) + 1;
fef20d9c
FW
1843 str = string(str, end, (char *)str_arg, spec);
1844 break;
4370aa4a
LJ
1845 }
1846
fef20d9c
FW
1847 case FORMAT_TYPE_PTR:
1848 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1849 while (isalnum(*fmt))
4370aa4a 1850 fmt++;
fef20d9c 1851 break;
4370aa4a 1852
fef20d9c 1853 case FORMAT_TYPE_PERCENT_CHAR:
fef20d9c 1854 case FORMAT_TYPE_INVALID:
4370aa4a
LJ
1855 if (str < end)
1856 *str = '%';
1857 ++str;
fef20d9c
FW
1858 break;
1859
1860 case FORMAT_TYPE_NRCHARS:
1861 /* skip */
1862 break;
1863
d4be151b
AGR
1864 default: {
1865 unsigned long long num;
1866
fef20d9c
FW
1867 switch (spec.type) {
1868
1869 case FORMAT_TYPE_LONG_LONG:
1870 num = get_arg(long long);
1871 break;
1872 case FORMAT_TYPE_ULONG:
fef20d9c
FW
1873 case FORMAT_TYPE_LONG:
1874 num = get_arg(unsigned long);
1875 break;
1876 case FORMAT_TYPE_SIZE_T:
1877 num = get_arg(size_t);
1878 break;
1879 case FORMAT_TYPE_PTRDIFF:
1880 num = get_arg(ptrdiff_t);
1881 break;
a4e94ef0
Z
1882 case FORMAT_TYPE_UBYTE:
1883 num = get_arg(unsigned char);
1884 break;
1885 case FORMAT_TYPE_BYTE:
1886 num = get_arg(signed char);
1887 break;
fef20d9c
FW
1888 case FORMAT_TYPE_USHORT:
1889 num = get_arg(unsigned short);
1890 break;
1891 case FORMAT_TYPE_SHORT:
1892 num = get_arg(short);
1893 break;
1894 case FORMAT_TYPE_UINT:
1895 num = get_arg(unsigned int);
1896 break;
1897 default:
1898 num = get_arg(int);
1899 }
1900
1901 str = number(str, end, num, spec);
d4be151b
AGR
1902 } /* default: */
1903 } /* switch(spec.type) */
1904 } /* while(*fmt) */
fef20d9c 1905
4370aa4a
LJ
1906 if (size > 0) {
1907 if (str < end)
1908 *str = '\0';
1909 else
1910 end[-1] = '\0';
1911 }
fef20d9c 1912
4370aa4a
LJ
1913#undef get_arg
1914
1915 /* the trailing null byte doesn't count towards the total */
1916 return str - buf;
1917}
1918EXPORT_SYMBOL_GPL(bstr_printf);
1919
1920/**
1921 * bprintf - Parse a format string and place args' binary value in a buffer
1922 * @bin_buf: The buffer to place args' binary value
1923 * @size: The size of the buffer(by words(32bits), not characters)
1924 * @fmt: The format string to use
1925 * @...: Arguments for the format string
1926 *
1927 * The function returns the number of words(u32) written
1928 * into @bin_buf.
1929 */
1930int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1931{
1932 va_list args;
1933 int ret;
1934
1935 va_start(args, fmt);
1936 ret = vbin_printf(bin_buf, size, fmt, args);
1937 va_end(args);
7b9186f5 1938
4370aa4a
LJ
1939 return ret;
1940}
1941EXPORT_SYMBOL_GPL(bprintf);
1942
1943#endif /* CONFIG_BINARY_PRINTF */
1944
1da177e4
LT
1945/**
1946 * vsscanf - Unformat a buffer into a list of arguments
1947 * @buf: input buffer
1948 * @fmt: format of buffer
1949 * @args: arguments
1950 */
7b9186f5 1951int vsscanf(const char *buf, const char *fmt, va_list args)
1da177e4
LT
1952{
1953 const char *str = buf;
1954 char *next;
1955 char digit;
1956 int num = 0;
ef0658f3
JP
1957 u8 qualifier;
1958 u8 base;
1959 s16 field_width;
d4be151b 1960 bool is_sign;
1da177e4 1961
7b9186f5 1962 while (*fmt && *str) {
1da177e4
LT
1963 /* skip any white space in format */
1964 /* white space in format matchs any amount of
1965 * white space, including none, in the input.
1966 */
1967 if (isspace(*fmt)) {
e7d2860b
AGR
1968 fmt = skip_spaces(++fmt);
1969 str = skip_spaces(str);
1da177e4
LT
1970 }
1971
1972 /* anything that is not a conversion must match exactly */
1973 if (*fmt != '%' && *fmt) {
1974 if (*fmt++ != *str++)
1975 break;
1976 continue;
1977 }
1978
1979 if (!*fmt)
1980 break;
1981 ++fmt;
7b9186f5 1982
1da177e4
LT
1983 /* skip this conversion.
1984 * advance both strings to next white space
1985 */
1986 if (*fmt == '*') {
8fccae2c 1987 while (!isspace(*fmt) && *fmt != '%' && *fmt)
1da177e4
LT
1988 fmt++;
1989 while (!isspace(*str) && *str)
1990 str++;
1991 continue;
1992 }
1993
1994 /* get field width */
1995 field_width = -1;
1996 if (isdigit(*fmt))
1997 field_width = skip_atoi(&fmt);
1998
1999 /* get conversion qualifier */
2000 qualifier = -1;
75fb8f26
AS
2001 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2002 _tolower(*fmt) == 'z') {
1da177e4
LT
2003 qualifier = *fmt++;
2004 if (unlikely(qualifier == *fmt)) {
2005 if (qualifier == 'h') {
2006 qualifier = 'H';
2007 fmt++;
2008 } else if (qualifier == 'l') {
2009 qualifier = 'L';
2010 fmt++;
2011 }
2012 }
2013 }
1da177e4
LT
2014
2015 if (!*fmt || !*str)
2016 break;
2017
d4be151b
AGR
2018 base = 10;
2019 is_sign = 0;
2020
7b9186f5 2021 switch (*fmt++) {
1da177e4
LT
2022 case 'c':
2023 {
7b9186f5 2024 char *s = (char *)va_arg(args, char*);
1da177e4
LT
2025 if (field_width == -1)
2026 field_width = 1;
2027 do {
2028 *s++ = *str++;
2029 } while (--field_width > 0 && *str);
2030 num++;
2031 }
2032 continue;
2033 case 's':
2034 {
7b9186f5
AGR
2035 char *s = (char *)va_arg(args, char *);
2036 if (field_width == -1)
4be929be 2037 field_width = SHRT_MAX;
1da177e4 2038 /* first, skip leading white space in buffer */
e7d2860b 2039 str = skip_spaces(str);
1da177e4
LT
2040
2041 /* now copy until next white space */
7b9186f5 2042 while (*str && !isspace(*str) && field_width--)
1da177e4 2043 *s++ = *str++;
1da177e4
LT
2044 *s = '\0';
2045 num++;
2046 }
2047 continue;
2048 case 'n':
2049 /* return number of characters read so far */
2050 {
7b9186f5 2051 int *i = (int *)va_arg(args, int*);
1da177e4
LT
2052 *i = str - buf;
2053 }
2054 continue;
2055 case 'o':
2056 base = 8;
2057 break;
2058 case 'x':
2059 case 'X':
2060 base = 16;
2061 break;
2062 case 'i':
7b9186f5 2063 base = 0;
1da177e4
LT
2064 case 'd':
2065 is_sign = 1;
2066 case 'u':
2067 break;
2068 case '%':
2069 /* looking for '%' in str */
7b9186f5 2070 if (*str++ != '%')
1da177e4
LT
2071 return num;
2072 continue;
2073 default:
2074 /* invalid format; stop here */
2075 return num;
2076 }
2077
2078 /* have some sort of integer conversion.
2079 * first, skip white space in buffer.
2080 */
e7d2860b 2081 str = skip_spaces(str);
1da177e4
LT
2082
2083 digit = *str;
2084 if (is_sign && digit == '-')
2085 digit = *(str + 1);
2086
2087 if (!digit
7b9186f5
AGR
2088 || (base == 16 && !isxdigit(digit))
2089 || (base == 10 && !isdigit(digit))
2090 || (base == 8 && (!isdigit(digit) || digit > '7'))
2091 || (base == 0 && !isdigit(digit)))
2092 break;
1da177e4 2093
7b9186f5 2094 switch (qualifier) {
1da177e4
LT
2095 case 'H': /* that's 'hh' in format */
2096 if (is_sign) {
7b9186f5
AGR
2097 signed char *s = (signed char *)va_arg(args, signed char *);
2098 *s = (signed char)simple_strtol(str, &next, base);
1da177e4 2099 } else {
7b9186f5
AGR
2100 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
2101 *s = (unsigned char)simple_strtoul(str, &next, base);
1da177e4
LT
2102 }
2103 break;
2104 case 'h':
2105 if (is_sign) {
7b9186f5
AGR
2106 short *s = (short *)va_arg(args, short *);
2107 *s = (short)simple_strtol(str, &next, base);
1da177e4 2108 } else {
7b9186f5
AGR
2109 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
2110 *s = (unsigned short)simple_strtoul(str, &next, base);
1da177e4
LT
2111 }
2112 break;
2113 case 'l':
2114 if (is_sign) {
7b9186f5
AGR
2115 long *l = (long *)va_arg(args, long *);
2116 *l = simple_strtol(str, &next, base);
1da177e4 2117 } else {
7b9186f5
AGR
2118 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
2119 *l = simple_strtoul(str, &next, base);
1da177e4
LT
2120 }
2121 break;
2122 case 'L':
2123 if (is_sign) {
7b9186f5
AGR
2124 long long *l = (long long *)va_arg(args, long long *);
2125 *l = simple_strtoll(str, &next, base);
1da177e4 2126 } else {
7b9186f5
AGR
2127 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
2128 *l = simple_strtoull(str, &next, base);
1da177e4
LT
2129 }
2130 break;
2131 case 'Z':
2132 case 'z':
2133 {
7b9186f5
AGR
2134 size_t *s = (size_t *)va_arg(args, size_t *);
2135 *s = (size_t)simple_strtoul(str, &next, base);
1da177e4
LT
2136 }
2137 break;
2138 default:
2139 if (is_sign) {
7b9186f5
AGR
2140 int *i = (int *)va_arg(args, int *);
2141 *i = (int)simple_strtol(str, &next, base);
1da177e4 2142 } else {
7b9186f5
AGR
2143 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
2144 *i = (unsigned int)simple_strtoul(str, &next, base);
1da177e4
LT
2145 }
2146 break;
2147 }
2148 num++;
2149
2150 if (!next)
2151 break;
2152 str = next;
2153 }
c6b40d16
JB
2154
2155 /*
2156 * Now we've come all the way through so either the input string or the
2157 * format ended. In the former case, there can be a %n at the current
2158 * position in the format that needs to be filled.
2159 */
2160 if (*fmt == '%' && *(fmt + 1) == 'n') {
2161 int *p = (int *)va_arg(args, int *);
2162 *p = str - buf;
2163 }
2164
1da177e4
LT
2165 return num;
2166}
1da177e4
LT
2167EXPORT_SYMBOL(vsscanf);
2168
2169/**
2170 * sscanf - Unformat a buffer into a list of arguments
2171 * @buf: input buffer
2172 * @fmt: formatting of buffer
2173 * @...: resulting arguments
2174 */
7b9186f5 2175int sscanf(const char *buf, const char *fmt, ...)
1da177e4
LT
2176{
2177 va_list args;
2178 int i;
2179
7b9186f5
AGR
2180 va_start(args, fmt);
2181 i = vsscanf(buf, fmt, args);
1da177e4 2182 va_end(args);
7b9186f5 2183
1da177e4
LT
2184 return i;
2185}
1da177e4 2186EXPORT_SYMBOL(sscanf);