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>
24 #include <linux/ctype.h>
25 #include <linux/err.h>
26 #include <linux/types.h>
27 #include <linux/string.h>
29 #define noinline __attribute__((noinline))
31 /* we use this so that we can do without the ctype library */
32 #define is_digit(c) ((c) >= '0' && (c) <= '9')
34 static int skip_atoi(const char **s)
39 i = i * 10 + *((*s)++) - '0';
44 /* Decimal conversion is by far the most typical, and is used
45 * for /proc and /sys data. This directly impacts e.g. top performance
46 * with many processes running. We optimize it for speed
48 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
49 * (with permission from the author, Douglas W. Jones). */
51 /* Formats correctly any integer in [0,99999].
52 * Outputs from one to five digits depending on input.
53 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
54 static char *put_dec_trunc(char *buf, unsigned q)
56 unsigned d3, d2, d1, d0;
61 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
62 q = (d0 * 0xcd) >> 11;
64 *buf++ = d0 + '0'; /* least significant digit */
65 d1 = q + 9*d3 + 5*d2 + d1;
67 q = (d1 * 0xcd) >> 11;
69 *buf++ = d1 + '0'; /* next digit */
72 if ((d2 != 0) || (d3 != 0)) {
75 *buf++ = d2 + '0'; /* next digit */
79 q = (d3 * 0xcd) >> 11;
81 *buf++ = d3 + '0'; /* next digit */
83 *buf++ = q + '0'; /* most sign. digit */
89 /* Same with if's removed. Always emits five digits */
90 static char *put_dec_full(char *buf, unsigned q)
92 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
93 /* but anyway, gcc produces better code with full-sized ints */
94 unsigned d3, d2, d1, d0;
100 * Possible ways to approx. divide by 10
101 * gcc -O2 replaces multiply with shifts and adds
102 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
103 * (x * 0x67) >> 10: 1100111
104 * (x * 0x34) >> 9: 110100 - same
105 * (x * 0x1a) >> 8: 11010 - same
106 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
109 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
110 q = (d0 * 0xcd) >> 11;
113 d1 = q + 9*d3 + 5*d2 + d1;
114 q = (d1 * 0xcd) >> 11;
124 q = (d3 * 0xcd) >> 11; /* - shorter code */
125 /* q = (d3 * 0x67) >> 10; - would also work */
131 /* No inlining helps gcc to use registers better */
132 static noinline char *put_dec(char *buf, uint64_t num)
137 return put_dec_trunc(buf, num);
138 rem = do_div(num, 100000);
139 buf = put_dec_full(buf, rem);
143 #define ZEROPAD 1 /* pad with zero */
144 #define SIGN 2 /* unsigned/signed long */
145 #define PLUS 4 /* show plus */
146 #define SPACE 8 /* space if plus */
147 #define LEFT 16 /* left justified */
148 #define SMALL 32 /* Must be 32 == 0x20 */
149 #define SPECIAL 64 /* 0x */
152 * Macro to add a new character to our output string, but only if it will
153 * fit. The macro moves to the next character position in the output string.
155 #define ADDCH(str, ch) do { \
161 static char *number(char *buf, char *end, u64 num,
162 int base, int size, int precision, int type)
164 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
165 static const char digits[16] = "0123456789ABCDEF";
170 int need_pfx = ((type & SPECIAL) && base != 10);
173 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
174 * produces same digits or (maybe lowercased) letters */
175 locase = (type & SMALL);
184 } else if (type & PLUS) {
187 } else if (type & SPACE) {
198 /* generate full string in tmp[], in reverse order */
202 /* Generic code, for any base:
204 tmp[i++] = (digits[do_div(num,base)] | locase);
207 else if (base != 10) { /* 8 or 16 */
215 tmp[i++] = (digits[((unsigned char)num) & mask]
219 } else { /* base 10 */
220 i = put_dec(tmp, num) - tmp;
223 /* printing 100 using %2d gives "100", not "00" */
226 /* leading space padding */
228 if (!(type & (ZEROPAD + LEFT))) {
235 /* "0x" / "0" prefix */
239 ADDCH(buf, 'X' | locase);
241 /* zero or space padding */
242 if (!(type & LEFT)) {
243 char c = (type & ZEROPAD) ? '0' : ' ';
248 /* hmm even more zero padding? */
249 while (i <= --precision)
251 /* actual digits of result */
254 /* trailing space padding */
260 static char *string(char *buf, char *end, char *s, int field_width,
261 int precision, int flags)
268 len = strnlen(s, precision);
271 while (len < field_width--)
273 for (i = 0; i < len; ++i)
275 while (len < field_width--)
280 /* U-Boot uses UTF-16 strings in the EFI context only. */
281 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
282 static char *string16(char *buf, char *end, u16 *s, int field_width,
283 int precision, int flags)
285 const u16 *str = s ? s : L"<NULL>";
286 ssize_t i, len = utf16_strnlen(str, precision);
289 for (; len < field_width; --field_width)
291 for (i = 0; i < len && buf + utf16_utf8_strnlen(str, 1) <= end; ++i) {
292 s32 s = utf16_get(&str);
298 for (; len < field_width; --field_width)
303 #if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT)
304 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
305 int precision, int flags)
309 /* If dp == NULL output the string '<NULL>' */
311 return string16(buf, end, dp, field_width, precision, flags);
313 str = efi_dp_str((struct efi_device_path *)dp);
315 return ERR_PTR(-ENOMEM);
317 buf = string16(buf, end, str, field_width, precision, flags);
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,
386 #ifdef CONFIG_LIB_UUID
388 * This works (roughly) the same way as Linux's.
390 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
391 * %pUB: 01020304-0506-0708-090A-0B0C0D0E0F10
392 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
393 * %pUL: 04030201-0605-0807-090A-0B0C0D0E0F10
395 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
396 int precision, int flags, const char *fmt)
398 char uuid[UUID_STR_LEN + 1];
403 str_format = UUID_STR_FORMAT_GUID | UUID_STR_UPPER_CASE;
406 str_format = UUID_STR_FORMAT_GUID;
409 str_format = UUID_STR_FORMAT_STD | UUID_STR_UPPER_CASE;
412 str_format = UUID_STR_FORMAT_STD;
417 uuid_bin_to_str(addr, uuid, str_format);
419 strcpy(uuid, "<NULL>");
421 return string(buf, end, uuid, field_width, precision, flags);
426 * Show a '%p' thing. A kernel extension is that the '%p' is followed
427 * by an extra set of alphanumeric characters that are extended format
430 * Right now we handle:
432 * - 'M' For a 6-byte MAC address, it prints the address in the
433 * usual colon-separated hex notation
434 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
435 * decimal for v4 and colon separated network-order 16 bit hex for v6)
436 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
439 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
440 * function pointers are really function descriptors, which contain a
441 * pointer to the real address.
443 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
444 int field_width, int precision, int flags)
446 u64 num = (uintptr_t)ptr;
449 * Being a boot loader, we explicitly allow pointers to
450 * (physical) address null.
454 return string(buf, end, "(null)", field_width, precision,
459 /* Device paths only exist in the EFI context. */
460 #if CONFIG_IS_ENABLED(EFI_DEVICE_PATH_TO_TEXT) && !defined(API_BUILD)
462 return device_path_string(buf, end, ptr, field_width,
466 flags |= SPECIAL | ZEROPAD;
471 field_width = sizeof(phys_addr_t) * 2 + 2;
472 num = *(phys_addr_t *)ptr;
480 return mac_address_string(buf, end, ptr, field_width,
487 return ip6_addr_string(buf, end, ptr, field_width,
490 return ip4_addr_string(buf, end, ptr, field_width,
494 #ifdef CONFIG_LIB_UUID
496 return uuid_string(buf, end, ptr, field_width, precision,
503 if (field_width == -1) {
504 field_width = 2*sizeof(void *);
507 return number(buf, end, num, 16, field_width, precision, flags);
510 static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
517 int flags; /* flags to number() */
519 int field_width; /* width of output field */
520 int precision; /* min. # of digits for integers; max
521 number of chars for from string */
522 int qualifier; /* 'h', 'l', or 'L' for integer fields */
523 /* 'z' support added 23/7/1999 S.H. */
524 /* 'z' changed to 'Z' --davidm 1/25/99 */
525 /* 't' added for ptrdiff_t */
526 char *end = buf + size;
528 /* Make sure end is always >= buf - do we want this in U-Boot? */
535 for (; *fmt ; ++fmt) {
544 ++fmt; /* this also skips first '%' */
563 /* get field width */
566 field_width = skip_atoi(&fmt);
567 else if (*fmt == '*') {
569 /* it's the next argument */
570 field_width = va_arg(args, int);
571 if (field_width < 0) {
572 field_width = -field_width;
577 /* get the precision */
582 precision = skip_atoi(&fmt);
583 else if (*fmt == '*') {
585 /* it's the next argument */
586 precision = va_arg(args, int);
592 /* get the conversion qualifier */
594 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
595 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
598 if (qualifier == 'l' && *fmt == 'l') {
609 if (!(flags & LEFT)) {
610 while (--field_width > 0)
613 ADDCH(str, (unsigned char) va_arg(args, int));
614 while (--field_width > 0)
619 /* U-Boot uses UTF-16 strings in the EFI context only. */
620 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
621 if (qualifier == 'l') {
622 str = string16(str, end, va_arg(args, u16 *),
623 field_width, precision, flags);
627 str = string(str, end, va_arg(args, char *),
628 field_width, precision, flags);
633 str = pointer(fmt + 1, str, end,
634 va_arg(args, void *),
635 field_width, precision, flags);
638 /* Skip all alphanumeric pointer suffixes */
639 while (isalnum(fmt[1]))
644 if (qualifier == 'l') {
645 long *ip = va_arg(args, long *);
648 int *ip = va_arg(args, int *);
657 /* integer number formats - set up the flags and "break" */
682 if (qualifier == 'L') /* "quad" for 64 bit variables */
683 num = va_arg(args, unsigned long long);
684 else if (qualifier == 'l') {
685 num = va_arg(args, unsigned long);
687 num = (signed long) num;
688 } else if (qualifier == 'Z' || qualifier == 'z') {
689 num = va_arg(args, size_t);
690 } else if (qualifier == 't') {
691 num = va_arg(args, ptrdiff_t);
692 } else if (qualifier == 'h') {
693 num = (unsigned short) va_arg(args, int);
695 num = (signed short) num;
697 num = va_arg(args, unsigned int);
699 num = (signed int) num;
701 str = number(str, end, num, base, field_width, precision,
711 /* the trailing null byte doesn't count towards the total */
715 int vsnprintf(char *buf, size_t size, const char *fmt,
718 return vsnprintf_internal(buf, size, fmt, args);
721 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
725 i = vsnprintf(buf, size, fmt, args);
727 if (likely(i < size))
734 int snprintf(char *buf, size_t size, const char *fmt, ...)
740 i = vsnprintf(buf, size, fmt, args);
746 int scnprintf(char *buf, size_t size, const char *fmt, ...)
752 i = vscnprintf(buf, size, fmt, args);
759 * Format a string and place it in a buffer (va_list version)
761 * @param buf The buffer to place the result into
762 * @param fmt The format string to use
763 * @param args Arguments for the format string
765 * The function returns the number of characters written
766 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
769 * If you're not already dealing with a va_list consider using sprintf().
771 int vsprintf(char *buf, const char *fmt, va_list args)
773 return vsnprintf_internal(buf, INT_MAX, fmt, args);
776 int sprintf(char *buf, const char *fmt, ...)
782 i = vsprintf(buf, fmt, args);
787 #if CONFIG_IS_ENABLED(PRINTF)
788 int printf(const char *fmt, ...)
792 char printbuffer[CONFIG_SYS_PBSIZE];
797 * For this to work, printbuffer must be larger than
798 * anything we ever want to print.
800 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
806 /* Print the string */
811 int vprintf(const char *fmt, va_list args)
814 char printbuffer[CONFIG_SYS_PBSIZE];
817 * For this to work, printbuffer must be larger than
818 * anything we ever want to print.
820 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
825 /* Print the string */
831 char *simple_itoa(ulong i)
833 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
834 static char local[22];
835 char *p = &local[21];
845 /* We don't seem to have %'d in U-Boot */
846 void print_grouped_ull(unsigned long long int_val, int digits)
851 digits = (digits + 2) / 3;
852 sprintf(str, "%*llu", digits * 3, int_val);
853 for (s = str; *s; s += grab) {
855 putc(s[-1] != ' ' ? ',' : ' ');
856 printf("%.*s", grab, s);
861 bool str2off(const char *p, loff_t *num)
865 *num = simple_strtoull(p, &endptr, 16);
866 return *p != '\0' && *endptr == '\0';
869 bool str2long(const char *p, ulong *num)
873 *num = simple_strtoul(p, &endptr, 16);
874 return *p != '\0' && *endptr == '\0';
877 char *strmhz(char *buf, unsigned long hz)
882 n = DIV_ROUND_CLOSEST(hz, 1000) / 1000L;
883 l = sprintf(buf, "%ld", n);
886 m = DIV_ROUND_CLOSEST(hz, 1000L);
888 sprintf(buf + l, ".%03ld", m);