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