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/module.h>       /* for KSYM_SYMBOL_LEN */
  21 #include <linux/types.h>
  22 #include <linux/string.h>
  23 #include <linux/ctype.h>
  24 #include <linux/kernel.h>
  25 #include <linux/kallsyms.h>
  26 #include <linux/math64.h>
  27 #include <linux/uaccess.h>
  28 #include <linux/ioport.h>
  29 #include <linux/dcache.h>
  30 #include <linux/cred.h>
  31 #include <net/addrconf.h>
  32
  33 #include <asm/page.h>           /* for PAGE_SIZE */
  34 #include <asm/sections.h>       /* for dereference_function_descriptor() */
  35
  36 #include <linux/string_helpers.h>
  37 #include "kstrtox.h"
  38
  39 /**
  40  * simple_strtoull - convert a string to an unsigned long long
  41  * @cp: The start of the string
  42  * @endp: A pointer to the end of the parsed string will be placed here
  43  * @base: The number base to use
  44  *
  45  * This function is obsolete. Please use kstrtoull instead.
  46  */
  47 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
  48 {
  49         unsigned long long result;
  50         unsigned int rv;
  51
  52         cp = _parse_integer_fixup_radix(cp, &base);
  53         rv = _parse_integer(cp, base, &result);
  54         /* FIXME */
  55         cp += (rv & ~KSTRTOX_OVERFLOW);
  56
  57         if (endp)
  58                 *endp = (char *)cp;
  59
  60         return result;
  61 }
  62 EXPORT_SYMBOL(simple_strtoull);
  63
  64 /**
  65  * simple_strtoul - convert a string to an unsigned long
  66  * @cp: The start of the string
  67  * @endp: A pointer to the end of the parsed string will be placed here
  68  * @base: The number base to use
  69  *
  70  * This function is obsolete. Please use kstrtoul instead.
  71  */
  72 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
  73 {
  74         return simple_strtoull(cp, endp, base);
  75 }
  76 EXPORT_SYMBOL(simple_strtoul);
  77
  78 /**
  79  * simple_strtol - convert a string to a signed long
  80  * @cp: The start of the string
  81  * @endp: A pointer to the end of the parsed string will be placed here
  82  * @base: The number base to use
  83  *
  84  * This function is obsolete. Please use kstrtol instead.
  85  */
  86 long simple_strtol(const char *cp, char **endp, unsigned int base)
  87 {
  88         if (*cp == '-')
  89                 return -simple_strtoul(cp + 1, endp, base);
  90
  91         return simple_strtoul(cp, endp, base);
  92 }
  93 EXPORT_SYMBOL(simple_strtol);
  94
  95 /**
  96  * simple_strtoll - convert a string to a signed long long
  97  * @cp: The start of the string
  98  * @endp: A pointer to the end of the parsed string will be placed here
  99  * @base: The number base to use
 100  *
 101  * This function is obsolete. Please use kstrtoll instead.
 102  */
 103 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
 104 {
 105         if (*cp == '-')
 106                 return -simple_strtoull(cp + 1, endp, base);
 107
 108         return simple_strtoull(cp, endp, base);
 109 }
 110 EXPORT_SYMBOL(simple_strtoll);
 111
 112 static noinline_for_stack
 113 int skip_atoi(const char **s)
 114 {
 115         int i = 0;
 116
 117         do {
 118                 i = i*10 + *((*s)++) - '0';
 119         } while (isdigit(**s));
 120
 121         return i;
 122 }
 123
 124 /* Decimal conversion is by far the most typical, and is used
 125  * for /proc and /sys data. This directly impacts e.g. top performance
 126  * with many processes running. We optimize it for speed
 127  * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
 128  * (with permission from the author, Douglas W. Jones).
 129  */
 130
 131 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
 132 /* Formats correctly any integer in [0, 999999999] */
 133 static noinline_for_stack
 134 char *put_dec_full9(char *buf, unsigned q)
 135 {
 136         unsigned r;
 137
 138         /*
 139          * Possible ways to approx. divide by 10
 140          * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
 141          * (x * 0xcccd) >> 19     x <      81920 (x < 262149 when 64-bit mul)
 142          * (x * 0x6667) >> 18     x <      43699
 143          * (x * 0x3334) >> 17     x <      16389
 144          * (x * 0x199a) >> 16     x <      16389
 145          * (x * 0x0ccd) >> 15     x <      16389
 146          * (x * 0x0667) >> 14     x <       2739
 147          * (x * 0x0334) >> 13     x <       1029
 148          * (x * 0x019a) >> 12     x <       1029
 149          * (x * 0x00cd) >> 11     x <       1029 shorter code than * 0x67 (on i386)
 150          * (x * 0x0067) >> 10     x <        179
 151          * (x * 0x0034) >>  9     x <         69 same
 152          * (x * 0x001a) >>  8     x <         69 same
 153          * (x * 0x000d) >>  7     x <         69 same, shortest code (on i386)
 154          * (x * 0x0007) >>  6     x <         19
 155          * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
 156          */
 157         r      = (q * (uint64_t)0x1999999a) >> 32;
 158         *buf++ = (q - 10 * r) + '0'; /* 1 */
 159         q      = (r * (uint64_t)0x1999999a) >> 32;
 160         *buf++ = (r - 10 * q) + '0'; /* 2 */
 161         r      = (q * (uint64_t)0x1999999a) >> 32;
 162         *buf++ = (q - 10 * r) + '0'; /* 3 */
 163         q      = (r * (uint64_t)0x1999999a) >> 32;
 164         *buf++ = (r - 10 * q) + '0'; /* 4 */
 165         r      = (q * (uint64_t)0x1999999a) >> 32;
 166         *buf++ = (q - 10 * r) + '0'; /* 5 */
 167         /* Now value is under 10000, can avoid 64-bit multiply */
 168         q      = (r * 0x199a) >> 16;
 169         *buf++ = (r - 10 * q)  + '0'; /* 6 */
 170         r      = (q * 0xcd) >> 11;
 171         *buf++ = (q - 10 * r)  + '0'; /* 7 */
 172         q      = (r * 0xcd) >> 11;
 173         *buf++ = (r - 10 * q) + '0'; /* 8 */
 174         *buf++ = q + '0'; /* 9 */
 175         return buf;
 176 }
 177 #endif
 178
 179 /* Similar to above but do not pad with zeros.
 180  * Code can be easily arranged to print 9 digits too, but our callers
 181  * always call put_dec_full9() instead when the number has 9 decimal digits.
 182  */
 183 static noinline_for_stack
 184 char *put_dec_trunc8(char *buf, unsigned r)
 185 {
 186         unsigned q;
 187
 188         /* Copy of previous function's body with added early returns */
 189         while (r >= 10000) {
 190                 q = r + '0';
 191                 r  = (r * (uint64_t)0x1999999a) >> 32;
 192                 *buf++ = q - 10*r;
 193         }
 194
 195         q      = (r * 0x199a) >> 16;    /* r <= 9999 */
 196         *buf++ = (r - 10 * q)  + '0';
 197         if (q == 0)
 198                 return buf;
 199         r      = (q * 0xcd) >> 11;      /* q <= 999 */
 200         *buf++ = (q - 10 * r)  + '0';
 201         if (r == 0)
 202                 return buf;
 203         q      = (r * 0xcd) >> 11;      /* r <= 99 */
 204         *buf++ = (r - 10 * q) + '0';
 205         if (q == 0)
 206                 return buf;
 207         *buf++ = q + '0';                /* q <= 9 */
 208         return buf;
 209 }
 210
 211 /* There are two algorithms to print larger numbers.
 212  * One is generic: divide by 1000000000 and repeatedly print
 213  * groups of (up to) 9 digits. It's conceptually simple,
 214  * but requires a (unsigned long long) / 1000000000 division.
 215  *
 216  * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
 217  * manipulates them cleverly and generates groups of 4 decimal digits.
 218  * It so happens that it does NOT require long long division.
 219  *
 220  * If long is > 32 bits, division of 64-bit values is relatively easy,
 221  * and we will use the first algorithm.
 222  * If long long is > 64 bits (strange architecture with VERY large long long),
 223  * second algorithm can't be used, and we again use the first one.
 224  *
 225  * Else (if long is 32 bits and long long is 64 bits) we use second one.
 226  */
 227
 228 #if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
 229
 230 /* First algorithm: generic */
 231
 232 static
 233 char *put_dec(char *buf, unsigned long long n)
 234 {
 235         if (n >= 100*1000*1000) {
 236                 while (n >= 1000*1000*1000)
 237                         buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
 238                 if (n >= 100*1000*1000)
 239                         return put_dec_full9(buf, n);
 240         }
 241         return put_dec_trunc8(buf, n);
 242 }
 243
 244 #else
 245
 246 /* Second algorithm: valid only for 64-bit long longs */
 247
 248 /* See comment in put_dec_full9 for choice of constants */
 249 static noinline_for_stack
 250 void put_dec_full4(char *buf, unsigned q)
 251 {
 252         unsigned r;
 253         r      = (q * 0xccd) >> 15;
 254         buf[0] = (q - 10 * r) + '0';
 255         q      = (r * 0xcd) >> 11;
 256         buf[1] = (r - 10 * q)  + '0';
 257         r      = (q * 0xcd) >> 11;
 258         buf[2] = (q - 10 * r)  + '0';
 259         buf[3] = r + '0';
 260 }
 261
 262 /*
 263  * Call put_dec_full4 on x % 10000, return x / 10000.
 264  * The approximation x/10000 == (x * 0x346DC5D7) >> 43
 265  * holds for all x < 1,128,869,999.  The largest value this
 266  * helper will ever be asked to convert is 1,125,520,955.
 267  * (d1 in the put_dec code, assuming n is all-ones).
 268  */
 269 static
 270 unsigned put_dec_helper4(char *buf, unsigned x)
 271 {
 272         uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
 273
 274         put_dec_full4(buf, x - q * 10000);
 275         return q;
 276 }
 277
 278 /* Based on code by Douglas W. Jones found at
 279  * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
 280  * (with permission from the author).
 281  * Performs no 64-bit division and hence should be fast on 32-bit machines.
 282  */
 283 static
 284 char *put_dec(char *buf, unsigned long long n)
 285 {
 286         uint32_t d3, d2, d1, q, h;
 287
 288         if (n < 100*1000*1000)
 289                 return put_dec_trunc8(buf, n);
 290
 291         d1  = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
 292         h   = (n >> 32);
 293         d2  = (h      ) & 0xffff;
 294         d3  = (h >> 16); /* implicit "& 0xffff" */
 295
 296         q   = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
 297         q = put_dec_helper4(buf, q);
 298
 299         q += 7671 * d3 + 9496 * d2 + 6 * d1;
 300         q = put_dec_helper4(buf+4, q);
 301
 302         q += 4749 * d3 + 42 * d2;
 303         q = put_dec_helper4(buf+8, q);
 304
 305         q += 281 * d3;
 306         buf += 12;
 307         if (q)
 308                 buf = put_dec_trunc8(buf, q);
 309         else while (buf[-1] == '0')
 310                 --buf;
 311
 312         return buf;
 313 }
 314
 315 #endif
 316
 317 /*
 318  * Convert passed number to decimal string.
 319  * Returns the length of string.  On buffer overflow, returns 0.
 320  *
 321  * If speed is not important, use snprintf(). It's easy to read the code.
 322  */
 323 int num_to_str(char *buf, int size, unsigned long long num)
 324 {
 325         char tmp[sizeof(num) * 3];
 326         int idx, len;
 327
 328         /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
 329         if (num <= 9) {
 330                 tmp[0] = '0' + num;
 331                 len = 1;
 332         } else {
 333                 len = put_dec(tmp, num) - tmp;
 334         }
 335
 336         if (len > size)
 337                 return 0;
 338         for (idx = 0; idx < len; ++idx)
 339                 buf[idx] = tmp[len - idx - 1];
 340         return len;
 341 }
 342
 343 #define SIGN    1               /* unsigned/signed, must be 1 */
 344 #define ZEROPAD 2               /* pad with zero */
 345 #define PLUS    4               /* show plus */
 346 #define SPACE   8               /* space if plus */
 347 #define LEFT    16              /* left justified */
 348 #define SMALL   32              /* use lowercase in hex (must be 32 == 0x20) */
 349 #define SPECIAL 64              /* prefix hex with "0x", octal with "0" */
 350
 351 enum format_type {
 352         FORMAT_TYPE_NONE, /* Just a string part */
 353         FORMAT_TYPE_WIDTH,
 354         FORMAT_TYPE_PRECISION,
 355         FORMAT_TYPE_CHAR,
 356         FORMAT_TYPE_STR,
 357         FORMAT_TYPE_PTR,
 358         FORMAT_TYPE_PERCENT_CHAR,
 359         FORMAT_TYPE_INVALID,
 360         FORMAT_TYPE_LONG_LONG,
 361         FORMAT_TYPE_ULONG,
 362         FORMAT_TYPE_LONG,
 363         FORMAT_TYPE_UBYTE,
 364         FORMAT_TYPE_BYTE,
 365         FORMAT_TYPE_USHORT,
 366         FORMAT_TYPE_SHORT,
 367         FORMAT_TYPE_UINT,
 368         FORMAT_TYPE_INT,
 369         FORMAT_TYPE_SIZE_T,
 370         FORMAT_TYPE_PTRDIFF
 371 };
 372
 373 struct printf_spec {
 374         u8      type;           /* format_type enum */
 375         u8      flags;          /* flags to number() */
 376         u8      base;           /* number base, 8, 10 or 16 only */
 377         u8      qualifier;      /* number qualifier, one of 'hHlLtzZ' */
 378         s16     field_width;    /* width of output field */
 379         s16     precision;      /* # of digits/chars */
 380 };
 381
 382 static noinline_for_stack
 383 char *number(char *buf, char *end, unsigned long long num,
 384              struct printf_spec spec)
 385 {
 386         /* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
 387         static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
 388
 389         char tmp[3 * sizeof(num)];
 390         char sign;
 391         char locase;
 392         int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
 393         int i;
 394         bool is_zero = num == 0LL;
 395
 396         /* locase = 0 or 0x20. ORing digits or letters with 'locase'
 397          * produces same digits or (maybe lowercased) letters */
 398         locase = (spec.flags & SMALL);
 399         if (spec.flags & LEFT)
 400                 spec.flags &= ~ZEROPAD;
 401         sign = 0;
 402         if (spec.flags & SIGN) {
 403                 if ((signed long long)num < 0) {
 404                         sign = '-';
 405                         num = -(signed long long)num;
 406                         spec.field_width--;
 407                 } else if (spec.flags & PLUS) {
 408                         sign = '+';
 409                         spec.field_width--;
 410                 } else if (spec.flags & SPACE) {
 411                         sign = ' ';
 412                         spec.field_width--;
 413                 }
 414         }
 415         if (need_pfx) {
 416                 if (spec.base == 16)
 417                         spec.field_width -= 2;
 418                 else if (!is_zero)
 419                         spec.field_width--;
 420         }
 421
 422         /* generate full string in tmp[], in reverse order */
 423         i = 0;
 424         if (num < spec.base)
 425                 tmp[i++] = digits[num] | locase;
 426         else if (spec.base != 10) { /* 8 or 16 */
 427                 int mask = spec.base - 1;
 428                 int shift = 3;
 429
 430                 if (spec.base == 16)
 431                         shift = 4;
 432                 do {
 433                         tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
 434                         num >>= shift;
 435                 } while (num);
 436         } else { /* base 10 */
 437                 i = put_dec(tmp, num) - tmp;
 438         }
 439
 440         /* printing 100 using %2d gives "100", not "00" */
 441         if (i > spec.precision)
 442                 spec.precision = i;
 443         /* leading space padding */
 444         spec.field_width -= spec.precision;
 445         if (!(spec.flags & (ZEROPAD | LEFT))) {
 446                 while (--spec.field_width >= 0) {
 447                         if (buf < end)
 448                                 *buf = ' ';
 449                         ++buf;
 450                 }
 451         }
 452         /* sign */
 453         if (sign) {
 454                 if (buf < end)
 455                         *buf = sign;
 456                 ++buf;
 457         }
 458         /* "0x" / "0" prefix */
 459         if (need_pfx) {
 460                 if (spec.base == 16 || !is_zero) {
 461                         if (buf < end)
 462                                 *buf = '0';
 463                         ++buf;
 464                 }
 465                 if (spec.base == 16) {
 466                         if (buf < end)
 467                                 *buf = ('X' | locase);
 468                         ++buf;
 469                 }
 470         }
 471         /* zero or space padding */
 472         if (!(spec.flags & LEFT)) {
 473                 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
 474                 while (--spec.field_width >= 0) {
 475                         if (buf < end)
 476                                 *buf = c;
 477                         ++buf;
 478                 }
 479         }
 480         /* hmm even more zero padding? */
 481         while (i <= --spec.precision) {
 482                 if (buf < end)
 483                         *buf = '0';
 484                 ++buf;
 485         }
 486         /* actual digits of result */
 487         while (--i >= 0) {
 488                 if (buf < end)
 489                         *buf = tmp[i];
 490                 ++buf;
 491         }
 492         /* trailing space padding */
 493         while (--spec.field_width >= 0) {
 494                 if (buf < end)
 495                         *buf = ' ';
 496                 ++buf;
 497         }
 498
 499         return buf;
 500 }
 501
 502 static noinline_for_stack
 503 char *string(char *buf, char *end, const char *s, struct printf_spec spec)
 504 {
 505         int len, i;
 506
 507         if ((unsigned long)s < PAGE_SIZE)
 508                 s = "(null)";
 509
 510         len = strnlen(s, spec.precision);
 511
 512         if (!(spec.flags & LEFT)) {
 513                 while (len < spec.field_width--) {
 514                         if (buf < end)
 515                                 *buf = ' ';
 516                         ++buf;
 517                 }
 518         }
 519         for (i = 0; i < len; ++i) {
 520                 if (buf < end)
 521                         *buf = *s;
 522                 ++buf; ++s;
 523         }
 524         while (len < spec.field_width--) {
 525                 if (buf < end)
 526                         *buf = ' ';
 527                 ++buf;
 528         }
 529
 530         return buf;
 531 }
 532
 533 static void widen(char *buf, char *end, unsigned len, unsigned spaces)
 534 {
 535         size_t size;
 536         if (buf >= end) /* nowhere to put anything */
 537                 return;
 538         size = end - buf;
 539         if (size <= spaces) {
 540                 memset(buf, ' ', size);
 541                 return;
 542         }
 543         if (len) {
 544                 if (len > size - spaces)
 545                         len = size - spaces;
 546                 memmove(buf + spaces, buf, len);
 547         }
 548         memset(buf, ' ', spaces);
 549 }
 550
 551 static noinline_for_stack
 552 char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
 553                   const char *fmt)
 554 {
 555         const char *array[4], *s;
 556         const struct dentry *p;
 557         int depth;
 558         int i, n;
 559
 560         switch (fmt[1]) {
 561                 case '2': case '3': case '4':
 562                         depth = fmt[1] - '0';
 563                         break;
 564                 default:
 565                         depth = 1;
 566         }
 567
 568         rcu_read_lock();
 569         for (i = 0; i < depth; i++, d = p) {
 570                 p = ACCESS_ONCE(d->d_parent);
 571                 array[i] = ACCESS_ONCE(d->d_name.name);
 572                 if (p == d) {
 573                         if (i)
 574                                 array[i] = "";
 575                         i++;
 576                         break;
 577                 }
 578         }
 579         s = array[--i];
 580         for (n = 0; n != spec.precision; n++, buf++) {
 581                 char c = *s++;
 582                 if (!c) {
 583                         if (!i)
 584                                 break;
 585                         c = '/';
 586                         s = array[--i];
 587                 }
 588                 if (buf < end)
 589                         *buf = c;
 590         }
 591         rcu_read_unlock();
 592         if (n < spec.field_width) {
 593                 /* we want to pad the sucker */
 594                 unsigned spaces = spec.field_width - n;
 595                 if (!(spec.flags & LEFT)) {
 596                         widen(buf - n, end, n, spaces);
 597                         return buf + spaces;
 598                 }
 599                 while (spaces--) {
 600                         if (buf < end)
 601                                 *buf = ' ';
 602                         ++buf;
 603                 }
 604         }
 605         return buf;
 606 }
 607
 608 static noinline_for_stack
 609 char *symbol_string(char *buf, char *end, void *ptr,
 610                     struct printf_spec spec, const char *fmt)
 611 {
 612         unsigned long value;
 613 #ifdef CONFIG_KALLSYMS
 614         char sym[KSYM_SYMBOL_LEN];
 615 #endif
 616
 617         if (fmt[1] == 'R')
 618                 ptr = __builtin_extract_return_addr(ptr);
 619         value = (unsigned long)ptr;
 620
 621 #ifdef CONFIG_KALLSYMS
 622         if (*fmt == 'B')
 623                 sprint_backtrace(sym, value);
 624         else if (*fmt != 'f' && *fmt != 's')
 625                 sprint_symbol(sym, value);
 626         else
 627                 sprint_symbol_no_offset(sym, value);
 628
 629         return string(buf, end, sym, spec);
 630 #else
 631         spec.field_width = 2 * sizeof(void *);
 632         spec.flags |= SPECIAL | SMALL | ZEROPAD;
 633         spec.base = 16;
 634
 635         return number(buf, end, value, spec);
 636 #endif
 637 }
 638
 639 static noinline_for_stack
 640 char *resource_string(char *buf, char *end, struct resource *res,
 641                       struct printf_spec spec, const char *fmt)
 642 {
 643 #ifndef IO_RSRC_PRINTK_SIZE
 644 #define IO_RSRC_PRINTK_SIZE     6
 645 #endif
 646
 647 #ifndef MEM_RSRC_PRINTK_SIZE
 648 #define MEM_RSRC_PRINTK_SIZE    10
 649 #endif
 650         static const struct printf_spec io_spec = {
 651                 .base = 16,
 652                 .field_width = IO_RSRC_PRINTK_SIZE,
 653                 .precision = -1,
 654                 .flags = SPECIAL | SMALL | ZEROPAD,
 655         };
 656         static const struct printf_spec mem_spec = {
 657                 .base = 16,
 658                 .field_width = MEM_RSRC_PRINTK_SIZE,
 659                 .precision = -1,
 660                 .flags = SPECIAL | SMALL | ZEROPAD,
 661         };
 662         static const struct printf_spec bus_spec = {
 663                 .base = 16,
 664                 .field_width = 2,
 665                 .precision = -1,
 666                 .flags = SMALL | ZEROPAD,
 667         };
 668         static const struct printf_spec dec_spec = {
 669                 .base = 10,
 670                 .precision = -1,
 671                 .flags = 0,
 672         };
 673         static const struct printf_spec str_spec = {
 674                 .field_width = -1,
 675                 .precision = 10,
 676                 .flags = LEFT,
 677         };
 678         static const struct printf_spec flag_spec = {
 679                 .base = 16,
 680                 .precision = -1,
 681                 .flags = SPECIAL | SMALL,
 682         };
 683
 684         /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
 685          * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
 686 #define RSRC_BUF_SIZE           ((2 * sizeof(resource_size_t)) + 4)
 687 #define FLAG_BUF_SIZE           (2 * sizeof(res->flags))
 688 #define DECODED_BUF_SIZE        sizeof("[mem - 64bit pref window disabled]")
 689 #define RAW_BUF_SIZE            sizeof("[mem - flags 0x]")
 690         char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
 691                      2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
 692
 693         char *p = sym, *pend = sym + sizeof(sym);
 694         int decode = (fmt[0] == 'R') ? 1 : 0;
 695         const struct printf_spec *specp;
 696
 697         *p++ = '[';
 698         if (res->flags & IORESOURCE_IO) {
 699                 p = string(p, pend, "io  ", str_spec);
 700                 specp = &io_spec;
 701         } else if (res->flags & IORESOURCE_MEM) {
 702                 p = string(p, pend, "mem ", str_spec);
 703                 specp = &mem_spec;
 704         } else if (res->flags & IORESOURCE_IRQ) {
 705                 p = string(p, pend, "irq ", str_spec);
 706                 specp = &dec_spec;
 707         } else if (res->flags & IORESOURCE_DMA) {
 708                 p = string(p, pend, "dma ", str_spec);
 709                 specp = &dec_spec;
 710         } else if (res->flags & IORESOURCE_BUS) {
 711                 p = string(p, pend, "bus ", str_spec);
 712                 specp = &bus_spec;
 713         } else {
 714                 p = string(p, pend, "??? ", str_spec);
 715                 specp = &mem_spec;
 716                 decode = 0;
 717         }
 718         if (decode && res->flags & IORESOURCE_UNSET) {
 719                 p = string(p, pend, "size ", str_spec);
 720                 p = number(p, pend, resource_size(res), *specp);
 721         } else {
 722                 p = number(p, pend, res->start, *specp);
 723                 if (res->start != res->end) {
 724                         *p++ = '-';
 725                         p = number(p, pend, res->end, *specp);
 726                 }
 727         }
 728         if (decode) {
 729                 if (res->flags & IORESOURCE_MEM_64)
 730                         p = string(p, pend, " 64bit", str_spec);
 731                 if (res->flags & IORESOURCE_PREFETCH)
 732                         p = string(p, pend, " pref", str_spec);
 733                 if (res->flags & IORESOURCE_WINDOW)
 734                         p = string(p, pend, " window", str_spec);
 735                 if (res->flags & IORESOURCE_DISABLED)
 736                         p = string(p, pend, " disabled", str_spec);
 737         } else {
 738                 p = string(p, pend, " flags ", str_spec);
 739                 p = number(p, pend, res->flags, flag_spec);
 740         }
 741         *p++ = ']';
 742         *p = '\0';
 743
 744         return string(buf, end, sym, spec);
 745 }
 746
 747 static noinline_for_stack
 748 char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
 749                  const char *fmt)
 750 {
 751         int i, len = 1;         /* if we pass '%ph[CDN]', field width remains
 752                                    negative value, fallback to the default */
 753         char separator;
 754
 755         if (spec.field_width == 0)
 756                 /* nothing to print */
 757                 return buf;
 758
 759         if (ZERO_OR_NULL_PTR(addr))
 760                 /* NULL pointer */
 761                 return string(buf, end, NULL, spec);
 762
 763         switch (fmt[1]) {
 764         case 'C':
 765                 separator = ':';
 766                 break;
 767         case 'D':
 768                 separator = '-';
 769                 break;
 770         case 'N':
 771                 separator = 0;
 772                 break;
 773         default:
 774                 separator = ' ';
 775                 break;
 776         }
 777
 778         if (spec.field_width > 0)
 779                 len = min_t(int, spec.field_width, 64);
 780
 781         for (i = 0; i < len && buf < end - 1; i++) {
 782                 buf = hex_byte_pack(buf, addr[i]);
 783
 784                 if (buf < end && separator && i != len - 1)
 785                         *buf++ = separator;
 786         }
 787
 788         return buf;
 789 }
 790
 791 static noinline_for_stack
 792 char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
 793                     struct printf_spec spec, const char *fmt)
 794 {
 795         const int CHUNKSZ = 32;
 796         int nr_bits = max_t(int, spec.field_width, 0);
 797         int i, chunksz;
 798         bool first = true;
 799
 800         /* reused to print numbers */
 801         spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
 802
 803         chunksz = nr_bits & (CHUNKSZ - 1);
 804         if (chunksz == 0)
 805                 chunksz = CHUNKSZ;
 806
 807         i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
 808         for (; i >= 0; i -= CHUNKSZ) {
 809                 u32 chunkmask, val;
 810                 int word, bit;
 811
 812                 chunkmask = ((1ULL << chunksz) - 1);
 813                 word = i / BITS_PER_LONG;
 814                 bit = i % BITS_PER_LONG;
 815                 val = (bitmap[word] >> bit) & chunkmask;
 816
 817                 if (!first) {
 818                         if (buf < end)
 819                                 *buf = ',';
 820                         buf++;
 821                 }
 822                 first = false;
 823
 824                 spec.field_width = DIV_ROUND_UP(chunksz, 4);
 825                 buf = number(buf, end, val, spec);
 826
 827                 chunksz = CHUNKSZ;
 828         }
 829         return buf;
 830 }
 831
 832 static noinline_for_stack
 833 char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
 834                          struct printf_spec spec, const char *fmt)
 835 {
 836         int nr_bits = max_t(int, spec.field_width, 0);
 837         /* current bit is 'cur', most recently seen range is [rbot, rtop] */
 838         int cur, rbot, rtop;
 839         bool first = true;
 840
 841         /* reused to print numbers */
 842         spec = (struct printf_spec){ .base = 10 };
 843
 844         rbot = cur = find_first_bit(bitmap, nr_bits);
 845         while (cur < nr_bits) {
 846                 rtop = cur;
 847                 cur = find_next_bit(bitmap, nr_bits, cur + 1);
 848                 if (cur < nr_bits && cur <= rtop + 1)
 849                         continue;
 850
 851                 if (!first) {
 852                         if (buf < end)
 853                                 *buf = ',';
 854                         buf++;
 855                 }
 856                 first = false;
 857
 858                 buf = number(buf, end, rbot, spec);
 859                 if (rbot < rtop) {
 860                         if (buf < end)
 861                                 *buf = '-';
 862                         buf++;
 863
 864                         buf = number(buf, end, rtop, spec);
 865                 }
 866
 867                 rbot = cur;
 868         }
 869         return buf;
 870 }
 871
 872 static noinline_for_stack
 873 char *mac_address_string(char *buf, char *end, u8 *addr,
 874                          struct printf_spec spec, const char *fmt)
 875 {
 876         char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
 877         char *p = mac_addr;
 878         int i;
 879         char separator;
 880         bool reversed = false;
 881
 882         switch (fmt[1]) {
 883         case 'F':
 884                 separator = '-';
 885                 break;
 886
 887         case 'R':
 888                 reversed = true;
 889                 /* fall through */
 890
 891         default:
 892                 separator = ':';
 893                 break;
 894         }
 895
 896         for (i = 0; i < 6; i++) {
 897                 if (reversed)
 898                         p = hex_byte_pack(p, addr[5 - i]);
 899                 else
 900                         p = hex_byte_pack(p, addr[i]);
 901
 902                 if (fmt[0] == 'M' && i != 5)
 903                         *p++ = separator;
 904         }
 905         *p = '\0';
 906
 907         return string(buf, end, mac_addr, spec);
 908 }
 909
 910 static noinline_for_stack
 911 char *ip4_string(char *p, const u8 *addr, const char *fmt)
 912 {
 913         int i;
 914         bool leading_zeros = (fmt[0] == 'i');
 915         int index;
 916         int step;
 917
 918         switch (fmt[2]) {
 919         case 'h':
 920 #ifdef __BIG_ENDIAN
 921                 index = 0;
 922                 step = 1;
 923 #else
 924                 index = 3;
 925                 step = -1;
 926 #endif
 927                 break;
 928         case 'l':
 929                 index = 3;
 930                 step = -1;
 931                 break;
 932         case 'n':
 933         case 'b':
 934         default:
 935                 index = 0;
 936                 step = 1;
 937                 break;
 938         }
 939         for (i = 0; i < 4; i++) {
 940                 char temp[3];   /* hold each IP quad in reverse order */
 941                 int digits = put_dec_trunc8(temp, addr[index]) - temp;
 942                 if (leading_zeros) {
 943                         if (digits < 3)
 944                                 *p++ = '0';
 945                         if (digits < 2)
 946                                 *p++ = '0';
 947                 }
 948                 /* reverse the digits in the quad */
 949                 while (digits--)
 950                         *p++ = temp[digits];
 951                 if (i < 3)
 952                         *p++ = '.';
 953                 index += step;
 954         }
 955         *p = '\0';
 956
 957         return p;
 958 }
 959
 960 static noinline_for_stack
 961 char *ip6_compressed_string(char *p, const char *addr)
 962 {
 963         int i, j, range;
 964         unsigned char zerolength[8];
 965         int longest = 1;
 966         int colonpos = -1;
 967         u16 word;
 968         u8 hi, lo;
 969         bool needcolon = false;
 970         bool useIPv4;
 971         struct in6_addr in6;
 972
 973         memcpy(&in6, addr, sizeof(struct in6_addr));
 974
 975         useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
 976
 977         memset(zerolength, 0, sizeof(zerolength));
 978
 979         if (useIPv4)
 980                 range = 6;
 981         else
 982                 range = 8;
 983
 984         /* find position of longest 0 run */
 985         for (i = 0; i < range; i++) {
 986                 for (j = i; j < range; j++) {
 987                         if (in6.s6_addr16[j] != 0)
 988                                 break;
 989                         zerolength[i]++;
 990                 }
 991         }
 992         for (i = 0; i < range; i++) {
 993                 if (zerolength[i] > longest) {
 994                         longest = zerolength[i];
 995                         colonpos = i;
 996                 }
 997         }
 998         if (longest == 1)               /* don't compress a single 0 */
 999                 colonpos = -1;
1000
1001         /* emit address */
1002         for (i = 0; i < range; i++) {
1003                 if (i == colonpos) {
1004                         if (needcolon || i == 0)
1005                                 *p++ = ':';
1006                         *p++ = ':';
1007                         needcolon = false;
1008                         i += longest - 1;
1009                         continue;
1010                 }
1011                 if (needcolon) {
1012                         *p++ = ':';
1013                         needcolon = false;
1014                 }
1015                 /* hex u16 without leading 0s */
1016                 word = ntohs(in6.s6_addr16[i]);
1017                 hi = word >> 8;
1018                 lo = word & 0xff;
1019                 if (hi) {
1020                         if (hi > 0x0f)
1021                                 p = hex_byte_pack(p, hi);
1022                         else
1023                                 *p++ = hex_asc_lo(hi);
1024                         p = hex_byte_pack(p, lo);
1025                 }
1026                 else if (lo > 0x0f)
1027                         p = hex_byte_pack(p, lo);
1028                 else
1029                         *p++ = hex_asc_lo(lo);
1030                 needcolon = true;
1031         }
1032
1033         if (useIPv4) {
1034                 if (needcolon)
1035                         *p++ = ':';
1036                 p = ip4_string(p, &in6.s6_addr[12], "I4");
1037         }
1038         *p = '\0';
1039
1040         return p;
1041 }
1042
1043 static noinline_for_stack
1044 char *ip6_string(char *p, const char *addr, const char *fmt)
1045 {
1046         int i;
1047
1048         for (i = 0; i < 8; i++) {
1049                 p = hex_byte_pack(p, *addr++);
1050                 p = hex_byte_pack(p, *addr++);
1051                 if (fmt[0] == 'I' && i != 7)
1052                         *p++ = ':';
1053         }
1054         *p = '\0';
1055
1056         return p;
1057 }
1058
1059 static noinline_for_stack
1060 char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1061                       struct printf_spec spec, const char *fmt)
1062 {
1063         char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1064
1065         if (fmt[0] == 'I' && fmt[2] == 'c')
1066                 ip6_compressed_string(ip6_addr, addr);
1067         else
1068                 ip6_string(ip6_addr, addr, fmt);
1069
1070         return string(buf, end, ip6_addr, spec);
1071 }
1072
1073 static noinline_for_stack
1074 char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1075                       struct printf_spec spec, const char *fmt)
1076 {
1077         char ip4_addr[sizeof("255.255.255.255")];
1078
1079         ip4_string(ip4_addr, addr, fmt);
1080
1081         return string(buf, end, ip4_addr, spec);
1082 }
1083
1084 static noinline_for_stack
1085 char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1086                          struct printf_spec spec, const char *fmt)
1087 {
1088         bool have_p = false, have_s = false, have_f = false, have_c = false;
1089         char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1090                       sizeof(":12345") + sizeof("/123456789") +
1091                       sizeof("%1234567890")];
1092         char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1093         const u8 *addr = (const u8 *) &sa->sin6_addr;
1094         char fmt6[2] = { fmt[0], '6' };
1095         u8 off = 0;
1096
1097         fmt++;
1098         while (isalpha(*++fmt)) {
1099                 switch (*fmt) {
1100                 case 'p':
1101                         have_p = true;
1102                         break;
1103                 case 'f':
1104                         have_f = true;
1105                         break;
1106                 case 's':
1107                         have_s = true;
1108                         break;
1109                 case 'c':
1110                         have_c = true;
1111                         break;
1112                 }
1113         }
1114
1115         if (have_p || have_s || have_f) {
1116                 *p = '[';
1117                 off = 1;
1118         }
1119
1120         if (fmt6[0] == 'I' && have_c)
1121                 p = ip6_compressed_string(ip6_addr + off, addr);
1122         else
1123                 p = ip6_string(ip6_addr + off, addr, fmt6);
1124
1125         if (have_p || have_s || have_f)
1126                 *p++ = ']';
1127
1128         if (have_p) {
1129                 *p++ = ':';
1130                 p = number(p, pend, ntohs(sa->sin6_port), spec);
1131         }
1132         if (have_f) {
1133                 *p++ = '/';
1134                 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1135                                           IPV6_FLOWINFO_MASK), spec);
1136         }
1137         if (have_s) {
1138                 *p++ = '%';
1139                 p = number(p, pend, sa->sin6_scope_id, spec);
1140         }
1141         *p = '\0';
1142
1143         return string(buf, end, ip6_addr, spec);
1144 }
1145
1146 static noinline_for_stack
1147 char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1148                          struct printf_spec spec, const char *fmt)
1149 {
1150         bool have_p = false;
1151         char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1152         char *pend = ip4_addr + sizeof(ip4_addr);
1153         const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1154         char fmt4[3] = { fmt[0], '4', 0 };
1155
1156         fmt++;
1157         while (isalpha(*++fmt)) {
1158                 switch (*fmt) {
1159                 case 'p':
1160                         have_p = true;
1161                         break;
1162                 case 'h':
1163                 case 'l':
1164                 case 'n':
1165                 case 'b':
1166                         fmt4[2] = *fmt;
1167                         break;
1168                 }
1169         }
1170
1171         p = ip4_string(ip4_addr, addr, fmt4);
1172         if (have_p) {
1173                 *p++ = ':';
1174                 p = number(p, pend, ntohs(sa->sin_port), spec);
1175         }
1176         *p = '\0';
1177
1178         return string(buf, end, ip4_addr, spec);
1179 }
1180
1181 static noinline_for_stack
1182 char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1183                      const char *fmt)
1184 {
1185         bool found = true;
1186         int count = 1;
1187         unsigned int flags = 0;
1188         int len;
1189
1190         if (spec.field_width == 0)
1191                 return buf;                             /* nothing to print */
1192
1193         if (ZERO_OR_NULL_PTR(addr))
1194                 return string(buf, end, NULL, spec);    /* NULL pointer */
1195
1196
1197         do {
1198                 switch (fmt[count++]) {
1199                 case 'a':
1200                         flags |= ESCAPE_ANY;
1201                         break;
1202                 case 'c':
1203                         flags |= ESCAPE_SPECIAL;
1204                         break;
1205                 case 'h':
1206                         flags |= ESCAPE_HEX;
1207                         break;
1208                 case 'n':
1209                         flags |= ESCAPE_NULL;
1210                         break;
1211                 case 'o':
1212                         flags |= ESCAPE_OCTAL;
1213                         break;
1214                 case 'p':
1215                         flags |= ESCAPE_NP;
1216                         break;
1217                 case 's':
1218                         flags |= ESCAPE_SPACE;
1219                         break;
1220                 default:
1221                         found = false;
1222                         break;
1223                 }
1224         } while (found);
1225
1226         if (!flags)
1227                 flags = ESCAPE_ANY_NP;
1228
1229         len = spec.field_width < 0 ? 1 : spec.field_width;
1230
1231         /* Ignore the error. We print as many characters as we can */
1232         string_escape_mem(addr, len, &buf, end - buf, flags, NULL);
1233
1234         return buf;
1235 }
1236
1237 static noinline_for_stack
1238 char *uuid_string(char *buf, char *end, const u8 *addr,
1239                   struct printf_spec spec, const char *fmt)
1240 {
1241         char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1242         char *p = uuid;
1243         int i;
1244         static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1245         static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1246         const u8 *index = be;
1247         bool uc = false;
1248
1249         switch (*(++fmt)) {
1250         case 'L':
1251                 uc = true;              /* fall-through */
1252         case 'l':
1253                 index = le;
1254                 break;
1255         case 'B':
1256                 uc = true;
1257                 break;
1258         }
1259
1260         for (i = 0; i < 16; i++) {
1261                 p = hex_byte_pack(p, addr[index[i]]);
1262                 switch (i) {
1263                 case 3:
1264                 case 5:
1265                 case 7:
1266                 case 9:
1267                         *p++ = '-';
1268                         break;
1269                 }
1270         }
1271
1272         *p = 0;
1273
1274         if (uc) {
1275                 p = uuid;
1276                 do {
1277                         *p = toupper(*p);
1278                 } while (*(++p));
1279         }
1280
1281         return string(buf, end, uuid, spec);
1282 }
1283
1284 static
1285 char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1286                       struct printf_spec spec)
1287 {
1288         spec.flags |= SPECIAL | SMALL | ZEROPAD;
1289         if (spec.field_width == -1)
1290                 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1291         spec.base = 16;
1292
1293         return number(buf, end, *(const netdev_features_t *)addr, spec);
1294 }
1295
1296 static noinline_for_stack
1297 char *address_val(char *buf, char *end, const void *addr,
1298                   struct printf_spec spec, const char *fmt)
1299 {
1300         unsigned long long num;
1301
1302         spec.flags |= SPECIAL | SMALL | ZEROPAD;
1303         spec.base = 16;
1304
1305         switch (fmt[1]) {
1306         case 'd':
1307                 num = *(const dma_addr_t *)addr;
1308                 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1309                 break;
1310         case 'p':
1311         default:
1312                 num = *(const phys_addr_t *)addr;
1313                 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1314                 break;
1315         }
1316
1317         return number(buf, end, num, spec);
1318 }
1319
1320 int kptr_restrict __read_mostly;
1321
1322 /*
1323  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
1324  * by an extra set of alphanumeric characters that are extended format
1325  * specifiers.
1326  *
1327  * Right now we handle:
1328  *
1329  * - 'F' For symbolic function descriptor pointers with offset
1330  * - 'f' For simple symbolic function names without offset
1331  * - 'S' For symbolic direct pointers with offset
1332  * - 's' For symbolic direct pointers without offset
1333  * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
1334  * - 'B' For backtraced symbolic direct pointers with offset
1335  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1336  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
1337  * - 'b[l]' For a bitmap, the number of bits is determined by the field
1338  *       width which must be explicitly specified either as part of the
1339  *       format string '%32b[l]' or through '%*b[l]', [l] selects
1340  *       range-list format instead of hex format
1341  * - 'M' For a 6-byte MAC address, it prints the address in the
1342  *       usual colon-separated hex notation
1343  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
1344  * - 'MF' For a 6-byte MAC FDDI address, it prints the address
1345  *       with a dash-separated hex notation
1346  * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
1347  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1348  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1349  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
1350  *       [S][pfs]
1351  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1352  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1353  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1354  *       IPv6 omits the colons (01020304...0f)
1355  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
1356  *       [S][pfs]
1357  *       Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1358  *       [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1359  * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1360  * - 'I[6S]c' for IPv6 addresses printed as specified by
1361  *       http://tools.ietf.org/html/rfc5952
1362  * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1363  *                of the following flags (see string_escape_mem() for the
1364  *                details):
1365  *                  a - ESCAPE_ANY
1366  *                  c - ESCAPE_SPECIAL
1367  *                  h - ESCAPE_HEX
1368  *                  n - ESCAPE_NULL
1369  *                  o - ESCAPE_OCTAL
1370  *                  p - ESCAPE_NP
1371  *                  s - ESCAPE_SPACE
1372  *                By default ESCAPE_ANY_NP is used.
1373  * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1374  *       "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1375  *       Options for %pU are:
1376  *         b big endian lower case hex (default)
1377  *         B big endian UPPER case hex
1378  *         l little endian lower case hex
1379  *         L little endian UPPER case hex
1380  *           big endian output byte order is:
1381  *             [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1382  *           little endian output byte order is:
1383  *             [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
1384  * - 'V' For a struct va_format which contains a format string * and va_list *,
1385  *       call vsnprintf(->format, *->va_list).
1386  *       Implements a "recursive vsnprintf".
1387  *       Do not use this feature without some mechanism to verify the
1388  *       correctness of the format string and va_list arguments.
1389  * - 'K' For a kernel pointer that should be hidden from unprivileged users
1390  * - 'NF' For a netdev_features_t
1391  * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1392  *            a certain separator (' ' by default):
1393  *              C colon
1394  *              D dash
1395  *              N no separator
1396  *            The maximum supported length is 64 bytes of the input. Consider
1397  *            to use print_hex_dump() for the larger input.
1398  * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1399  *           (default assumed to be phys_addr_t, passed by reference)
1400  * - 'd[234]' For a dentry name (optionally 2-4 last components)
1401  * - 'D[234]' Same as 'd' but for a struct file
1402  *
1403  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1404  * function pointers are really function descriptors, which contain a
1405  * pointer to the real address.
1406  */
1407 static noinline_for_stack
1408 char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1409               struct printf_spec spec)
1410 {
1411         int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1412
1413         if (!ptr && *fmt != 'K') {
1414                 /*
1415                  * Print (null) with the same width as a pointer so it makes
1416                  * tabular output look nice.
1417                  */
1418                 if (spec.field_width == -1)
1419                         spec.field_width = default_width;
1420                 return string(buf, end, "(null)", spec);
1421         }
1422
1423         switch (*fmt) {
1424         case 'F':
1425         case 'f':
1426                 ptr = dereference_function_descriptor(ptr);
1427                 /* Fallthrough */
1428         case 'S':
1429         case 's':
1430         case 'B':
1431                 return symbol_string(buf, end, ptr, spec, fmt);
1432         case 'R':
1433         case 'r':
1434                 return resource_string(buf, end, ptr, spec, fmt);
1435         case 'h':
1436                 return hex_string(buf, end, ptr, spec, fmt);
1437         case 'b':
1438                 switch (fmt[1]) {
1439                 case 'l':
1440                         return bitmap_list_string(buf, end, ptr, spec, fmt);
1441                 default:
1442                         return bitmap_string(buf, end, ptr, spec, fmt);
1443                 }
1444         case 'M':                       /* Colon separated: 00:01:02:03:04:05 */
1445         case 'm':                       /* Contiguous: 000102030405 */
1446                                         /* [mM]F (FDDI) */
1447                                         /* [mM]R (Reverse order; Bluetooth) */
1448                 return mac_address_string(buf, end, ptr, spec, fmt);
1449         case 'I':                       /* Formatted IP supported
1450                                          * 4:   1.2.3.4
1451                                          * 6:   0001:0203:...:0708
1452                                          * 6c:  1::708 or 1::1.2.3.4
1453                                          */
1454         case 'i':                       /* Contiguous:
1455                                          * 4:   001.002.003.004
1456                                          * 6:   000102...0f
1457                                          */
1458                 switch (fmt[1]) {
1459                 case '6':
1460                         return ip6_addr_string(buf, end, ptr, spec, fmt);
1461                 case '4':
1462                         return ip4_addr_string(buf, end, ptr, spec, fmt);
1463                 case 'S': {
1464                         const union {
1465                                 struct sockaddr         raw;
1466                                 struct sockaddr_in      v4;
1467                                 struct sockaddr_in6     v6;
1468                         } *sa = ptr;
1469
1470                         switch (sa->raw.sa_family) {
1471                         case AF_INET:
1472                                 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1473                         case AF_INET6:
1474                                 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1475                         default:
1476                                 return string(buf, end, "(invalid address)", spec);
1477                         }}
1478                 }
1479                 break;
1480         case 'E':
1481                 return escaped_string(buf, end, ptr, spec, fmt);
1482         case 'U':
1483                 return uuid_string(buf, end, ptr, spec, fmt);
1484         case 'V':
1485                 {
1486                         va_list va;
1487
1488                         va_copy(va, *((struct va_format *)ptr)->va);
1489                         buf += vsnprintf(buf, end > buf ? end - buf : 0,
1490                                          ((struct va_format *)ptr)->fmt, va);
1491                         va_end(va);
1492                         return buf;
1493                 }
1494         case 'K':
1495                 /*
1496                  * %pK cannot be used in IRQ context because its test
1497                  * for CAP_SYSLOG would be meaningless.
1498                  */
1499                 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1500                                       in_nmi())) {
1501                         if (spec.field_width == -1)
1502                                 spec.field_width = default_width;
1503                         return string(buf, end, "pK-error", spec);
1504                 }
1505
1506                 switch (kptr_restrict) {
1507                 case 0:
1508                         /* Always print %pK values */
1509                         break;
1510                 case 1: {
1511                         /*
1512                          * Only print the real pointer value if the current
1513                          * process has CAP_SYSLOG and is running with the
1514                          * same credentials it started with. This is because
1515                          * access to files is checked at open() time, but %pK
1516                          * checks permission at read() time. We don't want to
1517                          * leak pointer values if a binary opens a file using
1518                          * %pK and then elevates privileges before reading it.
1519                          */
1520                         const struct cred *cred = current_cred();
1521
1522                         if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1523                             !uid_eq(cred->euid, cred->uid) ||
1524                             !gid_eq(cred->egid, cred->gid))
1525                                 ptr = NULL;
1526                         break;
1527                 }
1528                 case 2:
1529                 default:
1530                         /* Always print 0's for %pK */
1531                         ptr = NULL;
1532                         break;
1533                 }
1534                 break;
1535
1536         case 'N':
1537                 switch (fmt[1]) {
1538                 case 'F':
1539                         return netdev_feature_string(buf, end, ptr, spec);
1540                 }
1541                 break;
1542         case 'a':
1543                 return address_val(buf, end, ptr, spec, fmt);
1544         case 'd':
1545                 return dentry_name(buf, end, ptr, spec, fmt);
1546         case 'D':
1547                 return dentry_name(buf, end,
1548                                    ((const struct file *)ptr)->f_path.dentry,
1549                                    spec, fmt);
1550         }
1551         spec.flags |= SMALL;
1552         if (spec.field_width == -1) {
1553                 spec.field_width = default_width;
1554                 spec.flags |= ZEROPAD;
1555         }
1556         spec.base = 16;
1557
1558         return number(buf, end, (unsigned long) ptr, spec);
1559 }
1560
1561 /*
1562  * Helper function to decode printf style format.
1563  * Each call decode a token from the format and return the
1564  * number of characters read (or likely the delta where it wants
1565  * to go on the next call).
1566  * The decoded token is returned through the parameters
1567  *
1568  * 'h', 'l', or 'L' for integer fields
1569  * 'z' support added 23/7/1999 S.H.
1570  * 'z' changed to 'Z' --davidm 1/25/99
1571  * 't' added for ptrdiff_t
1572  *
1573  * @fmt: the format string
1574  * @type of the token returned
1575  * @flags: various flags such as +, -, # tokens..
1576  * @field_width: overwritten width
1577  * @base: base of the number (octal, hex, ...)
1578  * @precision: precision of a number
1579  * @qualifier: qualifier of a number (long, size_t, ...)
1580  */
1581 static noinline_for_stack
1582 int format_decode(const char *fmt, struct printf_spec *spec)
1583 {
1584         const char *start = fmt;
1585
1586         /* we finished early by reading the field width */
1587         if (spec->type == FORMAT_TYPE_WIDTH) {
1588                 if (spec->field_width < 0) {
1589                         spec->field_width = -spec->field_width;
1590                         spec->flags |= LEFT;
1591                 }
1592                 spec->type = FORMAT_TYPE_NONE;
1593                 goto precision;
1594         }
1595
1596         /* we finished early by reading the precision */
1597         if (spec->type == FORMAT_TYPE_PRECISION) {
1598                 if (spec->precision < 0)
1599                         spec->precision = 0;
1600
1601                 spec->type = FORMAT_TYPE_NONE;
1602                 goto qualifier;
1603         }
1604
1605         /* By default */
1606         spec->type = FORMAT_TYPE_NONE;
1607
1608         for (; *fmt ; ++fmt) {
1609                 if (*fmt == '%')
1610                         break;
1611         }
1612
1613         /* Return the current non-format string */
1614         if (fmt != start || !*fmt)
1615                 return fmt - start;
1616
1617         /* Process flags */
1618         spec->flags = 0;
1619
1620         while (1) { /* this also skips first '%' */
1621                 bool found = true;
1622
1623                 ++fmt;
1624
1625                 switch (*fmt) {
1626                 case '-': spec->flags |= LEFT;    break;
1627                 case '+': spec->flags |= PLUS;    break;
1628                 case ' ': spec->flags |= SPACE;   break;
1629                 case '#': spec->flags |= SPECIAL; break;
1630                 case '0': spec->flags |= ZEROPAD; break;
1631                 default:  found = false;
1632                 }
1633
1634                 if (!found)
1635                         break;
1636         }
1637
1638         /* get field width */
1639         spec->field_width = -1;
1640
1641         if (isdigit(*fmt))
1642                 spec->field_width = skip_atoi(&fmt);
1643         else if (*fmt == '*') {
1644                 /* it's the next argument */
1645                 spec->type = FORMAT_TYPE_WIDTH;
1646                 return ++fmt - start;
1647         }
1648
1649 precision:
1650         /* get the precision */
1651         spec->precision = -1;
1652         if (*fmt == '.') {
1653                 ++fmt;
1654                 if (isdigit(*fmt)) {
1655                         spec->precision = skip_atoi(&fmt);
1656                         if (spec->precision < 0)
1657                                 spec->precision = 0;
1658                 } else if (*fmt == '*') {
1659                         /* it's the next argument */
1660                         spec->type = FORMAT_TYPE_PRECISION;
1661                         return ++fmt - start;
1662                 }
1663         }
1664
1665 qualifier:
1666         /* get the conversion qualifier */
1667         spec->qualifier = -1;
1668         if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1669             _tolower(*fmt) == 'z' || *fmt == 't') {
1670                 spec->qualifier = *fmt++;
1671                 if (unlikely(spec->qualifier == *fmt)) {
1672                         if (spec->qualifier == 'l') {
1673                                 spec->qualifier = 'L';
1674                                 ++fmt;
1675                         } else if (spec->qualifier == 'h') {
1676                                 spec->qualifier = 'H';
1677                                 ++fmt;
1678                         }
1679                 }
1680         }
1681
1682         /* default base */
1683         spec->base = 10;
1684         switch (*fmt) {
1685         case 'c':
1686                 spec->type = FORMAT_TYPE_CHAR;
1687                 return ++fmt - start;
1688
1689         case 's':
1690                 spec->type = FORMAT_TYPE_STR;
1691                 return ++fmt - start;
1692
1693         case 'p':
1694                 spec->type = FORMAT_TYPE_PTR;
1695                 return ++fmt - start;
1696
1697         case '%':
1698                 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1699                 return ++fmt - start;
1700
1701         /* integer number formats - set up the flags and "break" */
1702         case 'o':
1703                 spec->base = 8;
1704                 break;
1705
1706         case 'x':
1707                 spec->flags |= SMALL;
1708
1709         case 'X':
1710                 spec->base = 16;
1711                 break;
1712
1713         case 'd':
1714         case 'i':
1715                 spec->flags |= SIGN;
1716         case 'u':
1717                 break;
1718
1719         case 'n':
1720                 /*
1721                  * Since %n poses a greater security risk than utility, treat
1722                  * it as an invalid format specifier. Warn about its use so
1723                  * that new instances don't get added.
1724                  */
1725                 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1726                 /* Fall-through */
1727
1728         default:
1729                 spec->type = FORMAT_TYPE_INVALID;
1730                 return fmt - start;
1731         }
1732
1733         if (spec->qualifier == 'L')
1734                 spec->type = FORMAT_TYPE_LONG_LONG;
1735         else if (spec->qualifier == 'l') {
1736                 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1737                 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
1738         } else if (_tolower(spec->qualifier) == 'z') {
1739                 spec->type = FORMAT_TYPE_SIZE_T;
1740         } else if (spec->qualifier == 't') {
1741                 spec->type = FORMAT_TYPE_PTRDIFF;
1742         } else if (spec->qualifier == 'H') {
1743                 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1744                 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
1745         } else if (spec->qualifier == 'h') {
1746                 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1747                 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
1748         } else {
1749                 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1750                 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
1751         }
1752
1753         return ++fmt - start;
1754 }
1755
1756 /**
1757  * vsnprintf - Format a string and place it in a buffer
1758  * @buf: The buffer to place the result into
1759  * @size: The size of the buffer, including the trailing null space
1760  * @fmt: The format string to use
1761  * @args: Arguments for the format string
1762  *
1763  * This function follows C99 vsnprintf, but has some extensions:
1764  * %pS output the name of a text symbol with offset
1765  * %ps output the name of a text symbol without offset
1766  * %pF output the name of a function pointer with its offset
1767  * %pf output the name of a function pointer without its offset
1768  * %pB output the name of a backtrace symbol with its offset
1769  * %pR output the address range in a struct resource with decoded flags
1770  * %pr output the address range in a struct resource with raw flags
1771  * %pb output the bitmap with field width as the number of bits
1772  * %pbl output the bitmap as range list with field width as the number of bits
1773  * %pM output a 6-byte MAC address with colons
1774  * %pMR output a 6-byte MAC address with colons in reversed order
1775  * %pMF output a 6-byte MAC address with dashes
1776  * %pm output a 6-byte MAC address without colons
1777  * %pmR output a 6-byte MAC address without colons in reversed order
1778  * %pI4 print an IPv4 address without leading zeros
1779  * %pi4 print an IPv4 address with leading zeros
1780  * %pI6 print an IPv6 address with colons
1781  * %pi6 print an IPv6 address without colons
1782  * %pI6c print an IPv6 address as specified by RFC 5952
1783  * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1784  * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1785  * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1786  *   case.
1787  * %*pE[achnops] print an escaped buffer
1788  * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1789  *           bytes of the input)
1790  * %n is ignored
1791  *
1792  * ** Please update Documentation/printk-formats.txt when making changes **
1793  *
1794  * The return value is the number of characters which would
1795  * be generated for the given input, excluding the trailing
1796  * '\0', as per ISO C99. If you want to have the exact
1797  * number of characters written into @buf as return value
1798  * (not including the trailing '\0'), use vscnprintf(). If the
1799  * return is greater than or equal to @size, the resulting
1800  * string is truncated.
1801  *
1802  * If you're not already dealing with a va_list consider using snprintf().
1803  */
1804 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1805 {
1806         unsigned long long num;
1807         char *str, *end;
1808         struct printf_spec spec = {0};
1809
1810         /* Reject out-of-range values early.  Large positive sizes are
1811            used for unknown buffer sizes. */
1812         if (WARN_ON_ONCE(size > INT_MAX))
1813                 return 0;
1814
1815         str = buf;
1816         end = buf + size;
1817
1818         /* Make sure end is always >= buf */
1819         if (end < buf) {
1820                 end = ((void *)-1);
1821                 size = end - buf;
1822         }
1823
1824         while (*fmt) {
1825                 const char *old_fmt = fmt;
1826                 int read = format_decode(fmt, &spec);
1827
1828                 fmt += read;
1829
1830                 switch (spec.type) {
1831                 case FORMAT_TYPE_NONE: {
1832                         int copy = read;
1833                         if (str < end) {
1834                                 if (copy > end - str)
1835                                         copy = end - str;
1836                                 memcpy(str, old_fmt, copy);
1837                         }
1838                         str += read;
1839                         break;
1840                 }
1841
1842                 case FORMAT_TYPE_WIDTH:
1843                         spec.field_width = va_arg(args, int);
1844                         break;
1845
1846                 case FORMAT_TYPE_PRECISION:
1847                         spec.precision = va_arg(args, int);
1848                         break;
1849
1850                 case FORMAT_TYPE_CHAR: {
1851                         char c;
1852
1853                         if (!(spec.flags & LEFT)) {
1854                                 while (--spec.field_width > 0) {
1855                                         if (str < end)
1856                                                 *str = ' ';
1857                                         ++str;
1858
1859                                 }
1860                         }
1861                         c = (unsigned char) va_arg(args, int);
1862                         if (str < end)
1863                                 *str = c;
1864                         ++str;
1865                         while (--spec.field_width > 0) {
1866                                 if (str < end)
1867                                         *str = ' ';
1868                                 ++str;
1869                         }
1870                         break;
1871                 }
1872
1873                 case FORMAT_TYPE_STR:
1874                         str = string(str, end, va_arg(args, char *), spec);
1875                         break;
1876
1877                 case FORMAT_TYPE_PTR:
1878                         str = pointer(fmt, str, end, va_arg(args, void *),
1879                                       spec);
1880                         while (isalnum(*fmt))
1881                                 fmt++;
1882                         break;
1883
1884                 case FORMAT_TYPE_PERCENT_CHAR:
1885                         if (str < end)
1886                                 *str = '%';
1887                         ++str;
1888                         break;
1889
1890                 case FORMAT_TYPE_INVALID:
1891                         if (str < end)
1892                                 *str = '%';
1893                         ++str;
1894                         break;
1895
1896                 default:
1897                         switch (spec.type) {
1898                         case FORMAT_TYPE_LONG_LONG:
1899                                 num = va_arg(args, long long);
1900                                 break;
1901                         case FORMAT_TYPE_ULONG:
1902                                 num = va_arg(args, unsigned long);
1903                                 break;
1904                         case FORMAT_TYPE_LONG:
1905                                 num = va_arg(args, long);
1906                                 break;
1907                         case FORMAT_TYPE_SIZE_T:
1908                                 if (spec.flags & SIGN)
1909                                         num = va_arg(args, ssize_t);
1910                                 else
1911                                         num = va_arg(args, size_t);
1912                                 break;
1913                         case FORMAT_TYPE_PTRDIFF:
1914                                 num = va_arg(args, ptrdiff_t);
1915                                 break;
1916                         case FORMAT_TYPE_UBYTE:
1917                                 num = (unsigned char) va_arg(args, int);
1918                                 break;
1919                         case FORMAT_TYPE_BYTE:
1920                                 num = (signed char) va_arg(args, int);
1921                                 break;
1922                         case FORMAT_TYPE_USHORT:
1923                                 num = (unsigned short) va_arg(args, int);
1924                                 break;
1925                         case FORMAT_TYPE_SHORT:
1926                                 num = (short) va_arg(args, int);
1927                                 break;
1928                         case FORMAT_TYPE_INT:
1929                                 num = (int) va_arg(args, int);
1930                                 break;
1931                         default:
1932                                 num = va_arg(args, unsigned int);
1933                         }
1934
1935                         str = number(str, end, num, spec);
1936                 }
1937         }
1938
1939         if (size > 0) {
1940                 if (str < end)
1941                         *str = '\0';
1942                 else
1943                         end[-1] = '\0';
1944         }
1945
1946         /* the trailing null byte doesn't count towards the total */
1947         return str-buf;
1948
1949 }
1950 EXPORT_SYMBOL(vsnprintf);
1951
1952 /**
1953  * vscnprintf - Format a string and place it in a buffer
1954  * @buf: The buffer to place the result into
1955  * @size: The size of the buffer, including the trailing null space
1956  * @fmt: The format string to use
1957  * @args: Arguments for the format string
1958  *
1959  * The return value is the number of characters which have been written into
1960  * the @buf not including the trailing '\0'. If @size is == 0 the function
1961  * returns 0.
1962  *
1963  * If you're not already dealing with a va_list consider using scnprintf().
1964  *
1965  * See the vsnprintf() documentation for format string extensions over C99.
1966  */
1967 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1968 {
1969         int i;
1970
1971         i = vsnprintf(buf, size, fmt, args);
1972
1973         if (likely(i < size))
1974                 return i;
1975         if (size != 0)
1976                 return size - 1;
1977         return 0;
1978 }
1979 EXPORT_SYMBOL(vscnprintf);
1980
1981 /**
1982  * snprintf - Format a string and place it in a buffer
1983  * @buf: The buffer to place the result into
1984  * @size: The size of the buffer, including the trailing null space
1985  * @fmt: The format string to use
1986  * @...: Arguments for the format string
1987  *
1988  * The return value is the number of characters which would be
1989  * generated for the given input, excluding the trailing null,
1990  * as per ISO C99.  If the return is greater than or equal to
1991  * @size, the resulting string is truncated.
1992  *
1993  * See the vsnprintf() documentation for format string extensions over C99.
1994  */
1995 int snprintf(char *buf, size_t size, const char *fmt, ...)
1996 {
1997         va_list args;
1998         int i;
1999
2000         va_start(args, fmt);
2001         i = vsnprintf(buf, size, fmt, args);
2002         va_end(args);
2003
2004         return i;
2005 }
2006 EXPORT_SYMBOL(snprintf);
2007
2008 /**
2009  * scnprintf - Format a string and place it in a buffer
2010  * @buf: The buffer to place the result into
2011  * @size: The size of the buffer, including the trailing null space
2012  * @fmt: The format string to use
2013  * @...: Arguments for the format string
2014  *
2015  * The return value is the number of characters written into @buf not including
2016  * the trailing '\0'. If @size is == 0 the function returns 0.
2017  */
2018
2019 int scnprintf(char *buf, size_t size, const char *fmt, ...)
2020 {
2021         va_list args;
2022         int i;
2023
2024         va_start(args, fmt);
2025         i = vscnprintf(buf, size, fmt, args);
2026         va_end(args);
2027
2028         return i;
2029 }
2030 EXPORT_SYMBOL(scnprintf);
2031
2032 /**
2033  * vsprintf - Format a string and place it in a buffer
2034  * @buf: The buffer to place the result into
2035  * @fmt: The format string to use
2036  * @args: Arguments for the format string
2037  *
2038  * The function returns the number of characters written
2039  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
2040  * buffer overflows.
2041  *
2042  * If you're not already dealing with a va_list consider using sprintf().
2043  *
2044  * See the vsnprintf() documentation for format string extensions over C99.
2045  */
2046 int vsprintf(char *buf, const char *fmt, va_list args)
2047 {
2048         return vsnprintf(buf, INT_MAX, fmt, args);
2049 }
2050 EXPORT_SYMBOL(vsprintf);
2051
2052 /**
2053  * sprintf - Format a string and place it in a buffer
2054  * @buf: The buffer to place the result into
2055  * @fmt: The format string to use
2056  * @...: Arguments for the format string
2057  *
2058  * The function returns the number of characters written
2059  * into @buf. Use snprintf() or scnprintf() in order to avoid
2060  * buffer overflows.
2061  *
2062  * See the vsnprintf() documentation for format string extensions over C99.
2063  */
2064 int sprintf(char *buf, const char *fmt, ...)
2065 {
2066         va_list args;
2067         int i;
2068
2069         va_start(args, fmt);
2070         i = vsnprintf(buf, INT_MAX, fmt, args);
2071         va_end(args);
2072
2073         return i;
2074 }
2075 EXPORT_SYMBOL(sprintf);
2076
2077 #ifdef CONFIG_BINARY_PRINTF
2078 /*
2079  * bprintf service:
2080  * vbin_printf() - VA arguments to binary data
2081  * bstr_printf() - Binary data to text string
2082  */
2083
2084 /**
2085  * vbin_printf - Parse a format string and place args' binary value in a buffer
2086  * @bin_buf: The buffer to place args' binary value
2087  * @size: The size of the buffer(by words(32bits), not characters)
2088  * @fmt: The format string to use
2089  * @args: Arguments for the format string
2090  *
2091  * The format follows C99 vsnprintf, except %n is ignored, and its argument
2092  * is skipped.
2093  *
2094  * The return value is the number of words(32bits) which would be generated for
2095  * the given input.
2096  *
2097  * NOTE:
2098  * If the return value is greater than @size, the resulting bin_buf is NOT
2099  * valid for bstr_printf().
2100  */
2101 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2102 {
2103         struct printf_spec spec = {0};
2104         char *str, *end;
2105
2106         str = (char *)bin_buf;
2107         end = (char *)(bin_buf + size);
2108
2109 #define save_arg(type)                                                  \
2110 do {                                                                    \
2111         if (sizeof(type) == 8) {                                        \
2112                 unsigned long long value;                               \
2113                 str = PTR_ALIGN(str, sizeof(u32));                      \
2114                 value = va_arg(args, unsigned long long);               \
2115                 if (str + sizeof(type) <= end) {                        \
2116                         *(u32 *)str = *(u32 *)&value;                   \
2117                         *(u32 *)(str + 4) = *((u32 *)&value + 1);       \
2118                 }                                                       \
2119         } else {                                                        \
2120                 unsigned long value;                                    \
2121                 str = PTR_ALIGN(str, sizeof(type));                     \
2122                 value = va_arg(args, int);                              \
2123                 if (str + sizeof(type) <= end)                          \
2124                         *(typeof(type) *)str = (type)value;             \
2125         }                                                               \
2126         str += sizeof(type);                                            \
2127 } while (0)
2128
2129         while (*fmt) {
2130                 int read = format_decode(fmt, &spec);
2131
2132                 fmt += read;
2133
2134                 switch (spec.type) {
2135                 case FORMAT_TYPE_NONE:
2136                 case FORMAT_TYPE_INVALID:
2137                 case FORMAT_TYPE_PERCENT_CHAR:
2138                         break;
2139
2140                 case FORMAT_TYPE_WIDTH:
2141                 case FORMAT_TYPE_PRECISION:
2142                         save_arg(int);
2143                         break;
2144
2145                 case FORMAT_TYPE_CHAR:
2146                         save_arg(char);
2147                         break;
2148
2149                 case FORMAT_TYPE_STR: {
2150                         const char *save_str = va_arg(args, char *);
2151                         size_t len;
2152
2153                         if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2154                                         || (unsigned long)save_str < PAGE_SIZE)
2155                                 save_str = "(null)";
2156                         len = strlen(save_str) + 1;
2157                         if (str + len < end)
2158                                 memcpy(str, save_str, len);
2159                         str += len;
2160                         break;
2161                 }
2162
2163                 case FORMAT_TYPE_PTR:
2164                         save_arg(void *);
2165                         /* skip all alphanumeric pointer suffixes */
2166                         while (isalnum(*fmt))
2167                                 fmt++;
2168                         break;
2169
2170                 default:
2171                         switch (spec.type) {
2172
2173                         case FORMAT_TYPE_LONG_LONG:
2174                                 save_arg(long long);
2175                                 break;
2176                         case FORMAT_TYPE_ULONG:
2177                         case FORMAT_TYPE_LONG:
2178                                 save_arg(unsigned long);
2179                                 break;
2180                         case FORMAT_TYPE_SIZE_T:
2181                                 save_arg(size_t);
2182                                 break;
2183                         case FORMAT_TYPE_PTRDIFF:
2184                                 save_arg(ptrdiff_t);
2185                                 break;
2186                         case FORMAT_TYPE_UBYTE:
2187                         case FORMAT_TYPE_BYTE:
2188                                 save_arg(char);
2189                                 break;
2190                         case FORMAT_TYPE_USHORT:
2191                         case FORMAT_TYPE_SHORT:
2192                                 save_arg(short);
2193                                 break;
2194                         default:
2195                                 save_arg(int);
2196                         }
2197                 }
2198         }
2199
2200         return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
2201 #undef save_arg
2202 }
2203 EXPORT_SYMBOL_GPL(vbin_printf);
2204
2205 /**
2206  * bstr_printf - Format a string from binary arguments and place it in a buffer
2207  * @buf: The buffer to place the result into
2208  * @size: The size of the buffer, including the trailing null space
2209  * @fmt: The format string to use
2210  * @bin_buf: Binary arguments for the format string
2211  *
2212  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2213  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2214  * a binary buffer that generated by vbin_printf.
2215  *
2216  * The format follows C99 vsnprintf, but has some extensions:
2217  *  see vsnprintf comment for details.
2218  *
2219  * The return value is the number of characters which would
2220  * be generated for the given input, excluding the trailing
2221  * '\0', as per ISO C99. If you want to have the exact
2222  * number of characters written into @buf as return value
2223  * (not including the trailing '\0'), use vscnprintf(). If the
2224  * return is greater than or equal to @size, the resulting
2225  * string is truncated.
2226  */
2227 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2228 {
2229         struct printf_spec spec = {0};
2230         char *str, *end;
2231         const char *args = (const char *)bin_buf;
2232
2233         if (WARN_ON_ONCE((int) size < 0))
2234                 return 0;
2235
2236         str = buf;
2237         end = buf + size;
2238
2239 #define get_arg(type)                                                   \
2240 ({                                                                      \
2241         typeof(type) value;                                             \
2242         if (sizeof(type) == 8) {                                        \
2243                 args = PTR_ALIGN(args, sizeof(u32));                    \
2244                 *(u32 *)&value = *(u32 *)args;                          \
2245                 *((u32 *)&value + 1) = *(u32 *)(args + 4);              \
2246         } else {                                                        \
2247                 args = PTR_ALIGN(args, sizeof(type));                   \
2248                 value = *(typeof(type) *)args;                          \
2249         }                                                               \
2250         args += sizeof(type);                                           \
2251         value;                                                          \
2252 })
2253
2254         /* Make sure end is always >= buf */
2255         if (end < buf) {
2256                 end = ((void *)-1);
2257                 size = end - buf;
2258         }
2259
2260         while (*fmt) {
2261                 const char *old_fmt = fmt;
2262                 int read = format_decode(fmt, &spec);
2263
2264                 fmt += read;
2265
2266                 switch (spec.type) {
2267                 case FORMAT_TYPE_NONE: {
2268                         int copy = read;
2269                         if (str < end) {
2270                                 if (copy > end - str)
2271                                         copy = end - str;
2272                                 memcpy(str, old_fmt, copy);
2273                         }
2274                         str += read;
2275                         break;
2276                 }
2277
2278                 case FORMAT_TYPE_WIDTH:
2279                         spec.field_width = get_arg(int);
2280                         break;
2281
2282                 case FORMAT_TYPE_PRECISION:
2283                         spec.precision = get_arg(int);
2284                         break;
2285
2286                 case FORMAT_TYPE_CHAR: {
2287                         char c;
2288
2289                         if (!(spec.flags & LEFT)) {
2290                                 while (--spec.field_width > 0) {
2291                                         if (str < end)
2292                                                 *str = ' ';
2293                                         ++str;
2294                                 }
2295                         }
2296                         c = (unsigned char) get_arg(char);
2297                         if (str < end)
2298                                 *str = c;
2299                         ++str;
2300                         while (--spec.field_width > 0) {
2301                                 if (str < end)
2302                                         *str = ' ';
2303                                 ++str;
2304                         }
2305                         break;
2306                 }
2307
2308                 case FORMAT_TYPE_STR: {
2309                         const char *str_arg = args;
2310                         args += strlen(str_arg) + 1;
2311                         str = string(str, end, (char *)str_arg, spec);
2312                         break;
2313                 }
2314
2315                 case FORMAT_TYPE_PTR:
2316                         str = pointer(fmt, str, end, get_arg(void *), spec);
2317                         while (isalnum(*fmt))
2318                                 fmt++;
2319                         break;
2320
2321                 case FORMAT_TYPE_PERCENT_CHAR:
2322                 case FORMAT_TYPE_INVALID:
2323                         if (str < end)
2324                                 *str = '%';
2325                         ++str;
2326                         break;
2327
2328                 default: {
2329                         unsigned long long num;
2330
2331                         switch (spec.type) {
2332
2333                         case FORMAT_TYPE_LONG_LONG:
2334                                 num = get_arg(long long);
2335                                 break;
2336                         case FORMAT_TYPE_ULONG:
2337                         case FORMAT_TYPE_LONG:
2338                                 num = get_arg(unsigned long);
2339                                 break;
2340                         case FORMAT_TYPE_SIZE_T:
2341                                 num = get_arg(size_t);
2342                                 break;
2343                         case FORMAT_TYPE_PTRDIFF:
2344                                 num = get_arg(ptrdiff_t);
2345                                 break;
2346                         case FORMAT_TYPE_UBYTE:
2347                                 num = get_arg(unsigned char);
2348                                 break;
2349                         case FORMAT_TYPE_BYTE:
2350                                 num = get_arg(signed char);
2351                                 break;
2352                         case FORMAT_TYPE_USHORT:
2353                                 num = get_arg(unsigned short);
2354                                 break;
2355                         case FORMAT_TYPE_SHORT:
2356                                 num = get_arg(short);
2357                                 break;
2358                         case FORMAT_TYPE_UINT:
2359                                 num = get_arg(unsigned int);
2360                                 break;
2361                         default:
2362                                 num = get_arg(int);
2363                         }
2364
2365                         str = number(str, end, num, spec);
2366                 } /* default: */
2367                 } /* switch(spec.type) */
2368         } /* while(*fmt) */
2369
2370         if (size > 0) {
2371                 if (str < end)
2372                         *str = '\0';
2373                 else
2374                         end[-1] = '\0';
2375         }
2376
2377 #undef get_arg
2378
2379         /* the trailing null byte doesn't count towards the total */
2380         return str - buf;
2381 }
2382 EXPORT_SYMBOL_GPL(bstr_printf);
2383
2384 /**
2385  * bprintf - Parse a format string and place args' binary value in a buffer
2386  * @bin_buf: The buffer to place args' binary value
2387  * @size: The size of the buffer(by words(32bits), not characters)
2388  * @fmt: The format string to use
2389  * @...: Arguments for the format string
2390  *
2391  * The function returns the number of words(u32) written
2392  * into @bin_buf.
2393  */
2394 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2395 {
2396         va_list args;
2397         int ret;
2398
2399         va_start(args, fmt);
2400         ret = vbin_printf(bin_buf, size, fmt, args);
2401         va_end(args);
2402
2403         return ret;
2404 }
2405 EXPORT_SYMBOL_GPL(bprintf);
2406
2407 #endif /* CONFIG_BINARY_PRINTF */
2408
2409 /**
2410  * vsscanf - Unformat a buffer into a list of arguments
2411  * @buf:        input buffer
2412  * @fmt:        format of buffer
2413  * @args:       arguments
2414  */
2415 int vsscanf(const char *buf, const char *fmt, va_list args)
2416 {
2417         const char *str = buf;
2418         char *next;
2419         char digit;
2420         int num = 0;
2421         u8 qualifier;
2422         unsigned int base;
2423         union {
2424                 long long s;
2425                 unsigned long long u;
2426         } val;
2427         s16 field_width;
2428         bool is_sign;
2429
2430         while (*fmt) {
2431                 /* skip any white space in format */
2432                 /* white space in format matchs any amount of
2433                  * white space, including none, in the input.
2434                  */
2435                 if (isspace(*fmt)) {
2436                         fmt = skip_spaces(++fmt);
2437                         str = skip_spaces(str);
2438                 }
2439
2440                 /* anything that is not a conversion must match exactly */
2441                 if (*fmt != '%' && *fmt) {
2442                         if (*fmt++ != *str++)
2443                                 break;
2444                         continue;
2445                 }
2446
2447                 if (!*fmt)
2448                         break;
2449                 ++fmt;
2450
2451                 /* skip this conversion.
2452                  * advance both strings to next white space
2453                  */
2454                 if (*fmt == '*') {
2455                         if (!*str)
2456                                 break;
2457                         while (!isspace(*fmt) && *fmt != '%' && *fmt)
2458                                 fmt++;
2459                         while (!isspace(*str) && *str)
2460                                 str++;
2461                         continue;
2462                 }
2463
2464                 /* get field width */
2465                 field_width = -1;
2466                 if (isdigit(*fmt)) {
2467                         field_width = skip_atoi(&fmt);
2468                         if (field_width <= 0)
2469                                 break;
2470                 }
2471
2472                 /* get conversion qualifier */
2473                 qualifier = -1;
2474                 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2475                     _tolower(*fmt) == 'z') {
2476                         qualifier = *fmt++;
2477                         if (unlikely(qualifier == *fmt)) {
2478                                 if (qualifier == 'h') {
2479                                         qualifier = 'H';
2480                                         fmt++;
2481                                 } else if (qualifier == 'l') {
2482                                         qualifier = 'L';
2483                                         fmt++;
2484                                 }
2485                         }
2486                 }
2487
2488                 if (!*fmt)
2489                         break;
2490
2491                 if (*fmt == 'n') {
2492                         /* return number of characters read so far */
2493                         *va_arg(args, int *) = str - buf;
2494                         ++fmt;
2495                         continue;
2496                 }
2497
2498                 if (!*str)
2499                         break;
2500
2501                 base = 10;
2502                 is_sign = false;
2503
2504                 switch (*fmt++) {
2505                 case 'c':
2506                 {
2507                         char *s = (char *)va_arg(args, char*);
2508                         if (field_width == -1)
2509                                 field_width = 1;
2510                         do {
2511                                 *s++ = *str++;
2512                         } while (--field_width > 0 && *str);
2513                         num++;
2514                 }
2515                 continue;
2516                 case 's':
2517                 {
2518                         char *s = (char *)va_arg(args, char *);
2519                         if (field_width == -1)
2520                                 field_width = SHRT_MAX;
2521                         /* first, skip leading white space in buffer */
2522                         str = skip_spaces(str);
2523
2524                         /* now copy until next white space */
2525                         while (*str && !isspace(*str) && field_width--)
2526                                 *s++ = *str++;
2527                         *s = '\0';
2528                         num++;
2529                 }
2530                 continue;
2531                 case 'o':
2532                         base = 8;
2533                         break;
2534                 case 'x':
2535                 case 'X':
2536                         base = 16;
2537                         break;
2538                 case 'i':
2539                         base = 0;
2540                 case 'd':
2541                         is_sign = true;
2542                 case 'u':
2543                         break;
2544                 case '%':
2545                         /* looking for '%' in str */
2546                         if (*str++ != '%')
2547                                 return num;
2548                         continue;
2549                 default:
2550                         /* invalid format; stop here */
2551                         return num;
2552                 }
2553
2554                 /* have some sort of integer conversion.
2555                  * first, skip white space in buffer.
2556                  */
2557                 str = skip_spaces(str);
2558
2559                 digit = *str;
2560                 if (is_sign && digit == '-')
2561                         digit = *(str + 1);
2562
2563                 if (!digit
2564                     || (base == 16 && !isxdigit(digit))
2565                     || (base == 10 && !isdigit(digit))
2566                     || (base == 8 && (!isdigit(digit) || digit > '7'))
2567                     || (base == 0 && !isdigit(digit)))
2568                         break;
2569
2570                 if (is_sign)
2571                         val.s = qualifier != 'L' ?
2572                                 simple_strtol(str, &next, base) :
2573                                 simple_strtoll(str, &next, base);
2574                 else
2575                         val.u = qualifier != 'L' ?
2576                                 simple_strtoul(str, &next, base) :
2577                                 simple_strtoull(str, &next, base);
2578
2579                 if (field_width > 0 && next - str > field_width) {
2580                         if (base == 0)
2581                                 _parse_integer_fixup_radix(str, &base);
2582                         while (next - str > field_width) {
2583                                 if (is_sign)
2584                                         val.s = div_s64(val.s, base);
2585                                 else
2586                                         val.u = div_u64(val.u, base);
2587                                 --next;
2588                         }
2589                 }
2590
2591                 switch (qualifier) {
2592                 case 'H':       /* that's 'hh' in format */
2593                         if (is_sign)
2594                                 *va_arg(args, signed char *) = val.s;
2595                         else
2596                                 *va_arg(args, unsigned char *) = val.u;
2597                         break;
2598                 case 'h':
2599                         if (is_sign)
2600                                 *va_arg(args, short *) = val.s;
2601                         else
2602                                 *va_arg(args, unsigned short *) = val.u;
2603                         break;
2604                 case 'l':
2605                         if (is_sign)
2606                                 *va_arg(args, long *) = val.s;
2607                         else
2608                                 *va_arg(args, unsigned long *) = val.u;
2609                         break;
2610                 case 'L':
2611                         if (is_sign)
2612                                 *va_arg(args, long long *) = val.s;
2613                         else
2614                                 *va_arg(args, unsigned long long *) = val.u;
2615                         break;
2616                 case 'Z':
2617                 case 'z':
2618                         *va_arg(args, size_t *) = val.u;
2619                         break;
2620                 default:
2621                         if (is_sign)
2622                                 *va_arg(args, int *) = val.s;
2623                         else
2624                                 *va_arg(args, unsigned int *) = val.u;
2625                         break;
2626                 }
2627                 num++;
2628
2629                 if (!next)
2630                         break;
2631                 str = next;
2632         }
2633
2634         return num;
2635 }
2636 EXPORT_SYMBOL(vsscanf);
2637
2638 /**
2639  * sscanf - Unformat a buffer into a list of arguments
2640  * @buf:        input buffer
2641  * @fmt:        formatting of buffer
2642  * @...:        resulting arguments
2643  */
2644 int sscanf(const char *buf, const char *fmt, ...)
2645 {
2646         va_list args;
2647         int i;
2648
2649         va_start(args, fmt);
2650         i = vsscanf(buf, fmt, args);
2651         va_end(args);
2652
2653         return i;
2654 }
2655 EXPORT_SYMBOL(sscanf);