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  * from hush: simple_itoa() was lifted from boa-0.93.15
  12  */
  13
  14 #include <common.h>
  15 #include <charset.h>
  16 #include <efi_loader.h>
  17 #include <div64.h>
  18 #include <hexdump.h>
  19 #include <stdarg.h>
  20 #include <linux/ctype.h>
  21 #include <linux/err.h>
  22 #include <linux/types.h>
  23 #include <linux/string.h>
  24
  25 #define noinline __attribute__((noinline))
  26
  27 /* we use this so that we can do without the ctype library */
  28 #define is_digit(c)     ((c) >= '0' && (c) <= '9')
  29
  30 static int skip_atoi(const char **s)
  31 {
  32         int i = 0;
  33
  34         while (is_digit(**s))
  35                 i = i * 10 + *((*s)++) - '0';
  36
  37         return i;
  38 }
  39
  40 /* Decimal conversion is by far the most typical, and is used
  41  * for /proc and /sys data. This directly impacts e.g. top performance
  42  * with many processes running. We optimize it for speed
  43  * using code from
  44  * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
  45  * (with permission from the author, Douglas W. Jones). */
  46
  47 /* Formats correctly any integer in [0,99999].
  48  * Outputs from one to five digits depending on input.
  49  * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
  50 static char *put_dec_trunc(char *buf, unsigned q)
  51 {
  52         unsigned d3, d2, d1, d0;
  53         d1 = (q>>4) & 0xf;
  54         d2 = (q>>8) & 0xf;
  55         d3 = (q>>12);
  56
  57         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
  58         q = (d0 * 0xcd) >> 11;
  59         d0 = d0 - 10*q;
  60         *buf++ = d0 + '0'; /* least significant digit */
  61         d1 = q + 9*d3 + 5*d2 + d1;
  62         if (d1 != 0) {
  63                 q = (d1 * 0xcd) >> 11;
  64                 d1 = d1 - 10*q;
  65                 *buf++ = d1 + '0'; /* next digit */
  66
  67                 d2 = q + 2*d2;
  68                 if ((d2 != 0) || (d3 != 0)) {
  69                         q = (d2 * 0xd) >> 7;
  70                         d2 = d2 - 10*q;
  71                         *buf++ = d2 + '0'; /* next digit */
  72
  73                         d3 = q + 4*d3;
  74                         if (d3 != 0) {
  75                                 q = (d3 * 0xcd) >> 11;
  76                                 d3 = d3 - 10*q;
  77                                 *buf++ = d3 + '0';  /* next digit */
  78                                 if (q != 0)
  79                                         *buf++ = q + '0'; /* most sign. digit */
  80                         }
  81                 }
  82         }
  83         return buf;
  84 }
  85 /* Same with if's removed. Always emits five digits */
  86 static char *put_dec_full(char *buf, unsigned q)
  87 {
  88         /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
  89         /* but anyway, gcc produces better code with full-sized ints */
  90         unsigned d3, d2, d1, d0;
  91         d1 = (q>>4) & 0xf;
  92         d2 = (q>>8) & 0xf;
  93         d3 = (q>>12);
  94
  95         /*
  96          * Possible ways to approx. divide by 10
  97          * gcc -O2 replaces multiply with shifts and adds
  98          * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
  99          * (x * 0x67) >> 10:  1100111
 100          * (x * 0x34) >> 9:    110100 - same
 101          * (x * 0x1a) >> 8:     11010 - same
 102          * (x * 0x0d) >> 7:      1101 - same, shortest code (on i386)
 103          */
 104
 105         d0 = 6*(d3 + d2 + d1) + (q & 0xf);
 106         q = (d0 * 0xcd) >> 11;
 107         d0 = d0 - 10*q;
 108         *buf++ = d0 + '0';
 109         d1 = q + 9*d3 + 5*d2 + d1;
 110                 q = (d1 * 0xcd) >> 11;
 111                 d1 = d1 - 10*q;
 112                 *buf++ = d1 + '0';
 113
 114                 d2 = q + 2*d2;
 115                         q = (d2 * 0xd) >> 7;
 116                         d2 = d2 - 10*q;
 117                         *buf++ = d2 + '0';
 118
 119                         d3 = q + 4*d3;
 120                                 q = (d3 * 0xcd) >> 11; /* - shorter code */
 121                                 /* q = (d3 * 0x67) >> 10; - would also work */
 122                                 d3 = d3 - 10*q;
 123                                 *buf++ = d3 + '0';
 124                                         *buf++ = q + '0';
 125         return buf;
 126 }
 127 /* No inlining helps gcc to use registers better */
 128 static noinline char *put_dec(char *buf, uint64_t num)
 129 {
 130         while (1) {
 131                 unsigned rem;
 132                 if (num < 100000)
 133                         return put_dec_trunc(buf, num);
 134                 rem = do_div(num, 100000);
 135                 buf = put_dec_full(buf, rem);
 136         }
 137 }
 138
 139 #define ZEROPAD 1               /* pad with zero */
 140 #define SIGN    2               /* unsigned/signed long */
 141 #define PLUS    4               /* show plus */
 142 #define SPACE   8               /* space if plus */
 143 #define LEFT    16              /* left justified */
 144 #define SMALL   32              /* Must be 32 == 0x20 */
 145 #define SPECIAL 64              /* 0x */
 146
 147 /*
 148  * Macro to add a new character to our output string, but only if it will
 149  * fit. The macro moves to the next character position in the output string.
 150  */
 151 #define ADDCH(str, ch) do { \
 152         if ((str) < end) \
 153                 *(str) = (ch); \
 154         ++str; \
 155         } while (0)
 156
 157 static char *number(char *buf, char *end, u64 num,
 158                 int base, int size, int precision, int type)
 159 {
 160         /* we are called with base 8, 10 or 16, only, thus don't need "G..."  */
 161         static const char digits[16] = "0123456789ABCDEF";
 162
 163         char tmp[66];
 164         char sign;
 165         char locase;
 166         int need_pfx = ((type & SPECIAL) && base != 10);
 167         int i;
 168
 169         /* locase = 0 or 0x20. ORing digits or letters with 'locase'
 170          * produces same digits or (maybe lowercased) letters */
 171         locase = (type & SMALL);
 172         if (type & LEFT)
 173                 type &= ~ZEROPAD;
 174         sign = 0;
 175         if (type & SIGN) {
 176                 if ((s64) num < 0) {
 177                         sign = '-';
 178                         num = -(s64) num;
 179                         size--;
 180                 } else if (type & PLUS) {
 181                         sign = '+';
 182                         size--;
 183                 } else if (type & SPACE) {
 184                         sign = ' ';
 185                         size--;
 186                 }
 187         }
 188         if (need_pfx) {
 189                 size--;
 190                 if (base == 16)
 191                         size--;
 192         }
 193
 194         /* generate full string in tmp[], in reverse order */
 195         i = 0;
 196         if (num == 0)
 197                 tmp[i++] = '0';
 198         /* Generic code, for any base:
 199         else do {
 200                 tmp[i++] = (digits[do_div(num,base)] | locase);
 201         } while (num != 0);
 202         */
 203         else if (base != 10) { /* 8 or 16 */
 204                 int mask = base - 1;
 205                 int shift = 3;
 206
 207                 if (base == 16)
 208                         shift = 4;
 209
 210                 do {
 211                         tmp[i++] = (digits[((unsigned char)num) & mask]
 212                                         | locase);
 213                         num >>= shift;
 214                 } while (num);
 215         } else { /* base 10 */
 216                 i = put_dec(tmp, num) - tmp;
 217         }
 218
 219         /* printing 100 using %2d gives "100", not "00" */
 220         if (i > precision)
 221                 precision = i;
 222         /* leading space padding */
 223         size -= precision;
 224         if (!(type & (ZEROPAD + LEFT))) {
 225                 while (--size >= 0)
 226                         ADDCH(buf, ' ');
 227         }
 228         /* sign */
 229         if (sign)
 230                 ADDCH(buf, sign);
 231         /* "0x" / "0" prefix */
 232         if (need_pfx) {
 233                 ADDCH(buf, '0');
 234                 if (base == 16)
 235                         ADDCH(buf, 'X' | locase);
 236         }
 237         /* zero or space padding */
 238         if (!(type & LEFT)) {
 239                 char c = (type & ZEROPAD) ? '0' : ' ';
 240
 241                 while (--size >= 0)
 242                         ADDCH(buf, c);
 243         }
 244         /* hmm even more zero padding? */
 245         while (i <= --precision)
 246                 ADDCH(buf, '0');
 247         /* actual digits of result */
 248         while (--i >= 0)
 249                 ADDCH(buf, tmp[i]);
 250         /* trailing space padding */
 251         while (--size >= 0)
 252                 ADDCH(buf, ' ');
 253         return buf;
 254 }
 255
 256 static char *string(char *buf, char *end, char *s, int field_width,
 257                 int precision, int flags)
 258 {
 259         int len, i;
 260
 261         if (s == NULL)
 262                 s = "<NULL>";
 263
 264         len = strnlen(s, precision);
 265
 266         if (!(flags & LEFT))
 267                 while (len < field_width--)
 268                         ADDCH(buf, ' ');
 269         for (i = 0; i < len; ++i)
 270                 ADDCH(buf, *s++);
 271         while (len < field_width--)
 272                 ADDCH(buf, ' ');
 273         return buf;
 274 }
 275
 276 /* U-Boot uses UTF-16 strings in the EFI context only. */
 277 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
 278 static char *string16(char *buf, char *end, u16 *s, int field_width,
 279                 int precision, int flags)
 280 {
 281         const u16 *str = s ? s : L"<NULL>";
 282         ssize_t i, len = utf16_strnlen(str, precision);
 283
 284         if (!(flags & LEFT))
 285                 for (; len < field_width; --field_width)
 286                         ADDCH(buf, ' ');
 287         for (i = 0; i < len && buf + utf16_utf8_strnlen(str, 1) <= end; ++i) {
 288                 s32 s = utf16_get(&str);
 289
 290                 if (s < 0)
 291                         s = '?';
 292                 utf8_put(s, &buf);
 293         }
 294         for (; len < field_width; --field_width)
 295                 ADDCH(buf, ' ');
 296         return buf;
 297 }
 298
 299 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
 300                                 int precision, int flags)
 301 {
 302         u16 *str;
 303
 304         /* If dp == NULL output the string '<NULL>' */
 305         if (!dp)
 306                 return string16(buf, end, dp, field_width, precision, flags);
 307
 308         str = efi_dp_str((struct efi_device_path *)dp);
 309         if (!str)
 310                 return ERR_PTR(-ENOMEM);
 311
 312         buf = string16(buf, end, str, field_width, precision, flags);
 313         efi_free_pool(str);
 314         return buf;
 315 }
 316 #endif
 317
 318 #ifdef CONFIG_CMD_NET
 319 static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
 320                                 int precision, int flags)
 321 {
 322         /* (6 * 2 hex digits), 5 colons and trailing zero */
 323         char mac_addr[6 * 3];
 324         char *p = mac_addr;
 325         int i;
 326
 327         for (i = 0; i < 6; i++) {
 328                 p = hex_byte_pack(p, addr[i]);
 329                 if (!(flags & SPECIAL) && i != 5)
 330                         *p++ = ':';
 331         }
 332         *p = '\0';
 333
 334         return string(buf, end, mac_addr, field_width, precision,
 335                       flags & ~SPECIAL);
 336 }
 337
 338 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
 339                          int precision, int flags)
 340 {
 341         /* (8 * 4 hex digits), 7 colons and trailing zero */
 342         char ip6_addr[8 * 5];
 343         char *p = ip6_addr;
 344         int i;
 345
 346         for (i = 0; i < 8; i++) {
 347                 p = hex_byte_pack(p, addr[2 * i]);
 348                 p = hex_byte_pack(p, addr[2 * i + 1]);
 349                 if (!(flags & SPECIAL) && i != 7)
 350                         *p++ = ':';
 351         }
 352         *p = '\0';
 353
 354         return string(buf, end, ip6_addr, field_width, precision,
 355                       flags & ~SPECIAL);
 356 }
 357
 358 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
 359                          int precision, int flags)
 360 {
 361         /* (4 * 3 decimal digits), 3 dots and trailing zero */
 362         char ip4_addr[4 * 4];
 363         char temp[3];   /* hold each IP quad in reverse order */
 364         char *p = ip4_addr;
 365         int i, digits;
 366
 367         for (i = 0; i < 4; i++) {
 368                 digits = put_dec_trunc(temp, addr[i]) - temp;
 369                 /* reverse the digits in the quad */
 370                 while (digits--)
 371                         *p++ = temp[digits];
 372                 if (i != 3)
 373                         *p++ = '.';
 374         }
 375         *p = '\0';
 376
 377         return string(buf, end, ip4_addr, field_width, precision,
 378                       flags & ~SPECIAL);
 379 }
 380 #endif
 381
 382 #ifdef CONFIG_LIB_UUID
 383 /*
 384  * This works (roughly) the same way as linux's, but we currently always
 385  * print lower-case (ie. we just keep %pUB and %pUL for compat with linux),
 386  * mostly just because that is what uuid_bin_to_str() supports.
 387  *
 388  *   %pUb:   01020304-0506-0708-090a-0b0c0d0e0f10
 389  *   %pUl:   04030201-0605-0807-090a-0b0c0d0e0f10
 390  */
 391 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
 392                          int precision, int flags, const char *fmt)
 393 {
 394         char uuid[UUID_STR_LEN + 1];
 395         int str_format = UUID_STR_FORMAT_STD;
 396
 397         switch (*(++fmt)) {
 398         case 'L':
 399         case 'l':
 400                 str_format = UUID_STR_FORMAT_GUID;
 401                 break;
 402         case 'B':
 403         case 'b':
 404                 /* this is the default */
 405                 break;
 406         default:
 407                 break;
 408         }
 409
 410         if (addr)
 411                 uuid_bin_to_str(addr, uuid, str_format);
 412         else
 413                 strcpy(uuid, "<NULL>");
 414
 415         return string(buf, end, uuid, field_width, precision, flags);
 416 }
 417 #endif
 418
 419 /*
 420  * Show a '%p' thing.  A kernel extension is that the '%p' is followed
 421  * by an extra set of alphanumeric characters that are extended format
 422  * specifiers.
 423  *
 424  * Right now we handle:
 425  *
 426  * - 'M' For a 6-byte MAC address, it prints the address in the
 427  *       usual colon-separated hex notation
 428  * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
 429  *       decimal for v4 and colon separated network-order 16 bit hex for v6)
 430  * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
 431  *       currently the same
 432  *
 433  * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
 434  * function pointers are really function descriptors, which contain a
 435  * pointer to the real address.
 436  */
 437 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
 438                 int field_width, int precision, int flags)
 439 {
 440         u64 num = (uintptr_t)ptr;
 441
 442         /*
 443          * Being a boot loader, we explicitly allow pointers to
 444          * (physical) address null.
 445          */
 446 #if 0
 447         if (!ptr)
 448                 return string(buf, end, "(null)", field_width, precision,
 449                               flags);
 450 #endif
 451
 452         switch (*fmt) {
 453 /* Device paths only exist in the EFI context. */
 454 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
 455         case 'D':
 456                 return device_path_string(buf, end, ptr, field_width,
 457                                           precision, flags);
 458 #endif
 459         case 'a':
 460                 flags |= SPECIAL | ZEROPAD;
 461
 462                 switch (fmt[1]) {
 463                 case 'p':
 464                 default:
 465                         field_width = sizeof(phys_addr_t) * 2 + 2;
 466                         num = *(phys_addr_t *)ptr;
 467                         break;
 468                 }
 469                 break;
 470 #ifdef CONFIG_CMD_NET
 471         case 'm':
 472                 flags |= SPECIAL;
 473                 /* Fallthrough */
 474         case 'M':
 475                 return mac_address_string(buf, end, ptr, field_width,
 476                                           precision, flags);
 477         case 'i':
 478                 flags |= SPECIAL;
 479                 /* Fallthrough */
 480         case 'I':
 481                 if (fmt[1] == '6')
 482                         return ip6_addr_string(buf, end, ptr, field_width,
 483                                                precision, flags);
 484                 if (fmt[1] == '4')
 485                         return ip4_addr_string(buf, end, ptr, field_width,
 486                                                precision, flags);
 487                 flags &= ~SPECIAL;
 488                 break;
 489 #endif
 490 #ifdef CONFIG_LIB_UUID
 491         case 'U':
 492                 return uuid_string(buf, end, ptr, field_width, precision,
 493                                    flags, fmt);
 494 #endif
 495         default:
 496                 break;
 497         }
 498         flags |= SMALL;
 499         if (field_width == -1) {
 500                 field_width = 2*sizeof(void *);
 501                 flags |= ZEROPAD;
 502         }
 503         return number(buf, end, num, 16, field_width, precision, flags);
 504 }
 505
 506 static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
 507                               va_list args)
 508 {
 509         u64 num;
 510         int base;
 511         char *str;
 512
 513         int flags;              /* flags to number() */
 514
 515         int field_width;        /* width of output field */
 516         int precision;          /* min. # of digits for integers; max
 517                                    number of chars for from string */
 518         int qualifier;          /* 'h', 'l', or 'L' for integer fields */
 519                                 /* 'z' support added 23/7/1999 S.H.    */
 520                                 /* 'z' changed to 'Z' --davidm 1/25/99 */
 521                                 /* 't' added for ptrdiff_t */
 522         char *end = buf + size;
 523
 524         /* Make sure end is always >= buf - do we want this in U-Boot? */
 525         if (end < buf) {
 526                 end = ((void *)-1);
 527                 size = end - buf;
 528         }
 529         str = buf;
 530
 531         for (; *fmt ; ++fmt) {
 532                 if (*fmt != '%') {
 533                         ADDCH(str, *fmt);
 534                         continue;
 535                 }
 536
 537                 /* process flags */
 538                 flags = 0;
 539 repeat:
 540                         ++fmt;          /* this also skips first '%' */
 541                         switch (*fmt) {
 542                         case '-':
 543                                 flags |= LEFT;
 544                                 goto repeat;
 545                         case '+':
 546                                 flags |= PLUS;
 547                                 goto repeat;
 548                         case ' ':
 549                                 flags |= SPACE;
 550                                 goto repeat;
 551                         case '#':
 552                                 flags |= SPECIAL;
 553                                 goto repeat;
 554                         case '0':
 555                                 flags |= ZEROPAD;
 556                                 goto repeat;
 557                         }
 558
 559                 /* get field width */
 560                 field_width = -1;
 561                 if (is_digit(*fmt))
 562                         field_width = skip_atoi(&fmt);
 563                 else if (*fmt == '*') {
 564                         ++fmt;
 565                         /* it's the next argument */
 566                         field_width = va_arg(args, int);
 567                         if (field_width < 0) {
 568                                 field_width = -field_width;
 569                                 flags |= LEFT;
 570                         }
 571                 }
 572
 573                 /* get the precision */
 574                 precision = -1;
 575                 if (*fmt == '.') {
 576                         ++fmt;
 577                         if (is_digit(*fmt))
 578                                 precision = skip_atoi(&fmt);
 579                         else if (*fmt == '*') {
 580                                 ++fmt;
 581                                 /* it's the next argument */
 582                                 precision = va_arg(args, int);
 583                         }
 584                         if (precision < 0)
 585                                 precision = 0;
 586                 }
 587
 588                 /* get the conversion qualifier */
 589                 qualifier = -1;
 590                 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
 591                     *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
 592                         qualifier = *fmt;
 593                         ++fmt;
 594                         if (qualifier == 'l' && *fmt == 'l') {
 595                                 qualifier = 'L';
 596                                 ++fmt;
 597                         }
 598                 }
 599
 600                 /* default base */
 601                 base = 10;
 602
 603                 switch (*fmt) {
 604                 case 'c':
 605                         if (!(flags & LEFT)) {
 606                                 while (--field_width > 0)
 607                                         ADDCH(str, ' ');
 608                         }
 609                         ADDCH(str, (unsigned char) va_arg(args, int));
 610                         while (--field_width > 0)
 611                                 ADDCH(str, ' ');
 612                         continue;
 613
 614                 case 's':
 615 /* U-Boot uses UTF-16 strings in the EFI context only. */
 616 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
 617                         if (qualifier == 'l') {
 618                                 str = string16(str, end, va_arg(args, u16 *),
 619                                                field_width, precision, flags);
 620                         } else
 621 #endif
 622                         {
 623                                 str = string(str, end, va_arg(args, char *),
 624                                              field_width, precision, flags);
 625                         }
 626                         continue;
 627
 628                 case 'p':
 629                         str = pointer(fmt + 1, str, end,
 630                                         va_arg(args, void *),
 631                                         field_width, precision, flags);
 632                         if (IS_ERR(str))
 633                                 return PTR_ERR(str);
 634                         /* Skip all alphanumeric pointer suffixes */
 635                         while (isalnum(fmt[1]))
 636                                 fmt++;
 637                         continue;
 638
 639                 case 'n':
 640                         if (qualifier == 'l') {
 641                                 long *ip = va_arg(args, long *);
 642                                 *ip = (str - buf);
 643                         } else {
 644                                 int *ip = va_arg(args, int *);
 645                                 *ip = (str - buf);
 646                         }
 647                         continue;
 648
 649                 case '%':
 650                         ADDCH(str, '%');
 651                         continue;
 652
 653                 /* integer number formats - set up the flags and "break" */
 654                 case 'o':
 655                         base = 8;
 656                         break;
 657
 658                 case 'x':
 659                         flags |= SMALL;
 660                 case 'X':
 661                         base = 16;
 662                         break;
 663
 664                 case 'd':
 665                 case 'i':
 666                         flags |= SIGN;
 667                 case 'u':
 668                         break;
 669
 670                 default:
 671                         ADDCH(str, '%');
 672                         if (*fmt)
 673                                 ADDCH(str, *fmt);
 674                         else
 675                                 --fmt;
 676                         continue;
 677                 }
 678                 if (qualifier == 'L')  /* "quad" for 64 bit variables */
 679                         num = va_arg(args, unsigned long long);
 680                 else if (qualifier == 'l') {
 681                         num = va_arg(args, unsigned long);
 682                         if (flags & SIGN)
 683                                 num = (signed long) num;
 684                 } else if (qualifier == 'Z' || qualifier == 'z') {
 685                         num = va_arg(args, size_t);
 686                 } else if (qualifier == 't') {
 687                         num = va_arg(args, ptrdiff_t);
 688                 } else if (qualifier == 'h') {
 689                         num = (unsigned short) va_arg(args, int);
 690                         if (flags & SIGN)
 691                                 num = (signed short) num;
 692                 } else {
 693                         num = va_arg(args, unsigned int);
 694                         if (flags & SIGN)
 695                                 num = (signed int) num;
 696                 }
 697                 str = number(str, end, num, base, field_width, precision,
 698                              flags);
 699         }
 700
 701         if (size > 0) {
 702                 ADDCH(str, '\0');
 703                 if (str > end)
 704                         end[-1] = '\0';
 705                 --str;
 706         }
 707         /* the trailing null byte doesn't count towards the total */
 708         return str - buf;
 709 }
 710
 711 int vsnprintf(char *buf, size_t size, const char *fmt,
 712                               va_list args)
 713 {
 714         return vsnprintf_internal(buf, size, fmt, args);
 715 }
 716
 717 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
 718 {
 719         int i;
 720
 721         i = vsnprintf(buf, size, fmt, args);
 722
 723         if (likely(i < size))
 724                 return i;
 725         if (size != 0)
 726                 return size - 1;
 727         return 0;
 728 }
 729
 730 int snprintf(char *buf, size_t size, const char *fmt, ...)
 731 {
 732         va_list args;
 733         int i;
 734
 735         va_start(args, fmt);
 736         i = vsnprintf(buf, size, fmt, args);
 737         va_end(args);
 738
 739         return i;
 740 }
 741
 742 int scnprintf(char *buf, size_t size, const char *fmt, ...)
 743 {
 744         va_list args;
 745         int i;
 746
 747         va_start(args, fmt);
 748         i = vscnprintf(buf, size, fmt, args);
 749         va_end(args);
 750
 751         return i;
 752 }
 753
 754 /**
 755  * Format a string and place it in a buffer (va_list version)
 756  *
 757  * @param buf   The buffer to place the result into
 758  * @param fmt   The format string to use
 759  * @param args  Arguments for the format string
 760  *
 761  * The function returns the number of characters written
 762  * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
 763  * buffer overflows.
 764  *
 765  * If you're not already dealing with a va_list consider using sprintf().
 766  */
 767 int vsprintf(char *buf, const char *fmt, va_list args)
 768 {
 769         return vsnprintf_internal(buf, INT_MAX, fmt, args);
 770 }
 771
 772 int sprintf(char *buf, const char *fmt, ...)
 773 {
 774         va_list args;
 775         int i;
 776
 777         va_start(args, fmt);
 778         i = vsprintf(buf, fmt, args);
 779         va_end(args);
 780         return i;
 781 }
 782
 783 #if CONFIG_IS_ENABLED(PRINTF)
 784 int printf(const char *fmt, ...)
 785 {
 786         va_list args;
 787         uint i;
 788         char printbuffer[CONFIG_SYS_PBSIZE];
 789
 790         va_start(args, fmt);
 791
 792         /*
 793          * For this to work, printbuffer must be larger than
 794          * anything we ever want to print.
 795          */
 796         i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
 797         va_end(args);
 798
 799         /* Handle error */
 800         if (i <= 0)
 801                 return i;
 802         /* Print the string */
 803         puts(printbuffer);
 804         return i;
 805 }
 806
 807 int vprintf(const char *fmt, va_list args)
 808 {
 809         uint i;
 810         char printbuffer[CONFIG_SYS_PBSIZE];
 811
 812         /*
 813          * For this to work, printbuffer must be larger than
 814          * anything we ever want to print.
 815          */
 816         i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
 817
 818         /* Handle error */
 819         if (i <= 0)
 820                 return i;
 821         /* Print the string */
 822         puts(printbuffer);
 823         return i;
 824 }
 825 #endif
 826
 827 char *simple_itoa(ulong i)
 828 {
 829         /* 21 digits plus null terminator, good for 64-bit or smaller ints */
 830         static char local[22];
 831         char *p = &local[21];
 832
 833         *p-- = '\0';
 834         do {
 835                 *p-- = '0' + i % 10;
 836                 i /= 10;
 837         } while (i > 0);
 838         return p + 1;
 839 }
 840
 841 /* We don't seem to have %'d in U-Boot */
 842 void print_grouped_ull(unsigned long long int_val, int digits)
 843 {
 844         char str[21], *s;
 845         int grab = 3;
 846
 847         digits = (digits + 2) / 3;
 848         sprintf(str, "%*llu", digits * 3, int_val);
 849         for (s = str; *s; s += grab) {
 850                 if (s != str)
 851                         putc(s[-1] != ' ' ? ',' : ' ');
 852                 printf("%.*s", grab, s);
 853                 grab = 3;
 854         }
 855 }
 856
 857 bool str2off(const char *p, loff_t *num)
 858 {
 859         char *endptr;
 860
 861         *num = simple_strtoull(p, &endptr, 16);
 862         return *p != '\0' && *endptr == '\0';
 863 }
 864
 865 bool str2long(const char *p, ulong *num)
 866 {
 867         char *endptr;
 868
 869         *num = simple_strtoul(p, &endptr, 16);
 870         return *p != '\0' && *endptr == '\0';
 871 }