lib/vsprintf.c

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