SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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>
  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/uaccess.h>
  27 #include <linux/ioport.h>
  28 #include <net/addrconf.h>
  29
  30 #include <asm/page.h>           /* for PAGE_SIZE */
  31 #include <asm/div64.h>
  32 #include <asm/sections.h>       /* for dereference_function_descriptor() */
  33
  34 /* Works only for digits and letters, but small and fast */
  35 #define TOLOWER(x) ((x) | 0x20)
  36
  37 static unsigned int simple_guess_base(const char *cp)
  38 {
  39         if (cp[0] == '0') {
  40                 if (TOLOWER(cp[1]) == 'x' && isxdigit(cp[2]))
  41                         return 16;
  42                 else
  43                         return 8;
  44         } else {
  45                 return 10;
  46         }
  47 }
  48
  49 /**
  50  * simple_strtoull - convert a string to an unsigned long long
  51  * @cp: The start of the string
  52  * @endp: A pointer to the end of the parsed string will be placed here
  53  * @base: The number base to use
  54  */
  55 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
  56 {
  57         unsigned long long result = 0;
  58
  59         if (!base)
  60                 base = simple_guess_base(cp);
  61
  62         if (base == 16 && cp[0] == '0' && TOLOWER(cp[1]) == 'x')
  63                 cp += 2;
  64
  65         while (isxdigit(*cp)) {
  66                 unsigned int value;
  67
  68                 value = isdigit(*cp) ? *cp - '0' : TOLOWER(*cp) - 'a' + 10;
  69                 if (value >= base)
  70                         break;
  71                 result = result * base + value;
  72                 cp++;
  73         }
  74         if (endp)
  75                 *endp = (char *)cp;
  76
  77         return result;
  78 }
  79 EXPORT_SYMBOL(simple_strtoull);
  80
  81 /**
  82  * simple_strtoul - convert a string to an unsigned long
  83  * @cp: The start of the string
  84  * @endp: A pointer to the end of the parsed string will be placed here
  85  * @base: The number base to use
  86  */
  87 unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
  88 {
  89         return simple_strtoull(cp, endp, base);
  90 }
  91 EXPORT_SYMBOL(simple_strtoul);
  92
  93 /**
  94  * simple_strtol - convert a string to a signed long
  95  * @cp: The start of the string
  96  * @endp: A pointer to the end of the parsed string will be placed here
  97  * @base: The number base to use
  98  */
  99 long simple_strtol(const char *cp, char **endp, unsigned int base)
 100 {
 101         if (*cp == '-')
 102                 return -simple_strtoul(cp + 1, endp, base);
 103
 104         return simple_strtoul(cp, endp, base);
 105 }
 106 EXPORT_SYMBOL(simple_strtol);
 107
 108 /**
 109  * simple_strtoll - convert a string to a signed long long
 110  * @cp: The start of the string
 111  * @endp: A pointer to the end of the parsed string will be placed here
 112  * @base: The number base to use
 113  */
 114 long long simple_strtoll(const char *cp, char **endp, unsigned int base)
 115 {
 116         if (*cp == '-')
 117                 return -simple_strtoull(cp + 1, endp, base);
 118
 119         return simple_strtoull(cp, endp, base);
 120 }
 121
 122 /**
 123  * strict_strtoul - convert a string to an unsigned long strictly
 124  * @cp: The string to be converted
 125  * @base: The number base to use
 126  * @res: The converted result value
 127  *
 128  * strict_strtoul converts a string to an unsigned long only if the
 129  * string is really an unsigned long string, any string containing
 130  * any invalid char at the tail will be rejected and -EINVAL is returned,
 131  * only a newline char at the tail is acceptible because people generally
 132  * change a module parameter in the following way:
 133  *
 134  *      echo 1024 > /sys/module/e1000/parameters/copybreak
 135  *
 136  * echo will append a newline to the tail.
 137  *
 138  * It returns 0 if conversion is successful and *res is set to the converted
 139  * value, otherwise it returns -EINVAL and *res is set to 0.
 140  *
 141  * simple_strtoul just ignores the successive invalid characters and
 142  * return the converted value of prefix part of the string.
 143  */
 144 int strict_strtoul(const char *cp, unsigned int base, unsigned long *res)
 145 {
 146         char *tail;
 147         unsigned long val;
 148         size_t len;
 149
 150         *res = 0;
 151         len = strlen(cp);
 152         if (len == 0)
 153                 return -EINVAL;
 154
 155         val = simple_strtoul(cp, &tail, base);
 156         if (tail == cp)
 157                 return -EINVAL;
 158
 159         if ((*tail == '\0') ||
 160                 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
 161                 *res = val;
 162                 return 0;
 163         }
 164
 165         return -EINVAL;
 166 }
 167 EXPORT_SYMBOL(strict_strtoul);
 168
 169 /**
 170  * strict_strtol - convert a string to a long strictly
 171  * @cp: The string to be converted
 172  * @base: The number base to use
 173  * @res: The converted result value
 174  *
 175  * strict_strtol is similiar to strict_strtoul, but it allows the first
 176  * character of a string is '-'.
 177  *
 178  * It returns 0 if conversion is successful and *res is set to the converted
 179  * value, otherwise it returns -EINVAL and *res is set to 0.
 180  */
 181 int strict_strtol(const char *cp, unsigned int base, long *res)
 182 {
 183         int ret;
 184         if (*cp == '-') {
 185                 ret = strict_strtoul(cp + 1, base, (unsigned long *)res);
 186                 if (!ret)
 187                         *res = -(*res);
 188         } else {
 189                 ret = strict_strtoul(cp, base, (unsigned long *)res);
 190         }
 191
 192         return ret;
 193 }
 194 EXPORT_SYMBOL(strict_strtol);
 195
 196 /**
 197  * strict_strtoull - convert a string to an unsigned long long strictly
 198  * @cp: The string to be converted
 199  * @base: The number base to use
 200  * @res: The converted result value
 201  *
 202  * strict_strtoull converts a string to an unsigned long long only if the
 203  * string is really an unsigned long long string, any string containing
 204  * any invalid char at the tail will be rejected and -EINVAL is returned,
 205  * only a newline char at the tail is acceptible because people generally
 206  * change a module parameter in the following way:
 207  *
 208  *      echo 1024 > /sys/module/e1000/parameters/copybreak
 209  *
 210  * echo will append a newline to the tail of the string.
 211  *
 212  * It returns 0 if conversion is successful and *res is set to the converted
 213  * value, otherwise it returns -EINVAL and *res is set to 0.
 214  *
 215  * simple_strtoull just ignores the successive invalid characters and
 216  * return the converted value of prefix part of the string.
 217  */
 218 int strict_strtoull(const char *cp, unsigned int base, unsigned long long *res)
 219 {
 220         char *tail;
 221         unsigned long long val;
 222         size_t len;
 223
 224         *res = 0;
 225         len = strlen(cp);
 226         if (len == 0)
 227                 return -EINVAL;
 228
 229         val = simple_strtoull(cp, &tail, base);
 230         if (tail == cp)
 231                 return -EINVAL;
 232         if ((*tail == '\0') ||
 233                 ((len == (size_t)(tail - cp) + 1) && (*tail == '\n'))) {
 234                 *res = val;
 235                 return 0;
 236         }
 237
 238         return -EINVAL;
 239 }
 240 EXPORT_SYMBOL(strict_strtoull);
 241
 242 /**
 243  * strict_strtoll - convert a string to a long long strictly
 244  * @cp: The string to be converted
 245  * @base: The number base to use
 246  * @res: The converted result value
 247  *
 248  * strict_strtoll is similiar to strict_strtoull, but it allows the first
 249  * character of a string is '-'.
 250  *
 251  * It returns 0 if conversion is successful and *res is set to the converted
 252  * value, otherwise it returns -EINVAL and *res is set to 0.
 253  */
 254 int strict_strtoll(const char *cp, unsigned int base, long long *res)
 255 {
 256         int ret;
 257         if (*cp == '-') {
 258                 ret = strict_strtoull(cp + 1, base, (unsigned long long *)res);
 259                 if (!ret)
 260                         *res = -(*res);
 261         } else {
 262                 ret = strict_strtoull(cp, base, (unsigned long long *)res);
 263         }
 264
 265         return ret;
 266 }
 267 EXPORT_SYMBOL(strict_strtoll);
 268
 269 static int skip_atoi(const char **s)
 270 {
 271         int i = 0;
 272
 273         while (isdigit(**s))
 274                 i = i*10 + *((*s)++) - '0';
 275
 276         return i;
 277 }
 278
 279 /* Decimal conversion is by far the most typical, and is used
 280  * for /proc and /sys data. This directly impacts e.g. top performance
 281  * with many processes running. We optimize it for speed
 282  * using code from
 283  * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
 284  * (with permission from the author, Douglas W. Jones). */
 285
 286 /* Formats correctly any integer in [0,99999].
 287  * Outputs from one to five digits depending on input.
 288  * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
 289 static char *put_dec_trunc(char *buf, unsigned q)
 290 {
 291         unsigned d3, d2, d1, d0;
 292         d1 = (q>>4) & 0xf;
 293         d2 = (q>>8) & 0xf;
 294         d3 = (q>>12);
 295
 296         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
 297         q = (d0 * 0xcd) >> 11;
 298         d0 = d0 - 10*q;
 299         *buf++ = d0 + '0'; /* least significant digit */
 300         d1 = q + 9*d3 + 5*d2 + d1;
 301         if (d1 != 0) {
 302                 q = (d1 * 0xcd) >> 11;
 303                 d1 = d1 - 10*q;
 304                 *buf++ = d1 + '0'; /* next digit */
 305
 306                 d2 = q + 2*d2;
 307                 if ((d2 != 0) || (d3 != 0)) {
 308                         q = (d2 * 0xd) >> 7;
 309                         d2 = d2 - 10*q;
 310                         *buf++ = d2 + '0'; /* next digit */
 311
 312                         d3 = q + 4*d3;
 313                         if (d3 != 0) {
 314                                 q = (d3 * 0xcd) >> 11;
 315                                 d3 = d3 - 10*q;
 316                                 *buf++ = d3 + '0';  /* next digit */
 317                                 if (q != 0)
 318                                         *buf++ = q + '0'; /* most sign. digit */
 319                         }
 320                 }
 321         }
 322
 323         return buf;
 324 }
 325 /* Same with if's removed. Always emits five digits */
 326 static char *put_dec_full(char *buf, unsigned q)
 327 {
 328         /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
 329         /* but anyway, gcc produces better code with full-sized ints */
 330         unsigned d3, d2, d1, d0;
 331         d1 = (q>>4) & 0xf;
 332         d2 = (q>>8) & 0xf;
 333         d3 = (q>>12);
 334
 335         /*
 336          * Possible ways to approx. divide by 10
 337          * gcc -O2 replaces multiply with shifts and adds
 338          * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
 339          * (x * 0x67) >> 10:  1100111
 340          * (x * 0x34) >> 9:    110100 - same
 341          * (x * 0x1a) >> 8:     11010 - same
 342          * (x * 0x0d) >> 7:      1101 - same, shortest code (on i386)
 343          */
 344         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
 345         q = (d0 * 0xcd) >> 11;
 346         d0 = d0 - 10*q;
 347         *buf++ = d0 + '0';
 348         d1 = q + 9*d3 + 5*d2 + d1;
 349                 q = (d1 * 0xcd) >> 11;
 350                 d1 = d1 - 10*q;
 351                 *buf++ = d1 + '0';
 352
 353                 d2 = q + 2*d2;
 354                         q = (d2 * 0xd) >> 7;
 355                         d2 = d2 - 10*q;
 356                         *buf++ = d2 + '0';
 357
 358                         d3 = q + 4*d3;
 359                                 q = (d3 * 0xcd) >> 11; /* - shorter code */
 360                                 /* q = (d3 * 0x67) >> 10; - would also work */
 361                                 d3 = d3 - 10*q;
 362                                 *buf++ = d3 + '0';
 363                                         *buf++ = q + '0';
 364
 365         return buf;
 366 }
 367 /* No inlining helps gcc to use registers better */
 368 static noinline char *put_dec(char *buf, unsigned long long num)
 369 {
 370         while (1) {
 371                 unsigned rem;
 372                 if (num < 100000)
 373                         return put_dec_trunc(buf, num);
 374                 rem = do_div(num, 100000);
 375                 buf = put_dec_full(buf, rem);
 376         }
 377 }
 378
 379 #define ZEROPAD 1               /* pad with zero */
 380 #define SIGN    2               /* unsigned/signed long */
 381 #define PLUS    4               /* show plus */
 382 #define SPACE   8               /* space if plus */
 383 #define LEFT    16              /* left justified */
 384 #define SMALL   32              /* Must be 32 == 0x20 */
 385 #define SPECIAL 64              /* 0x */
 386
 387 enum format_type {
 388         FORMAT_TYPE_NONE, /* Just a string part */
 389         FORMAT_TYPE_WIDTH,
 390         FORMAT_TYPE_PRECISION,
 391         FORMAT_TYPE_CHAR,
 392         FORMAT_TYPE_STR,
 393         FORMAT_TYPE_PTR,
 394         FORMAT_TYPE_PERCENT_CHAR,
 395         FORMAT_TYPE_INVALID,
 396         FORMAT_TYPE_LONG_LONG,
 397         FORMAT_TYPE_ULONG,
 398         FORMAT_TYPE_LONG,
 399         FORMAT_TYPE_UBYTE,
 400         FORMAT_TYPE_BYTE,
 401         FORMAT_TYPE_USHORT,
 402         FORMAT_TYPE_SHORT,
 403         FORMAT_TYPE_UINT,
 404         FORMAT_TYPE_INT,
 405         FORMAT_TYPE_NRCHARS,
 406         FORMAT_TYPE_SIZE_T,
 407         FORMAT_TYPE_PTRDIFF
 408 };
 409
 410 struct printf_spec {
 411         enum format_type        type;
 412         int                     flags;          /* flags to number() */
 413         int                     field_width;    /* width of output field */
 414         int                     base;
 415         int                     precision;      /* # of digits/chars */
 416         int                     qualifier;
 417 };
 418
 419 static char *number(char *buf, char *end, unsigned long long num,
 420                         struct printf_spec spec)
 421 {
 422         /* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
 423         static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
 424
 425         char tmp[66];
 426         char sign;
 427         char locase;
 428         int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
 429         int i;
 430
 431         /* locase = 0 or 0x20. ORing digits or letters with 'locase'
 432          * produces same digits or (maybe lowercased) letters */
 433         locase = (spec.flags & SMALL);
 434         if (spec.flags & LEFT)
 435                 spec.flags &= ~ZEROPAD;
 436         sign = 0;
 437         if (spec.flags & SIGN) {
 438                 if ((signed long long)num < 0) {
 439                         sign = '-';
 440                         num = -(signed long long)num;
 441                         spec.field_width--;
 442                 } else if (spec.flags & PLUS) {
 443                         sign = '+';
 444                         spec.field_width--;
 445                 } else if (spec.flags & SPACE) {
 446                         sign = ' ';
 447                         spec.field_width--;
 448                 }
 449         }
 450         if (need_pfx) {
 451                 spec.field_width--;
 452                 if (spec.base == 16)
 453                         spec.field_width--;
 454         }
 455
 456         /* generate full string in tmp[], in reverse order */
 457         i = 0;
 458         if (num == 0)
 459                 tmp[i++] = '0';
 460         /* Generic code, for any base:
 461         else do {
 462                 tmp[i++] = (digits[do_div(num,base)] | locase);
 463         } while (num != 0);
 464         */
 465         else if (spec.base != 10) { /* 8 or 16 */
 466                 int mask = spec.base - 1;
 467                 int shift = 3;
 468
 469                 if (spec.base == 16)
 470                         shift = 4;
 471                 do {
 472                         tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
 473                         num >>= shift;
 474                 } while (num);
 475         } else { /* base 10 */
 476                 i = put_dec(tmp, num) - tmp;
 477         }
 478
 479         /* printing 100 using %2d gives "100", not "00" */
 480         if (i > spec.precision)
 481                 spec.precision = i;
 482         /* leading space padding */
 483         spec.field_width -= spec.precision;
 484         if (!(spec.flags & (ZEROPAD+LEFT))) {
 485                 while (--spec.field_width >= 0) {
 486                         if (buf < end)
 487                                 *buf = ' ';
 488                         ++buf;
 489                 }
 490         }
 491         /* sign */
 492         if (sign) {
 493                 if (buf < end)
 494                         *buf = sign;
 495                 ++buf;
 496         }
 497         /* "0x" / "0" prefix */
 498         if (need_pfx) {
 499                 if (buf < end)
 500                         *buf = '0';
 501                 ++buf;
 502                 if (spec.base == 16) {
 503                         if (buf < end)
 504                                 *buf = ('X' | locase);
 505                         ++buf;
 506                 }
 507         }
 508         /* zero or space padding */
 509         if (!(spec.flags & LEFT)) {
 510                 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
 511                 while (--spec.field_width >= 0) {
 512                         if (buf < end)
 513                                 *buf = c;
 514                         ++buf;
 515                 }
 516         }
 517         /* hmm even more zero padding? */
 518         while (i <= --spec.precision) {
 519                 if (buf < end)
 520                         *buf = '0';
 521                 ++buf;
 522         }
 523         /* actual digits of result */
 524         while (--i >= 0) {
 525                 if (buf < end)
 526                         *buf = tmp[i];
 527                 ++buf;
 528         }
 529         /* trailing space padding */
 530         while (--spec.field_width >= 0) {
 531                 if (buf < end)
 532                         *buf = ' ';
 533                 ++buf;
 534         }
 535
 536         return buf;
 537 }
 538
 539 static char *string(char *buf, char *end, const char *s, struct printf_spec spec)
 540 {
 541         int len, i;
 542
 543         if ((unsigned long)s < PAGE_SIZE)
 544                 s = "(null)";
 545
 546         len = strnlen(s, spec.precision);
 547
 548         if (!(spec.flags & LEFT)) {
 549                 while (len < spec.field_width--) {
 550                         if (buf < end)
 551                                 *buf = ' ';
 552                         ++buf;
 553                 }
 554         }
 555         for (i = 0; i < len; ++i) {
 556                 if (buf < end)
 557                         *buf = *s;
 558                 ++buf; ++s;
 559         }
 560         while (len < spec.field_width--) {
 561                 if (buf < end)
 562                         *buf = ' ';
 563                 ++buf;
 564         }
 565
 566         return buf;
 567 }
 568
 569 static char *symbol_string(char *buf, char *end, void *ptr,
 570                                 struct printf_spec spec, char ext)
 571 {
 572         unsigned long value = (unsigned long) ptr;
 573 #ifdef CONFIG_KALLSYMS
 574         char sym[KSYM_SYMBOL_LEN];
 575         if (ext != 'f' && ext != 's')
 576                 sprint_symbol(sym, value);
 577         else
 578                 kallsyms_lookup(value, NULL, NULL, NULL, sym);
 579
 580         return string(buf, end, sym, spec);
 581 #else
 582         spec.field_width = 2 * sizeof(void *);
 583         spec.flags |= SPECIAL | SMALL | ZEROPAD;
 584         spec.base = 16;
 585
 586         return number(buf, end, value, spec);
 587 #endif
 588 }
 589
 590 static char *resource_string(char *buf, char *end, struct resource *res,
 591                                 struct printf_spec spec, const char *fmt)
 592 {
 593 #ifndef IO_RSRC_PRINTK_SIZE
 594 #define IO_RSRC_PRINTK_SIZE     6
 595 #endif
 596
 597 #ifndef MEM_RSRC_PRINTK_SIZE
 598 #define MEM_RSRC_PRINTK_SIZE    10
 599 #endif
 600         struct printf_spec hex_spec = {
 601                 .base = 16,
 602                 .precision = -1,
 603                 .flags = SPECIAL | SMALL | ZEROPAD,
 604         };
 605         struct printf_spec dec_spec = {
 606                 .base = 10,
 607                 .precision = -1,
 608                 .flags = 0,
 609         };
 610         struct printf_spec str_spec = {
 611                 .field_width = -1,
 612                 .precision = 10,
 613                 .flags = LEFT,
 614         };
 615         struct printf_spec flag_spec = {
 616                 .base = 16,
 617                 .precision = -1,
 618                 .flags = SPECIAL | SMALL,
 619         };
 620
 621         /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
 622          * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
 623 #define RSRC_BUF_SIZE           ((2 * sizeof(resource_size_t)) + 4)
 624 #define FLAG_BUF_SIZE           (2 * sizeof(res->flags))
 625 #define DECODED_BUF_SIZE        sizeof("[mem - 64bit pref disabled]")
 626 #define RAW_BUF_SIZE            sizeof("[mem - flags 0x]")
 627         char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
 628                      2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
 629
 630         char *p = sym, *pend = sym + sizeof(sym);
 631         int size = -1, addr = 0;
 632         int decode = (fmt[0] == 'R') ? 1 : 0;
 633
 634         if (res->flags & IORESOURCE_IO) {
 635                 size = IO_RSRC_PRINTK_SIZE;
 636                 addr = 1;
 637         } else if (res->flags & IORESOURCE_MEM) {
 638                 size = MEM_RSRC_PRINTK_SIZE;
 639                 addr = 1;
 640         }
 641
 642         *p++ = '[';
 643         if (res->flags & IORESOURCE_IO)
 644                 p = string(p, pend, "io  ", str_spec);
 645         else if (res->flags & IORESOURCE_MEM)
 646                 p = string(p, pend, "mem ", str_spec);
 647         else if (res->flags & IORESOURCE_IRQ)
 648                 p = string(p, pend, "irq ", str_spec);
 649         else if (res->flags & IORESOURCE_DMA)
 650                 p = string(p, pend, "dma ", str_spec);
 651         else {
 652                 p = string(p, pend, "??? ", str_spec);
 653                 decode = 0;
 654         }
 655         hex_spec.field_width = size;
 656         p = number(p, pend, res->start, addr ? hex_spec : dec_spec);
 657         if (res->start != res->end) {
 658                 *p++ = '-';
 659                 p = number(p, pend, res->end, addr ? hex_spec : dec_spec);
 660         }
 661         if (decode) {
 662                 if (res->flags & IORESOURCE_MEM_64)
 663                         p = string(p, pend, " 64bit", str_spec);
 664                 if (res->flags & IORESOURCE_PREFETCH)
 665                         p = string(p, pend, " pref", str_spec);
 666                 if (res->flags & IORESOURCE_DISABLED)
 667                         p = string(p, pend, " disabled", str_spec);
 668         } else {
 669                 p = string(p, pend, " flags ", str_spec);
 670                 p = number(p, pend, res->flags, flag_spec);
 671         }
 672         *p++ = ']';
 673         *p = '\0';
 674
 675         return string(buf, end, sym, spec);
 676 }
 677
 678 static char *mac_address_string(char *buf, char *end, u8 *addr,
 679                                 struct printf_spec spec, const char *fmt)
 680 {
 681         char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
 682         char *p = mac_addr;
 683         int i;
 684
 685         for (i = 0; i < 6; i++) {
 686                 p = pack_hex_byte(p, addr[i]);
 687                 if (fmt[0] == 'M' && i != 5)
 688                         *p++ = ':';
 689         }
 690         *p = '\0';
 691
 692         return string(buf, end, mac_addr, spec);
 693 }
 694
 695 static char *ip4_string(char *p, const u8 *addr, bool leading_zeros)
 696 {
 697         int i;
 698
 699         for (i = 0; i < 4; i++) {
 700                 char temp[3];   /* hold each IP quad in reverse order */
 701                 int digits = put_dec_trunc(temp, addr[i]) - temp;
 702                 if (leading_zeros) {
 703                         if (digits < 3)
 704                                 *p++ = '0';
 705                         if (digits < 2)
 706                                 *p++ = '0';
 707                 }
 708                 /* reverse the digits in the quad */
 709                 while (digits--)
 710                         *p++ = temp[digits];
 711                 if (i < 3)
 712                         *p++ = '.';
 713         }
 714         *p = '\0';
 715
 716         return p;
 717 }
 718
 719 static char *ip6_compressed_string(char *p, const char *addr)
 720 {
 721         int i, j, range;
 722         unsigned char zerolength[8];
 723         int longest = 1;
 724         int colonpos = -1;
 725         u16 word;
 726         u8 hi, lo;
 727         bool needcolon = false;
 728         bool useIPv4;
 729         struct in6_addr in6;
 730
 731         memcpy(&in6, addr, sizeof(struct in6_addr));
 732
 733         useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
 734
 735         memset(zerolength, 0, sizeof(zerolength));
 736
 737         if (useIPv4)
 738                 range = 6;
 739         else
 740                 range = 8;
 741
 742         /* find position of longest 0 run */
 743         for (i = 0; i < range; i++) {
 744                 for (j = i; j < range; j++) {
 745                         if (in6.s6_addr16[j] != 0)
 746                                 break;
 747                         zerolength[i]++;
 748                 }
 749         }
 750         for (i = 0; i < range; i++) {
 751                 if (zerolength[i] > longest) {
 752                         longest = zerolength[i];
 753                         colonpos = i;
 754                 }
 755         }
 756
 757         /* emit address */
 758         for (i = 0; i < range; i++) {
 759                 if (i == colonpos) {
 760                         if (needcolon || i == 0)
 761                                 *p++ = ':';
 762                         *p++ = ':';
 763                         needcolon = false;
 764                         i += longest - 1;
 765                         continue;
 766                 }
 767                 if (needcolon) {
 768                         *p++ = ':';
 769                         needcolon = false;
 770                 }
 771                 /* hex u16 without leading 0s */
 772                 word = ntohs(in6.s6_addr16[i]);
 773                 hi = word >> 8;
 774                 lo = word & 0xff;
 775                 if (hi) {
 776                         if (hi > 0x0f)
 777                                 p = pack_hex_byte(p, hi);
 778                         else
 779                                 *p++ = hex_asc_lo(hi);
 780                         p = pack_hex_byte(p, lo);
 781                 }
 782                 else if (lo > 0x0f)
 783                         p = pack_hex_byte(p, lo);
 784                 else
 785                         *p++ = hex_asc_lo(lo);
 786                 needcolon = true;
 787         }
 788
 789         if (useIPv4) {
 790                 if (needcolon)
 791                         *p++ = ':';
 792                 p = ip4_string(p, &in6.s6_addr[12], false);
 793         }
 794         *p = '\0';
 795
 796         return p;
 797 }
 798
 799 static char *ip6_string(char *p, const char *addr, const char *fmt)
 800 {
 801         int i;
 802
 803         for (i = 0; i < 8; i++) {
 804                 p = pack_hex_byte(p, *addr++);
 805                 p = pack_hex_byte(p, *addr++);
 806                 if (fmt[0] == 'I' && i != 7)
 807                         *p++ = ':';
 808         }
 809         *p = '\0';
 810
 811         return p;
 812 }
 813
 814 static char *ip6_addr_string(char *buf, char *end, const u8 *addr,
 815                              struct printf_spec spec, const char *fmt)
 816 {
 817         char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
 818
 819         if (fmt[0] == 'I' && fmt[2] == 'c')
 820                 ip6_compressed_string(ip6_addr, addr);
 821         else
 822                 ip6_string(ip6_addr, addr, fmt);
 823
 824         return string(buf, end, ip6_addr, spec);
 825 }
 826
 827 static char *ip4_addr_string(char *buf, char *end, const u8 *addr,
 828                              struct printf_spec spec, const char *fmt)
 829 {
 830         char ip4_addr[sizeof("255.255.255.255")];
 831
 832         ip4_string(ip4_addr, addr, fmt[0] == 'i');
 833
 834         return string(buf, end, ip4_addr, spec);
 835 }
 836
 837 /*
 838  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
 839  * by an extra set of alphanumeric characters that are extended format
 840  * specifiers.
 841  *
 842  * Right now we handle:
 843  *
 844  * - 'F' For symbolic function descriptor pointers with offset
 845  * - 'f' For simple symbolic function names without offset
 846  * - 'S' For symbolic direct pointers with offset
 847  * - 's' For symbolic direct pointers without offset
 848  * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
 849  * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
 850  * - 'M' For a 6-byte MAC address, it prints the address in the
 851  *       usual colon-separated hex notation
 852  * - 'm' For a 6-byte MAC address, it prints the hex address without colons
 853  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
 854  *       IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
 855  *       IPv6 uses colon separated network-order 16 bit hex with leading 0's
 856  * - 'i' [46] for 'raw' IPv4/IPv6 addresses
 857  *       IPv6 omits the colons (01020304...0f)
 858  *       IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
 859  * - 'I6c' for IPv6 addresses printed as specified by
 860  *       http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
 861  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
 862  * function pointers are really function descriptors, which contain a
 863  * pointer to the real address.
 864  */
 865 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
 866                         struct printf_spec spec)
 867 {
 868         if (!ptr)
 869                 return string(buf, end, "(null)", spec);
 870
 871         switch (*fmt) {
 872         case 'F':
 873         case 'f':
 874                 ptr = dereference_function_descriptor(ptr);
 875                 /* Fallthrough */
 876         case 's':
 877         case 'S':
 878                 return symbol_string(buf, end, ptr, spec, *fmt);
 879         case 'R':
 880         case 'r':
 881                 return resource_string(buf, end, ptr, spec, fmt);
 882         case 'M':                       /* Colon separated: 00:01:02:03:04:05 */
 883         case 'm':                       /* Contiguous: 000102030405 */
 884                 return mac_address_string(buf, end, ptr, spec, fmt);
 885         case 'I':                       /* Formatted IP supported
 886                                          * 4:   1.2.3.4
 887                                          * 6:   0001:0203:...:0708
 888                                          * 6c:  1::708 or 1::1.2.3.4
 889                                          */
 890         case 'i':                       /* Contiguous:
 891                                          * 4:   001.002.003.004
 892                                          * 6:   000102...0f
 893                                          */
 894                 switch (fmt[1]) {
 895                 case '6':
 896                         return ip6_addr_string(buf, end, ptr, spec, fmt);
 897                 case '4':
 898                         return ip4_addr_string(buf, end, ptr, spec, fmt);
 899                 }
 900                 break;
 901         }
 902         spec.flags |= SMALL;
 903         if (spec.field_width == -1) {
 904                 spec.field_width = 2*sizeof(void *);
 905                 spec.flags |= ZEROPAD;
 906         }
 907         spec.base = 16;
 908
 909         return number(buf, end, (unsigned long) ptr, spec);
 910 }
 911
 912 /*
 913  * Helper function to decode printf style format.
 914  * Each call decode a token from the format and return the
 915  * number of characters read (or likely the delta where it wants
 916  * to go on the next call).
 917  * The decoded token is returned through the parameters
 918  *
 919  * 'h', 'l', or 'L' for integer fields
 920  * 'z' support added 23/7/1999 S.H.
 921  * 'z' changed to 'Z' --davidm 1/25/99
 922  * 't' added for ptrdiff_t
 923  *
 924  * @fmt: the format string
 925  * @type of the token returned
 926  * @flags: various flags such as +, -, # tokens..
 927  * @field_width: overwritten width
 928  * @base: base of the number (octal, hex, ...)
 929  * @precision: precision of a number
 930  * @qualifier: qualifier of a number (long, size_t, ...)
 931  */
 932 static int format_decode(const char *fmt, struct printf_spec *spec)
 933 {
 934         const char *start = fmt;
 935
 936         /* we finished early by reading the field width */
 937         if (spec->type == FORMAT_TYPE_WIDTH) {
 938                 if (spec->field_width < 0) {
 939                         spec->field_width = -spec->field_width;
 940                         spec->flags |= LEFT;
 941                 }
 942                 spec->type = FORMAT_TYPE_NONE;
 943                 goto precision;
 944         }
 945
 946         /* we finished early by reading the precision */
 947         if (spec->type == FORMAT_TYPE_PRECISION) {
 948                 if (spec->precision < 0)
 949                         spec->precision = 0;
 950
 951                 spec->type = FORMAT_TYPE_NONE;
 952                 goto qualifier;
 953         }
 954
 955         /* By default */
 956         spec->type = FORMAT_TYPE_NONE;
 957
 958         for (; *fmt ; ++fmt) {
 959                 if (*fmt == '%')
 960                         break;
 961         }
 962
 963         /* Return the current non-format string */
 964         if (fmt != start || !*fmt)
 965                 return fmt - start;
 966
 967         /* Process flags */
 968         spec->flags = 0;
 969
 970         while (1) { /* this also skips first '%' */
 971                 bool found = true;
 972
 973                 ++fmt;
 974
 975                 switch (*fmt) {
 976                 case '-': spec->flags |= LEFT;    break;
 977                 case '+': spec->flags |= PLUS;    break;
 978                 case ' ': spec->flags |= SPACE;   break;
 979                 case '#': spec->flags |= SPECIAL; break;
 980                 case '0': spec->flags |= ZEROPAD; break;
 981                 default:  found = false;
 982                 }
 983
 984                 if (!found)
 985                         break;
 986         }
 987
 988         /* get field width */
 989         spec->field_width = -1;
 990
 991         if (isdigit(*fmt))
 992                 spec->field_width = skip_atoi(&fmt);
 993         else if (*fmt == '*') {
 994                 /* it's the next argument */
 995                 spec->type = FORMAT_TYPE_WIDTH;
 996                 return ++fmt - start;
 997         }
 998
 999 precision:
1000         /* get the precision */
1001         spec->precision = -1;
1002         if (*fmt == '.') {
1003                 ++fmt;
1004                 if (isdigit(*fmt)) {
1005                         spec->precision = skip_atoi(&fmt);
1006                         if (spec->precision < 0)
1007                                 spec->precision = 0;
1008                 } else if (*fmt == '*') {
1009                         /* it's the next argument */
1010                         spec->type = FORMAT_TYPE_PRECISION;
1011                         return ++fmt - start;
1012                 }
1013         }
1014
1015 qualifier:
1016         /* get the conversion qualifier */
1017         spec->qualifier = -1;
1018         if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1019             TOLOWER(*fmt) == 'z' || *fmt == 't') {
1020                 spec->qualifier = *fmt++;
1021                 if (unlikely(spec->qualifier == *fmt)) {
1022                         if (spec->qualifier == 'l') {
1023                                 spec->qualifier = 'L';
1024                                 ++fmt;
1025                         } else if (spec->qualifier == 'h') {
1026                                 spec->qualifier = 'H';
1027                                 ++fmt;
1028                         }
1029                 }
1030         }
1031
1032         /* default base */
1033         spec->base = 10;
1034         switch (*fmt) {
1035         case 'c':
1036                 spec->type = FORMAT_TYPE_CHAR;
1037                 return ++fmt - start;
1038
1039         case 's':
1040                 spec->type = FORMAT_TYPE_STR;
1041                 return ++fmt - start;
1042
1043         case 'p':
1044                 spec->type = FORMAT_TYPE_PTR;
1045                 return fmt - start;
1046                 /* skip alnum */
1047
1048         case 'n':
1049                 spec->type = FORMAT_TYPE_NRCHARS;
1050                 return ++fmt - start;
1051
1052         case '%':
1053                 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1054                 return ++fmt - start;
1055
1056         /* integer number formats - set up the flags and "break" */
1057         case 'o':
1058                 spec->base = 8;
1059                 break;
1060
1061         case 'x':
1062                 spec->flags |= SMALL;
1063
1064         case 'X':
1065                 spec->base = 16;
1066                 break;
1067
1068         case 'd':
1069         case 'i':
1070                 spec->flags |= SIGN;
1071         case 'u':
1072                 break;
1073
1074         default:
1075                 spec->type = FORMAT_TYPE_INVALID;
1076                 return fmt - start;
1077         }
1078
1079         if (spec->qualifier == 'L')
1080                 spec->type = FORMAT_TYPE_LONG_LONG;
1081         else if (spec->qualifier == 'l') {
1082                 if (spec->flags & SIGN)
1083                         spec->type = FORMAT_TYPE_LONG;
1084                 else
1085                         spec->type = FORMAT_TYPE_ULONG;
1086         } else if (TOLOWER(spec->qualifier) == 'z') {
1087                 spec->type = FORMAT_TYPE_SIZE_T;
1088         } else if (spec->qualifier == 't') {
1089                 spec->type = FORMAT_TYPE_PTRDIFF;
1090         } else if (spec->qualifier == 'H') {
1091                 if (spec->flags & SIGN)
1092                         spec->type = FORMAT_TYPE_BYTE;
1093                 else
1094                         spec->type = FORMAT_TYPE_UBYTE;
1095         } else if (spec->qualifier == 'h') {
1096                 if (spec->flags & SIGN)
1097                         spec->type = FORMAT_TYPE_SHORT;
1098                 else
1099                         spec->type = FORMAT_TYPE_USHORT;
1100         } else {
1101                 if (spec->flags & SIGN)
1102                         spec->type = FORMAT_TYPE_INT;
1103                 else
1104                         spec->type = FORMAT_TYPE_UINT;
1105         }
1106
1107         return ++fmt - start;
1108 }
1109
1110 /**
1111  * vsnprintf - Format a string and place it in a buffer
1112  * @buf: The buffer to place the result into
1113  * @size: The size of the buffer, including the trailing null space
1114  * @fmt: The format string to use
1115  * @args: Arguments for the format string
1116  *
1117  * This function follows C99 vsnprintf, but has some extensions:
1118  * %pS output the name of a text symbol with offset
1119  * %ps output the name of a text symbol without offset
1120  * %pF output the name of a function pointer with its offset
1121  * %pf output the name of a function pointer without its offset
1122  * %pR output the address range in a struct resource
1123  * %n is ignored
1124  *
1125  * The return value is the number of characters which would
1126  * be generated for the given input, excluding the trailing
1127  * '\0', as per ISO C99. If you want to have the exact
1128  * number of characters written into @buf as return value
1129  * (not including the trailing '\0'), use vscnprintf(). If the
1130  * return is greater than or equal to @size, the resulting
1131  * string is truncated.
1132  *
1133  * Call this function if you are already dealing with a va_list.
1134  * You probably want snprintf() instead.
1135  */
1136 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1137 {
1138         unsigned long long num;
1139         char *str, *end;
1140         struct printf_spec spec = {0};
1141
1142         /* Reject out-of-range values early.  Large positive sizes are
1143            used for unknown buffer sizes. */
1144         if (WARN_ON_ONCE((int) size < 0))
1145                 return 0;
1146
1147         str = buf;
1148         end = buf + size;
1149
1150         /* Make sure end is always >= buf */
1151         if (end < buf) {
1152                 end = ((void *)-1);
1153                 size = end - buf;
1154         }
1155
1156         while (*fmt) {
1157                 const char *old_fmt = fmt;
1158                 int read = format_decode(fmt, &spec);
1159
1160                 fmt += read;
1161
1162                 switch (spec.type) {
1163                 case FORMAT_TYPE_NONE: {
1164                         int copy = read;
1165                         if (str < end) {
1166                                 if (copy > end - str)
1167                                         copy = end - str;
1168                                 memcpy(str, old_fmt, copy);
1169                         }
1170                         str += read;
1171                         break;
1172                 }
1173
1174                 case FORMAT_TYPE_WIDTH:
1175                         spec.field_width = va_arg(args, int);
1176                         break;
1177
1178                 case FORMAT_TYPE_PRECISION:
1179                         spec.precision = va_arg(args, int);
1180                         break;
1181
1182                 case FORMAT_TYPE_CHAR: {
1183                         char c;
1184
1185                         if (!(spec.flags & LEFT)) {
1186                                 while (--spec.field_width > 0) {
1187                                         if (str < end)
1188                                                 *str = ' ';
1189                                         ++str;
1190
1191                                 }
1192                         }
1193                         c = (unsigned char) va_arg(args, int);
1194                         if (str < end)
1195                                 *str = c;
1196                         ++str;
1197                         while (--spec.field_width > 0) {
1198                                 if (str < end)
1199                                         *str = ' ';
1200                                 ++str;
1201                         }
1202                         break;
1203                 }
1204
1205                 case FORMAT_TYPE_STR:
1206                         str = string(str, end, va_arg(args, char *), spec);
1207                         break;
1208
1209                 case FORMAT_TYPE_PTR:
1210                         str = pointer(fmt+1, str, end, va_arg(args, void *),
1211                                       spec);
1212                         while (isalnum(*fmt))
1213                                 fmt++;
1214                         break;
1215
1216                 case FORMAT_TYPE_PERCENT_CHAR:
1217                         if (str < end)
1218                                 *str = '%';
1219                         ++str;
1220                         break;
1221
1222                 case FORMAT_TYPE_INVALID:
1223                         if (str < end)
1224                                 *str = '%';
1225                         ++str;
1226                         break;
1227
1228                 case FORMAT_TYPE_NRCHARS: {
1229                         int qualifier = spec.qualifier;
1230
1231                         if (qualifier == 'l') {
1232                                 long *ip = va_arg(args, long *);
1233                                 *ip = (str - buf);
1234                         } else if (TOLOWER(qualifier) == 'z') {
1235                                 size_t *ip = va_arg(args, size_t *);
1236                                 *ip = (str - buf);
1237                         } else {
1238                                 int *ip = va_arg(args, int *);
1239                                 *ip = (str - buf);
1240                         }
1241                         break;
1242                 }
1243
1244                 default:
1245                         switch (spec.type) {
1246                         case FORMAT_TYPE_LONG_LONG:
1247                                 num = va_arg(args, long long);
1248                                 break;
1249                         case FORMAT_TYPE_ULONG:
1250                                 num = va_arg(args, unsigned long);
1251                                 break;
1252                         case FORMAT_TYPE_LONG:
1253                                 num = va_arg(args, long);
1254                                 break;
1255                         case FORMAT_TYPE_SIZE_T:
1256                                 num = va_arg(args, size_t);
1257                                 break;
1258                         case FORMAT_TYPE_PTRDIFF:
1259                                 num = va_arg(args, ptrdiff_t);
1260                                 break;
1261                         case FORMAT_TYPE_UBYTE:
1262                                 num = (unsigned char) va_arg(args, int);
1263                                 break;
1264                         case FORMAT_TYPE_BYTE:
1265                                 num = (signed char) va_arg(args, int);
1266                                 break;
1267                         case FORMAT_TYPE_USHORT:
1268                                 num = (unsigned short) va_arg(args, int);
1269                                 break;
1270                         case FORMAT_TYPE_SHORT:
1271                                 num = (short) va_arg(args, int);
1272                                 break;
1273                         case FORMAT_TYPE_INT:
1274                                 num = (int) va_arg(args, int);
1275                                 break;
1276                         default:
1277                                 num = va_arg(args, unsigned int);
1278                         }
1279
1280                         str = number(str, end, num, spec);
1281                 }
1282         }
1283
1284         if (size > 0) {
1285                 if (str < end)
1286                         *str = '\0';
1287                 else
1288                         end[-1] = '\0';
1289         }
1290
1291         /* the trailing null byte doesn't count towards the total */
1292         return str-buf;
1293
1294 }
1295 EXPORT_SYMBOL(vsnprintf);
1296
1297 /**
1298  * vscnprintf - Format a string and place it in a buffer
1299  * @buf: The buffer to place the result into
1300  * @size: The size of the buffer, including the trailing null space
1301  * @fmt: The format string to use
1302  * @args: Arguments for the format string
1303  *
1304  * The return value is the number of characters which have been written into
1305  * the @buf not including the trailing '\0'. If @size is <= 0 the function
1306  * returns 0.
1307  *
1308  * Call this function if you are already dealing with a va_list.
1309  * You probably want scnprintf() instead.
1310  *
1311  * See the vsnprintf() documentation for format string extensions over C99.
1312  */
1313 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1314 {
1315         int i;
1316
1317         i = vsnprintf(buf, size, fmt, args);
1318
1319         return (i >= size) ? (size - 1) : i;
1320 }
1321 EXPORT_SYMBOL(vscnprintf);
1322
1323 /**
1324  * snprintf - Format a string and place it in a buffer
1325  * @buf: The buffer to place the result into
1326  * @size: The size of the buffer, including the trailing null space
1327  * @fmt: The format string to use
1328  * @...: Arguments for the format string
1329  *
1330  * The return value is the number of characters which would be
1331  * generated for the given input, excluding the trailing null,
1332  * as per ISO C99.  If the return is greater than or equal to
1333  * @size, the resulting string is truncated.
1334  *
1335  * See the vsnprintf() documentation for format string extensions over C99.
1336  */
1337 int snprintf(char *buf, size_t size, const char *fmt, ...)
1338 {
1339         va_list args;
1340         int i;
1341
1342         va_start(args, fmt);
1343         i = vsnprintf(buf, size, fmt, args);
1344         va_end(args);
1345
1346         return i;
1347 }
1348 EXPORT_SYMBOL(snprintf);
1349
1350 /**
1351  * scnprintf - Format a string and place it in a buffer
1352  * @buf: The buffer to place the result into
1353  * @size: The size of the buffer, including the trailing null space
1354  * @fmt: The format string to use
1355  * @...: Arguments for the format string
1356  *
1357  * The return value is the number of characters written into @buf not including
1358  * the trailing '\0'. If @size is <= 0 the function returns 0.
1359  */
1360
1361 int scnprintf(char *buf, size_t size, const char *fmt, ...)
1362 {
1363         va_list args;
1364         int i;
1365
1366         va_start(args, fmt);
1367         i = vsnprintf(buf, size, fmt, args);
1368         va_end(args);
1369
1370         return (i >= size) ? (size - 1) : i;
1371 }
1372 EXPORT_SYMBOL(scnprintf);
1373
1374 /**
1375  * vsprintf - Format a string and place it in a buffer
1376  * @buf: The buffer to place the result into
1377  * @fmt: The format string to use
1378  * @args: Arguments for the format string
1379  *
1380  * The function returns the number of characters written
1381  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1382  * buffer overflows.
1383  *
1384  * Call this function if you are already dealing with a va_list.
1385  * You probably want sprintf() instead.
1386  *
1387  * See the vsnprintf() documentation for format string extensions over C99.
1388  */
1389 int vsprintf(char *buf, const char *fmt, va_list args)
1390 {
1391         return vsnprintf(buf, INT_MAX, fmt, args);
1392 }
1393 EXPORT_SYMBOL(vsprintf);
1394
1395 /**
1396  * sprintf - Format a string and place it in a buffer
1397  * @buf: The buffer to place the result into
1398  * @fmt: The format string to use
1399  * @...: Arguments for the format string
1400  *
1401  * The function returns the number of characters written
1402  * into @buf. Use snprintf() or scnprintf() in order to avoid
1403  * buffer overflows.
1404  *
1405  * See the vsnprintf() documentation for format string extensions over C99.
1406  */
1407 int sprintf(char *buf, const char *fmt, ...)
1408 {
1409         va_list args;
1410         int i;
1411
1412         va_start(args, fmt);
1413         i = vsnprintf(buf, INT_MAX, fmt, args);
1414         va_end(args);
1415
1416         return i;
1417 }
1418 EXPORT_SYMBOL(sprintf);
1419
1420 #ifdef CONFIG_BINARY_PRINTF
1421 /*
1422  * bprintf service:
1423  * vbin_printf() - VA arguments to binary data
1424  * bstr_printf() - Binary data to text string
1425  */
1426
1427 /**
1428  * vbin_printf - Parse a format string and place args' binary value in a buffer
1429  * @bin_buf: The buffer to place args' binary value
1430  * @size: The size of the buffer(by words(32bits), not characters)
1431  * @fmt: The format string to use
1432  * @args: Arguments for the format string
1433  *
1434  * The format follows C99 vsnprintf, except %n is ignored, and its argument
1435  * is skiped.
1436  *
1437  * The return value is the number of words(32bits) which would be generated for
1438  * the given input.
1439  *
1440  * NOTE:
1441  * If the return value is greater than @size, the resulting bin_buf is NOT
1442  * valid for bstr_printf().
1443  */
1444 int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1445 {
1446         struct printf_spec spec = {0};
1447         char *str, *end;
1448
1449         str = (char *)bin_buf;
1450         end = (char *)(bin_buf + size);
1451
1452 #define save_arg(type)                                                  \
1453 do {                                                                    \
1454         if (sizeof(type) == 8) {                                        \
1455                 unsigned long long value;                               \
1456                 str = PTR_ALIGN(str, sizeof(u32));                      \
1457                 value = va_arg(args, unsigned long long);               \
1458                 if (str + sizeof(type) <= end) {                        \
1459                         *(u32 *)str = *(u32 *)&value;                   \
1460                         *(u32 *)(str + 4) = *((u32 *)&value + 1);       \
1461                 }                                                       \
1462         } else {                                                        \
1463                 unsigned long value;                                    \
1464                 str = PTR_ALIGN(str, sizeof(type));                     \
1465                 value = va_arg(args, int);                              \
1466                 if (str + sizeof(type) <= end)                          \
1467                         *(typeof(type) *)str = (type)value;             \
1468         }                                                               \
1469         str += sizeof(type);                                            \
1470 } while (0)
1471
1472         while (*fmt) {
1473                 int read = format_decode(fmt, &spec);
1474
1475                 fmt += read;
1476
1477                 switch (spec.type) {
1478                 case FORMAT_TYPE_NONE:
1479                 case FORMAT_TYPE_INVALID:
1480                 case FORMAT_TYPE_PERCENT_CHAR:
1481                         break;
1482
1483                 case FORMAT_TYPE_WIDTH:
1484                 case FORMAT_TYPE_PRECISION:
1485                         save_arg(int);
1486                         break;
1487
1488                 case FORMAT_TYPE_CHAR:
1489                         save_arg(char);
1490                         break;
1491
1492                 case FORMAT_TYPE_STR: {
1493                         const char *save_str = va_arg(args, char *);
1494                         size_t len;
1495
1496                         if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1497                                         || (unsigned long)save_str < PAGE_SIZE)
1498                                 save_str = "(null)";
1499                         len = strlen(save_str) + 1;
1500                         if (str + len < end)
1501                                 memcpy(str, save_str, len);
1502                         str += len;
1503                         break;
1504                 }
1505
1506                 case FORMAT_TYPE_PTR:
1507                         save_arg(void *);
1508                         /* skip all alphanumeric pointer suffixes */
1509                         while (isalnum(*fmt))
1510                                 fmt++;
1511                         break;
1512
1513                 case FORMAT_TYPE_NRCHARS: {
1514                         /* skip %n 's argument */
1515                         int qualifier = spec.qualifier;
1516                         void *skip_arg;
1517                         if (qualifier == 'l')
1518                                 skip_arg = va_arg(args, long *);
1519                         else if (TOLOWER(qualifier) == 'z')
1520                                 skip_arg = va_arg(args, size_t *);
1521                         else
1522                                 skip_arg = va_arg(args, int *);
1523                         break;
1524                 }
1525
1526                 default:
1527                         switch (spec.type) {
1528
1529                         case FORMAT_TYPE_LONG_LONG:
1530                                 save_arg(long long);
1531                                 break;
1532                         case FORMAT_TYPE_ULONG:
1533                         case FORMAT_TYPE_LONG:
1534                                 save_arg(unsigned long);
1535                                 break;
1536                         case FORMAT_TYPE_SIZE_T:
1537                                 save_arg(size_t);
1538                                 break;
1539                         case FORMAT_TYPE_PTRDIFF:
1540                                 save_arg(ptrdiff_t);
1541                                 break;
1542                         case FORMAT_TYPE_UBYTE:
1543                         case FORMAT_TYPE_BYTE:
1544                                 save_arg(char);
1545                                 break;
1546                         case FORMAT_TYPE_USHORT:
1547                         case FORMAT_TYPE_SHORT:
1548                                 save_arg(short);
1549                                 break;
1550                         default:
1551                                 save_arg(int);
1552                         }
1553                 }
1554         }
1555
1556         return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
1557 #undef save_arg
1558 }
1559 EXPORT_SYMBOL_GPL(vbin_printf);
1560
1561 /**
1562  * bstr_printf - Format a string from binary arguments and place it in a buffer
1563  * @buf: The buffer to place the result into
1564  * @size: The size of the buffer, including the trailing null space
1565  * @fmt: The format string to use
1566  * @bin_buf: Binary arguments for the format string
1567  *
1568  * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1569  * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1570  * a binary buffer that generated by vbin_printf.
1571  *
1572  * The format follows C99 vsnprintf, but has some extensions:
1573  *  see vsnprintf comment for details.
1574  *
1575  * The return value is the number of characters which would
1576  * be generated for the given input, excluding the trailing
1577  * '\0', as per ISO C99. If you want to have the exact
1578  * number of characters written into @buf as return value
1579  * (not including the trailing '\0'), use vscnprintf(). If the
1580  * return is greater than or equal to @size, the resulting
1581  * string is truncated.
1582  */
1583 int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1584 {
1585         struct printf_spec spec = {0};
1586         char *str, *end;
1587         const char *args = (const char *)bin_buf;
1588
1589         if (WARN_ON_ONCE((int) size < 0))
1590                 return 0;
1591
1592         str = buf;
1593         end = buf + size;
1594
1595 #define get_arg(type)                                                   \
1596 ({                                                                      \
1597         typeof(type) value;                                             \
1598         if (sizeof(type) == 8) {                                        \
1599                 args = PTR_ALIGN(args, sizeof(u32));                    \
1600                 *(u32 *)&value = *(u32 *)args;                          \
1601                 *((u32 *)&value + 1) = *(u32 *)(args + 4);              \
1602         } else {                                                        \
1603                 args = PTR_ALIGN(args, sizeof(type));                   \
1604                 value = *(typeof(type) *)args;                          \
1605         }                                                               \
1606         args += sizeof(type);                                           \
1607         value;                                                          \
1608 })
1609
1610         /* Make sure end is always >= buf */
1611         if (end < buf) {
1612                 end = ((void *)-1);
1613                 size = end - buf;
1614         }
1615
1616         while (*fmt) {
1617                 const char *old_fmt = fmt;
1618                 int read = format_decode(fmt, &spec);
1619
1620                 fmt += read;
1621
1622                 switch (spec.type) {
1623                 case FORMAT_TYPE_NONE: {
1624                         int copy = read;
1625                         if (str < end) {
1626                                 if (copy > end - str)
1627                                         copy = end - str;
1628                                 memcpy(str, old_fmt, copy);
1629                         }
1630                         str += read;
1631                         break;
1632                 }
1633
1634                 case FORMAT_TYPE_WIDTH:
1635                         spec.field_width = get_arg(int);
1636                         break;
1637
1638                 case FORMAT_TYPE_PRECISION:
1639                         spec.precision = get_arg(int);
1640                         break;
1641
1642                 case FORMAT_TYPE_CHAR: {
1643                         char c;
1644
1645                         if (!(spec.flags & LEFT)) {
1646                                 while (--spec.field_width > 0) {
1647                                         if (str < end)
1648                                                 *str = ' ';
1649                                         ++str;
1650                                 }
1651                         }
1652                         c = (unsigned char) get_arg(char);
1653                         if (str < end)
1654                                 *str = c;
1655                         ++str;
1656                         while (--spec.field_width > 0) {
1657                                 if (str < end)
1658                                         *str = ' ';
1659                                 ++str;
1660                         }
1661                         break;
1662                 }
1663
1664                 case FORMAT_TYPE_STR: {
1665                         const char *str_arg = args;
1666                         args += strlen(str_arg) + 1;
1667                         str = string(str, end, (char *)str_arg, spec);
1668                         break;
1669                 }
1670
1671                 case FORMAT_TYPE_PTR:
1672                         str = pointer(fmt+1, str, end, get_arg(void *), spec);
1673                         while (isalnum(*fmt))
1674                                 fmt++;
1675                         break;
1676
1677                 case FORMAT_TYPE_PERCENT_CHAR:
1678                 case FORMAT_TYPE_INVALID:
1679                         if (str < end)
1680                                 *str = '%';
1681                         ++str;
1682                         break;
1683
1684                 case FORMAT_TYPE_NRCHARS:
1685                         /* skip */
1686                         break;
1687
1688                 default: {
1689                         unsigned long long num;
1690
1691                         switch (spec.type) {
1692
1693                         case FORMAT_TYPE_LONG_LONG:
1694                                 num = get_arg(long long);
1695                                 break;
1696                         case FORMAT_TYPE_ULONG:
1697                         case FORMAT_TYPE_LONG:
1698                                 num = get_arg(unsigned long);
1699                                 break;
1700                         case FORMAT_TYPE_SIZE_T:
1701                                 num = get_arg(size_t);
1702                                 break;
1703                         case FORMAT_TYPE_PTRDIFF:
1704                                 num = get_arg(ptrdiff_t);
1705                                 break;
1706                         case FORMAT_TYPE_UBYTE:
1707                                 num = get_arg(unsigned char);
1708                                 break;
1709                         case FORMAT_TYPE_BYTE:
1710                                 num = get_arg(signed char);
1711                                 break;
1712                         case FORMAT_TYPE_USHORT:
1713                                 num = get_arg(unsigned short);
1714                                 break;
1715                         case FORMAT_TYPE_SHORT:
1716                                 num = get_arg(short);
1717                                 break;
1718                         case FORMAT_TYPE_UINT:
1719                                 num = get_arg(unsigned int);
1720                                 break;
1721                         default:
1722                                 num = get_arg(int);
1723                         }
1724
1725                         str = number(str, end, num, spec);
1726                 } /* default: */
1727                 } /* switch(spec.type) */
1728         } /* while(*fmt) */
1729
1730         if (size > 0) {
1731                 if (str < end)
1732                         *str = '\0';
1733                 else
1734                         end[-1] = '\0';
1735         }
1736
1737 #undef get_arg
1738
1739         /* the trailing null byte doesn't count towards the total */
1740         return str - buf;
1741 }
1742 EXPORT_SYMBOL_GPL(bstr_printf);
1743
1744 /**
1745  * bprintf - Parse a format string and place args' binary value in a buffer
1746  * @bin_buf: The buffer to place args' binary value
1747  * @size: The size of the buffer(by words(32bits), not characters)
1748  * @fmt: The format string to use
1749  * @...: Arguments for the format string
1750  *
1751  * The function returns the number of words(u32) written
1752  * into @bin_buf.
1753  */
1754 int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1755 {
1756         va_list args;
1757         int ret;
1758
1759         va_start(args, fmt);
1760         ret = vbin_printf(bin_buf, size, fmt, args);
1761         va_end(args);
1762
1763         return ret;
1764 }
1765 EXPORT_SYMBOL_GPL(bprintf);
1766
1767 #endif /* CONFIG_BINARY_PRINTF */
1768
1769 static noinline char *skip_space(const char *str)
1770 {
1771         while (isspace(*str))
1772                 ++str;
1773         return (char *)str;
1774 }
1775
1776 /**
1777  * vsscanf - Unformat a buffer into a list of arguments
1778  * @buf:        input buffer
1779  * @fmt:        format of buffer
1780  * @args:       arguments
1781  */
1782 int vsscanf(const char *buf, const char *fmt, va_list args)
1783 {
1784         const char *str = buf;
1785         char *next;
1786         char digit;
1787         int num = 0;
1788         int qualifier, base, field_width;
1789         bool is_sign;
1790
1791         while (*fmt && *str) {
1792                 /* skip any white space in format */
1793                 /* white space in format matchs any amount of
1794                  * white space, including none, in the input.
1795                  */
1796                 if (isspace(*fmt)) {
1797                         fmt = skip_space(fmt);
1798                         str = skip_space(str);
1799                 }
1800
1801                 /* anything that is not a conversion must match exactly */
1802                 if (*fmt != '%' && *fmt) {
1803                         if (*fmt++ != *str++)
1804                                 break;
1805                         continue;
1806                 }
1807
1808                 if (!*fmt)
1809                         break;
1810                 ++fmt;
1811
1812                 /* skip this conversion.
1813                  * advance both strings to next white space
1814                  */
1815                 if (*fmt == '*') {
1816                         while (!isspace(*fmt) && *fmt != '%' && *fmt)
1817                                 fmt++;
1818                         while (!isspace(*str) && *str)
1819                                 str++;
1820                         continue;
1821                 }
1822
1823                 /* get field width */
1824                 field_width = -1;
1825                 if (isdigit(*fmt))
1826                         field_width = skip_atoi(&fmt);
1827
1828                 /* get conversion qualifier */
1829                 qualifier = -1;
1830                 if (*fmt == 'h' || TOLOWER(*fmt) == 'l' ||
1831                     TOLOWER(*fmt) == 'z') {
1832                         qualifier = *fmt++;
1833                         if (unlikely(qualifier == *fmt)) {
1834                                 if (qualifier == 'h') {
1835                                         qualifier = 'H';
1836                                         fmt++;
1837                                 } else if (qualifier == 'l') {
1838                                         qualifier = 'L';
1839                                         fmt++;
1840                                 }
1841                         }
1842                 }
1843
1844                 if (!*fmt || !*str)
1845                         break;
1846
1847                 base = 10;
1848                 is_sign = 0;
1849
1850                 switch (*fmt++) {
1851                 case 'c':
1852                 {
1853                         char *s = (char *)va_arg(args, char*);
1854                         if (field_width == -1)
1855                                 field_width = 1;
1856                         do {
1857                                 *s++ = *str++;
1858                         } while (--field_width > 0 && *str);
1859                         num++;
1860                 }
1861                 continue;
1862                 case 's':
1863                 {
1864                         char *s = (char *)va_arg(args, char *);
1865                         if (field_width == -1)
1866                                 field_width = INT_MAX;
1867                         /* first, skip leading white space in buffer */
1868                         str = skip_space(str);
1869
1870                         /* now copy until next white space */
1871                         while (*str && !isspace(*str) && field_width--)
1872                                 *s++ = *str++;
1873                         *s = '\0';
1874                         num++;
1875                 }
1876                 continue;
1877                 case 'n':
1878                         /* return number of characters read so far */
1879                 {
1880                         int *i = (int *)va_arg(args, int*);
1881                         *i = str - buf;
1882                 }
1883                 continue;
1884                 case 'o':
1885                         base = 8;
1886                         break;
1887                 case 'x':
1888                 case 'X':
1889                         base = 16;
1890                         break;
1891                 case 'i':
1892                         base = 0;
1893                 case 'd':
1894                         is_sign = 1;
1895                 case 'u':
1896                         break;
1897                 case '%':
1898                         /* looking for '%' in str */
1899                         if (*str++ != '%')
1900                                 return num;
1901                         continue;
1902                 default:
1903                         /* invalid format; stop here */
1904                         return num;
1905                 }
1906
1907                 /* have some sort of integer conversion.
1908                  * first, skip white space in buffer.
1909                  */
1910                 str = skip_space(str);
1911
1912                 digit = *str;
1913                 if (is_sign && digit == '-')
1914                         digit = *(str + 1);
1915
1916                 if (!digit
1917                     || (base == 16 && !isxdigit(digit))
1918                     || (base == 10 && !isdigit(digit))
1919                     || (base == 8 && (!isdigit(digit) || digit > '7'))
1920                     || (base == 0 && !isdigit(digit)))
1921                         break;
1922
1923                 switch (qualifier) {
1924                 case 'H':       /* that's 'hh' in format */
1925                         if (is_sign) {
1926                                 signed char *s = (signed char *)va_arg(args, signed char *);
1927                                 *s = (signed char)simple_strtol(str, &next, base);
1928                         } else {
1929                                 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
1930                                 *s = (unsigned char)simple_strtoul(str, &next, base);
1931                         }
1932                         break;
1933                 case 'h':
1934                         if (is_sign) {
1935                                 short *s = (short *)va_arg(args, short *);
1936                                 *s = (short)simple_strtol(str, &next, base);
1937                         } else {
1938                                 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
1939                                 *s = (unsigned short)simple_strtoul(str, &next, base);
1940                         }
1941                         break;
1942                 case 'l':
1943                         if (is_sign) {
1944                                 long *l = (long *)va_arg(args, long *);
1945                                 *l = simple_strtol(str, &next, base);
1946                         } else {
1947                                 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
1948                                 *l = simple_strtoul(str, &next, base);
1949                         }
1950                         break;
1951                 case 'L':
1952                         if (is_sign) {
1953                                 long long *l = (long long *)va_arg(args, long long *);
1954                                 *l = simple_strtoll(str, &next, base);
1955                         } else {
1956                                 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
1957                                 *l = simple_strtoull(str, &next, base);
1958                         }
1959                         break;
1960                 case 'Z':
1961                 case 'z':
1962                 {
1963                         size_t *s = (size_t *)va_arg(args, size_t *);
1964                         *s = (size_t)simple_strtoul(str, &next, base);
1965                 }
1966                 break;
1967                 default:
1968                         if (is_sign) {
1969                                 int *i = (int *)va_arg(args, int *);
1970                                 *i = (int)simple_strtol(str, &next, base);
1971                         } else {
1972                                 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
1973                                 *i = (unsigned int)simple_strtoul(str, &next, base);
1974                         }
1975                         break;
1976                 }
1977                 num++;
1978
1979                 if (!next)
1980                         break;
1981                 str = next;
1982         }
1983
1984         /*
1985          * Now we've come all the way through so either the input string or the
1986          * format ended. In the former case, there can be a %n at the current
1987          * position in the format that needs to be filled.
1988          */
1989         if (*fmt == '%' && *(fmt + 1) == 'n') {
1990                 int *p = (int *)va_arg(args, int *);
1991                 *p = str - buf;
1992         }
1993
1994         return num;
1995 }
1996 EXPORT_SYMBOL(vsscanf);
1997
1998 /**
1999  * sscanf - Unformat a buffer into a list of arguments
2000  * @buf:        input buffer
2001  * @fmt:        formatting of buffer
2002  * @...:        resulting arguments
2003  */
2004 int sscanf(const char *buf, const char *fmt, ...)
2005 {
2006         va_list args;
2007         int i;
2008
2009         va_start(args, fmt);
2010         i = vsscanf(buf, fmt, args);
2011         va_end(args);
2012
2013         return i;
2014 }
2015 EXPORT_SYMBOL(sscanf);