4 * Copyright (C) 1991, 1992 Linus Torvalds
7 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
11 * from hush: simple_itoa() was lifted from boa-0.93.15
16 #include <efi_loader.h>
20 #include <linux/ctype.h>
21 #include <linux/err.h>
22 #include <linux/types.h>
23 #include <linux/string.h>
25 #define noinline __attribute__((noinline))
27 /* we use this so that we can do without the ctype library */
28 #define is_digit(c) ((c) >= '0' && (c) <= '9')
30 static int skip_atoi(const char **s)
35 i = i * 10 + *((*s)++) - '0';
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
44 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
45 * (with permission from the author, Douglas W. Jones). */
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)
52 unsigned d3, d2, d1, d0;
57 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
58 q = (d0 * 0xcd) >> 11;
60 *buf++ = d0 + '0'; /* least significant digit */
61 d1 = q + 9*d3 + 5*d2 + d1;
63 q = (d1 * 0xcd) >> 11;
65 *buf++ = d1 + '0'; /* next digit */
68 if ((d2 != 0) || (d3 != 0)) {
71 *buf++ = d2 + '0'; /* next digit */
75 q = (d3 * 0xcd) >> 11;
77 *buf++ = d3 + '0'; /* next digit */
79 *buf++ = q + '0'; /* most sign. digit */
85 /* Same with if's removed. Always emits five digits */
86 static char *put_dec_full(char *buf, unsigned q)
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;
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)
105 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
106 q = (d0 * 0xcd) >> 11;
109 d1 = q + 9*d3 + 5*d2 + d1;
110 q = (d1 * 0xcd) >> 11;
120 q = (d3 * 0xcd) >> 11; /* - shorter code */
121 /* q = (d3 * 0x67) >> 10; - would also work */
127 /* No inlining helps gcc to use registers better */
128 static noinline char *put_dec(char *buf, uint64_t num)
133 return put_dec_trunc(buf, num);
134 rem = do_div(num, 100000);
135 buf = put_dec_full(buf, rem);
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 */
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.
151 #define ADDCH(str, ch) do { \
157 static char *number(char *buf, char *end, u64 num,
158 int base, int size, int precision, int type)
160 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
161 static const char digits[16] = "0123456789ABCDEF";
166 int need_pfx = ((type & SPECIAL) && base != 10);
169 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
170 * produces same digits or (maybe lowercased) letters */
171 locase = (type & SMALL);
180 } else if (type & PLUS) {
183 } else if (type & SPACE) {
194 /* generate full string in tmp[], in reverse order */
198 /* Generic code, for any base:
200 tmp[i++] = (digits[do_div(num,base)] | locase);
203 else if (base != 10) { /* 8 or 16 */
211 tmp[i++] = (digits[((unsigned char)num) & mask]
215 } else { /* base 10 */
216 i = put_dec(tmp, num) - tmp;
219 /* printing 100 using %2d gives "100", not "00" */
222 /* leading space padding */
224 if (!(type & (ZEROPAD + LEFT))) {
231 /* "0x" / "0" prefix */
235 ADDCH(buf, 'X' | locase);
237 /* zero or space padding */
238 if (!(type & LEFT)) {
239 char c = (type & ZEROPAD) ? '0' : ' ';
244 /* hmm even more zero padding? */
245 while (i <= --precision)
247 /* actual digits of result */
250 /* trailing space padding */
256 static char *string(char *buf, char *end, char *s, int field_width,
257 int precision, int flags)
264 len = strnlen(s, precision);
267 while (len < field_width--)
269 for (i = 0; i < len; ++i)
271 while (len < field_width--)
276 static char *string16(char *buf, char *end, u16 *s, int field_width,
277 int precision, int flags)
279 u16 *str = s ? s : L"<NULL>";
280 int utf16_len = utf16_strnlen(str, precision);
281 u8 utf8[utf16_len * MAX_UTF8_PER_UTF16];
284 utf8_len = utf16_to_utf8(utf8, str, utf16_len) - utf8;
287 while (utf8_len < field_width--)
289 for (i = 0; i < utf8_len; ++i)
291 while (utf8_len < field_width--)
296 #if defined(CONFIG_EFI_LOADER) && \
297 !defined(CONFIG_SPL_BUILD) && !defined(API_BUILD)
298 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
299 int precision, int flags)
303 /* If dp == NULL output the string '<NULL>' */
305 return string16(buf, end, dp, field_width, precision, flags);
307 str = efi_dp_str((struct efi_device_path *)dp);
309 return ERR_PTR(-ENOMEM);
311 buf = string16(buf, end, str, field_width, precision, flags);
317 #ifdef CONFIG_CMD_NET
318 static const char hex_asc[] = "0123456789abcdef";
319 #define hex_asc_lo(x) hex_asc[((x) & 0x0f)]
320 #define hex_asc_hi(x) hex_asc[((x) & 0xf0) >> 4]
322 static inline char *pack_hex_byte(char *buf, u8 byte)
324 *buf++ = hex_asc_hi(byte);
325 *buf++ = hex_asc_lo(byte);
329 static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
330 int precision, int flags)
332 /* (6 * 2 hex digits), 5 colons and trailing zero */
333 char mac_addr[6 * 3];
337 for (i = 0; i < 6; i++) {
338 p = pack_hex_byte(p, addr[i]);
339 if (!(flags & SPECIAL) && i != 5)
344 return string(buf, end, mac_addr, field_width, precision,
348 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
349 int precision, int flags)
351 /* (8 * 4 hex digits), 7 colons and trailing zero */
352 char ip6_addr[8 * 5];
356 for (i = 0; i < 8; i++) {
357 p = pack_hex_byte(p, addr[2 * i]);
358 p = pack_hex_byte(p, addr[2 * i + 1]);
359 if (!(flags & SPECIAL) && i != 7)
364 return string(buf, end, ip6_addr, field_width, precision,
368 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
369 int precision, int flags)
371 /* (4 * 3 decimal digits), 3 dots and trailing zero */
372 char ip4_addr[4 * 4];
373 char temp[3]; /* hold each IP quad in reverse order */
377 for (i = 0; i < 4; i++) {
378 digits = put_dec_trunc(temp, addr[i]) - temp;
379 /* reverse the digits in the quad */
387 return string(buf, end, ip4_addr, field_width, precision,
392 #ifdef CONFIG_LIB_UUID
394 * This works (roughly) the same way as linux's, but we currently always
395 * print lower-case (ie. we just keep %pUB and %pUL for compat with linux),
396 * mostly just because that is what uuid_bin_to_str() supports.
398 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
399 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
401 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
402 int precision, int flags, const char *fmt)
404 char uuid[UUID_STR_LEN + 1];
405 int str_format = UUID_STR_FORMAT_STD;
410 str_format = UUID_STR_FORMAT_GUID;
414 /* this is the default */
420 uuid_bin_to_str(addr, uuid, str_format);
422 return string(buf, end, uuid, field_width, precision, flags);
427 * Show a '%p' thing. A kernel extension is that the '%p' is followed
428 * by an extra set of alphanumeric characters that are extended format
431 * Right now we handle:
433 * - 'M' For a 6-byte MAC address, it prints the address in the
434 * usual colon-separated hex notation
435 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
436 * decimal for v4 and colon separated network-order 16 bit hex for v6)
437 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
440 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
441 * function pointers are really function descriptors, which contain a
442 * pointer to the real address.
444 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
445 int field_width, int precision, int flags)
447 u64 num = (uintptr_t)ptr;
450 * Being a boot loader, we explicitly allow pointers to
451 * (physical) address null.
455 return string(buf, end, "(null)", field_width, precision,
460 #if defined(CONFIG_EFI_LOADER) && \
461 !defined(CONFIG_SPL_BUILD) && !defined(API_BUILD)
463 return device_path_string(buf, end, ptr, field_width,
466 #ifdef CONFIG_CMD_NET
468 flags |= SPECIAL | ZEROPAD;
473 field_width = sizeof(phys_addr_t) * 2 + 2;
474 num = *(phys_addr_t *)ptr;
482 return mac_address_string(buf, end, ptr, field_width,
489 return ip6_addr_string(buf, end, ptr, field_width,
492 return ip4_addr_string(buf, end, ptr, field_width,
497 #ifdef CONFIG_LIB_UUID
499 return uuid_string(buf, end, ptr, field_width, precision,
506 if (field_width == -1) {
507 field_width = 2*sizeof(void *);
510 return number(buf, end, num, 16, field_width, precision, flags);
513 static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
520 int flags; /* flags to number() */
522 int field_width; /* width of output field */
523 int precision; /* min. # of digits for integers; max
524 number of chars for from string */
525 int qualifier; /* 'h', 'l', or 'L' for integer fields */
526 /* 'z' support added 23/7/1999 S.H. */
527 /* 'z' changed to 'Z' --davidm 1/25/99 */
528 /* 't' added for ptrdiff_t */
529 char *end = buf + size;
531 /* Make sure end is always >= buf - do we want this in U-Boot? */
538 for (; *fmt ; ++fmt) {
547 ++fmt; /* this also skips first '%' */
566 /* get field width */
569 field_width = skip_atoi(&fmt);
570 else if (*fmt == '*') {
572 /* it's the next argument */
573 field_width = va_arg(args, int);
574 if (field_width < 0) {
575 field_width = -field_width;
580 /* get the precision */
585 precision = skip_atoi(&fmt);
586 else if (*fmt == '*') {
588 /* it's the next argument */
589 precision = va_arg(args, int);
595 /* get the conversion qualifier */
597 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
598 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
601 if (qualifier == 'l' && *fmt == 'l') {
612 if (!(flags & LEFT)) {
613 while (--field_width > 0)
616 ADDCH(str, (unsigned char) va_arg(args, int));
617 while (--field_width > 0)
622 if (qualifier == 'l' && !IS_ENABLED(CONFIG_SPL_BUILD)) {
623 str = string16(str, end, va_arg(args, u16 *),
624 field_width, precision, flags);
626 str = string(str, end, va_arg(args, char *),
627 field_width, precision, flags);
632 str = pointer(fmt + 1, str, end,
633 va_arg(args, void *),
634 field_width, precision, flags);
637 /* Skip all alphanumeric pointer suffixes */
638 while (isalnum(fmt[1]))
643 if (qualifier == 'l') {
644 long *ip = va_arg(args, long *);
647 int *ip = va_arg(args, int *);
656 /* integer number formats - set up the flags and "break" */
681 if (qualifier == 'L') /* "quad" for 64 bit variables */
682 num = va_arg(args, unsigned long long);
683 else if (qualifier == 'l') {
684 num = va_arg(args, unsigned long);
686 num = (signed long) num;
687 } else if (qualifier == 'Z' || qualifier == 'z') {
688 num = va_arg(args, size_t);
689 } else if (qualifier == 't') {
690 num = va_arg(args, ptrdiff_t);
691 } else if (qualifier == 'h') {
692 num = (unsigned short) va_arg(args, int);
694 num = (signed short) num;
696 num = va_arg(args, unsigned int);
698 num = (signed int) num;
700 str = number(str, end, num, base, field_width, precision,
710 /* the trailing null byte doesn't count towards the total */
714 int vsnprintf(char *buf, size_t size, const char *fmt,
717 return vsnprintf_internal(buf, size, fmt, args);
720 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
724 i = vsnprintf(buf, size, fmt, args);
726 if (likely(i < size))
733 int snprintf(char *buf, size_t size, const char *fmt, ...)
739 i = vsnprintf(buf, size, fmt, args);
745 int scnprintf(char *buf, size_t size, const char *fmt, ...)
751 i = vscnprintf(buf, size, fmt, args);
758 * Format a string and place it in a buffer (va_list version)
760 * @param buf The buffer to place the result into
761 * @param fmt The format string to use
762 * @param args Arguments for the format string
764 * The function returns the number of characters written
765 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
768 * If you're not already dealing with a va_list consider using sprintf().
770 int vsprintf(char *buf, const char *fmt, va_list args)
772 return vsnprintf_internal(buf, INT_MAX, fmt, args);
775 int sprintf(char *buf, const char *fmt, ...)
781 i = vsprintf(buf, fmt, args);
786 #if CONFIG_IS_ENABLED(PRINTF)
787 int printf(const char *fmt, ...)
791 char printbuffer[CONFIG_SYS_PBSIZE];
796 * For this to work, printbuffer must be larger than
797 * anything we ever want to print.
799 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
805 /* Print the string */
810 int vprintf(const char *fmt, va_list args)
813 char printbuffer[CONFIG_SYS_PBSIZE];
816 * For this to work, printbuffer must be larger than
817 * anything we ever want to print.
819 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
824 /* Print the string */
830 char *simple_itoa(ulong i)
832 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
833 static char local[22];
834 char *p = &local[21];
844 /* We don't seem to have %'d in U-Boot */
845 void print_grouped_ull(unsigned long long int_val, int digits)
850 digits = (digits + 2) / 3;
851 sprintf(str, "%*llu", digits * 3, int_val);
852 for (s = str; *s; s += grab) {
854 putc(s[-1] != ' ' ? ',' : ' ');
855 printf("%.*s", grab, s);
860 bool str2off(const char *p, loff_t *num)
864 *num = simple_strtoull(p, &endptr, 16);
865 return *p != '\0' && *endptr == '\0';
868 bool str2long(const char *p, ulong *num)
872 *num = simple_strtoul(p, &endptr, 16);
873 return *p != '\0' && *endptr == '\0';