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>
21 #include <linux/ctype.h>
22 #include <linux/err.h>
23 #include <linux/types.h>
24 #include <linux/string.h>
26 #define noinline __attribute__((noinline))
28 /* we use this so that we can do without the ctype library */
29 #define is_digit(c) ((c) >= '0' && (c) <= '9')
31 static int skip_atoi(const char **s)
36 i = i * 10 + *((*s)++) - '0';
41 /* Decimal conversion is by far the most typical, and is used
42 * for /proc and /sys data. This directly impacts e.g. top performance
43 * with many processes running. We optimize it for speed
45 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
46 * (with permission from the author, Douglas W. Jones). */
48 /* Formats correctly any integer in [0,99999].
49 * Outputs from one to five digits depending on input.
50 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
51 static char *put_dec_trunc(char *buf, unsigned q)
53 unsigned d3, d2, d1, d0;
58 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
59 q = (d0 * 0xcd) >> 11;
61 *buf++ = d0 + '0'; /* least significant digit */
62 d1 = q + 9*d3 + 5*d2 + d1;
64 q = (d1 * 0xcd) >> 11;
66 *buf++ = d1 + '0'; /* next digit */
69 if ((d2 != 0) || (d3 != 0)) {
72 *buf++ = d2 + '0'; /* next digit */
76 q = (d3 * 0xcd) >> 11;
78 *buf++ = d3 + '0'; /* next digit */
80 *buf++ = q + '0'; /* most sign. digit */
86 /* Same with if's removed. Always emits five digits */
87 static char *put_dec_full(char *buf, unsigned q)
89 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
90 /* but anyway, gcc produces better code with full-sized ints */
91 unsigned d3, d2, d1, d0;
97 * Possible ways to approx. divide by 10
98 * gcc -O2 replaces multiply with shifts and adds
99 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
100 * (x * 0x67) >> 10: 1100111
101 * (x * 0x34) >> 9: 110100 - same
102 * (x * 0x1a) >> 8: 11010 - same
103 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
106 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
107 q = (d0 * 0xcd) >> 11;
110 d1 = q + 9*d3 + 5*d2 + d1;
111 q = (d1 * 0xcd) >> 11;
121 q = (d3 * 0xcd) >> 11; /* - shorter code */
122 /* q = (d3 * 0x67) >> 10; - would also work */
128 /* No inlining helps gcc to use registers better */
129 static noinline char *put_dec(char *buf, uint64_t num)
134 return put_dec_trunc(buf, num);
135 rem = do_div(num, 100000);
136 buf = put_dec_full(buf, rem);
140 #define ZEROPAD 1 /* pad with zero */
141 #define SIGN 2 /* unsigned/signed long */
142 #define PLUS 4 /* show plus */
143 #define SPACE 8 /* space if plus */
144 #define LEFT 16 /* left justified */
145 #define SMALL 32 /* Must be 32 == 0x20 */
146 #define SPECIAL 64 /* 0x */
149 * Macro to add a new character to our output string, but only if it will
150 * fit. The macro moves to the next character position in the output string.
152 #define ADDCH(str, ch) do { \
158 static char *number(char *buf, char *end, u64 num,
159 int base, int size, int precision, int type)
161 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
162 static const char digits[16] = "0123456789ABCDEF";
167 int need_pfx = ((type & SPECIAL) && base != 10);
170 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
171 * produces same digits or (maybe lowercased) letters */
172 locase = (type & SMALL);
181 } else if (type & PLUS) {
184 } else if (type & SPACE) {
195 /* generate full string in tmp[], in reverse order */
199 /* Generic code, for any base:
201 tmp[i++] = (digits[do_div(num,base)] | locase);
204 else if (base != 10) { /* 8 or 16 */
212 tmp[i++] = (digits[((unsigned char)num) & mask]
216 } else { /* base 10 */
217 i = put_dec(tmp, num) - tmp;
220 /* printing 100 using %2d gives "100", not "00" */
223 /* leading space padding */
225 if (!(type & (ZEROPAD + LEFT))) {
232 /* "0x" / "0" prefix */
236 ADDCH(buf, 'X' | locase);
238 /* zero or space padding */
239 if (!(type & LEFT)) {
240 char c = (type & ZEROPAD) ? '0' : ' ';
245 /* hmm even more zero padding? */
246 while (i <= --precision)
248 /* actual digits of result */
251 /* trailing space padding */
257 static char *string(char *buf, char *end, char *s, int field_width,
258 int precision, int flags)
265 len = strnlen(s, precision);
268 while (len < field_width--)
270 for (i = 0; i < len; ++i)
272 while (len < field_width--)
277 /* U-Boot uses UTF-16 strings in the EFI context only. */
278 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
279 static char *string16(char *buf, char *end, u16 *s, int field_width,
280 int precision, int flags)
282 u16 *str = s ? s : L"<NULL>";
283 ssize_t len = utf16_strnlen(str, precision);
286 for (; len < field_width; --field_width)
288 utf16_utf8_strncpy(&buf, str, len);
289 for (; len < field_width; --field_width)
294 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
295 int precision, int flags)
299 /* If dp == NULL output the string '<NULL>' */
301 return string16(buf, end, dp, field_width, precision, flags);
303 str = efi_dp_str((struct efi_device_path *)dp);
305 return ERR_PTR(-ENOMEM);
307 buf = string16(buf, end, str, field_width, precision, flags);
313 #ifdef CONFIG_CMD_NET
314 static char *mac_address_string(char *buf, char *end, u8 *addr, int field_width,
315 int precision, int flags)
317 /* (6 * 2 hex digits), 5 colons and trailing zero */
318 char mac_addr[6 * 3];
322 for (i = 0; i < 6; i++) {
323 p = hex_byte_pack(p, addr[i]);
324 if (!(flags & SPECIAL) && i != 5)
329 return string(buf, end, mac_addr, field_width, precision,
333 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
334 int precision, int flags)
336 /* (8 * 4 hex digits), 7 colons and trailing zero */
337 char ip6_addr[8 * 5];
341 for (i = 0; i < 8; i++) {
342 p = hex_byte_pack(p, addr[2 * i]);
343 p = hex_byte_pack(p, addr[2 * i + 1]);
344 if (!(flags & SPECIAL) && i != 7)
349 return string(buf, end, ip6_addr, field_width, precision,
353 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
354 int precision, int flags)
356 /* (4 * 3 decimal digits), 3 dots and trailing zero */
357 char ip4_addr[4 * 4];
358 char temp[3]; /* hold each IP quad in reverse order */
362 for (i = 0; i < 4; i++) {
363 digits = put_dec_trunc(temp, addr[i]) - temp;
364 /* reverse the digits in the quad */
372 return string(buf, end, ip4_addr, field_width, precision,
377 #ifdef CONFIG_LIB_UUID
379 * This works (roughly) the same way as linux's, but we currently always
380 * print lower-case (ie. we just keep %pUB and %pUL for compat with linux),
381 * mostly just because that is what uuid_bin_to_str() supports.
383 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
384 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
386 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
387 int precision, int flags, const char *fmt)
389 char uuid[UUID_STR_LEN + 1];
390 int str_format = UUID_STR_FORMAT_STD;
395 str_format = UUID_STR_FORMAT_GUID;
399 /* this is the default */
406 uuid_bin_to_str(addr, uuid, str_format);
408 strcpy(uuid, "<NULL>");
410 return string(buf, end, uuid, field_width, precision, flags);
415 * Show a '%p' thing. A kernel extension is that the '%p' is followed
416 * by an extra set of alphanumeric characters that are extended format
419 * Right now we handle:
421 * - 'M' For a 6-byte MAC address, it prints the address in the
422 * usual colon-separated hex notation
423 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way (dot-separated
424 * decimal for v4 and colon separated network-order 16 bit hex for v6)
425 * - 'i' [46] for 'raw' IPv4/IPv6 addresses, IPv6 omits the colons, IPv4 is
428 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
429 * function pointers are really function descriptors, which contain a
430 * pointer to the real address.
432 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
433 int field_width, int precision, int flags)
435 u64 num = (uintptr_t)ptr;
438 * Being a boot loader, we explicitly allow pointers to
439 * (physical) address null.
443 return string(buf, end, "(null)", field_width, precision,
448 /* Device paths only exist in the EFI context. */
449 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
451 return device_path_string(buf, end, ptr, field_width,
454 #ifdef CONFIG_CMD_NET
456 flags |= SPECIAL | ZEROPAD;
461 field_width = sizeof(phys_addr_t) * 2 + 2;
462 num = *(phys_addr_t *)ptr;
470 return mac_address_string(buf, end, ptr, field_width,
477 return ip6_addr_string(buf, end, ptr, field_width,
480 return ip4_addr_string(buf, end, ptr, field_width,
485 #ifdef CONFIG_LIB_UUID
487 return uuid_string(buf, end, ptr, field_width, precision,
494 if (field_width == -1) {
495 field_width = 2*sizeof(void *);
498 return number(buf, end, num, 16, field_width, precision, flags);
501 static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
508 int flags; /* flags to number() */
510 int field_width; /* width of output field */
511 int precision; /* min. # of digits for integers; max
512 number of chars for from string */
513 int qualifier; /* 'h', 'l', or 'L' for integer fields */
514 /* 'z' support added 23/7/1999 S.H. */
515 /* 'z' changed to 'Z' --davidm 1/25/99 */
516 /* 't' added for ptrdiff_t */
517 char *end = buf + size;
519 /* Make sure end is always >= buf - do we want this in U-Boot? */
526 for (; *fmt ; ++fmt) {
535 ++fmt; /* this also skips first '%' */
554 /* get field width */
557 field_width = skip_atoi(&fmt);
558 else if (*fmt == '*') {
560 /* it's the next argument */
561 field_width = va_arg(args, int);
562 if (field_width < 0) {
563 field_width = -field_width;
568 /* get the precision */
573 precision = skip_atoi(&fmt);
574 else if (*fmt == '*') {
576 /* it's the next argument */
577 precision = va_arg(args, int);
583 /* get the conversion qualifier */
585 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
586 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
589 if (qualifier == 'l' && *fmt == 'l') {
600 if (!(flags & LEFT)) {
601 while (--field_width > 0)
604 ADDCH(str, (unsigned char) va_arg(args, int));
605 while (--field_width > 0)
610 /* U-Boot uses UTF-16 strings in the EFI context only. */
611 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
612 if (qualifier == 'l') {
613 str = string16(str, end, va_arg(args, u16 *),
614 field_width, precision, flags);
618 str = string(str, end, va_arg(args, char *),
619 field_width, precision, flags);
624 str = pointer(fmt + 1, str, end,
625 va_arg(args, void *),
626 field_width, precision, flags);
629 /* Skip all alphanumeric pointer suffixes */
630 while (isalnum(fmt[1]))
635 if (qualifier == 'l') {
636 long *ip = va_arg(args, long *);
639 int *ip = va_arg(args, int *);
648 /* integer number formats - set up the flags and "break" */
673 if (qualifier == 'L') /* "quad" for 64 bit variables */
674 num = va_arg(args, unsigned long long);
675 else if (qualifier == 'l') {
676 num = va_arg(args, unsigned long);
678 num = (signed long) num;
679 } else if (qualifier == 'Z' || qualifier == 'z') {
680 num = va_arg(args, size_t);
681 } else if (qualifier == 't') {
682 num = va_arg(args, ptrdiff_t);
683 } else if (qualifier == 'h') {
684 num = (unsigned short) va_arg(args, int);
686 num = (signed short) num;
688 num = va_arg(args, unsigned int);
690 num = (signed int) num;
692 str = number(str, end, num, base, field_width, precision,
702 /* the trailing null byte doesn't count towards the total */
706 int vsnprintf(char *buf, size_t size, const char *fmt,
709 return vsnprintf_internal(buf, size, fmt, args);
712 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
716 i = vsnprintf(buf, size, fmt, args);
718 if (likely(i < size))
725 int snprintf(char *buf, size_t size, const char *fmt, ...)
731 i = vsnprintf(buf, size, fmt, args);
737 int scnprintf(char *buf, size_t size, const char *fmt, ...)
743 i = vscnprintf(buf, size, fmt, args);
750 * Format a string and place it in a buffer (va_list version)
752 * @param buf The buffer to place the result into
753 * @param fmt The format string to use
754 * @param args Arguments for the format string
756 * The function returns the number of characters written
757 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
760 * If you're not already dealing with a va_list consider using sprintf().
762 int vsprintf(char *buf, const char *fmt, va_list args)
764 return vsnprintf_internal(buf, INT_MAX, fmt, args);
767 int sprintf(char *buf, const char *fmt, ...)
773 i = vsprintf(buf, fmt, args);
778 #if CONFIG_IS_ENABLED(PRINTF)
779 int printf(const char *fmt, ...)
783 char printbuffer[CONFIG_SYS_PBSIZE];
788 * For this to work, printbuffer must be larger than
789 * anything we ever want to print.
791 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
797 /* Print the string */
802 int vprintf(const char *fmt, va_list args)
805 char printbuffer[CONFIG_SYS_PBSIZE];
808 * For this to work, printbuffer must be larger than
809 * anything we ever want to print.
811 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
816 /* Print the string */
822 char *simple_itoa(ulong i)
824 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
825 static char local[22];
826 char *p = &local[21];
836 /* We don't seem to have %'d in U-Boot */
837 void print_grouped_ull(unsigned long long int_val, int digits)
842 digits = (digits + 2) / 3;
843 sprintf(str, "%*llu", digits * 3, int_val);
844 for (s = str; *s; s += grab) {
846 putc(s[-1] != ' ' ? ',' : ' ');
847 printf("%.*s", grab, s);
852 bool str2off(const char *p, loff_t *num)
856 *num = simple_strtoull(p, &endptr, 16);
857 return *p != '\0' && *endptr == '\0';
860 bool str2long(const char *p, ulong *num)
864 *num = simple_strtoul(p, &endptr, 16);
865 return *p != '\0' && *endptr == '\0';