lib/vsprintf: refactor duplicate code to special_hex_number()
[deliverable/linux.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>
0d1d7a55 20#include <linux/clk.h>
900cca29 21#include <linux/clk-provider.h>
8bc3bcc9 22#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
1da177e4
LT
23#include <linux/types.h>
24#include <linux/string.h>
25#include <linux/ctype.h>
26#include <linux/kernel.h>
0fe1ef24 27#include <linux/kallsyms.h>
53809751 28#include <linux/math64.h>
0fe1ef24 29#include <linux/uaccess.h>
332d2e78 30#include <linux/ioport.h>
4b6ccca7 31#include <linux/dcache.h>
312b4e22 32#include <linux/cred.h>
8a27f7c9 33#include <net/addrconf.h>
1031bc58
DM
34#ifdef CONFIG_BLOCK
35#include <linux/blkdev.h>
36#endif
1da177e4 37
4e57b681 38#include <asm/page.h> /* for PAGE_SIZE */
deac93df 39#include <asm/sections.h> /* for dereference_function_descriptor() */
7c43d9a3 40#include <asm/byteorder.h> /* cpu_to_le16 */
1da177e4 41
71dca95d 42#include <linux/string_helpers.h>
1dff46d6 43#include "kstrtox.h"
aa46a63e 44
1da177e4 45/**
922ac25c 46 * simple_strtoull - convert a string to an unsigned long long
1da177e4
LT
47 * @cp: The start of the string
48 * @endp: A pointer to the end of the parsed string will be placed here
49 * @base: The number base to use
462e4711
EZ
50 *
51 * This function is obsolete. Please use kstrtoull instead.
1da177e4 52 */
922ac25c 53unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
1da177e4 54{
1dff46d6
AD
55 unsigned long long result;
56 unsigned int rv;
aa46a63e 57
1dff46d6
AD
58 cp = _parse_integer_fixup_radix(cp, &base);
59 rv = _parse_integer(cp, base, &result);
60 /* FIXME */
61 cp += (rv & ~KSTRTOX_OVERFLOW);
aa46a63e 62
1da177e4
LT
63 if (endp)
64 *endp = (char *)cp;
7b9186f5 65
1da177e4
LT
66 return result;
67}
922ac25c 68EXPORT_SYMBOL(simple_strtoull);
1da177e4
LT
69
70/**
922ac25c 71 * simple_strtoul - convert a string to an unsigned long
1da177e4
LT
72 * @cp: The start of the string
73 * @endp: A pointer to the end of the parsed string will be placed here
74 * @base: The number base to use
462e4711
EZ
75 *
76 * This function is obsolete. Please use kstrtoul instead.
1da177e4 77 */
922ac25c 78unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
1da177e4 79{
922ac25c 80 return simple_strtoull(cp, endp, base);
1da177e4 81}
922ac25c 82EXPORT_SYMBOL(simple_strtoul);
1da177e4
LT
83
84/**
922ac25c 85 * simple_strtol - convert a string to a signed long
1da177e4
LT
86 * @cp: The start of the string
87 * @endp: A pointer to the end of the parsed string will be placed here
88 * @base: The number base to use
462e4711
EZ
89 *
90 * This function is obsolete. Please use kstrtol instead.
1da177e4 91 */
922ac25c 92long simple_strtol(const char *cp, char **endp, unsigned int base)
1da177e4 93{
922ac25c
AGR
94 if (*cp == '-')
95 return -simple_strtoul(cp + 1, endp, base);
7b9186f5 96
922ac25c 97 return simple_strtoul(cp, endp, base);
1da177e4 98}
922ac25c 99EXPORT_SYMBOL(simple_strtol);
1da177e4
LT
100
101/**
102 * simple_strtoll - convert a string to a signed long long
103 * @cp: The start of the string
104 * @endp: A pointer to the end of the parsed string will be placed here
105 * @base: The number base to use
462e4711
EZ
106 *
107 * This function is obsolete. Please use kstrtoll instead.
1da177e4 108 */
22d27051 109long long simple_strtoll(const char *cp, char **endp, unsigned int base)
1da177e4 110{
7b9186f5 111 if (*cp == '-')
22d27051 112 return -simple_strtoull(cp + 1, endp, base);
7b9186f5 113
22d27051 114 return simple_strtoull(cp, endp, base);
1da177e4 115}
98d5ce0d 116EXPORT_SYMBOL(simple_strtoll);
1da177e4 117
cf3b429b
JP
118static noinline_for_stack
119int skip_atoi(const char **s)
1da177e4 120{
7b9186f5 121 int i = 0;
1da177e4 122
43e5b666 123 do {
1da177e4 124 i = i*10 + *((*s)++) - '0';
43e5b666 125 } while (isdigit(**s));
7b9186f5 126
1da177e4
LT
127 return i;
128}
129
7c43d9a3
RV
130/*
131 * Decimal conversion is by far the most typical, and is used for
132 * /proc and /sys data. This directly impacts e.g. top performance
133 * with many processes running. We optimize it for speed by emitting
134 * two characters at a time, using a 200 byte lookup table. This
135 * roughly halves the number of multiplications compared to computing
136 * the digits one at a time. Implementation strongly inspired by the
137 * previous version, which in turn used ideas described at
138 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
139 * from the author, Douglas W. Jones).
140 *
141 * It turns out there is precisely one 26 bit fixed-point
142 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
143 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
144 * range happens to be somewhat larger (x <= 1073741898), but that's
145 * irrelevant for our purpose.
146 *
147 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
148 * need a 32x32->64 bit multiply, so we simply use the same constant.
149 *
150 * For dividing a number in the range [100, 10^4-1] by 100, there are
151 * several options. The simplest is (x * 0x147b) >> 19, which is valid
152 * for all x <= 43698.
133fd9f5 153 */
4277eedd 154
7c43d9a3
RV
155static const u16 decpair[100] = {
156#define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
157 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
158 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
159 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
160 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
161 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
162 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
163 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
164 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
165 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
166 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
167#undef _
168};
169
170/*
171 * This will print a single '0' even if r == 0, since we would
675cf53c
RV
172 * immediately jump to out_r where two 0s would be written but only
173 * one of them accounted for in buf. This is needed by ip4_string
174 * below. All other callers pass a non-zero value of r.
7c43d9a3 175*/
cf3b429b 176static noinline_for_stack
7c43d9a3 177char *put_dec_trunc8(char *buf, unsigned r)
4277eedd 178{
7c43d9a3
RV
179 unsigned q;
180
181 /* 1 <= r < 10^8 */
182 if (r < 100)
183 goto out_r;
184
185 /* 100 <= r < 10^8 */
186 q = (r * (u64)0x28f5c29) >> 32;
187 *((u16 *)buf) = decpair[r - 100*q];
188 buf += 2;
189
190 /* 1 <= q < 10^6 */
191 if (q < 100)
192 goto out_q;
193
194 /* 100 <= q < 10^6 */
195 r = (q * (u64)0x28f5c29) >> 32;
196 *((u16 *)buf) = decpair[q - 100*r];
197 buf += 2;
198
199 /* 1 <= r < 10^4 */
200 if (r < 100)
201 goto out_r;
202
203 /* 100 <= r < 10^4 */
204 q = (r * 0x147b) >> 19;
205 *((u16 *)buf) = decpair[r - 100*q];
206 buf += 2;
207out_q:
208 /* 1 <= q < 100 */
209 r = q;
210out_r:
211 /* 1 <= r < 100 */
212 *((u16 *)buf) = decpair[r];
675cf53c 213 buf += r < 10 ? 1 : 2;
4277eedd
DV
214 return buf;
215}
133fd9f5 216
7c43d9a3 217#if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
cf3b429b 218static noinline_for_stack
7c43d9a3 219char *put_dec_full8(char *buf, unsigned r)
4277eedd 220{
133fd9f5
DV
221 unsigned q;
222
7c43d9a3
RV
223 /* 0 <= r < 10^8 */
224 q = (r * (u64)0x28f5c29) >> 32;
225 *((u16 *)buf) = decpair[r - 100*q];
226 buf += 2;
4277eedd 227
7c43d9a3
RV
228 /* 0 <= q < 10^6 */
229 r = (q * (u64)0x28f5c29) >> 32;
230 *((u16 *)buf) = decpair[q - 100*r];
231 buf += 2;
7b9186f5 232
7c43d9a3
RV
233 /* 0 <= r < 10^4 */
234 q = (r * 0x147b) >> 19;
235 *((u16 *)buf) = decpair[r - 100*q];
236 buf += 2;
133fd9f5 237
7c43d9a3
RV
238 /* 0 <= q < 100 */
239 *((u16 *)buf) = decpair[q];
240 buf += 2;
241 return buf;
242}
133fd9f5 243
7c43d9a3 244static noinline_for_stack
133fd9f5
DV
245char *put_dec(char *buf, unsigned long long n)
246{
7c43d9a3
RV
247 if (n >= 100*1000*1000)
248 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
249 /* 1 <= n <= 1.6e11 */
250 if (n >= 100*1000*1000)
251 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
252 /* 1 <= n < 1e8 */
133fd9f5 253 return put_dec_trunc8(buf, n);
4277eedd 254}
133fd9f5 255
7c43d9a3 256#elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
133fd9f5 257
7c43d9a3
RV
258static void
259put_dec_full4(char *buf, unsigned r)
4277eedd 260{
7c43d9a3
RV
261 unsigned q;
262
263 /* 0 <= r < 10^4 */
264 q = (r * 0x147b) >> 19;
265 *((u16 *)buf) = decpair[r - 100*q];
266 buf += 2;
267 /* 0 <= q < 100 */
268 *((u16 *)buf) = decpair[q];
2359172a
GS
269}
270
271/*
272 * Call put_dec_full4 on x % 10000, return x / 10000.
273 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
274 * holds for all x < 1,128,869,999. The largest value this
275 * helper will ever be asked to convert is 1,125,520,955.
7c43d9a3 276 * (second call in the put_dec code, assuming n is all-ones).
2359172a 277 */
7c43d9a3 278static noinline_for_stack
2359172a
GS
279unsigned put_dec_helper4(char *buf, unsigned x)
280{
281 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
282
283 put_dec_full4(buf, x - q * 10000);
284 return q;
4277eedd
DV
285}
286
133fd9f5
DV
287/* Based on code by Douglas W. Jones found at
288 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
289 * (with permission from the author).
290 * Performs no 64-bit division and hence should be fast on 32-bit machines.
291 */
292static
293char *put_dec(char *buf, unsigned long long n)
294{
295 uint32_t d3, d2, d1, q, h;
296
297 if (n < 100*1000*1000)
298 return put_dec_trunc8(buf, n);
299
300 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
301 h = (n >> 32);
302 d2 = (h ) & 0xffff;
303 d3 = (h >> 16); /* implicit "& 0xffff" */
304
7c43d9a3
RV
305 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
306 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
133fd9f5 307 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
2359172a
GS
308 q = put_dec_helper4(buf, q);
309
310 q += 7671 * d3 + 9496 * d2 + 6 * d1;
311 q = put_dec_helper4(buf+4, q);
312
313 q += 4749 * d3 + 42 * d2;
314 q = put_dec_helper4(buf+8, q);
133fd9f5 315
2359172a
GS
316 q += 281 * d3;
317 buf += 12;
318 if (q)
319 buf = put_dec_trunc8(buf, q);
320 else while (buf[-1] == '0')
133fd9f5
DV
321 --buf;
322
323 return buf;
324}
325
326#endif
327
1ac101a5
KH
328/*
329 * Convert passed number to decimal string.
330 * Returns the length of string. On buffer overflow, returns 0.
331 *
332 * If speed is not important, use snprintf(). It's easy to read the code.
333 */
334int num_to_str(char *buf, int size, unsigned long long num)
335{
7c43d9a3
RV
336 /* put_dec requires 2-byte alignment of the buffer. */
337 char tmp[sizeof(num) * 3] __aligned(2);
1ac101a5
KH
338 int idx, len;
339
133fd9f5
DV
340 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
341 if (num <= 9) {
342 tmp[0] = '0' + num;
343 len = 1;
344 } else {
345 len = put_dec(tmp, num) - tmp;
346 }
1ac101a5
KH
347
348 if (len > size)
349 return 0;
350 for (idx = 0; idx < len; ++idx)
351 buf[idx] = tmp[len - idx - 1];
133fd9f5 352 return len;
1ac101a5
KH
353}
354
51be17df 355#define SIGN 1 /* unsigned/signed, must be 1 */
d1c1b121 356#define LEFT 2 /* left justified */
1da177e4
LT
357#define PLUS 4 /* show plus */
358#define SPACE 8 /* space if plus */
d1c1b121 359#define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
b89dc5d6
BH
360#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
361#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
1da177e4 362
fef20d9c
FW
363enum format_type {
364 FORMAT_TYPE_NONE, /* Just a string part */
ed681a91 365 FORMAT_TYPE_WIDTH,
fef20d9c
FW
366 FORMAT_TYPE_PRECISION,
367 FORMAT_TYPE_CHAR,
368 FORMAT_TYPE_STR,
369 FORMAT_TYPE_PTR,
370 FORMAT_TYPE_PERCENT_CHAR,
371 FORMAT_TYPE_INVALID,
372 FORMAT_TYPE_LONG_LONG,
373 FORMAT_TYPE_ULONG,
374 FORMAT_TYPE_LONG,
a4e94ef0
Z
375 FORMAT_TYPE_UBYTE,
376 FORMAT_TYPE_BYTE,
fef20d9c
FW
377 FORMAT_TYPE_USHORT,
378 FORMAT_TYPE_SHORT,
379 FORMAT_TYPE_UINT,
380 FORMAT_TYPE_INT,
fef20d9c
FW
381 FORMAT_TYPE_SIZE_T,
382 FORMAT_TYPE_PTRDIFF
383};
384
385struct printf_spec {
d0484193
RV
386 unsigned int type:8; /* format_type enum */
387 signed int field_width:24; /* width of output field */
388 unsigned int flags:8; /* flags to number() */
389 unsigned int base:8; /* number base, 8, 10 or 16 only */
390 signed int precision:16; /* # of digits/chars */
391} __packed;
4d72ba01
RV
392#define FIELD_WIDTH_MAX ((1 << 23) - 1)
393#define PRECISION_MAX ((1 << 15) - 1)
fef20d9c 394
cf3b429b
JP
395static noinline_for_stack
396char *number(char *buf, char *end, unsigned long long num,
397 struct printf_spec spec)
1da177e4 398{
7c43d9a3
RV
399 /* put_dec requires 2-byte alignment of the buffer. */
400 char tmp[3 * sizeof(num)] __aligned(2);
9b706aee
DV
401 char sign;
402 char locase;
fef20d9c 403 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
1da177e4 404 int i;
7c203422 405 bool is_zero = num == 0LL;
1c7a8e62
RV
406 int field_width = spec.field_width;
407 int precision = spec.precision;
1da177e4 408
d0484193
RV
409 BUILD_BUG_ON(sizeof(struct printf_spec) != 8);
410
9b706aee
DV
411 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
412 * produces same digits or (maybe lowercased) letters */
fef20d9c
FW
413 locase = (spec.flags & SMALL);
414 if (spec.flags & LEFT)
415 spec.flags &= ~ZEROPAD;
1da177e4 416 sign = 0;
fef20d9c 417 if (spec.flags & SIGN) {
7b9186f5 418 if ((signed long long)num < 0) {
1da177e4 419 sign = '-';
7b9186f5 420 num = -(signed long long)num;
1c7a8e62 421 field_width--;
fef20d9c 422 } else if (spec.flags & PLUS) {
1da177e4 423 sign = '+';
1c7a8e62 424 field_width--;
fef20d9c 425 } else if (spec.flags & SPACE) {
1da177e4 426 sign = ' ';
1c7a8e62 427 field_width--;
1da177e4
LT
428 }
429 }
b39a7340 430 if (need_pfx) {
fef20d9c 431 if (spec.base == 16)
1c7a8e62 432 field_width -= 2;
7c203422 433 else if (!is_zero)
1c7a8e62 434 field_width--;
1da177e4 435 }
b39a7340
DV
436
437 /* generate full string in tmp[], in reverse order */
1da177e4 438 i = 0;
133fd9f5 439 if (num < spec.base)
3ea8d440 440 tmp[i++] = hex_asc_upper[num] | locase;
fef20d9c
FW
441 else if (spec.base != 10) { /* 8 or 16 */
442 int mask = spec.base - 1;
b39a7340 443 int shift = 3;
7b9186f5
AGR
444
445 if (spec.base == 16)
446 shift = 4;
b39a7340 447 do {
3ea8d440 448 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
b39a7340
DV
449 num >>= shift;
450 } while (num);
4277eedd
DV
451 } else { /* base 10 */
452 i = put_dec(tmp, num) - tmp;
453 }
b39a7340
DV
454
455 /* printing 100 using %2d gives "100", not "00" */
1c7a8e62
RV
456 if (i > precision)
457 precision = i;
b39a7340 458 /* leading space padding */
1c7a8e62 459 field_width -= precision;
51be17df 460 if (!(spec.flags & (ZEROPAD | LEFT))) {
1c7a8e62 461 while (--field_width >= 0) {
f796937a 462 if (buf < end)
1da177e4
LT
463 *buf = ' ';
464 ++buf;
465 }
466 }
b39a7340 467 /* sign */
1da177e4 468 if (sign) {
f796937a 469 if (buf < end)
1da177e4
LT
470 *buf = sign;
471 ++buf;
472 }
b39a7340
DV
473 /* "0x" / "0" prefix */
474 if (need_pfx) {
7c203422
PC
475 if (spec.base == 16 || !is_zero) {
476 if (buf < end)
477 *buf = '0';
478 ++buf;
479 }
fef20d9c 480 if (spec.base == 16) {
f796937a 481 if (buf < end)
9b706aee 482 *buf = ('X' | locase);
1da177e4
LT
483 ++buf;
484 }
485 }
b39a7340 486 /* zero or space padding */
fef20d9c 487 if (!(spec.flags & LEFT)) {
d1c1b121
RV
488 char c = ' ' + (spec.flags & ZEROPAD);
489 BUILD_BUG_ON(' ' + ZEROPAD != '0');
1c7a8e62 490 while (--field_width >= 0) {
f796937a 491 if (buf < end)
1da177e4
LT
492 *buf = c;
493 ++buf;
494 }
495 }
b39a7340 496 /* hmm even more zero padding? */
1c7a8e62 497 while (i <= --precision) {
f796937a 498 if (buf < end)
1da177e4
LT
499 *buf = '0';
500 ++buf;
501 }
b39a7340
DV
502 /* actual digits of result */
503 while (--i >= 0) {
f796937a 504 if (buf < end)
1da177e4
LT
505 *buf = tmp[i];
506 ++buf;
507 }
b39a7340 508 /* trailing space padding */
1c7a8e62 509 while (--field_width >= 0) {
f796937a 510 if (buf < end)
1da177e4
LT
511 *buf = ' ';
512 ++buf;
513 }
7b9186f5 514
1da177e4
LT
515 return buf;
516}
517
3cab1e71
AS
518static noinline_for_stack
519char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
520{
521 struct printf_spec spec;
522
523 spec.type = FORMAT_TYPE_PTR;
524 spec.field_width = 2 + 2 * size; /* 0x + hex */
525 spec.flags = SPECIAL | SMALL | ZEROPAD;
526 spec.base = 16;
527 spec.precision = -1;
528
529 return number(buf, end, num, spec);
530}
531
cfccde04 532static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
4b6ccca7
AV
533{
534 size_t size;
535 if (buf >= end) /* nowhere to put anything */
536 return;
537 size = end - buf;
538 if (size <= spaces) {
539 memset(buf, ' ', size);
540 return;
541 }
542 if (len) {
543 if (len > size - spaces)
544 len = size - spaces;
545 memmove(buf + spaces, buf, len);
546 }
547 memset(buf, ' ', spaces);
548}
549
cfccde04
RV
550/*
551 * Handle field width padding for a string.
552 * @buf: current buffer position
553 * @n: length of string
554 * @end: end of output buffer
555 * @spec: for field width and flags
556 * Returns: new buffer position after padding.
557 */
558static noinline_for_stack
559char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
560{
561 unsigned spaces;
562
563 if (likely(n >= spec.field_width))
564 return buf;
565 /* we want to pad the sucker */
566 spaces = spec.field_width - n;
567 if (!(spec.flags & LEFT)) {
568 move_right(buf - n, end, n, spaces);
569 return buf + spaces;
570 }
571 while (spaces--) {
572 if (buf < end)
573 *buf = ' ';
574 ++buf;
575 }
576 return buf;
577}
578
95508cfa
RV
579static noinline_for_stack
580char *string(char *buf, char *end, const char *s, struct printf_spec spec)
581{
34fc8b90
RV
582 int len = 0;
583 size_t lim = spec.precision;
95508cfa
RV
584
585 if ((unsigned long)s < PAGE_SIZE)
586 s = "(null)";
587
34fc8b90
RV
588 while (lim--) {
589 char c = *s++;
590 if (!c)
591 break;
95508cfa 592 if (buf < end)
34fc8b90 593 *buf = c;
95508cfa 594 ++buf;
34fc8b90 595 ++len;
95508cfa 596 }
34fc8b90 597 return widen_string(buf, len, end, spec);
95508cfa
RV
598}
599
4b6ccca7
AV
600static noinline_for_stack
601char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
602 const char *fmt)
603{
604 const char *array[4], *s;
605 const struct dentry *p;
606 int depth;
607 int i, n;
608
609 switch (fmt[1]) {
610 case '2': case '3': case '4':
611 depth = fmt[1] - '0';
612 break;
613 default:
614 depth = 1;
615 }
616
617 rcu_read_lock();
618 for (i = 0; i < depth; i++, d = p) {
619 p = ACCESS_ONCE(d->d_parent);
620 array[i] = ACCESS_ONCE(d->d_name.name);
621 if (p == d) {
622 if (i)
623 array[i] = "";
624 i++;
625 break;
626 }
627 }
628 s = array[--i];
629 for (n = 0; n != spec.precision; n++, buf++) {
630 char c = *s++;
631 if (!c) {
632 if (!i)
633 break;
634 c = '/';
635 s = array[--i];
636 }
637 if (buf < end)
638 *buf = c;
639 }
640 rcu_read_unlock();
cfccde04 641 return widen_string(buf, n, end, spec);
4b6ccca7
AV
642}
643
1031bc58
DM
644#ifdef CONFIG_BLOCK
645static noinline_for_stack
646char *bdev_name(char *buf, char *end, struct block_device *bdev,
647 struct printf_spec spec, const char *fmt)
648{
649 struct gendisk *hd = bdev->bd_disk;
650
651 buf = string(buf, end, hd->disk_name, spec);
652 if (bdev->bd_part->partno) {
653 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
654 if (buf < end)
655 *buf = 'p';
656 buf++;
657 }
658 buf = number(buf, end, bdev->bd_part->partno, spec);
659 }
660 return buf;
661}
662#endif
663
cf3b429b
JP
664static noinline_for_stack
665char *symbol_string(char *buf, char *end, void *ptr,
b0d33c2b 666 struct printf_spec spec, const char *fmt)
0fe1ef24 667{
b0d33c2b 668 unsigned long value;
0fe1ef24
LT
669#ifdef CONFIG_KALLSYMS
670 char sym[KSYM_SYMBOL_LEN];
b0d33c2b
JP
671#endif
672
673 if (fmt[1] == 'R')
674 ptr = __builtin_extract_return_addr(ptr);
675 value = (unsigned long)ptr;
676
677#ifdef CONFIG_KALLSYMS
678 if (*fmt == 'B')
0f77a8d3 679 sprint_backtrace(sym, value);
b0d33c2b 680 else if (*fmt != 'f' && *fmt != 's')
0c8b946e
FW
681 sprint_symbol(sym, value);
682 else
4796dd20 683 sprint_symbol_no_offset(sym, value);
7b9186f5 684
fef20d9c 685 return string(buf, end, sym, spec);
0fe1ef24 686#else
3cab1e71 687 return special_hex_number(buf, end, value, sizeof(void *));
0fe1ef24
LT
688#endif
689}
690
cf3b429b
JP
691static noinline_for_stack
692char *resource_string(char *buf, char *end, struct resource *res,
693 struct printf_spec spec, const char *fmt)
332d2e78
LT
694{
695#ifndef IO_RSRC_PRINTK_SIZE
28405372 696#define IO_RSRC_PRINTK_SIZE 6
332d2e78
LT
697#endif
698
699#ifndef MEM_RSRC_PRINTK_SIZE
28405372 700#define MEM_RSRC_PRINTK_SIZE 10
332d2e78 701#endif
4da0b66c 702 static const struct printf_spec io_spec = {
fef20d9c 703 .base = 16,
4da0b66c 704 .field_width = IO_RSRC_PRINTK_SIZE,
fef20d9c
FW
705 .precision = -1,
706 .flags = SPECIAL | SMALL | ZEROPAD,
707 };
4da0b66c
BH
708 static const struct printf_spec mem_spec = {
709 .base = 16,
710 .field_width = MEM_RSRC_PRINTK_SIZE,
711 .precision = -1,
712 .flags = SPECIAL | SMALL | ZEROPAD,
713 };
0f4050c7
BH
714 static const struct printf_spec bus_spec = {
715 .base = 16,
716 .field_width = 2,
717 .precision = -1,
718 .flags = SMALL | ZEROPAD,
719 };
4da0b66c 720 static const struct printf_spec dec_spec = {
c91d3376
BH
721 .base = 10,
722 .precision = -1,
723 .flags = 0,
724 };
4da0b66c 725 static const struct printf_spec str_spec = {
fd95541e
BH
726 .field_width = -1,
727 .precision = 10,
728 .flags = LEFT,
729 };
4da0b66c 730 static const struct printf_spec flag_spec = {
fd95541e
BH
731 .base = 16,
732 .precision = -1,
733 .flags = SPECIAL | SMALL,
734 };
c7dabef8
BH
735
736 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
737 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
738#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
739#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
9d7cca04 740#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
c7dabef8
BH
741#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
742 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
743 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
744
332d2e78 745 char *p = sym, *pend = sym + sizeof(sym);
c7dabef8 746 int decode = (fmt[0] == 'R') ? 1 : 0;
4da0b66c 747 const struct printf_spec *specp;
332d2e78
LT
748
749 *p++ = '[';
4da0b66c 750 if (res->flags & IORESOURCE_IO) {
c7dabef8 751 p = string(p, pend, "io ", str_spec);
4da0b66c
BH
752 specp = &io_spec;
753 } else if (res->flags & IORESOURCE_MEM) {
c7dabef8 754 p = string(p, pend, "mem ", str_spec);
4da0b66c
BH
755 specp = &mem_spec;
756 } else if (res->flags & IORESOURCE_IRQ) {
c7dabef8 757 p = string(p, pend, "irq ", str_spec);
4da0b66c
BH
758 specp = &dec_spec;
759 } else if (res->flags & IORESOURCE_DMA) {
c7dabef8 760 p = string(p, pend, "dma ", str_spec);
4da0b66c 761 specp = &dec_spec;
0f4050c7
BH
762 } else if (res->flags & IORESOURCE_BUS) {
763 p = string(p, pend, "bus ", str_spec);
764 specp = &bus_spec;
4da0b66c 765 } else {
c7dabef8 766 p = string(p, pend, "??? ", str_spec);
4da0b66c 767 specp = &mem_spec;
c7dabef8 768 decode = 0;
fd95541e 769 }
d19cb803
BH
770 if (decode && res->flags & IORESOURCE_UNSET) {
771 p = string(p, pend, "size ", str_spec);
772 p = number(p, pend, resource_size(res), *specp);
773 } else {
774 p = number(p, pend, res->start, *specp);
775 if (res->start != res->end) {
776 *p++ = '-';
777 p = number(p, pend, res->end, *specp);
778 }
c91d3376 779 }
c7dabef8 780 if (decode) {
fd95541e
BH
781 if (res->flags & IORESOURCE_MEM_64)
782 p = string(p, pend, " 64bit", str_spec);
783 if (res->flags & IORESOURCE_PREFETCH)
784 p = string(p, pend, " pref", str_spec);
9d7cca04
BH
785 if (res->flags & IORESOURCE_WINDOW)
786 p = string(p, pend, " window", str_spec);
fd95541e
BH
787 if (res->flags & IORESOURCE_DISABLED)
788 p = string(p, pend, " disabled", str_spec);
c7dabef8
BH
789 } else {
790 p = string(p, pend, " flags ", str_spec);
791 p = number(p, pend, res->flags, flag_spec);
fd95541e 792 }
332d2e78 793 *p++ = ']';
c7dabef8 794 *p = '\0';
332d2e78 795
fef20d9c 796 return string(buf, end, sym, spec);
332d2e78
LT
797}
798
31550a16
AS
799static noinline_for_stack
800char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
801 const char *fmt)
802{
360603a1 803 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
31550a16
AS
804 negative value, fallback to the default */
805 char separator;
806
807 if (spec.field_width == 0)
808 /* nothing to print */
809 return buf;
810
811 if (ZERO_OR_NULL_PTR(addr))
812 /* NULL pointer */
813 return string(buf, end, NULL, spec);
814
815 switch (fmt[1]) {
816 case 'C':
817 separator = ':';
818 break;
819 case 'D':
820 separator = '-';
821 break;
822 case 'N':
823 separator = 0;
824 break;
825 default:
826 separator = ' ';
827 break;
828 }
829
830 if (spec.field_width > 0)
831 len = min_t(int, spec.field_width, 64);
832
9c98f235
RV
833 for (i = 0; i < len; ++i) {
834 if (buf < end)
835 *buf = hex_asc_hi(addr[i]);
836 ++buf;
837 if (buf < end)
838 *buf = hex_asc_lo(addr[i]);
839 ++buf;
31550a16 840
9c98f235
RV
841 if (separator && i != len - 1) {
842 if (buf < end)
843 *buf = separator;
844 ++buf;
845 }
31550a16
AS
846 }
847
848 return buf;
849}
850
dbc760bc
TH
851static noinline_for_stack
852char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
853 struct printf_spec spec, const char *fmt)
854{
855 const int CHUNKSZ = 32;
856 int nr_bits = max_t(int, spec.field_width, 0);
857 int i, chunksz;
858 bool first = true;
859
860 /* reused to print numbers */
861 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
862
863 chunksz = nr_bits & (CHUNKSZ - 1);
864 if (chunksz == 0)
865 chunksz = CHUNKSZ;
866
867 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
868 for (; i >= 0; i -= CHUNKSZ) {
869 u32 chunkmask, val;
870 int word, bit;
871
872 chunkmask = ((1ULL << chunksz) - 1);
873 word = i / BITS_PER_LONG;
874 bit = i % BITS_PER_LONG;
875 val = (bitmap[word] >> bit) & chunkmask;
876
877 if (!first) {
878 if (buf < end)
879 *buf = ',';
880 buf++;
881 }
882 first = false;
883
884 spec.field_width = DIV_ROUND_UP(chunksz, 4);
885 buf = number(buf, end, val, spec);
886
887 chunksz = CHUNKSZ;
888 }
889 return buf;
890}
891
892static noinline_for_stack
893char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
894 struct printf_spec spec, const char *fmt)
895{
896 int nr_bits = max_t(int, spec.field_width, 0);
897 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
898 int cur, rbot, rtop;
899 bool first = true;
900
901 /* reused to print numbers */
902 spec = (struct printf_spec){ .base = 10 };
903
904 rbot = cur = find_first_bit(bitmap, nr_bits);
905 while (cur < nr_bits) {
906 rtop = cur;
907 cur = find_next_bit(bitmap, nr_bits, cur + 1);
908 if (cur < nr_bits && cur <= rtop + 1)
909 continue;
910
911 if (!first) {
912 if (buf < end)
913 *buf = ',';
914 buf++;
915 }
916 first = false;
917
918 buf = number(buf, end, rbot, spec);
919 if (rbot < rtop) {
920 if (buf < end)
921 *buf = '-';
922 buf++;
923
924 buf = number(buf, end, rtop, spec);
925 }
926
927 rbot = cur;
928 }
929 return buf;
930}
931
cf3b429b
JP
932static noinline_for_stack
933char *mac_address_string(char *buf, char *end, u8 *addr,
934 struct printf_spec spec, const char *fmt)
dd45c9cf 935{
8a27f7c9 936 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
dd45c9cf
HH
937 char *p = mac_addr;
938 int i;
bc7259a2 939 char separator;
76597ff9 940 bool reversed = false;
bc7259a2 941
76597ff9
AE
942 switch (fmt[1]) {
943 case 'F':
bc7259a2 944 separator = '-';
76597ff9
AE
945 break;
946
947 case 'R':
948 reversed = true;
949 /* fall through */
950
951 default:
bc7259a2 952 separator = ':';
76597ff9 953 break;
bc7259a2 954 }
dd45c9cf
HH
955
956 for (i = 0; i < 6; i++) {
76597ff9
AE
957 if (reversed)
958 p = hex_byte_pack(p, addr[5 - i]);
959 else
960 p = hex_byte_pack(p, addr[i]);
961
8a27f7c9 962 if (fmt[0] == 'M' && i != 5)
bc7259a2 963 *p++ = separator;
dd45c9cf
HH
964 }
965 *p = '\0';
966
fef20d9c 967 return string(buf, end, mac_addr, spec);
dd45c9cf
HH
968}
969
cf3b429b
JP
970static noinline_for_stack
971char *ip4_string(char *p, const u8 *addr, const char *fmt)
8a27f7c9
JP
972{
973 int i;
0159f24e
JP
974 bool leading_zeros = (fmt[0] == 'i');
975 int index;
976 int step;
977
978 switch (fmt[2]) {
979 case 'h':
980#ifdef __BIG_ENDIAN
981 index = 0;
982 step = 1;
983#else
984 index = 3;
985 step = -1;
986#endif
987 break;
988 case 'l':
989 index = 3;
990 step = -1;
991 break;
992 case 'n':
993 case 'b':
994 default:
995 index = 0;
996 step = 1;
997 break;
998 }
8a27f7c9 999 for (i = 0; i < 4; i++) {
7c43d9a3 1000 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
133fd9f5 1001 int digits = put_dec_trunc8(temp, addr[index]) - temp;
8a27f7c9
JP
1002 if (leading_zeros) {
1003 if (digits < 3)
1004 *p++ = '0';
1005 if (digits < 2)
1006 *p++ = '0';
1007 }
1008 /* reverse the digits in the quad */
1009 while (digits--)
1010 *p++ = temp[digits];
1011 if (i < 3)
1012 *p++ = '.';
0159f24e 1013 index += step;
8a27f7c9 1014 }
8a27f7c9 1015 *p = '\0';
7b9186f5 1016
8a27f7c9
JP
1017 return p;
1018}
1019
cf3b429b
JP
1020static noinline_for_stack
1021char *ip6_compressed_string(char *p, const char *addr)
689afa7d 1022{
7b9186f5 1023 int i, j, range;
8a27f7c9
JP
1024 unsigned char zerolength[8];
1025 int longest = 1;
1026 int colonpos = -1;
1027 u16 word;
7b9186f5 1028 u8 hi, lo;
8a27f7c9 1029 bool needcolon = false;
eb78cd26
JP
1030 bool useIPv4;
1031 struct in6_addr in6;
1032
1033 memcpy(&in6, addr, sizeof(struct in6_addr));
1034
1035 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
8a27f7c9
JP
1036
1037 memset(zerolength, 0, sizeof(zerolength));
1038
1039 if (useIPv4)
1040 range = 6;
1041 else
1042 range = 8;
1043
1044 /* find position of longest 0 run */
1045 for (i = 0; i < range; i++) {
1046 for (j = i; j < range; j++) {
eb78cd26 1047 if (in6.s6_addr16[j] != 0)
8a27f7c9
JP
1048 break;
1049 zerolength[i]++;
1050 }
1051 }
1052 for (i = 0; i < range; i++) {
1053 if (zerolength[i] > longest) {
1054 longest = zerolength[i];
1055 colonpos = i;
1056 }
1057 }
29cf519e
JP
1058 if (longest == 1) /* don't compress a single 0 */
1059 colonpos = -1;
689afa7d 1060
8a27f7c9
JP
1061 /* emit address */
1062 for (i = 0; i < range; i++) {
1063 if (i == colonpos) {
1064 if (needcolon || i == 0)
1065 *p++ = ':';
1066 *p++ = ':';
1067 needcolon = false;
1068 i += longest - 1;
1069 continue;
1070 }
1071 if (needcolon) {
1072 *p++ = ':';
1073 needcolon = false;
1074 }
1075 /* hex u16 without leading 0s */
eb78cd26 1076 word = ntohs(in6.s6_addr16[i]);
8a27f7c9
JP
1077 hi = word >> 8;
1078 lo = word & 0xff;
1079 if (hi) {
1080 if (hi > 0x0f)
55036ba7 1081 p = hex_byte_pack(p, hi);
8a27f7c9
JP
1082 else
1083 *p++ = hex_asc_lo(hi);
55036ba7 1084 p = hex_byte_pack(p, lo);
8a27f7c9 1085 }
b5ff992b 1086 else if (lo > 0x0f)
55036ba7 1087 p = hex_byte_pack(p, lo);
8a27f7c9
JP
1088 else
1089 *p++ = hex_asc_lo(lo);
1090 needcolon = true;
1091 }
1092
1093 if (useIPv4) {
1094 if (needcolon)
1095 *p++ = ':';
0159f24e 1096 p = ip4_string(p, &in6.s6_addr[12], "I4");
8a27f7c9 1097 }
8a27f7c9 1098 *p = '\0';
7b9186f5 1099
8a27f7c9
JP
1100 return p;
1101}
1102
cf3b429b
JP
1103static noinline_for_stack
1104char *ip6_string(char *p, const char *addr, const char *fmt)
8a27f7c9
JP
1105{
1106 int i;
7b9186f5 1107
689afa7d 1108 for (i = 0; i < 8; i++) {
55036ba7
AS
1109 p = hex_byte_pack(p, *addr++);
1110 p = hex_byte_pack(p, *addr++);
8a27f7c9 1111 if (fmt[0] == 'I' && i != 7)
689afa7d
HH
1112 *p++ = ':';
1113 }
1114 *p = '\0';
7b9186f5 1115
8a27f7c9
JP
1116 return p;
1117}
1118
cf3b429b
JP
1119static noinline_for_stack
1120char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1121 struct printf_spec spec, const char *fmt)
8a27f7c9
JP
1122{
1123 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1124
1125 if (fmt[0] == 'I' && fmt[2] == 'c')
eb78cd26 1126 ip6_compressed_string(ip6_addr, addr);
8a27f7c9 1127 else
eb78cd26 1128 ip6_string(ip6_addr, addr, fmt);
689afa7d 1129
fef20d9c 1130 return string(buf, end, ip6_addr, spec);
689afa7d
HH
1131}
1132
cf3b429b
JP
1133static noinline_for_stack
1134char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1135 struct printf_spec spec, const char *fmt)
4aa99606 1136{
8a27f7c9 1137 char ip4_addr[sizeof("255.255.255.255")];
4aa99606 1138
0159f24e 1139 ip4_string(ip4_addr, addr, fmt);
4aa99606 1140
fef20d9c 1141 return string(buf, end, ip4_addr, spec);
4aa99606
HH
1142}
1143
10679643
DB
1144static noinline_for_stack
1145char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1146 struct printf_spec spec, const char *fmt)
1147{
1148 bool have_p = false, have_s = false, have_f = false, have_c = false;
1149 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1150 sizeof(":12345") + sizeof("/123456789") +
1151 sizeof("%1234567890")];
1152 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1153 const u8 *addr = (const u8 *) &sa->sin6_addr;
1154 char fmt6[2] = { fmt[0], '6' };
1155 u8 off = 0;
1156
1157 fmt++;
1158 while (isalpha(*++fmt)) {
1159 switch (*fmt) {
1160 case 'p':
1161 have_p = true;
1162 break;
1163 case 'f':
1164 have_f = true;
1165 break;
1166 case 's':
1167 have_s = true;
1168 break;
1169 case 'c':
1170 have_c = true;
1171 break;
1172 }
1173 }
1174
1175 if (have_p || have_s || have_f) {
1176 *p = '[';
1177 off = 1;
1178 }
1179
1180 if (fmt6[0] == 'I' && have_c)
1181 p = ip6_compressed_string(ip6_addr + off, addr);
1182 else
1183 p = ip6_string(ip6_addr + off, addr, fmt6);
1184
1185 if (have_p || have_s || have_f)
1186 *p++ = ']';
1187
1188 if (have_p) {
1189 *p++ = ':';
1190 p = number(p, pend, ntohs(sa->sin6_port), spec);
1191 }
1192 if (have_f) {
1193 *p++ = '/';
1194 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1195 IPV6_FLOWINFO_MASK), spec);
1196 }
1197 if (have_s) {
1198 *p++ = '%';
1199 p = number(p, pend, sa->sin6_scope_id, spec);
1200 }
1201 *p = '\0';
1202
1203 return string(buf, end, ip6_addr, spec);
1204}
1205
1206static noinline_for_stack
1207char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1208 struct printf_spec spec, const char *fmt)
1209{
1210 bool have_p = false;
1211 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1212 char *pend = ip4_addr + sizeof(ip4_addr);
1213 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1214 char fmt4[3] = { fmt[0], '4', 0 };
1215
1216 fmt++;
1217 while (isalpha(*++fmt)) {
1218 switch (*fmt) {
1219 case 'p':
1220 have_p = true;
1221 break;
1222 case 'h':
1223 case 'l':
1224 case 'n':
1225 case 'b':
1226 fmt4[2] = *fmt;
1227 break;
1228 }
1229 }
1230
1231 p = ip4_string(ip4_addr, addr, fmt4);
1232 if (have_p) {
1233 *p++ = ':';
1234 p = number(p, pend, ntohs(sa->sin_port), spec);
1235 }
1236 *p = '\0';
1237
1238 return string(buf, end, ip4_addr, spec);
1239}
1240
71dca95d
AS
1241static noinline_for_stack
1242char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1243 const char *fmt)
1244{
1245 bool found = true;
1246 int count = 1;
1247 unsigned int flags = 0;
1248 int len;
1249
1250 if (spec.field_width == 0)
1251 return buf; /* nothing to print */
1252
1253 if (ZERO_OR_NULL_PTR(addr))
1254 return string(buf, end, NULL, spec); /* NULL pointer */
1255
1256
1257 do {
1258 switch (fmt[count++]) {
1259 case 'a':
1260 flags |= ESCAPE_ANY;
1261 break;
1262 case 'c':
1263 flags |= ESCAPE_SPECIAL;
1264 break;
1265 case 'h':
1266 flags |= ESCAPE_HEX;
1267 break;
1268 case 'n':
1269 flags |= ESCAPE_NULL;
1270 break;
1271 case 'o':
1272 flags |= ESCAPE_OCTAL;
1273 break;
1274 case 'p':
1275 flags |= ESCAPE_NP;
1276 break;
1277 case 's':
1278 flags |= ESCAPE_SPACE;
1279 break;
1280 default:
1281 found = false;
1282 break;
1283 }
1284 } while (found);
1285
1286 if (!flags)
1287 flags = ESCAPE_ANY_NP;
1288
1289 len = spec.field_width < 0 ? 1 : spec.field_width;
1290
41416f23
RV
1291 /*
1292 * string_escape_mem() writes as many characters as it can to
1293 * the given buffer, and returns the total size of the output
1294 * had the buffer been big enough.
1295 */
1296 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
71dca95d
AS
1297
1298 return buf;
1299}
1300
cf3b429b
JP
1301static noinline_for_stack
1302char *uuid_string(char *buf, char *end, const u8 *addr,
1303 struct printf_spec spec, const char *fmt)
9ac6e44e
JP
1304{
1305 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1306 char *p = uuid;
1307 int i;
1308 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1309 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1310 const u8 *index = be;
1311 bool uc = false;
1312
1313 switch (*(++fmt)) {
1314 case 'L':
1315 uc = true; /* fall-through */
1316 case 'l':
1317 index = le;
1318 break;
1319 case 'B':
1320 uc = true;
1321 break;
1322 }
1323
1324 for (i = 0; i < 16; i++) {
55036ba7 1325 p = hex_byte_pack(p, addr[index[i]]);
9ac6e44e
JP
1326 switch (i) {
1327 case 3:
1328 case 5:
1329 case 7:
1330 case 9:
1331 *p++ = '-';
1332 break;
1333 }
1334 }
1335
1336 *p = 0;
1337
1338 if (uc) {
1339 p = uuid;
1340 do {
1341 *p = toupper(*p);
1342 } while (*(++p));
1343 }
1344
1345 return string(buf, end, uuid, spec);
1346}
1347
c8f44aff 1348static
3cab1e71 1349char *netdev_feature_string(char *buf, char *end, const void *addr)
c8f44aff 1350{
3cab1e71
AS
1351 unsigned long long num = *(const netdev_features_t *)addr;
1352 int size = sizeof(netdev_features_t);
c8f44aff 1353
3cab1e71 1354 return special_hex_number(buf, end, num, size);
c8f44aff
MM
1355}
1356
aaf07621 1357static noinline_for_stack
3cab1e71 1358char *address_val(char *buf, char *end, const void *addr, const char *fmt)
aaf07621
JP
1359{
1360 unsigned long long num;
3cab1e71 1361 int size;
aaf07621
JP
1362
1363 switch (fmt[1]) {
1364 case 'd':
1365 num = *(const dma_addr_t *)addr;
3cab1e71 1366 size = sizeof(dma_addr_t);
aaf07621
JP
1367 break;
1368 case 'p':
1369 default:
1370 num = *(const phys_addr_t *)addr;
3cab1e71 1371 size = sizeof(phys_addr_t);
aaf07621
JP
1372 break;
1373 }
1374
3cab1e71 1375 return special_hex_number(buf, end, num, size);
aaf07621
JP
1376}
1377
900cca29
GU
1378static noinline_for_stack
1379char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1380 const char *fmt)
1381{
1382 if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1383 return string(buf, end, NULL, spec);
1384
1385 switch (fmt[1]) {
1386 case 'r':
1387 return number(buf, end, clk_get_rate(clk), spec);
1388
1389 case 'n':
1390 default:
1391#ifdef CONFIG_COMMON_CLK
1392 return string(buf, end, __clk_get_name(clk), spec);
1393#else
3cab1e71 1394 return special_hex_number(buf, end, (unsigned long)clk, sizeof(unsigned long));
900cca29
GU
1395#endif
1396 }
1397}
1398
411f05f1 1399int kptr_restrict __read_mostly;
455cd5ab 1400
4d8a743c
LT
1401/*
1402 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1403 * by an extra set of alphanumeric characters that are extended format
1404 * specifiers.
1405 *
332d2e78
LT
1406 * Right now we handle:
1407 *
0c8b946e
FW
1408 * - 'F' For symbolic function descriptor pointers with offset
1409 * - 'f' For simple symbolic function names without offset
0efb4d20
SR
1410 * - 'S' For symbolic direct pointers with offset
1411 * - 's' For symbolic direct pointers without offset
b0d33c2b 1412 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
0f77a8d3 1413 * - 'B' For backtraced symbolic direct pointers with offset
c7dabef8
BH
1414 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1415 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
dbc760bc
TH
1416 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1417 * width which must be explicitly specified either as part of the
1418 * format string '%32b[l]' or through '%*b[l]', [l] selects
1419 * range-list format instead of hex format
dd45c9cf
HH
1420 * - 'M' For a 6-byte MAC address, it prints the address in the
1421 * usual colon-separated hex notation
8a27f7c9 1422 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
bc7259a2 1423 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
c8e00060 1424 * with a dash-separated hex notation
7c59154e 1425 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
8a27f7c9
JP
1426 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1427 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1428 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
10679643
DB
1429 * [S][pfs]
1430 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1431 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
8a27f7c9
JP
1432 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1433 * IPv6 omits the colons (01020304...0f)
1434 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
10679643
DB
1435 * [S][pfs]
1436 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1437 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1438 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1439 * - 'I[6S]c' for IPv6 addresses printed as specified by
29cf519e 1440 * http://tools.ietf.org/html/rfc5952
71dca95d
AS
1441 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1442 * of the following flags (see string_escape_mem() for the
1443 * details):
1444 * a - ESCAPE_ANY
1445 * c - ESCAPE_SPECIAL
1446 * h - ESCAPE_HEX
1447 * n - ESCAPE_NULL
1448 * o - ESCAPE_OCTAL
1449 * p - ESCAPE_NP
1450 * s - ESCAPE_SPACE
1451 * By default ESCAPE_ANY_NP is used.
9ac6e44e
JP
1452 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1453 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1454 * Options for %pU are:
1455 * b big endian lower case hex (default)
1456 * B big endian UPPER case hex
1457 * l little endian lower case hex
1458 * L little endian UPPER case hex
1459 * big endian output byte order is:
1460 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1461 * little endian output byte order is:
1462 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
7db6f5fb
JP
1463 * - 'V' For a struct va_format which contains a format string * and va_list *,
1464 * call vsnprintf(->format, *->va_list).
1465 * Implements a "recursive vsnprintf".
1466 * Do not use this feature without some mechanism to verify the
1467 * correctness of the format string and va_list arguments.
455cd5ab 1468 * - 'K' For a kernel pointer that should be hidden from unprivileged users
c8f44aff 1469 * - 'NF' For a netdev_features_t
31550a16
AS
1470 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1471 * a certain separator (' ' by default):
1472 * C colon
1473 * D dash
1474 * N no separator
1475 * The maximum supported length is 64 bytes of the input. Consider
1476 * to use print_hex_dump() for the larger input.
aaf07621
JP
1477 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1478 * (default assumed to be phys_addr_t, passed by reference)
c0d92a57
OJ
1479 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1480 * - 'D[234]' Same as 'd' but for a struct file
1031bc58 1481 * - 'g' For block_device name (gendisk + partition number)
900cca29
GU
1482 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1483 * (legacy clock framework) of the clock
1484 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1485 * (legacy clock framework) of the clock
1486 * - 'Cr' For a clock, it prints the current rate of the clock
5e4ee7b1
MK
1487 *
1488 * ** Please update also Documentation/printk-formats.txt when making changes **
9ac6e44e 1489 *
332d2e78
LT
1490 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1491 * function pointers are really function descriptors, which contain a
1492 * pointer to the real address.
4d8a743c 1493 */
cf3b429b
JP
1494static noinline_for_stack
1495char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1496 struct printf_spec spec)
78a8bf69 1497{
80c9eb46 1498 const int default_width = 2 * sizeof(void *);
725fe002 1499
9f36e2c4 1500 if (!ptr && *fmt != 'K') {
5e057981
JP
1501 /*
1502 * Print (null) with the same width as a pointer so it makes
1503 * tabular output look nice.
1504 */
1505 if (spec.field_width == -1)
725fe002 1506 spec.field_width = default_width;
fef20d9c 1507 return string(buf, end, "(null)", spec);
5e057981 1508 }
d97106ab 1509
0fe1ef24
LT
1510 switch (*fmt) {
1511 case 'F':
0c8b946e 1512 case 'f':
0fe1ef24
LT
1513 ptr = dereference_function_descriptor(ptr);
1514 /* Fallthrough */
1515 case 'S':
9ac6e44e 1516 case 's':
0f77a8d3 1517 case 'B':
b0d33c2b 1518 return symbol_string(buf, end, ptr, spec, fmt);
332d2e78 1519 case 'R':
c7dabef8 1520 case 'r':
fd95541e 1521 return resource_string(buf, end, ptr, spec, fmt);
31550a16
AS
1522 case 'h':
1523 return hex_string(buf, end, ptr, spec, fmt);
dbc760bc
TH
1524 case 'b':
1525 switch (fmt[1]) {
1526 case 'l':
1527 return bitmap_list_string(buf, end, ptr, spec, fmt);
1528 default:
1529 return bitmap_string(buf, end, ptr, spec, fmt);
1530 }
8a27f7c9
JP
1531 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1532 case 'm': /* Contiguous: 000102030405 */
76597ff9
AE
1533 /* [mM]F (FDDI) */
1534 /* [mM]R (Reverse order; Bluetooth) */
8a27f7c9
JP
1535 return mac_address_string(buf, end, ptr, spec, fmt);
1536 case 'I': /* Formatted IP supported
1537 * 4: 1.2.3.4
1538 * 6: 0001:0203:...:0708
1539 * 6c: 1::708 or 1::1.2.3.4
1540 */
1541 case 'i': /* Contiguous:
1542 * 4: 001.002.003.004
1543 * 6: 000102...0f
1544 */
1545 switch (fmt[1]) {
1546 case '6':
1547 return ip6_addr_string(buf, end, ptr, spec, fmt);
1548 case '4':
1549 return ip4_addr_string(buf, end, ptr, spec, fmt);
10679643
DB
1550 case 'S': {
1551 const union {
1552 struct sockaddr raw;
1553 struct sockaddr_in v4;
1554 struct sockaddr_in6 v6;
1555 } *sa = ptr;
1556
1557 switch (sa->raw.sa_family) {
1558 case AF_INET:
1559 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1560 case AF_INET6:
1561 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1562 default:
1563 return string(buf, end, "(invalid address)", spec);
1564 }}
8a27f7c9 1565 }
fef20d9c 1566 break;
71dca95d
AS
1567 case 'E':
1568 return escaped_string(buf, end, ptr, spec, fmt);
9ac6e44e
JP
1569 case 'U':
1570 return uuid_string(buf, end, ptr, spec, fmt);
7db6f5fb 1571 case 'V':
5756b76e
JB
1572 {
1573 va_list va;
1574
1575 va_copy(va, *((struct va_format *)ptr)->va);
1576 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1577 ((struct va_format *)ptr)->fmt, va);
1578 va_end(va);
1579 return buf;
1580 }
455cd5ab
DR
1581 case 'K':
1582 /*
1583 * %pK cannot be used in IRQ context because its test
1584 * for CAP_SYSLOG would be meaningless.
1585 */
3715c530
DR
1586 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1587 in_nmi())) {
455cd5ab 1588 if (spec.field_width == -1)
725fe002 1589 spec.field_width = default_width;
455cd5ab 1590 return string(buf, end, "pK-error", spec);
455cd5ab 1591 }
312b4e22
RM
1592
1593 switch (kptr_restrict) {
1594 case 0:
1595 /* Always print %pK values */
1596 break;
1597 case 1: {
1598 /*
1599 * Only print the real pointer value if the current
1600 * process has CAP_SYSLOG and is running with the
1601 * same credentials it started with. This is because
1602 * access to files is checked at open() time, but %pK
1603 * checks permission at read() time. We don't want to
1604 * leak pointer values if a binary opens a file using
1605 * %pK and then elevates privileges before reading it.
1606 */
1607 const struct cred *cred = current_cred();
1608
1609 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1610 !uid_eq(cred->euid, cred->uid) ||
1611 !gid_eq(cred->egid, cred->gid))
1612 ptr = NULL;
1613 break;
1614 }
1615 case 2:
1616 default:
1617 /* Always print 0's for %pK */
26297607 1618 ptr = NULL;
312b4e22
RM
1619 break;
1620 }
26297607 1621 break;
312b4e22 1622
c8f44aff
MM
1623 case 'N':
1624 switch (fmt[1]) {
1625 case 'F':
3cab1e71 1626 return netdev_feature_string(buf, end, ptr);
c8f44aff
MM
1627 }
1628 break;
7d799210 1629 case 'a':
3cab1e71 1630 return address_val(buf, end, ptr, fmt);
4b6ccca7
AV
1631 case 'd':
1632 return dentry_name(buf, end, ptr, spec, fmt);
900cca29
GU
1633 case 'C':
1634 return clock(buf, end, ptr, spec, fmt);
4b6ccca7
AV
1635 case 'D':
1636 return dentry_name(buf, end,
1637 ((const struct file *)ptr)->f_path.dentry,
1638 spec, fmt);
1031bc58
DM
1639#ifdef CONFIG_BLOCK
1640 case 'g':
1641 return bdev_name(buf, end, ptr, spec, fmt);
1642#endif
1643
fef20d9c
FW
1644 }
1645 spec.flags |= SMALL;
1646 if (spec.field_width == -1) {
725fe002 1647 spec.field_width = default_width;
fef20d9c
FW
1648 spec.flags |= ZEROPAD;
1649 }
1650 spec.base = 16;
1651
1652 return number(buf, end, (unsigned long) ptr, spec);
1653}
1654
1655/*
1656 * Helper function to decode printf style format.
1657 * Each call decode a token from the format and return the
1658 * number of characters read (or likely the delta where it wants
1659 * to go on the next call).
1660 * The decoded token is returned through the parameters
1661 *
1662 * 'h', 'l', or 'L' for integer fields
1663 * 'z' support added 23/7/1999 S.H.
1664 * 'z' changed to 'Z' --davidm 1/25/99
1665 * 't' added for ptrdiff_t
1666 *
1667 * @fmt: the format string
1668 * @type of the token returned
1669 * @flags: various flags such as +, -, # tokens..
1670 * @field_width: overwritten width
1671 * @base: base of the number (octal, hex, ...)
1672 * @precision: precision of a number
1673 * @qualifier: qualifier of a number (long, size_t, ...)
1674 */
cf3b429b
JP
1675static noinline_for_stack
1676int format_decode(const char *fmt, struct printf_spec *spec)
fef20d9c
FW
1677{
1678 const char *start = fmt;
d0484193 1679 char qualifier;
fef20d9c
FW
1680
1681 /* we finished early by reading the field width */
ed681a91 1682 if (spec->type == FORMAT_TYPE_WIDTH) {
fef20d9c
FW
1683 if (spec->field_width < 0) {
1684 spec->field_width = -spec->field_width;
1685 spec->flags |= LEFT;
1686 }
1687 spec->type = FORMAT_TYPE_NONE;
1688 goto precision;
1689 }
1690
1691 /* we finished early by reading the precision */
1692 if (spec->type == FORMAT_TYPE_PRECISION) {
1693 if (spec->precision < 0)
1694 spec->precision = 0;
1695
1696 spec->type = FORMAT_TYPE_NONE;
1697 goto qualifier;
1698 }
1699
1700 /* By default */
1701 spec->type = FORMAT_TYPE_NONE;
1702
1703 for (; *fmt ; ++fmt) {
1704 if (*fmt == '%')
1705 break;
1706 }
1707
1708 /* Return the current non-format string */
1709 if (fmt != start || !*fmt)
1710 return fmt - start;
1711
1712 /* Process flags */
1713 spec->flags = 0;
1714
1715 while (1) { /* this also skips first '%' */
1716 bool found = true;
1717
1718 ++fmt;
1719
1720 switch (*fmt) {
1721 case '-': spec->flags |= LEFT; break;
1722 case '+': spec->flags |= PLUS; break;
1723 case ' ': spec->flags |= SPACE; break;
1724 case '#': spec->flags |= SPECIAL; break;
1725 case '0': spec->flags |= ZEROPAD; break;
1726 default: found = false;
1727 }
1728
1729 if (!found)
1730 break;
1731 }
1732
1733 /* get field width */
1734 spec->field_width = -1;
1735
1736 if (isdigit(*fmt))
1737 spec->field_width = skip_atoi(&fmt);
1738 else if (*fmt == '*') {
1739 /* it's the next argument */
ed681a91 1740 spec->type = FORMAT_TYPE_WIDTH;
fef20d9c
FW
1741 return ++fmt - start;
1742 }
1743
1744precision:
1745 /* get the precision */
1746 spec->precision = -1;
1747 if (*fmt == '.') {
1748 ++fmt;
1749 if (isdigit(*fmt)) {
1750 spec->precision = skip_atoi(&fmt);
1751 if (spec->precision < 0)
1752 spec->precision = 0;
1753 } else if (*fmt == '*') {
1754 /* it's the next argument */
adf26f84 1755 spec->type = FORMAT_TYPE_PRECISION;
fef20d9c
FW
1756 return ++fmt - start;
1757 }
1758 }
1759
1760qualifier:
1761 /* get the conversion qualifier */
d0484193 1762 qualifier = 0;
75fb8f26
AS
1763 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1764 _tolower(*fmt) == 'z' || *fmt == 't') {
d0484193
RV
1765 qualifier = *fmt++;
1766 if (unlikely(qualifier == *fmt)) {
1767 if (qualifier == 'l') {
1768 qualifier = 'L';
a4e94ef0 1769 ++fmt;
d0484193
RV
1770 } else if (qualifier == 'h') {
1771 qualifier = 'H';
a4e94ef0
Z
1772 ++fmt;
1773 }
fef20d9c
FW
1774 }
1775 }
1776
1777 /* default base */
1778 spec->base = 10;
1779 switch (*fmt) {
1780 case 'c':
1781 spec->type = FORMAT_TYPE_CHAR;
1782 return ++fmt - start;
1783
1784 case 's':
1785 spec->type = FORMAT_TYPE_STR;
1786 return ++fmt - start;
1787
1788 case 'p':
1789 spec->type = FORMAT_TYPE_PTR;
ffbfed03 1790 return ++fmt - start;
fef20d9c 1791
fef20d9c
FW
1792 case '%':
1793 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1794 return ++fmt - start;
1795
1796 /* integer number formats - set up the flags and "break" */
1797 case 'o':
1798 spec->base = 8;
1799 break;
1800
1801 case 'x':
1802 spec->flags |= SMALL;
1803
1804 case 'X':
1805 spec->base = 16;
1806 break;
1807
1808 case 'd':
1809 case 'i':
39e874f8 1810 spec->flags |= SIGN;
fef20d9c 1811 case 'u':
4aa99606 1812 break;
fef20d9c 1813
708d96fd
RM
1814 case 'n':
1815 /*
b006f19b
RV
1816 * Since %n poses a greater security risk than
1817 * utility, treat it as any other invalid or
1818 * unsupported format specifier.
708d96fd 1819 */
708d96fd
RM
1820 /* Fall-through */
1821
fef20d9c 1822 default:
b006f19b 1823 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
fef20d9c
FW
1824 spec->type = FORMAT_TYPE_INVALID;
1825 return fmt - start;
0fe1ef24 1826 }
fef20d9c 1827
d0484193 1828 if (qualifier == 'L')
fef20d9c 1829 spec->type = FORMAT_TYPE_LONG_LONG;
d0484193 1830 else if (qualifier == 'l') {
51be17df
RV
1831 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1832 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
d0484193 1833 } else if (_tolower(qualifier) == 'z') {
fef20d9c 1834 spec->type = FORMAT_TYPE_SIZE_T;
d0484193 1835 } else if (qualifier == 't') {
fef20d9c 1836 spec->type = FORMAT_TYPE_PTRDIFF;
d0484193 1837 } else if (qualifier == 'H') {
51be17df
RV
1838 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1839 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
d0484193 1840 } else if (qualifier == 'h') {
51be17df
RV
1841 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1842 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
fef20d9c 1843 } else {
51be17df
RV
1844 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1845 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
78a8bf69 1846 }
fef20d9c
FW
1847
1848 return ++fmt - start;
78a8bf69
LT
1849}
1850
4d72ba01
RV
1851static void
1852set_field_width(struct printf_spec *spec, int width)
1853{
1854 spec->field_width = width;
1855 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
1856 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
1857 }
1858}
1859
1860static void
1861set_precision(struct printf_spec *spec, int prec)
1862{
1863 spec->precision = prec;
1864 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
1865 spec->precision = clamp(prec, 0, PRECISION_MAX);
1866 }
1867}
1868
1da177e4
LT
1869/**
1870 * vsnprintf - Format a string and place it in a buffer
1871 * @buf: The buffer to place the result into
1872 * @size: The size of the buffer, including the trailing null space
1873 * @fmt: The format string to use
1874 * @args: Arguments for the format string
1875 *
d7ec9a05
RV
1876 * This function generally follows C99 vsnprintf, but has some
1877 * extensions and a few limitations:
1878 *
1879 * %n is unsupported
5e4ee7b1
MK
1880 * %p* is handled by pointer()
1881 *
1882 * See pointer() or Documentation/printk-formats.txt for more
1883 * extensive description.
20036fdc 1884 *
5e4ee7b1 1885 * ** Please update the documentation in both places when making changes **
80f548e0 1886 *
1da177e4
LT
1887 * The return value is the number of characters which would
1888 * be generated for the given input, excluding the trailing
1889 * '\0', as per ISO C99. If you want to have the exact
1890 * number of characters written into @buf as return value
72fd4a35 1891 * (not including the trailing '\0'), use vscnprintf(). If the
1da177e4
LT
1892 * return is greater than or equal to @size, the resulting
1893 * string is truncated.
1894 *
ba1835eb 1895 * If you're not already dealing with a va_list consider using snprintf().
1da177e4
LT
1896 */
1897int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1898{
1da177e4 1899 unsigned long long num;
d4be151b 1900 char *str, *end;
fef20d9c 1901 struct printf_spec spec = {0};
1da177e4 1902
f796937a
JF
1903 /* Reject out-of-range values early. Large positive sizes are
1904 used for unknown buffer sizes. */
2aa2f9e2 1905 if (WARN_ON_ONCE(size > INT_MAX))
1da177e4 1906 return 0;
1da177e4
LT
1907
1908 str = buf;
f796937a 1909 end = buf + size;
1da177e4 1910
f796937a
JF
1911 /* Make sure end is always >= buf */
1912 if (end < buf) {
1913 end = ((void *)-1);
1914 size = end - buf;
1da177e4
LT
1915 }
1916
fef20d9c
FW
1917 while (*fmt) {
1918 const char *old_fmt = fmt;
d4be151b 1919 int read = format_decode(fmt, &spec);
1da177e4 1920
fef20d9c 1921 fmt += read;
1da177e4 1922
fef20d9c
FW
1923 switch (spec.type) {
1924 case FORMAT_TYPE_NONE: {
1925 int copy = read;
1926 if (str < end) {
1927 if (copy > end - str)
1928 copy = end - str;
1929 memcpy(str, old_fmt, copy);
1da177e4 1930 }
fef20d9c
FW
1931 str += read;
1932 break;
1da177e4
LT
1933 }
1934
ed681a91 1935 case FORMAT_TYPE_WIDTH:
4d72ba01 1936 set_field_width(&spec, va_arg(args, int));
fef20d9c 1937 break;
1da177e4 1938
fef20d9c 1939 case FORMAT_TYPE_PRECISION:
4d72ba01 1940 set_precision(&spec, va_arg(args, int));
fef20d9c 1941 break;
1da177e4 1942
d4be151b
AGR
1943 case FORMAT_TYPE_CHAR: {
1944 char c;
1945
fef20d9c
FW
1946 if (!(spec.flags & LEFT)) {
1947 while (--spec.field_width > 0) {
f796937a 1948 if (str < end)
1da177e4
LT
1949 *str = ' ';
1950 ++str;
1da177e4 1951
fef20d9c
FW
1952 }
1953 }
1954 c = (unsigned char) va_arg(args, int);
1955 if (str < end)
1956 *str = c;
1957 ++str;
1958 while (--spec.field_width > 0) {
f796937a 1959 if (str < end)
fef20d9c 1960 *str = ' ';
1da177e4 1961 ++str;
fef20d9c
FW
1962 }
1963 break;
d4be151b 1964 }
1da177e4 1965
fef20d9c
FW
1966 case FORMAT_TYPE_STR:
1967 str = string(str, end, va_arg(args, char *), spec);
1968 break;
1da177e4 1969
fef20d9c 1970 case FORMAT_TYPE_PTR:
ffbfed03 1971 str = pointer(fmt, str, end, va_arg(args, void *),
fef20d9c
FW
1972 spec);
1973 while (isalnum(*fmt))
1974 fmt++;
1975 break;
1da177e4 1976
fef20d9c
FW
1977 case FORMAT_TYPE_PERCENT_CHAR:
1978 if (str < end)
1979 *str = '%';
1980 ++str;
1981 break;
1da177e4 1982
fef20d9c 1983 case FORMAT_TYPE_INVALID:
b006f19b
RV
1984 /*
1985 * Presumably the arguments passed gcc's type
1986 * checking, but there is no safe or sane way
1987 * for us to continue parsing the format and
1988 * fetching from the va_list; the remaining
1989 * specifiers and arguments would be out of
1990 * sync.
1991 */
1992 goto out;
fef20d9c 1993
fef20d9c
FW
1994 default:
1995 switch (spec.type) {
1996 case FORMAT_TYPE_LONG_LONG:
1997 num = va_arg(args, long long);
1998 break;
1999 case FORMAT_TYPE_ULONG:
2000 num = va_arg(args, unsigned long);
2001 break;
2002 case FORMAT_TYPE_LONG:
2003 num = va_arg(args, long);
2004 break;
2005 case FORMAT_TYPE_SIZE_T:
ef124960
JG
2006 if (spec.flags & SIGN)
2007 num = va_arg(args, ssize_t);
2008 else
2009 num = va_arg(args, size_t);
fef20d9c
FW
2010 break;
2011 case FORMAT_TYPE_PTRDIFF:
2012 num = va_arg(args, ptrdiff_t);
2013 break;
a4e94ef0
Z
2014 case FORMAT_TYPE_UBYTE:
2015 num = (unsigned char) va_arg(args, int);
2016 break;
2017 case FORMAT_TYPE_BYTE:
2018 num = (signed char) va_arg(args, int);
2019 break;
fef20d9c
FW
2020 case FORMAT_TYPE_USHORT:
2021 num = (unsigned short) va_arg(args, int);
2022 break;
2023 case FORMAT_TYPE_SHORT:
2024 num = (short) va_arg(args, int);
2025 break;
39e874f8
FW
2026 case FORMAT_TYPE_INT:
2027 num = (int) va_arg(args, int);
fef20d9c
FW
2028 break;
2029 default:
2030 num = va_arg(args, unsigned int);
2031 }
2032
2033 str = number(str, end, num, spec);
1da177e4 2034 }
1da177e4 2035 }
fef20d9c 2036
b006f19b 2037out:
f796937a
JF
2038 if (size > 0) {
2039 if (str < end)
2040 *str = '\0';
2041 else
0a6047ee 2042 end[-1] = '\0';
f796937a 2043 }
fef20d9c 2044
f796937a 2045 /* the trailing null byte doesn't count towards the total */
1da177e4 2046 return str-buf;
fef20d9c 2047
1da177e4 2048}
1da177e4
LT
2049EXPORT_SYMBOL(vsnprintf);
2050
2051/**
2052 * vscnprintf - Format a string and place it in a buffer
2053 * @buf: The buffer to place the result into
2054 * @size: The size of the buffer, including the trailing null space
2055 * @fmt: The format string to use
2056 * @args: Arguments for the format string
2057 *
2058 * The return value is the number of characters which have been written into
b921c69f 2059 * the @buf not including the trailing '\0'. If @size is == 0 the function
1da177e4
LT
2060 * returns 0.
2061 *
ba1835eb 2062 * If you're not already dealing with a va_list consider using scnprintf().
20036fdc
AK
2063 *
2064 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4
LT
2065 */
2066int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2067{
2068 int i;
2069
7b9186f5
AGR
2070 i = vsnprintf(buf, size, fmt, args);
2071
b921c69f
AA
2072 if (likely(i < size))
2073 return i;
2074 if (size != 0)
2075 return size - 1;
2076 return 0;
1da177e4 2077}
1da177e4
LT
2078EXPORT_SYMBOL(vscnprintf);
2079
2080/**
2081 * snprintf - Format a string and place it in a buffer
2082 * @buf: The buffer to place the result into
2083 * @size: The size of the buffer, including the trailing null space
2084 * @fmt: The format string to use
2085 * @...: Arguments for the format string
2086 *
2087 * The return value is the number of characters which would be
2088 * generated for the given input, excluding the trailing null,
2089 * as per ISO C99. If the return is greater than or equal to
2090 * @size, the resulting string is truncated.
20036fdc
AK
2091 *
2092 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 2093 */
7b9186f5 2094int snprintf(char *buf, size_t size, const char *fmt, ...)
1da177e4
LT
2095{
2096 va_list args;
2097 int i;
2098
2099 va_start(args, fmt);
7b9186f5 2100 i = vsnprintf(buf, size, fmt, args);
1da177e4 2101 va_end(args);
7b9186f5 2102
1da177e4
LT
2103 return i;
2104}
1da177e4
LT
2105EXPORT_SYMBOL(snprintf);
2106
2107/**
2108 * scnprintf - Format a string and place it in a buffer
2109 * @buf: The buffer to place the result into
2110 * @size: The size of the buffer, including the trailing null space
2111 * @fmt: The format string to use
2112 * @...: Arguments for the format string
2113 *
2114 * The return value is the number of characters written into @buf not including
b903c0b8 2115 * the trailing '\0'. If @size is == 0 the function returns 0.
1da177e4
LT
2116 */
2117
7b9186f5 2118int scnprintf(char *buf, size_t size, const char *fmt, ...)
1da177e4
LT
2119{
2120 va_list args;
2121 int i;
2122
2123 va_start(args, fmt);
b921c69f 2124 i = vscnprintf(buf, size, fmt, args);
1da177e4 2125 va_end(args);
7b9186f5 2126
b921c69f 2127 return i;
1da177e4
LT
2128}
2129EXPORT_SYMBOL(scnprintf);
2130
2131/**
2132 * vsprintf - Format a string and place it in a buffer
2133 * @buf: The buffer to place the result into
2134 * @fmt: The format string to use
2135 * @args: Arguments for the format string
2136 *
2137 * The function returns the number of characters written
72fd4a35 2138 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1da177e4
LT
2139 * buffer overflows.
2140 *
ba1835eb 2141 * If you're not already dealing with a va_list consider using sprintf().
20036fdc
AK
2142 *
2143 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4
LT
2144 */
2145int vsprintf(char *buf, const char *fmt, va_list args)
2146{
2147 return vsnprintf(buf, INT_MAX, fmt, args);
2148}
1da177e4
LT
2149EXPORT_SYMBOL(vsprintf);
2150
2151/**
2152 * sprintf - Format a string and place it in a buffer
2153 * @buf: The buffer to place the result into
2154 * @fmt: The format string to use
2155 * @...: Arguments for the format string
2156 *
2157 * The function returns the number of characters written
72fd4a35 2158 * into @buf. Use snprintf() or scnprintf() in order to avoid
1da177e4 2159 * buffer overflows.
20036fdc
AK
2160 *
2161 * See the vsnprintf() documentation for format string extensions over C99.
1da177e4 2162 */
7b9186f5 2163int sprintf(char *buf, const char *fmt, ...)
1da177e4
LT
2164{
2165 va_list args;
2166 int i;
2167
2168 va_start(args, fmt);
7b9186f5 2169 i = vsnprintf(buf, INT_MAX, fmt, args);
1da177e4 2170 va_end(args);
7b9186f5 2171
1da177e4
LT
2172 return i;
2173}
1da177e4
LT
2174EXPORT_SYMBOL(sprintf);
2175
4370aa4a
LJ
2176#ifdef CONFIG_BINARY_PRINTF
2177/*
2178 * bprintf service:
2179 * vbin_printf() - VA arguments to binary data
2180 * bstr_printf() - Binary data to text string
2181 */
2182
2183/**
2184 * vbin_printf - Parse a format string and place args' binary value in a buffer
2185 * @bin_buf: The buffer to place args' binary value
2186 * @size: The size of the buffer(by words(32bits), not characters)
2187 * @fmt: The format string to use
2188 * @args: Arguments for the format string
2189 *
2190 * The format follows C99 vsnprintf, except %n is ignored, and its argument
da3dae54 2191 * is skipped.
4370aa4a
LJ
2192 *
2193 * The return value is the number of words(32bits) which would be generated for
2194 * the given input.
2195 *
2196 * NOTE:
2197 * If the return value is greater than @size, the resulting bin_buf is NOT
2198 * valid for bstr_printf().
2199 */
2200int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2201{
fef20d9c 2202 struct printf_spec spec = {0};
4370aa4a 2203 char *str, *end;
4370aa4a
LJ
2204
2205 str = (char *)bin_buf;
2206 end = (char *)(bin_buf + size);
2207
2208#define save_arg(type) \
2209do { \
2210 if (sizeof(type) == 8) { \
2211 unsigned long long value; \
2212 str = PTR_ALIGN(str, sizeof(u32)); \
2213 value = va_arg(args, unsigned long long); \
2214 if (str + sizeof(type) <= end) { \
2215 *(u32 *)str = *(u32 *)&value; \
2216 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2217 } \
2218 } else { \
2219 unsigned long value; \
2220 str = PTR_ALIGN(str, sizeof(type)); \
2221 value = va_arg(args, int); \
2222 if (str + sizeof(type) <= end) \
2223 *(typeof(type) *)str = (type)value; \
2224 } \
2225 str += sizeof(type); \
2226} while (0)
2227
fef20d9c 2228 while (*fmt) {
d4be151b 2229 int read = format_decode(fmt, &spec);
4370aa4a 2230
fef20d9c 2231 fmt += read;
4370aa4a 2232
fef20d9c
FW
2233 switch (spec.type) {
2234 case FORMAT_TYPE_NONE:
d4be151b 2235 case FORMAT_TYPE_PERCENT_CHAR:
fef20d9c 2236 break;
b006f19b
RV
2237 case FORMAT_TYPE_INVALID:
2238 goto out;
fef20d9c 2239
ed681a91 2240 case FORMAT_TYPE_WIDTH:
fef20d9c
FW
2241 case FORMAT_TYPE_PRECISION:
2242 save_arg(int);
2243 break;
2244
2245 case FORMAT_TYPE_CHAR:
4370aa4a 2246 save_arg(char);
fef20d9c
FW
2247 break;
2248
2249 case FORMAT_TYPE_STR: {
4370aa4a
LJ
2250 const char *save_str = va_arg(args, char *);
2251 size_t len;
6c356634 2252
4370aa4a
LJ
2253 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2254 || (unsigned long)save_str < PAGE_SIZE)
0f4f81dc 2255 save_str = "(null)";
6c356634
AGR
2256 len = strlen(save_str) + 1;
2257 if (str + len < end)
2258 memcpy(str, save_str, len);
2259 str += len;
fef20d9c 2260 break;
4370aa4a 2261 }
fef20d9c
FW
2262
2263 case FORMAT_TYPE_PTR:
4370aa4a
LJ
2264 save_arg(void *);
2265 /* skip all alphanumeric pointer suffixes */
fef20d9c 2266 while (isalnum(*fmt))
4370aa4a 2267 fmt++;
fef20d9c
FW
2268 break;
2269
fef20d9c
FW
2270 default:
2271 switch (spec.type) {
2272
2273 case FORMAT_TYPE_LONG_LONG:
4370aa4a 2274 save_arg(long long);
fef20d9c
FW
2275 break;
2276 case FORMAT_TYPE_ULONG:
2277 case FORMAT_TYPE_LONG:
4370aa4a 2278 save_arg(unsigned long);
fef20d9c
FW
2279 break;
2280 case FORMAT_TYPE_SIZE_T:
4370aa4a 2281 save_arg(size_t);
fef20d9c
FW
2282 break;
2283 case FORMAT_TYPE_PTRDIFF:
4370aa4a 2284 save_arg(ptrdiff_t);
fef20d9c 2285 break;
a4e94ef0
Z
2286 case FORMAT_TYPE_UBYTE:
2287 case FORMAT_TYPE_BYTE:
2288 save_arg(char);
2289 break;
fef20d9c
FW
2290 case FORMAT_TYPE_USHORT:
2291 case FORMAT_TYPE_SHORT:
4370aa4a 2292 save_arg(short);
fef20d9c
FW
2293 break;
2294 default:
4370aa4a 2295 save_arg(int);
fef20d9c 2296 }
4370aa4a
LJ
2297 }
2298 }
fef20d9c 2299
b006f19b 2300out:
7b9186f5 2301 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
fef20d9c 2302#undef save_arg
4370aa4a
LJ
2303}
2304EXPORT_SYMBOL_GPL(vbin_printf);
2305
2306/**
2307 * bstr_printf - Format a string from binary arguments and place it in a buffer
2308 * @buf: The buffer to place the result into
2309 * @size: The size of the buffer, including the trailing null space
2310 * @fmt: The format string to use
2311 * @bin_buf: Binary arguments for the format string
2312 *
2313 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2314 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2315 * a binary buffer that generated by vbin_printf.
2316 *
2317 * The format follows C99 vsnprintf, but has some extensions:
0efb4d20 2318 * see vsnprintf comment for details.
4370aa4a
LJ
2319 *
2320 * The return value is the number of characters which would
2321 * be generated for the given input, excluding the trailing
2322 * '\0', as per ISO C99. If you want to have the exact
2323 * number of characters written into @buf as return value
2324 * (not including the trailing '\0'), use vscnprintf(). If the
2325 * return is greater than or equal to @size, the resulting
2326 * string is truncated.
2327 */
2328int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2329{
fef20d9c 2330 struct printf_spec spec = {0};
d4be151b
AGR
2331 char *str, *end;
2332 const char *args = (const char *)bin_buf;
4370aa4a 2333
762abb51 2334 if (WARN_ON_ONCE(size > INT_MAX))
4370aa4a 2335 return 0;
4370aa4a
LJ
2336
2337 str = buf;
2338 end = buf + size;
2339
2340#define get_arg(type) \
2341({ \
2342 typeof(type) value; \
2343 if (sizeof(type) == 8) { \
2344 args = PTR_ALIGN(args, sizeof(u32)); \
2345 *(u32 *)&value = *(u32 *)args; \
2346 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2347 } else { \
2348 args = PTR_ALIGN(args, sizeof(type)); \
2349 value = *(typeof(type) *)args; \
2350 } \
2351 args += sizeof(type); \
2352 value; \
2353})
2354
2355 /* Make sure end is always >= buf */
2356 if (end < buf) {
2357 end = ((void *)-1);
2358 size = end - buf;
2359 }
2360
fef20d9c 2361 while (*fmt) {
fef20d9c 2362 const char *old_fmt = fmt;
d4be151b 2363 int read = format_decode(fmt, &spec);
4370aa4a 2364
fef20d9c 2365 fmt += read;
4370aa4a 2366
fef20d9c
FW
2367 switch (spec.type) {
2368 case FORMAT_TYPE_NONE: {
2369 int copy = read;
2370 if (str < end) {
2371 if (copy > end - str)
2372 copy = end - str;
2373 memcpy(str, old_fmt, copy);
4370aa4a 2374 }
fef20d9c
FW
2375 str += read;
2376 break;
4370aa4a
LJ
2377 }
2378
ed681a91 2379 case FORMAT_TYPE_WIDTH:
4d72ba01 2380 set_field_width(&spec, get_arg(int));
fef20d9c 2381 break;
4370aa4a 2382
fef20d9c 2383 case FORMAT_TYPE_PRECISION:
4d72ba01 2384 set_precision(&spec, get_arg(int));
fef20d9c 2385 break;
4370aa4a 2386
d4be151b
AGR
2387 case FORMAT_TYPE_CHAR: {
2388 char c;
2389
fef20d9c
FW
2390 if (!(spec.flags & LEFT)) {
2391 while (--spec.field_width > 0) {
4370aa4a
LJ
2392 if (str < end)
2393 *str = ' ';
2394 ++str;
2395 }
2396 }
2397 c = (unsigned char) get_arg(char);
2398 if (str < end)
2399 *str = c;
2400 ++str;
fef20d9c 2401 while (--spec.field_width > 0) {
4370aa4a
LJ
2402 if (str < end)
2403 *str = ' ';
2404 ++str;
2405 }
fef20d9c 2406 break;
d4be151b 2407 }
4370aa4a 2408
fef20d9c 2409 case FORMAT_TYPE_STR: {
4370aa4a 2410 const char *str_arg = args;
d4be151b 2411 args += strlen(str_arg) + 1;
fef20d9c
FW
2412 str = string(str, end, (char *)str_arg, spec);
2413 break;
4370aa4a
LJ
2414 }
2415
fef20d9c 2416 case FORMAT_TYPE_PTR:
ffbfed03 2417 str = pointer(fmt, str, end, get_arg(void *), spec);
fef20d9c 2418 while (isalnum(*fmt))
4370aa4a 2419 fmt++;
fef20d9c 2420 break;
4370aa4a 2421
fef20d9c 2422 case FORMAT_TYPE_PERCENT_CHAR:
4370aa4a
LJ
2423 if (str < end)
2424 *str = '%';
2425 ++str;
fef20d9c
FW
2426 break;
2427
b006f19b
RV
2428 case FORMAT_TYPE_INVALID:
2429 goto out;
2430
d4be151b
AGR
2431 default: {
2432 unsigned long long num;
2433
fef20d9c
FW
2434 switch (spec.type) {
2435
2436 case FORMAT_TYPE_LONG_LONG:
2437 num = get_arg(long long);
2438 break;
2439 case FORMAT_TYPE_ULONG:
fef20d9c
FW
2440 case FORMAT_TYPE_LONG:
2441 num = get_arg(unsigned long);
2442 break;
2443 case FORMAT_TYPE_SIZE_T:
2444 num = get_arg(size_t);
2445 break;
2446 case FORMAT_TYPE_PTRDIFF:
2447 num = get_arg(ptrdiff_t);
2448 break;
a4e94ef0
Z
2449 case FORMAT_TYPE_UBYTE:
2450 num = get_arg(unsigned char);
2451 break;
2452 case FORMAT_TYPE_BYTE:
2453 num = get_arg(signed char);
2454 break;
fef20d9c
FW
2455 case FORMAT_TYPE_USHORT:
2456 num = get_arg(unsigned short);
2457 break;
2458 case FORMAT_TYPE_SHORT:
2459 num = get_arg(short);
2460 break;
2461 case FORMAT_TYPE_UINT:
2462 num = get_arg(unsigned int);
2463 break;
2464 default:
2465 num = get_arg(int);
2466 }
2467
2468 str = number(str, end, num, spec);
d4be151b
AGR
2469 } /* default: */
2470 } /* switch(spec.type) */
2471 } /* while(*fmt) */
fef20d9c 2472
b006f19b 2473out:
4370aa4a
LJ
2474 if (size > 0) {
2475 if (str < end)
2476 *str = '\0';
2477 else
2478 end[-1] = '\0';
2479 }
fef20d9c 2480
4370aa4a
LJ
2481#undef get_arg
2482
2483 /* the trailing null byte doesn't count towards the total */
2484 return str - buf;
2485}
2486EXPORT_SYMBOL_GPL(bstr_printf);
2487
2488/**
2489 * bprintf - Parse a format string and place args' binary value in a buffer
2490 * @bin_buf: The buffer to place args' binary value
2491 * @size: The size of the buffer(by words(32bits), not characters)
2492 * @fmt: The format string to use
2493 * @...: Arguments for the format string
2494 *
2495 * The function returns the number of words(u32) written
2496 * into @bin_buf.
2497 */
2498int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2499{
2500 va_list args;
2501 int ret;
2502
2503 va_start(args, fmt);
2504 ret = vbin_printf(bin_buf, size, fmt, args);
2505 va_end(args);
7b9186f5 2506
4370aa4a
LJ
2507 return ret;
2508}
2509EXPORT_SYMBOL_GPL(bprintf);
2510
2511#endif /* CONFIG_BINARY_PRINTF */
2512
1da177e4
LT
2513/**
2514 * vsscanf - Unformat a buffer into a list of arguments
2515 * @buf: input buffer
2516 * @fmt: format of buffer
2517 * @args: arguments
2518 */
7b9186f5 2519int vsscanf(const char *buf, const char *fmt, va_list args)
1da177e4
LT
2520{
2521 const char *str = buf;
2522 char *next;
2523 char digit;
2524 int num = 0;
ef0658f3 2525 u8 qualifier;
53809751
JB
2526 unsigned int base;
2527 union {
2528 long long s;
2529 unsigned long long u;
2530 } val;
ef0658f3 2531 s16 field_width;
d4be151b 2532 bool is_sign;
1da177e4 2533
da99075c 2534 while (*fmt) {
1da177e4
LT
2535 /* skip any white space in format */
2536 /* white space in format matchs any amount of
2537 * white space, including none, in the input.
2538 */
2539 if (isspace(*fmt)) {
e7d2860b
AGR
2540 fmt = skip_spaces(++fmt);
2541 str = skip_spaces(str);
1da177e4
LT
2542 }
2543
2544 /* anything that is not a conversion must match exactly */
2545 if (*fmt != '%' && *fmt) {
2546 if (*fmt++ != *str++)
2547 break;
2548 continue;
2549 }
2550
2551 if (!*fmt)
2552 break;
2553 ++fmt;
7b9186f5 2554
1da177e4
LT
2555 /* skip this conversion.
2556 * advance both strings to next white space
2557 */
2558 if (*fmt == '*') {
da99075c
JB
2559 if (!*str)
2560 break;
8fccae2c 2561 while (!isspace(*fmt) && *fmt != '%' && *fmt)
1da177e4
LT
2562 fmt++;
2563 while (!isspace(*str) && *str)
2564 str++;
2565 continue;
2566 }
2567
2568 /* get field width */
2569 field_width = -1;
53809751 2570 if (isdigit(*fmt)) {
1da177e4 2571 field_width = skip_atoi(&fmt);
53809751
JB
2572 if (field_width <= 0)
2573 break;
2574 }
1da177e4
LT
2575
2576 /* get conversion qualifier */
2577 qualifier = -1;
75fb8f26
AS
2578 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2579 _tolower(*fmt) == 'z') {
1da177e4
LT
2580 qualifier = *fmt++;
2581 if (unlikely(qualifier == *fmt)) {
2582 if (qualifier == 'h') {
2583 qualifier = 'H';
2584 fmt++;
2585 } else if (qualifier == 'l') {
2586 qualifier = 'L';
2587 fmt++;
2588 }
2589 }
2590 }
1da177e4 2591
da99075c
JB
2592 if (!*fmt)
2593 break;
2594
2595 if (*fmt == 'n') {
2596 /* return number of characters read so far */
2597 *va_arg(args, int *) = str - buf;
2598 ++fmt;
2599 continue;
2600 }
2601
2602 if (!*str)
1da177e4
LT
2603 break;
2604
d4be151b 2605 base = 10;
3f623eba 2606 is_sign = false;
d4be151b 2607
7b9186f5 2608 switch (*fmt++) {
1da177e4
LT
2609 case 'c':
2610 {
7b9186f5 2611 char *s = (char *)va_arg(args, char*);
1da177e4
LT
2612 if (field_width == -1)
2613 field_width = 1;
2614 do {
2615 *s++ = *str++;
2616 } while (--field_width > 0 && *str);
2617 num++;
2618 }
2619 continue;
2620 case 's':
2621 {
7b9186f5
AGR
2622 char *s = (char *)va_arg(args, char *);
2623 if (field_width == -1)
4be929be 2624 field_width = SHRT_MAX;
1da177e4 2625 /* first, skip leading white space in buffer */
e7d2860b 2626 str = skip_spaces(str);
1da177e4
LT
2627
2628 /* now copy until next white space */
7b9186f5 2629 while (*str && !isspace(*str) && field_width--)
1da177e4 2630 *s++ = *str++;
1da177e4
LT
2631 *s = '\0';
2632 num++;
2633 }
2634 continue;
1da177e4
LT
2635 case 'o':
2636 base = 8;
2637 break;
2638 case 'x':
2639 case 'X':
2640 base = 16;
2641 break;
2642 case 'i':
7b9186f5 2643 base = 0;
1da177e4 2644 case 'd':
3f623eba 2645 is_sign = true;
1da177e4
LT
2646 case 'u':
2647 break;
2648 case '%':
2649 /* looking for '%' in str */
7b9186f5 2650 if (*str++ != '%')
1da177e4
LT
2651 return num;
2652 continue;
2653 default:
2654 /* invalid format; stop here */
2655 return num;
2656 }
2657
2658 /* have some sort of integer conversion.
2659 * first, skip white space in buffer.
2660 */
e7d2860b 2661 str = skip_spaces(str);
1da177e4
LT
2662
2663 digit = *str;
2664 if (is_sign && digit == '-')
2665 digit = *(str + 1);
2666
2667 if (!digit
7b9186f5
AGR
2668 || (base == 16 && !isxdigit(digit))
2669 || (base == 10 && !isdigit(digit))
2670 || (base == 8 && (!isdigit(digit) || digit > '7'))
2671 || (base == 0 && !isdigit(digit)))
2672 break;
1da177e4 2673
53809751
JB
2674 if (is_sign)
2675 val.s = qualifier != 'L' ?
2676 simple_strtol(str, &next, base) :
2677 simple_strtoll(str, &next, base);
2678 else
2679 val.u = qualifier != 'L' ?
2680 simple_strtoul(str, &next, base) :
2681 simple_strtoull(str, &next, base);
2682
2683 if (field_width > 0 && next - str > field_width) {
2684 if (base == 0)
2685 _parse_integer_fixup_radix(str, &base);
2686 while (next - str > field_width) {
2687 if (is_sign)
2688 val.s = div_s64(val.s, base);
2689 else
2690 val.u = div_u64(val.u, base);
2691 --next;
2692 }
2693 }
2694
7b9186f5 2695 switch (qualifier) {
1da177e4 2696 case 'H': /* that's 'hh' in format */
53809751
JB
2697 if (is_sign)
2698 *va_arg(args, signed char *) = val.s;
2699 else
2700 *va_arg(args, unsigned char *) = val.u;
1da177e4
LT
2701 break;
2702 case 'h':
53809751
JB
2703 if (is_sign)
2704 *va_arg(args, short *) = val.s;
2705 else
2706 *va_arg(args, unsigned short *) = val.u;
1da177e4
LT
2707 break;
2708 case 'l':
53809751
JB
2709 if (is_sign)
2710 *va_arg(args, long *) = val.s;
2711 else
2712 *va_arg(args, unsigned long *) = val.u;
1da177e4
LT
2713 break;
2714 case 'L':
53809751
JB
2715 if (is_sign)
2716 *va_arg(args, long long *) = val.s;
2717 else
2718 *va_arg(args, unsigned long long *) = val.u;
1da177e4
LT
2719 break;
2720 case 'Z':
2721 case 'z':
53809751
JB
2722 *va_arg(args, size_t *) = val.u;
2723 break;
1da177e4 2724 default:
53809751
JB
2725 if (is_sign)
2726 *va_arg(args, int *) = val.s;
2727 else
2728 *va_arg(args, unsigned int *) = val.u;
1da177e4
LT
2729 break;
2730 }
2731 num++;
2732
2733 if (!next)
2734 break;
2735 str = next;
2736 }
c6b40d16 2737
1da177e4
LT
2738 return num;
2739}
1da177e4
LT
2740EXPORT_SYMBOL(vsscanf);
2741
2742/**
2743 * sscanf - Unformat a buffer into a list of arguments
2744 * @buf: input buffer
2745 * @fmt: formatting of buffer
2746 * @...: resulting arguments
2747 */
7b9186f5 2748int sscanf(const char *buf, const char *fmt, ...)
1da177e4
LT
2749{
2750 va_list args;
2751 int i;
2752
7b9186f5
AGR
2753 va_start(args, fmt);
2754 i = vsscanf(buf, fmt, args);
1da177e4 2755 va_end(args);
7b9186f5 2756
1da177e4
LT
2757 return i;
2758}
1da177e4 2759EXPORT_SYMBOL(sscanf);
This page took 0.897866 seconds and 5 git commands to generate.