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