lib/vsprintf.c

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