4 * Copyright (C) 1991, 1992 Linus Torvalds
5 * (C) Copyright 2000-2009
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
11 * Wirzenius wrote this portably, Torvalds fucked it up :-)
13 * from hush: simple_itoa() was lifted from boa-0.93.15
18 #include <efi_loader.h>
23 #include <linux/ctype.h>
24 #include <linux/err.h>
25 #include <linux/types.h>
26 #include <linux/string.h>
28 #define noinline __attribute__((noinline))
30 /* we use this so that we can do without the ctype library */
31 #define is_digit(c) ((c) >= '0' && (c) <= '9')
33 static int skip_atoi(const char **s)
38 i = i * 10 + *((*s)++) - '0';
43 /* Decimal conversion is by far the most typical, and is used
44 * for /proc and /sys data. This directly impacts e.g. top performance
45 * with many processes running. We optimize it for speed
47 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
48 * (with permission from the author, Douglas W. Jones). */
50 /* Formats correctly any integer in [0,99999].
51 * Outputs from one to five digits depending on input.
52 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
53 static char *put_dec_trunc(char *buf, unsigned q)
55 unsigned d3, d2, d1, d0;
60 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
61 q = (d0 * 0xcd) >> 11;
63 *buf++ = d0 + '0'; /* least significant digit */
64 d1 = q + 9*d3 + 5*d2 + d1;
66 q = (d1 * 0xcd) >> 11;
68 *buf++ = d1 + '0'; /* next digit */
71 if ((d2 != 0) || (d3 != 0)) {
74 *buf++ = d2 + '0'; /* next digit */
78 q = (d3 * 0xcd) >> 11;
80 *buf++ = d3 + '0'; /* next digit */
82 *buf++ = q + '0'; /* most sign. digit */
88 /* Same with if's removed. Always emits five digits */
89 static char *put_dec_full(char *buf, unsigned q)
91 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
92 /* but anyway, gcc produces better code with full-sized ints */
93 unsigned d3, d2, d1, d0;
99 * Possible ways to approx. divide by 10
100 * gcc -O2 replaces multiply with shifts and adds
101 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
102 * (x * 0x67) >> 10: 1100111
103 * (x * 0x34) >> 9: 110100 - same
104 * (x * 0x1a) >> 8: 11010 - same
105 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
108 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
109 q = (d0 * 0xcd) >> 11;
112 d1 = q + 9*d3 + 5*d2 + d1;
113 q = (d1 * 0xcd) >> 11;
123 q = (d3 * 0xcd) >> 11; /* - shorter code */
124 /* q = (d3 * 0x67) >> 10; - would also work */
130 /* No inlining helps gcc to use registers better */
131 static noinline char *put_dec(char *buf, uint64_t num)
136 return put_dec_trunc(buf, num);
137 rem = do_div(num, 100000);
138 buf = put_dec_full(buf, rem);
142 #define ZEROPAD 1 /* pad with zero */
143 #define SIGN 2 /* unsigned/signed long */
144 #define PLUS 4 /* show plus */
145 #define SPACE 8 /* space if plus */
146 #define LEFT 16 /* left justified */
147 #define SMALL 32 /* Must be 32 == 0x20 */
148 #define SPECIAL 64 /* 0x */
151 * Macro to add a new character to our output string, but only if it will
152 * fit. The macro moves to the next character position in the output string.
154 #define ADDCH(str, ch) do { \
160 static char *number(char *buf, char *end, u64 num,
161 int base, int size, int precision, int type)
163 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
164 static const char digits[16] = "0123456789ABCDEF";
169 int need_pfx = ((type & SPECIAL) && base != 10);
172 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
173 * produces same digits or (maybe lowercased) letters */
174 locase = (type & SMALL);
183 } else if (type & PLUS) {
186 } else if (type & SPACE) {
197 /* generate full string in tmp[], in reverse order */
201 /* Generic code, for any base:
203 tmp[i++] = (digits[do_div(num,base)] | locase);
206 else if (base != 10) { /* 8 or 16 */
214 tmp[i++] = (digits[((unsigned char)num) & mask]
218 } else { /* base 10 */
219 i = put_dec(tmp, num) - tmp;
222 /* printing 100 using %2d gives "100", not "00" */
225 /* leading space padding */
227 if (!(type & (ZEROPAD + LEFT))) {
234 /* "0x" / "0" prefix */
238 ADDCH(buf, 'X' | locase);
240 /* zero or space padding */
241 if (!(type & LEFT)) {
242 char c = (type & ZEROPAD) ? '0' : ' ';
247 /* hmm even more zero padding? */
248 while (i <= --precision)
250 /* actual digits of result */
253 /* trailing space padding */
259 static char *string(char *buf, char *end, char *s, int field_width,
260 int precision, int flags)
267 len = strnlen(s, precision);
270 while (len < field_width--)
272 for (i = 0; i < len; ++i)
274 while (len < field_width--)
279 /* U-Boot uses UTF-16 strings in the EFI context only. */
280 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
281 static char *string16(char *buf, char *end, u16 *s, int field_width,
282 int precision, int flags)
284 const u16 *str = s ? s : L"<NULL>";
285 ssize_t i, len = utf16_strnlen(str, precision);
288 for (; len < field_width; --field_width)
290 for (i = 0; i < len && buf + utf16_utf8_strnlen(str, 1) <= end; ++i) {
291 s32 s = utf16_get(&str);
297 for (; len < field_width; --field_width)
302 #if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT)
303 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
304 int precision, int flags)
308 /* If dp == NULL output the string '<NULL>' */
310 return string16(buf, end, dp, field_width, precision, flags);
312 str = efi_dp_str((struct efi_device_path *)dp);
314 return ERR_PTR(-ENOMEM);
316 buf = string16(buf, end, str, field_width, precision, flags);
323 #ifdef CONFIG_CMD_NET
324 static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
325 int precision, int flags)
327 /* (6 * 2 hex digits), 5 colons and trailing zero */
328 char mac_addr[6 * 3];
332 for (i = 0; i < 6; i++) {
333 p = hex_byte_pack(p, addr[i]);
334 if (!(flags & SPECIAL) && i != 5)
339 return string(buf, end, mac_addr, field_width, precision,
343 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
344 int precision, int flags)
346 /* (8 * 4 hex digits), 7 colons and trailing zero */
347 char ip6_addr[8 * 5];
351 for (i = 0; i < 8; i++) {
352 p = hex_byte_pack(p, addr[2 * i]);
353 p = hex_byte_pack(p, addr[2 * i + 1]);
354 if (!(flags & SPECIAL) && i != 7)
359 return string(buf, end, ip6_addr, field_width, precision,
363 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
364 int precision, int flags)
366 /* (4 * 3 decimal digits), 3 dots and trailing zero */
367 char ip4_addr[4 * 4];
368 char temp[3]; /* hold each IP quad in reverse order */
372 for (i = 0; i < 4; i++) {
373 digits = put_dec_trunc(temp, addr[i]) - temp;
374 /* reverse the digits in the quad */
382 return string(buf, end, ip4_addr, field_width, precision,
387 #ifdef CONFIG_LIB_UUID
389 * This works (roughly) the same way as Linux's.
391 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
392 * %pUB: 01020304-0506-0708-090A-0B0C0D0E0F10
393 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
394 * %pUL: 04030201-0605-0807-090A-0B0C0D0E0F10
396 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
397 int precision, int flags, const char *fmt)
399 char uuid[UUID_STR_LEN + 1];
404 str_format = UUID_STR_FORMAT_GUID | UUID_STR_UPPER_CASE;
407 str_format = UUID_STR_FORMAT_GUID;
410 str_format = UUID_STR_FORMAT_STD | UUID_STR_UPPER_CASE;
413 str_format = UUID_STR_FORMAT_STD;
418 uuid_bin_to_str(addr, uuid, str_format);
420 strcpy(uuid, "<NULL>");
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 /* Device paths only exist in the EFI context. */
461 #if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT) && !defined(API_BUILD)
463 return device_path_string(buf, end, ptr, field_width,
467 flags |= SPECIAL | ZEROPAD;
472 field_width = sizeof(phys_addr_t) * 2 + 2;
473 num = *(phys_addr_t *)ptr;
477 #ifdef CONFIG_CMD_NET
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 /* U-Boot uses UTF-16 strings in the EFI context only. */
623 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
624 if (qualifier == 'l') {
625 str = string16(str, end, va_arg(args, u16 *),
626 field_width, precision, flags);
630 str = string(str, end, va_arg(args, char *),
631 field_width, precision, flags);
636 str = pointer(fmt + 1, str, end,
637 va_arg(args, void *),
638 field_width, precision, flags);
641 /* Skip all alphanumeric pointer suffixes */
642 while (isalnum(fmt[1]))
647 if (qualifier == 'l') {
648 long *ip = va_arg(args, long *);
651 int *ip = va_arg(args, int *);
660 /* integer number formats - set up the flags and "break" */
685 if (qualifier == 'L') /* "quad" for 64 bit variables */
686 num = va_arg(args, unsigned long long);
687 else if (qualifier == 'l') {
688 num = va_arg(args, unsigned long);
690 num = (signed long) num;
691 } else if (qualifier == 'Z' || qualifier == 'z') {
692 num = va_arg(args, size_t);
693 } else if (qualifier == 't') {
694 num = va_arg(args, ptrdiff_t);
695 } else if (qualifier == 'h') {
696 num = (unsigned short) va_arg(args, int);
698 num = (signed short) num;
700 num = va_arg(args, unsigned int);
702 num = (signed int) num;
704 str = number(str, end, num, base, field_width, precision,
714 /* the trailing null byte doesn't count towards the total */
718 int vsnprintf(char *buf, size_t size, const char *fmt,
721 return vsnprintf_internal(buf, size, fmt, args);
724 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
728 i = vsnprintf(buf, size, fmt, args);
730 if (likely(i < size))
737 int snprintf(char *buf, size_t size, const char *fmt, ...)
743 i = vsnprintf(buf, size, fmt, args);
749 int scnprintf(char *buf, size_t size, const char *fmt, ...)
755 i = vscnprintf(buf, size, fmt, args);
762 * Format a string and place it in a buffer (va_list version)
764 * @param buf The buffer to place the result into
765 * @param fmt The format string to use
766 * @param args Arguments for the format string
768 * The function returns the number of characters written
769 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
772 * If you're not already dealing with a va_list consider using sprintf().
774 int vsprintf(char *buf, const char *fmt, va_list args)
776 return vsnprintf_internal(buf, INT_MAX, fmt, args);
779 int sprintf(char *buf, const char *fmt, ...)
785 i = vsprintf(buf, fmt, args);
790 #if CONFIG_IS_ENABLED(PRINTF)
791 int printf(const char *fmt, ...)
795 char printbuffer[CONFIG_SYS_PBSIZE];
800 * For this to work, printbuffer must be larger than
801 * anything we ever want to print.
803 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
809 /* Print the string */
814 int vprintf(const char *fmt, va_list args)
817 char printbuffer[CONFIG_SYS_PBSIZE];
820 * For this to work, printbuffer must be larger than
821 * anything we ever want to print.
823 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
828 /* Print the string */
834 char *simple_itoa(ulong i)
836 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
837 static char local[22];
838 char *p = &local[21];
848 /* We don't seem to have %'d in U-Boot */
849 void print_grouped_ull(unsigned long long int_val, int digits)
854 digits = (digits + 2) / 3;
855 sprintf(str, "%*llu", digits * 3, int_val);
856 for (s = str; *s; s += grab) {
858 putc(s[-1] != ' ' ? ',' : ' ');
859 printf("%.*s", grab, s);
864 bool str2off(const char *p, loff_t *num)
868 *num = simple_strtoull(p, &endptr, 16);
869 return *p != '\0' && *endptr == '\0';
872 bool str2long(const char *p, ulong *num)
876 *num = simple_strtoul(p, &endptr, 16);
877 return *p != '\0' && *endptr == '\0';
880 char *strmhz(char *buf, unsigned long hz)
885 n = DIV_ROUND_CLOSEST(hz, 1000) / 1000L;
886 l = sprintf(buf, "%ld", n);
889 m = DIV_ROUND_CLOSEST(hz, 1000L);
891 sprintf(buf + l, ".%03ld", m);