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 /* 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)
281 const u16 *str = s ? s : L"<NULL>";
282 ssize_t i, len = utf16_strnlen(str, precision);
285 for (; len < field_width; --field_width)
287 for (i = 0; i < len && buf + utf16_utf8_strnlen(str, 1) <= end; ++i) {
288 s32 s = utf16_get(&str);
294 for (; len < field_width; --field_width)
299 static char *device_path_string(char *buf, char *end, void *dp, int field_width,
300 int precision, int flags)
304 /* If dp == NULL output the string '<NULL>' */
306 return string16(buf, end, dp, field_width, precision, flags);
308 str = efi_dp_str((struct efi_device_path *)dp);
310 return ERR_PTR(-ENOMEM);
312 buf = string16(buf, end, str, field_width, precision, flags);
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)
322 /* (6 * 2 hex digits), 5 colons and trailing zero */
323 char mac_addr[6 * 3];
327 for (i = 0; i < 6; i++) {
328 p = hex_byte_pack(p, addr[i]);
329 if (!(flags & SPECIAL) && i != 5)
334 return string(buf, end, mac_addr, field_width, precision,
338 static char *ip6_addr_string(char *buf, char *end, u8 *addr, int field_width,
339 int precision, int flags)
341 /* (8 * 4 hex digits), 7 colons and trailing zero */
342 char ip6_addr[8 * 5];
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)
354 return string(buf, end, ip6_addr, field_width, precision,
358 static char *ip4_addr_string(char *buf, char *end, u8 *addr, int field_width,
359 int precision, int flags)
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 */
367 for (i = 0; i < 4; i++) {
368 digits = put_dec_trunc(temp, addr[i]) - temp;
369 /* reverse the digits in the quad */
377 return string(buf, end, ip4_addr, field_width, precision,
382 #ifdef CONFIG_LIB_UUID
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.
388 * %pUb: 01020304-0506-0708-090a-0b0c0d0e0f10
389 * %pUl: 04030201-0605-0807-090a-0b0c0d0e0f10
391 static char *uuid_string(char *buf, char *end, u8 *addr, int field_width,
392 int precision, int flags, const char *fmt)
394 char uuid[UUID_STR_LEN + 1];
395 int str_format = UUID_STR_FORMAT_STD;
400 str_format = UUID_STR_FORMAT_GUID;
404 /* this is the default */
411 uuid_bin_to_str(addr, uuid, str_format);
413 strcpy(uuid, "<NULL>");
415 return string(buf, end, uuid, field_width, precision, flags);
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
424 * Right now we handle:
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
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.
437 static char *pointer(const char *fmt, char *buf, char *end, void *ptr,
438 int field_width, int precision, int flags)
440 u64 num = (uintptr_t)ptr;
443 * Being a boot loader, we explicitly allow pointers to
444 * (physical) address null.
448 return string(buf, end, "(null)", field_width, precision,
453 /* Device paths only exist in the EFI context. */
454 #if CONFIG_IS_ENABLED(EFI_LOADER) && !defined(API_BUILD)
456 return device_path_string(buf, end, ptr, field_width,
460 flags |= SPECIAL | ZEROPAD;
465 field_width = sizeof(phys_addr_t) * 2 + 2;
466 num = *(phys_addr_t *)ptr;
470 #ifdef CONFIG_CMD_NET
475 return mac_address_string(buf, end, ptr, field_width,
482 return ip6_addr_string(buf, end, ptr, field_width,
485 return ip4_addr_string(buf, end, ptr, field_width,
490 #ifdef CONFIG_LIB_UUID
492 return uuid_string(buf, end, ptr, field_width, precision,
499 if (field_width == -1) {
500 field_width = 2*sizeof(void *);
503 return number(buf, end, num, 16, field_width, precision, flags);
506 static int vsnprintf_internal(char *buf, size_t size, const char *fmt,
513 int flags; /* flags to number() */
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;
524 /* Make sure end is always >= buf - do we want this in U-Boot? */
531 for (; *fmt ; ++fmt) {
540 ++fmt; /* this also skips first '%' */
559 /* get field width */
562 field_width = skip_atoi(&fmt);
563 else if (*fmt == '*') {
565 /* it's the next argument */
566 field_width = va_arg(args, int);
567 if (field_width < 0) {
568 field_width = -field_width;
573 /* get the precision */
578 precision = skip_atoi(&fmt);
579 else if (*fmt == '*') {
581 /* it's the next argument */
582 precision = va_arg(args, int);
588 /* get the conversion qualifier */
590 if (*fmt == 'h' || *fmt == 'l' || *fmt == 'L' ||
591 *fmt == 'Z' || *fmt == 'z' || *fmt == 't') {
594 if (qualifier == 'l' && *fmt == 'l') {
605 if (!(flags & LEFT)) {
606 while (--field_width > 0)
609 ADDCH(str, (unsigned char) va_arg(args, int));
610 while (--field_width > 0)
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);
623 str = string(str, end, va_arg(args, char *),
624 field_width, precision, flags);
629 str = pointer(fmt + 1, str, end,
630 va_arg(args, void *),
631 field_width, precision, flags);
634 /* Skip all alphanumeric pointer suffixes */
635 while (isalnum(fmt[1]))
640 if (qualifier == 'l') {
641 long *ip = va_arg(args, long *);
644 int *ip = va_arg(args, int *);
653 /* integer number formats - set up the flags and "break" */
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);
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);
691 num = (signed short) num;
693 num = va_arg(args, unsigned int);
695 num = (signed int) num;
697 str = number(str, end, num, base, field_width, precision,
707 /* the trailing null byte doesn't count towards the total */
711 int vsnprintf(char *buf, size_t size, const char *fmt,
714 return vsnprintf_internal(buf, size, fmt, args);
717 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
721 i = vsnprintf(buf, size, fmt, args);
723 if (likely(i < size))
730 int snprintf(char *buf, size_t size, const char *fmt, ...)
736 i = vsnprintf(buf, size, fmt, args);
742 int scnprintf(char *buf, size_t size, const char *fmt, ...)
748 i = vscnprintf(buf, size, fmt, args);
755 * Format a string and place it in a buffer (va_list version)
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
761 * The function returns the number of characters written
762 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
765 * If you're not already dealing with a va_list consider using sprintf().
767 int vsprintf(char *buf, const char *fmt, va_list args)
769 return vsnprintf_internal(buf, INT_MAX, fmt, args);
772 int sprintf(char *buf, const char *fmt, ...)
778 i = vsprintf(buf, fmt, args);
783 #if CONFIG_IS_ENABLED(PRINTF)
784 int printf(const char *fmt, ...)
788 char printbuffer[CONFIG_SYS_PBSIZE];
793 * For this to work, printbuffer must be larger than
794 * anything we ever want to print.
796 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
802 /* Print the string */
807 int vprintf(const char *fmt, va_list args)
810 char printbuffer[CONFIG_SYS_PBSIZE];
813 * For this to work, printbuffer must be larger than
814 * anything we ever want to print.
816 i = vscnprintf(printbuffer, sizeof(printbuffer), fmt, args);
821 /* Print the string */
827 char *simple_itoa(ulong i)
829 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
830 static char local[22];
831 char *p = &local[21];
841 /* We don't seem to have %'d in U-Boot */
842 void print_grouped_ull(unsigned long long int_val, int digits)
847 digits = (digits + 2) / 3;
848 sprintf(str, "%*llu", digits * 3, int_val);
849 for (s = str; *s; s += grab) {
851 putc(s[-1] != ' ' ? ',' : ' ');
852 printf("%.*s", grab, s);
857 bool str2off(const char *p, loff_t *num)
861 *num = simple_strtoull(p, &endptr, 16);
862 return *p != '\0' && *endptr == '\0';
865 bool str2long(const char *p, ulong *num)
869 *num = simple_strtoul(p, &endptr, 16);
870 return *p != '\0' && *endptr == '\0';