lib/vsprintf.c

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