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