4 * Copyright (C) 1991, 1992 Linus Torvalds
7 /* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
13 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
14 * - changed to provide snprintf and vsnprintf functions
15 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
16 * - scnprintf and vscnprintf
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/string.h>
23 #include <linux/ctype.h>
24 #include <linux/kernel.h>
25 #include <linux/kallsyms.h>
26 #include <linux/uaccess.h>
27 #include <linux/ioport.h>
28 #include <net/addrconf.h>
30 #include <asm/page.h> /* for PAGE_SIZE */
31 #include <asm/div64.h>
32 #include <asm/sections.h> /* for dereference_function_descriptor() */
34 /* Works only for digits and letters, but small and fast */
35 #define TOLOWER(x) ((x) | 0x20)
37 static unsigned int simple_guess_base(const char *cp
)
40 if (TOLOWER(cp
[1]) == 'x' && isxdigit(cp
[2]))
50 * simple_strtoul - convert a string to an unsigned long
51 * @cp: The start of the string
52 * @endp: A pointer to the end of the parsed string will be placed here
53 * @base: The number base to use
55 unsigned long simple_strtoul(const char *cp
, char **endp
, unsigned int base
)
57 unsigned long result
= 0;
60 base
= simple_guess_base(cp
);
62 if (base
== 16 && cp
[0] == '0' && TOLOWER(cp
[1]) == 'x')
65 while (isxdigit(*cp
)) {
68 value
= isdigit(*cp
) ? *cp
- '0' : TOLOWER(*cp
) - 'a' + 10;
71 result
= result
* base
+ value
;
79 EXPORT_SYMBOL(simple_strtoul
);
82 * simple_strtol - convert a string to a signed long
83 * @cp: The start of the string
84 * @endp: A pointer to the end of the parsed string will be placed here
85 * @base: The number base to use
87 long simple_strtol(const char *cp
, char **endp
, unsigned int base
)
90 return -simple_strtoul(cp
+ 1, endp
, base
);
91 return simple_strtoul(cp
, endp
, base
);
93 EXPORT_SYMBOL(simple_strtol
);
96 * simple_strtoull - convert a string to an unsigned long long
97 * @cp: The start of the string
98 * @endp: A pointer to the end of the parsed string will be placed here
99 * @base: The number base to use
101 unsigned long long simple_strtoull(const char *cp
, char **endp
, unsigned int base
)
103 unsigned long long result
= 0;
106 base
= simple_guess_base(cp
);
108 if (base
== 16 && cp
[0] == '0' && TOLOWER(cp
[1]) == 'x')
111 while (isxdigit(*cp
)) {
114 value
= isdigit(*cp
) ? *cp
- '0' : TOLOWER(*cp
) - 'a' + 10;
117 result
= result
* base
+ value
;
125 EXPORT_SYMBOL(simple_strtoull
);
128 * simple_strtoll - convert a string to a signed long long
129 * @cp: The start of the string
130 * @endp: A pointer to the end of the parsed string will be placed here
131 * @base: The number base to use
133 long long simple_strtoll(const char *cp
, char **endp
, unsigned int base
)
136 return -simple_strtoull(cp
+ 1, endp
, base
);
137 return simple_strtoull(cp
, endp
, base
);
141 * strict_strtoul - convert a string to an unsigned long strictly
142 * @cp: The string to be converted
143 * @base: The number base to use
144 * @res: The converted result value
146 * strict_strtoul converts a string to an unsigned long only if the
147 * string is really an unsigned long string, any string containing
148 * any invalid char at the tail will be rejected and -EINVAL is returned,
149 * only a newline char at the tail is acceptible because people generally
150 * change a module parameter in the following way:
152 * echo 1024 > /sys/module/e1000/parameters/copybreak
154 * echo will append a newline to the tail.
156 * It returns 0 if conversion is successful and *res is set to the converted
157 * value, otherwise it returns -EINVAL and *res is set to 0.
159 * simple_strtoul just ignores the successive invalid characters and
160 * return the converted value of prefix part of the string.
162 int strict_strtoul(const char *cp
, unsigned int base
, unsigned long *res
)
173 val
= simple_strtoul(cp
, &tail
, base
);
176 if ((*tail
== '\0') ||
177 ((len
== (size_t)(tail
- cp
) + 1) && (*tail
== '\n'))) {
184 EXPORT_SYMBOL(strict_strtoul
);
187 * strict_strtol - convert a string to a long strictly
188 * @cp: The string to be converted
189 * @base: The number base to use
190 * @res: The converted result value
192 * strict_strtol is similiar to strict_strtoul, but it allows the first
193 * character of a string is '-'.
195 * It returns 0 if conversion is successful and *res is set to the converted
196 * value, otherwise it returns -EINVAL and *res is set to 0.
198 int strict_strtol(const char *cp
, unsigned int base
, long *res
)
202 ret
= strict_strtoul(cp
+ 1, base
, (unsigned long *)res
);
206 ret
= strict_strtoul(cp
, base
, (unsigned long *)res
);
211 EXPORT_SYMBOL(strict_strtol
);
214 * strict_strtoull - convert a string to an unsigned long long strictly
215 * @cp: The string to be converted
216 * @base: The number base to use
217 * @res: The converted result value
219 * strict_strtoull converts a string to an unsigned long long only if the
220 * string is really an unsigned long long string, any string containing
221 * any invalid char at the tail will be rejected and -EINVAL is returned,
222 * only a newline char at the tail is acceptible because people generally
223 * change a module parameter in the following way:
225 * echo 1024 > /sys/module/e1000/parameters/copybreak
227 * echo will append a newline to the tail of the string.
229 * It returns 0 if conversion is successful and *res is set to the converted
230 * value, otherwise it returns -EINVAL and *res is set to 0.
232 * simple_strtoull just ignores the successive invalid characters and
233 * return the converted value of prefix part of the string.
235 int strict_strtoull(const char *cp
, unsigned int base
, unsigned long long *res
)
238 unsigned long long val
;
246 val
= simple_strtoull(cp
, &tail
, base
);
249 if ((*tail
== '\0') ||
250 ((len
== (size_t)(tail
- cp
) + 1) && (*tail
== '\n'))) {
257 EXPORT_SYMBOL(strict_strtoull
);
260 * strict_strtoll - convert a string to a long long strictly
261 * @cp: The string to be converted
262 * @base: The number base to use
263 * @res: The converted result value
265 * strict_strtoll is similiar to strict_strtoull, but it allows the first
266 * character of a string is '-'.
268 * It returns 0 if conversion is successful and *res is set to the converted
269 * value, otherwise it returns -EINVAL and *res is set to 0.
271 int strict_strtoll(const char *cp
, unsigned int base
, long long *res
)
275 ret
= strict_strtoull(cp
+ 1, base
, (unsigned long long *)res
);
279 ret
= strict_strtoull(cp
, base
, (unsigned long long *)res
);
284 EXPORT_SYMBOL(strict_strtoll
);
286 static int skip_atoi(const char **s
)
291 i
= i
*10 + *((*s
)++) - '0';
295 /* Decimal conversion is by far the most typical, and is used
296 * for /proc and /sys data. This directly impacts e.g. top performance
297 * with many processes running. We optimize it for speed
299 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
300 * (with permission from the author, Douglas W. Jones). */
302 /* Formats correctly any integer in [0,99999].
303 * Outputs from one to five digits depending on input.
304 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
305 static char* put_dec_trunc(char *buf
, unsigned q
)
307 unsigned d3
, d2
, d1
, d0
;
312 d0
= 6*(d3
+ d2
+ d1
) + (q
& 0xf);
313 q
= (d0
* 0xcd) >> 11;
315 *buf
++ = d0
+ '0'; /* least significant digit */
316 d1
= q
+ 9*d3
+ 5*d2
+ d1
;
318 q
= (d1
* 0xcd) >> 11;
320 *buf
++ = d1
+ '0'; /* next digit */
323 if ((d2
!= 0) || (d3
!= 0)) {
326 *buf
++ = d2
+ '0'; /* next digit */
330 q
= (d3
* 0xcd) >> 11;
332 *buf
++ = d3
+ '0'; /* next digit */
334 *buf
++ = q
+ '0'; /* most sign. digit */
340 /* Same with if's removed. Always emits five digits */
341 static char* put_dec_full(char *buf
, unsigned q
)
343 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
344 /* but anyway, gcc produces better code with full-sized ints */
345 unsigned d3
, d2
, d1
, d0
;
350 /* Possible ways to approx. divide by 10 */
351 /* gcc -O2 replaces multiply with shifts and adds */
352 // (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
353 // (x * 0x67) >> 10: 1100111
354 // (x * 0x34) >> 9: 110100 - same
355 // (x * 0x1a) >> 8: 11010 - same
356 // (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
358 d0
= 6*(d3
+ d2
+ d1
) + (q
& 0xf);
359 q
= (d0
* 0xcd) >> 11;
362 d1
= q
+ 9*d3
+ 5*d2
+ d1
;
363 q
= (d1
* 0xcd) >> 11;
373 q
= (d3
* 0xcd) >> 11; /* - shorter code */
374 /* q = (d3 * 0x67) >> 10; - would also work */
380 /* No inlining helps gcc to use registers better */
381 static noinline
char* put_dec(char *buf
, unsigned long long num
)
386 return put_dec_trunc(buf
, num
);
387 rem
= do_div(num
, 100000);
388 buf
= put_dec_full(buf
, rem
);
392 #define ZEROPAD 1 /* pad with zero */
393 #define SIGN 2 /* unsigned/signed long */
394 #define PLUS 4 /* show plus */
395 #define SPACE 8 /* space if plus */
396 #define LEFT 16 /* left justified */
397 #define SMALL 32 /* Must be 32 == 0x20 */
398 #define SPECIAL 64 /* 0x */
401 FORMAT_TYPE_NONE
, /* Just a string part */
403 FORMAT_TYPE_PRECISION
,
407 FORMAT_TYPE_PERCENT_CHAR
,
409 FORMAT_TYPE_LONG_LONG
,
424 enum format_type type
;
425 int flags
; /* flags to number() */
426 int field_width
; /* width of output field */
428 int precision
; /* # of digits/chars */
432 static char *number(char *buf
, char *end
, unsigned long long num
,
433 struct printf_spec spec
)
435 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
436 static const char digits
[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
441 int need_pfx
= ((spec
.flags
& SPECIAL
) && spec
.base
!= 10);
444 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
445 * produces same digits or (maybe lowercased) letters */
446 locase
= (spec
.flags
& SMALL
);
447 if (spec
.flags
& LEFT
)
448 spec
.flags
&= ~ZEROPAD
;
450 if (spec
.flags
& SIGN
) {
451 if ((signed long long) num
< 0) {
453 num
= - (signed long long) num
;
455 } else if (spec
.flags
& PLUS
) {
458 } else if (spec
.flags
& SPACE
) {
469 /* generate full string in tmp[], in reverse order */
473 /* Generic code, for any base:
475 tmp[i++] = (digits[do_div(num,base)] | locase);
478 else if (spec
.base
!= 10) { /* 8 or 16 */
479 int mask
= spec
.base
- 1;
481 if (spec
.base
== 16) shift
= 4;
483 tmp
[i
++] = (digits
[((unsigned char)num
) & mask
] | locase
);
486 } else { /* base 10 */
487 i
= put_dec(tmp
, num
) - tmp
;
490 /* printing 100 using %2d gives "100", not "00" */
491 if (i
> spec
.precision
)
493 /* leading space padding */
494 spec
.field_width
-= spec
.precision
;
495 if (!(spec
.flags
& (ZEROPAD
+LEFT
))) {
496 while(--spec
.field_width
>= 0) {
508 /* "0x" / "0" prefix */
513 if (spec
.base
== 16) {
515 *buf
= ('X' | locase
);
519 /* zero or space padding */
520 if (!(spec
.flags
& LEFT
)) {
521 char c
= (spec
.flags
& ZEROPAD
) ? '0' : ' ';
522 while (--spec
.field_width
>= 0) {
528 /* hmm even more zero padding? */
529 while (i
<= --spec
.precision
) {
534 /* actual digits of result */
540 /* trailing space padding */
541 while (--spec
.field_width
>= 0) {
549 static char *string(char *buf
, char *end
, char *s
, struct printf_spec spec
)
553 if ((unsigned long)s
< PAGE_SIZE
)
556 len
= strnlen(s
, spec
.precision
);
558 if (!(spec
.flags
& LEFT
)) {
559 while (len
< spec
.field_width
--) {
565 for (i
= 0; i
< len
; ++i
) {
570 while (len
< spec
.field_width
--) {
578 static char *symbol_string(char *buf
, char *end
, void *ptr
,
579 struct printf_spec spec
, char ext
)
581 unsigned long value
= (unsigned long) ptr
;
582 #ifdef CONFIG_KALLSYMS
583 char sym
[KSYM_SYMBOL_LEN
];
584 if (ext
!= 'f' && ext
!= 's')
585 sprint_symbol(sym
, value
);
587 kallsyms_lookup(value
, NULL
, NULL
, NULL
, sym
);
588 return string(buf
, end
, sym
, spec
);
590 spec
.field_width
= 2*sizeof(void *);
591 spec
.flags
|= SPECIAL
| SMALL
| ZEROPAD
;
593 return number(buf
, end
, value
, spec
);
597 static char *resource_string(char *buf
, char *end
, struct resource
*res
,
598 struct printf_spec spec
, const char *fmt
)
600 #ifndef IO_RSRC_PRINTK_SIZE
601 #define IO_RSRC_PRINTK_SIZE 6
604 #ifndef MEM_RSRC_PRINTK_SIZE
605 #define MEM_RSRC_PRINTK_SIZE 10
607 struct printf_spec hex_spec
= {
610 .flags
= SPECIAL
| SMALL
| ZEROPAD
,
612 struct printf_spec dec_spec
= {
617 struct printf_spec str_spec
= {
622 struct printf_spec flag_spec
= {
625 .flags
= SPECIAL
| SMALL
,
628 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
629 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
630 #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
631 #define FLAG_BUF_SIZE (2 * sizeof(res->flags))
632 #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref disabled]")
633 #define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
634 char sym
[max(2*RSRC_BUF_SIZE
+ DECODED_BUF_SIZE
,
635 2*RSRC_BUF_SIZE
+ FLAG_BUF_SIZE
+ RAW_BUF_SIZE
)];
637 char *p
= sym
, *pend
= sym
+ sizeof(sym
);
638 int size
= -1, addr
= 0;
639 int decode
= (fmt
[0] == 'R') ? 1 : 0;
641 if (res
->flags
& IORESOURCE_IO
) {
642 size
= IO_RSRC_PRINTK_SIZE
;
644 } else if (res
->flags
& IORESOURCE_MEM
) {
645 size
= MEM_RSRC_PRINTK_SIZE
;
650 if (res
->flags
& IORESOURCE_IO
)
651 p
= string(p
, pend
, "io ", str_spec
);
652 else if (res
->flags
& IORESOURCE_MEM
)
653 p
= string(p
, pend
, "mem ", str_spec
);
654 else if (res
->flags
& IORESOURCE_IRQ
)
655 p
= string(p
, pend
, "irq ", str_spec
);
656 else if (res
->flags
& IORESOURCE_DMA
)
657 p
= string(p
, pend
, "dma ", str_spec
);
659 p
= string(p
, pend
, "??? ", str_spec
);
662 hex_spec
.field_width
= size
;
663 p
= number(p
, pend
, res
->start
, addr
? hex_spec
: dec_spec
);
664 if (res
->start
!= res
->end
) {
666 p
= number(p
, pend
, res
->end
, addr
? hex_spec
: dec_spec
);
669 if (res
->flags
& IORESOURCE_MEM_64
)
670 p
= string(p
, pend
, " 64bit", str_spec
);
671 if (res
->flags
& IORESOURCE_PREFETCH
)
672 p
= string(p
, pend
, " pref", str_spec
);
673 if (res
->flags
& IORESOURCE_DISABLED
)
674 p
= string(p
, pend
, " disabled", str_spec
);
676 p
= string(p
, pend
, " flags ", str_spec
);
677 p
= number(p
, pend
, res
->flags
, flag_spec
);
682 return string(buf
, end
, sym
, spec
);
685 static char *mac_address_string(char *buf
, char *end
, u8
*addr
,
686 struct printf_spec spec
, const char *fmt
)
688 char mac_addr
[sizeof("xx:xx:xx:xx:xx:xx")];
692 for (i
= 0; i
< 6; i
++) {
693 p
= pack_hex_byte(p
, addr
[i
]);
694 if (fmt
[0] == 'M' && i
!= 5)
699 return string(buf
, end
, mac_addr
, spec
);
702 static char *ip4_string(char *p
, const u8
*addr
, bool leading_zeros
)
706 for (i
= 0; i
< 4; i
++) {
707 char temp
[3]; /* hold each IP quad in reverse order */
708 int digits
= put_dec_trunc(temp
, addr
[i
]) - temp
;
715 /* reverse the digits in the quad */
726 static char *ip6_compressed_string(char *p
, const char *addr
)
731 unsigned char zerolength
[8];
737 bool needcolon
= false;
741 memcpy(&in6
, addr
, sizeof(struct in6_addr
));
743 useIPv4
= ipv6_addr_v4mapped(&in6
) || ipv6_addr_is_isatap(&in6
);
745 memset(zerolength
, 0, sizeof(zerolength
));
752 /* find position of longest 0 run */
753 for (i
= 0; i
< range
; i
++) {
754 for (j
= i
; j
< range
; j
++) {
755 if (in6
.s6_addr16
[j
] != 0)
760 for (i
= 0; i
< range
; i
++) {
761 if (zerolength
[i
] > longest
) {
762 longest
= zerolength
[i
];
768 for (i
= 0; i
< range
; i
++) {
770 if (needcolon
|| i
== 0)
781 /* hex u16 without leading 0s */
782 word
= ntohs(in6
.s6_addr16
[i
]);
787 p
= pack_hex_byte(p
, hi
);
789 *p
++ = hex_asc_lo(hi
);
792 p
= pack_hex_byte(p
, lo
);
794 *p
++ = hex_asc_lo(lo
);
801 p
= ip4_string(p
, &in6
.s6_addr
[12], false);
808 static char *ip6_string(char *p
, const char *addr
, const char *fmt
)
811 for (i
= 0; i
< 8; i
++) {
812 p
= pack_hex_byte(p
, *addr
++);
813 p
= pack_hex_byte(p
, *addr
++);
814 if (fmt
[0] == 'I' && i
!= 7)
822 static char *ip6_addr_string(char *buf
, char *end
, const u8
*addr
,
823 struct printf_spec spec
, const char *fmt
)
825 char ip6_addr
[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
827 if (fmt
[0] == 'I' && fmt
[2] == 'c')
828 ip6_compressed_string(ip6_addr
, addr
);
830 ip6_string(ip6_addr
, addr
, fmt
);
832 return string(buf
, end
, ip6_addr
, spec
);
835 static char *ip4_addr_string(char *buf
, char *end
, const u8
*addr
,
836 struct printf_spec spec
, const char *fmt
)
838 char ip4_addr
[sizeof("255.255.255.255")];
840 ip4_string(ip4_addr
, addr
, fmt
[0] == 'i');
842 return string(buf
, end
, ip4_addr
, spec
);
846 * Show a '%p' thing. A kernel extension is that the '%p' is followed
847 * by an extra set of alphanumeric characters that are extended format
850 * Right now we handle:
852 * - 'F' For symbolic function descriptor pointers with offset
853 * - 'f' For simple symbolic function names without offset
854 * - 'S' For symbolic direct pointers with offset
855 * - 's' For symbolic direct pointers without offset
856 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
857 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
858 * - 'M' For a 6-byte MAC address, it prints the address in the
859 * usual colon-separated hex notation
860 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
861 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
862 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
863 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
864 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
865 * IPv6 omits the colons (01020304...0f)
866 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
867 * - 'I6c' for IPv6 addresses printed as specified by
868 * http://www.ietf.org/id/draft-kawamura-ipv6-text-representation-03.txt
869 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
870 * function pointers are really function descriptors, which contain a
871 * pointer to the real address.
873 static char *pointer(const char *fmt
, char *buf
, char *end
, void *ptr
,
874 struct printf_spec spec
)
877 return string(buf
, end
, "(null)", spec
);
882 ptr
= dereference_function_descriptor(ptr
);
886 return symbol_string(buf
, end
, ptr
, spec
, *fmt
);
889 return resource_string(buf
, end
, ptr
, spec
, fmt
);
890 case 'M': /* Colon separated: 00:01:02:03:04:05 */
891 case 'm': /* Contiguous: 000102030405 */
892 return mac_address_string(buf
, end
, ptr
, spec
, fmt
);
893 case 'I': /* Formatted IP supported
895 * 6: 0001:0203:...:0708
896 * 6c: 1::708 or 1::1.2.3.4
898 case 'i': /* Contiguous:
904 return ip6_addr_string(buf
, end
, ptr
, spec
, fmt
);
906 return ip4_addr_string(buf
, end
, ptr
, spec
, fmt
);
911 if (spec
.field_width
== -1) {
912 spec
.field_width
= 2*sizeof(void *);
913 spec
.flags
|= ZEROPAD
;
917 return number(buf
, end
, (unsigned long) ptr
, spec
);
921 * Helper function to decode printf style format.
922 * Each call decode a token from the format and return the
923 * number of characters read (or likely the delta where it wants
924 * to go on the next call).
925 * The decoded token is returned through the parameters
927 * 'h', 'l', or 'L' for integer fields
928 * 'z' support added 23/7/1999 S.H.
929 * 'z' changed to 'Z' --davidm 1/25/99
930 * 't' added for ptrdiff_t
932 * @fmt: the format string
933 * @type of the token returned
934 * @flags: various flags such as +, -, # tokens..
935 * @field_width: overwritten width
936 * @base: base of the number (octal, hex, ...)
937 * @precision: precision of a number
938 * @qualifier: qualifier of a number (long, size_t, ...)
940 static int format_decode(const char *fmt
, struct printf_spec
*spec
)
942 const char *start
= fmt
;
944 /* we finished early by reading the field width */
945 if (spec
->type
== FORMAT_TYPE_WIDTH
) {
946 if (spec
->field_width
< 0) {
947 spec
->field_width
= -spec
->field_width
;
950 spec
->type
= FORMAT_TYPE_NONE
;
954 /* we finished early by reading the precision */
955 if (spec
->type
== FORMAT_TYPE_PRECISION
) {
956 if (spec
->precision
< 0)
959 spec
->type
= FORMAT_TYPE_NONE
;
964 spec
->type
= FORMAT_TYPE_NONE
;
966 for (; *fmt
; ++fmt
) {
971 /* Return the current non-format string */
972 if (fmt
!= start
|| !*fmt
)
978 while (1) { /* this also skips first '%' */
984 case '-': spec
->flags
|= LEFT
; break;
985 case '+': spec
->flags
|= PLUS
; break;
986 case ' ': spec
->flags
|= SPACE
; break;
987 case '#': spec
->flags
|= SPECIAL
; break;
988 case '0': spec
->flags
|= ZEROPAD
; break;
989 default: found
= false;
996 /* get field width */
997 spec
->field_width
= -1;
1000 spec
->field_width
= skip_atoi(&fmt
);
1001 else if (*fmt
== '*') {
1002 /* it's the next argument */
1003 spec
->type
= FORMAT_TYPE_WIDTH
;
1004 return ++fmt
- start
;
1008 /* get the precision */
1009 spec
->precision
= -1;
1012 if (isdigit(*fmt
)) {
1013 spec
->precision
= skip_atoi(&fmt
);
1014 if (spec
->precision
< 0)
1015 spec
->precision
= 0;
1016 } else if (*fmt
== '*') {
1017 /* it's the next argument */
1018 spec
->type
= FORMAT_TYPE_PRECISION
;
1019 return ++fmt
- start
;
1024 /* get the conversion qualifier */
1025 spec
->qualifier
= -1;
1026 if (*fmt
== 'h' || *fmt
== 'l' || *fmt
== 'L' ||
1027 *fmt
== 'Z' || *fmt
== 'z' || *fmt
== 't') {
1028 spec
->qualifier
= *fmt
++;
1029 if (unlikely(spec
->qualifier
== *fmt
)) {
1030 if (spec
->qualifier
== 'l') {
1031 spec
->qualifier
= 'L';
1033 } else if (spec
->qualifier
== 'h') {
1034 spec
->qualifier
= 'H';
1044 spec
->type
= FORMAT_TYPE_CHAR
;
1045 return ++fmt
- start
;
1048 spec
->type
= FORMAT_TYPE_STR
;
1049 return ++fmt
- start
;
1052 spec
->type
= FORMAT_TYPE_PTR
;
1057 spec
->type
= FORMAT_TYPE_NRCHARS
;
1058 return ++fmt
- start
;
1061 spec
->type
= FORMAT_TYPE_PERCENT_CHAR
;
1062 return ++fmt
- start
;
1064 /* integer number formats - set up the flags and "break" */
1070 spec
->flags
|= SMALL
;
1078 spec
->flags
|= SIGN
;
1083 spec
->type
= FORMAT_TYPE_INVALID
;
1087 if (spec
->qualifier
== 'L')
1088 spec
->type
= FORMAT_TYPE_LONG_LONG
;
1089 else if (spec
->qualifier
== 'l') {
1090 if (spec
->flags
& SIGN
)
1091 spec
->type
= FORMAT_TYPE_LONG
;
1093 spec
->type
= FORMAT_TYPE_ULONG
;
1094 } else if (spec
->qualifier
== 'Z' || spec
->qualifier
== 'z') {
1095 spec
->type
= FORMAT_TYPE_SIZE_T
;
1096 } else if (spec
->qualifier
== 't') {
1097 spec
->type
= FORMAT_TYPE_PTRDIFF
;
1098 } else if (spec
->qualifier
== 'H') {
1099 if (spec
->flags
& SIGN
)
1100 spec
->type
= FORMAT_TYPE_BYTE
;
1102 spec
->type
= FORMAT_TYPE_UBYTE
;
1103 } else if (spec
->qualifier
== 'h') {
1104 if (spec
->flags
& SIGN
)
1105 spec
->type
= FORMAT_TYPE_SHORT
;
1107 spec
->type
= FORMAT_TYPE_USHORT
;
1109 if (spec
->flags
& SIGN
)
1110 spec
->type
= FORMAT_TYPE_INT
;
1112 spec
->type
= FORMAT_TYPE_UINT
;
1115 return ++fmt
- start
;
1119 * vsnprintf - Format a string and place it in a buffer
1120 * @buf: The buffer to place the result into
1121 * @size: The size of the buffer, including the trailing null space
1122 * @fmt: The format string to use
1123 * @args: Arguments for the format string
1125 * This function follows C99 vsnprintf, but has some extensions:
1126 * %pS output the name of a text symbol with offset
1127 * %ps output the name of a text symbol without offset
1128 * %pF output the name of a function pointer with its offset
1129 * %pf output the name of a function pointer without its offset
1130 * %pR output the address range in a struct resource
1133 * The return value is the number of characters which would
1134 * be generated for the given input, excluding the trailing
1135 * '\0', as per ISO C99. If you want to have the exact
1136 * number of characters written into @buf as return value
1137 * (not including the trailing '\0'), use vscnprintf(). If the
1138 * return is greater than or equal to @size, the resulting
1139 * string is truncated.
1141 * Call this function if you are already dealing with a va_list.
1142 * You probably want snprintf() instead.
1144 int vsnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
1146 unsigned long long num
;
1149 struct printf_spec spec
= {0};
1151 /* Reject out-of-range values early. Large positive sizes are
1152 used for unknown buffer sizes. */
1153 if (WARN_ON_ONCE((int) size
< 0))
1159 /* Make sure end is always >= buf */
1166 const char *old_fmt
= fmt
;
1168 read
= format_decode(fmt
, &spec
);
1172 switch (spec
.type
) {
1173 case FORMAT_TYPE_NONE
: {
1176 if (copy
> end
- str
)
1178 memcpy(str
, old_fmt
, copy
);
1184 case FORMAT_TYPE_WIDTH
:
1185 spec
.field_width
= va_arg(args
, int);
1188 case FORMAT_TYPE_PRECISION
:
1189 spec
.precision
= va_arg(args
, int);
1192 case FORMAT_TYPE_CHAR
:
1193 if (!(spec
.flags
& LEFT
)) {
1194 while (--spec
.field_width
> 0) {
1201 c
= (unsigned char) va_arg(args
, int);
1205 while (--spec
.field_width
> 0) {
1212 case FORMAT_TYPE_STR
:
1213 str
= string(str
, end
, va_arg(args
, char *), spec
);
1216 case FORMAT_TYPE_PTR
:
1217 str
= pointer(fmt
+1, str
, end
, va_arg(args
, void *),
1219 while (isalnum(*fmt
))
1223 case FORMAT_TYPE_PERCENT_CHAR
:
1229 case FORMAT_TYPE_INVALID
:
1235 case FORMAT_TYPE_NRCHARS
: {
1236 int qualifier
= spec
.qualifier
;
1238 if (qualifier
== 'l') {
1239 long *ip
= va_arg(args
, long *);
1241 } else if (qualifier
== 'Z' ||
1243 size_t *ip
= va_arg(args
, size_t *);
1246 int *ip
= va_arg(args
, int *);
1253 switch (spec
.type
) {
1254 case FORMAT_TYPE_LONG_LONG
:
1255 num
= va_arg(args
, long long);
1257 case FORMAT_TYPE_ULONG
:
1258 num
= va_arg(args
, unsigned long);
1260 case FORMAT_TYPE_LONG
:
1261 num
= va_arg(args
, long);
1263 case FORMAT_TYPE_SIZE_T
:
1264 num
= va_arg(args
, size_t);
1266 case FORMAT_TYPE_PTRDIFF
:
1267 num
= va_arg(args
, ptrdiff_t);
1269 case FORMAT_TYPE_UBYTE
:
1270 num
= (unsigned char) va_arg(args
, int);
1272 case FORMAT_TYPE_BYTE
:
1273 num
= (signed char) va_arg(args
, int);
1275 case FORMAT_TYPE_USHORT
:
1276 num
= (unsigned short) va_arg(args
, int);
1278 case FORMAT_TYPE_SHORT
:
1279 num
= (short) va_arg(args
, int);
1281 case FORMAT_TYPE_INT
:
1282 num
= (int) va_arg(args
, int);
1285 num
= va_arg(args
, unsigned int);
1288 str
= number(str
, end
, num
, spec
);
1299 /* the trailing null byte doesn't count towards the total */
1303 EXPORT_SYMBOL(vsnprintf
);
1306 * vscnprintf - Format a string and place it in a buffer
1307 * @buf: The buffer to place the result into
1308 * @size: The size of the buffer, including the trailing null space
1309 * @fmt: The format string to use
1310 * @args: Arguments for the format string
1312 * The return value is the number of characters which have been written into
1313 * the @buf not including the trailing '\0'. If @size is <= 0 the function
1316 * Call this function if you are already dealing with a va_list.
1317 * You probably want scnprintf() instead.
1319 * See the vsnprintf() documentation for format string extensions over C99.
1321 int vscnprintf(char *buf
, size_t size
, const char *fmt
, va_list args
)
1325 i
=vsnprintf(buf
,size
,fmt
,args
);
1326 return (i
>= size
) ? (size
- 1) : i
;
1328 EXPORT_SYMBOL(vscnprintf
);
1331 * snprintf - Format a string and place it in a buffer
1332 * @buf: The buffer to place the result into
1333 * @size: The size of the buffer, including the trailing null space
1334 * @fmt: The format string to use
1335 * @...: Arguments for the format string
1337 * The return value is the number of characters which would be
1338 * generated for the given input, excluding the trailing null,
1339 * as per ISO C99. If the return is greater than or equal to
1340 * @size, the resulting string is truncated.
1342 * See the vsnprintf() documentation for format string extensions over C99.
1344 int snprintf(char * buf
, size_t size
, const char *fmt
, ...)
1349 va_start(args
, fmt
);
1350 i
=vsnprintf(buf
,size
,fmt
,args
);
1354 EXPORT_SYMBOL(snprintf
);
1357 * scnprintf - Format a string and place it in a buffer
1358 * @buf: The buffer to place the result into
1359 * @size: The size of the buffer, including the trailing null space
1360 * @fmt: The format string to use
1361 * @...: Arguments for the format string
1363 * The return value is the number of characters written into @buf not including
1364 * the trailing '\0'. If @size is <= 0 the function returns 0.
1367 int scnprintf(char * buf
, size_t size
, const char *fmt
, ...)
1372 va_start(args
, fmt
);
1373 i
= vsnprintf(buf
, size
, fmt
, args
);
1375 return (i
>= size
) ? (size
- 1) : i
;
1377 EXPORT_SYMBOL(scnprintf
);
1380 * vsprintf - Format a string and place it in a buffer
1381 * @buf: The buffer to place the result into
1382 * @fmt: The format string to use
1383 * @args: Arguments for the format string
1385 * The function returns the number of characters written
1386 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
1389 * Call this function if you are already dealing with a va_list.
1390 * You probably want sprintf() instead.
1392 * See the vsnprintf() documentation for format string extensions over C99.
1394 int vsprintf(char *buf
, const char *fmt
, va_list args
)
1396 return vsnprintf(buf
, INT_MAX
, fmt
, args
);
1398 EXPORT_SYMBOL(vsprintf
);
1401 * sprintf - Format a string and place it in a buffer
1402 * @buf: The buffer to place the result into
1403 * @fmt: The format string to use
1404 * @...: Arguments for the format string
1406 * The function returns the number of characters written
1407 * into @buf. Use snprintf() or scnprintf() in order to avoid
1410 * See the vsnprintf() documentation for format string extensions over C99.
1412 int sprintf(char * buf
, const char *fmt
, ...)
1417 va_start(args
, fmt
);
1418 i
=vsnprintf(buf
, INT_MAX
, fmt
, args
);
1422 EXPORT_SYMBOL(sprintf
);
1424 #ifdef CONFIG_BINARY_PRINTF
1427 * vbin_printf() - VA arguments to binary data
1428 * bstr_printf() - Binary data to text string
1432 * vbin_printf - Parse a format string and place args' binary value in a buffer
1433 * @bin_buf: The buffer to place args' binary value
1434 * @size: The size of the buffer(by words(32bits), not characters)
1435 * @fmt: The format string to use
1436 * @args: Arguments for the format string
1438 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1441 * The return value is the number of words(32bits) which would be generated for
1445 * If the return value is greater than @size, the resulting bin_buf is NOT
1446 * valid for bstr_printf().
1448 int vbin_printf(u32
*bin_buf
, size_t size
, const char *fmt
, va_list args
)
1450 struct printf_spec spec
= {0};
1454 str
= (char *)bin_buf
;
1455 end
= (char *)(bin_buf
+ size
);
1457 #define save_arg(type) \
1459 if (sizeof(type) == 8) { \
1460 unsigned long long value; \
1461 str = PTR_ALIGN(str, sizeof(u32)); \
1462 value = va_arg(args, unsigned long long); \
1463 if (str + sizeof(type) <= end) { \
1464 *(u32 *)str = *(u32 *)&value; \
1465 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1468 unsigned long value; \
1469 str = PTR_ALIGN(str, sizeof(type)); \
1470 value = va_arg(args, int); \
1471 if (str + sizeof(type) <= end) \
1472 *(typeof(type) *)str = (type)value; \
1474 str += sizeof(type); \
1479 read
= format_decode(fmt
, &spec
);
1483 switch (spec
.type
) {
1484 case FORMAT_TYPE_NONE
:
1487 case FORMAT_TYPE_WIDTH
:
1488 case FORMAT_TYPE_PRECISION
:
1492 case FORMAT_TYPE_CHAR
:
1496 case FORMAT_TYPE_STR
: {
1497 const char *save_str
= va_arg(args
, char *);
1499 if ((unsigned long)save_str
> (unsigned long)-PAGE_SIZE
1500 || (unsigned long)save_str
< PAGE_SIZE
)
1501 save_str
= "<NULL>";
1502 len
= strlen(save_str
);
1503 if (str
+ len
+ 1 < end
)
1504 memcpy(str
, save_str
, len
+ 1);
1509 case FORMAT_TYPE_PTR
:
1511 /* skip all alphanumeric pointer suffixes */
1512 while (isalnum(*fmt
))
1516 case FORMAT_TYPE_PERCENT_CHAR
:
1519 case FORMAT_TYPE_INVALID
:
1522 case FORMAT_TYPE_NRCHARS
: {
1523 /* skip %n 's argument */
1524 int qualifier
= spec
.qualifier
;
1526 if (qualifier
== 'l')
1527 skip_arg
= va_arg(args
, long *);
1528 else if (qualifier
== 'Z' || qualifier
== 'z')
1529 skip_arg
= va_arg(args
, size_t *);
1531 skip_arg
= va_arg(args
, int *);
1536 switch (spec
.type
) {
1538 case FORMAT_TYPE_LONG_LONG
:
1539 save_arg(long long);
1541 case FORMAT_TYPE_ULONG
:
1542 case FORMAT_TYPE_LONG
:
1543 save_arg(unsigned long);
1545 case FORMAT_TYPE_SIZE_T
:
1548 case FORMAT_TYPE_PTRDIFF
:
1549 save_arg(ptrdiff_t);
1551 case FORMAT_TYPE_UBYTE
:
1552 case FORMAT_TYPE_BYTE
:
1555 case FORMAT_TYPE_USHORT
:
1556 case FORMAT_TYPE_SHORT
:
1564 return (u32
*)(PTR_ALIGN(str
, sizeof(u32
))) - bin_buf
;
1568 EXPORT_SYMBOL_GPL(vbin_printf
);
1571 * bstr_printf - Format a string from binary arguments and place it in a buffer
1572 * @buf: The buffer to place the result into
1573 * @size: The size of the buffer, including the trailing null space
1574 * @fmt: The format string to use
1575 * @bin_buf: Binary arguments for the format string
1577 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1578 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1579 * a binary buffer that generated by vbin_printf.
1581 * The format follows C99 vsnprintf, but has some extensions:
1582 * see vsnprintf comment for details.
1584 * The return value is the number of characters which would
1585 * be generated for the given input, excluding the trailing
1586 * '\0', as per ISO C99. If you want to have the exact
1587 * number of characters written into @buf as return value
1588 * (not including the trailing '\0'), use vscnprintf(). If the
1589 * return is greater than or equal to @size, the resulting
1590 * string is truncated.
1592 int bstr_printf(char *buf
, size_t size
, const char *fmt
, const u32
*bin_buf
)
1594 unsigned long long num
;
1596 const char *args
= (const char *)bin_buf
;
1598 struct printf_spec spec
= {0};
1600 if (WARN_ON_ONCE((int) size
< 0))
1606 #define get_arg(type) \
1608 typeof(type) value; \
1609 if (sizeof(type) == 8) { \
1610 args = PTR_ALIGN(args, sizeof(u32)); \
1611 *(u32 *)&value = *(u32 *)args; \
1612 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1614 args = PTR_ALIGN(args, sizeof(type)); \
1615 value = *(typeof(type) *)args; \
1617 args += sizeof(type); \
1621 /* Make sure end is always >= buf */
1629 const char *old_fmt
= fmt
;
1631 read
= format_decode(fmt
, &spec
);
1635 switch (spec
.type
) {
1636 case FORMAT_TYPE_NONE
: {
1639 if (copy
> end
- str
)
1641 memcpy(str
, old_fmt
, copy
);
1647 case FORMAT_TYPE_WIDTH
:
1648 spec
.field_width
= get_arg(int);
1651 case FORMAT_TYPE_PRECISION
:
1652 spec
.precision
= get_arg(int);
1655 case FORMAT_TYPE_CHAR
:
1656 if (!(spec
.flags
& LEFT
)) {
1657 while (--spec
.field_width
> 0) {
1663 c
= (unsigned char) get_arg(char);
1667 while (--spec
.field_width
> 0) {
1674 case FORMAT_TYPE_STR
: {
1675 const char *str_arg
= args
;
1676 size_t len
= strlen(str_arg
);
1678 str
= string(str
, end
, (char *)str_arg
, spec
);
1682 case FORMAT_TYPE_PTR
:
1683 str
= pointer(fmt
+1, str
, end
, get_arg(void *), spec
);
1684 while (isalnum(*fmt
))
1688 case FORMAT_TYPE_PERCENT_CHAR
:
1694 case FORMAT_TYPE_INVALID
:
1700 case FORMAT_TYPE_NRCHARS
:
1705 switch (spec
.type
) {
1707 case FORMAT_TYPE_LONG_LONG
:
1708 num
= get_arg(long long);
1710 case FORMAT_TYPE_ULONG
:
1711 num
= get_arg(unsigned long);
1713 case FORMAT_TYPE_LONG
:
1714 num
= get_arg(unsigned long);
1716 case FORMAT_TYPE_SIZE_T
:
1717 num
= get_arg(size_t);
1719 case FORMAT_TYPE_PTRDIFF
:
1720 num
= get_arg(ptrdiff_t);
1722 case FORMAT_TYPE_UBYTE
:
1723 num
= get_arg(unsigned char);
1725 case FORMAT_TYPE_BYTE
:
1726 num
= get_arg(signed char);
1728 case FORMAT_TYPE_USHORT
:
1729 num
= get_arg(unsigned short);
1731 case FORMAT_TYPE_SHORT
:
1732 num
= get_arg(short);
1734 case FORMAT_TYPE_UINT
:
1735 num
= get_arg(unsigned int);
1741 str
= number(str
, end
, num
, spec
);
1754 /* the trailing null byte doesn't count towards the total */
1757 EXPORT_SYMBOL_GPL(bstr_printf
);
1760 * bprintf - Parse a format string and place args' binary value in a buffer
1761 * @bin_buf: The buffer to place args' binary value
1762 * @size: The size of the buffer(by words(32bits), not characters)
1763 * @fmt: The format string to use
1764 * @...: Arguments for the format string
1766 * The function returns the number of words(u32) written
1769 int bprintf(u32
*bin_buf
, size_t size
, const char *fmt
, ...)
1774 va_start(args
, fmt
);
1775 ret
= vbin_printf(bin_buf
, size
, fmt
, args
);
1779 EXPORT_SYMBOL_GPL(bprintf
);
1781 #endif /* CONFIG_BINARY_PRINTF */
1784 * vsscanf - Unformat a buffer into a list of arguments
1785 * @buf: input buffer
1786 * @fmt: format of buffer
1789 int vsscanf(const char * buf
, const char * fmt
, va_list args
)
1791 const char *str
= buf
;
1800 while(*fmt
&& *str
) {
1801 /* skip any white space in format */
1802 /* white space in format matchs any amount of
1803 * white space, including none, in the input.
1805 if (isspace(*fmt
)) {
1806 while (isspace(*fmt
))
1808 while (isspace(*str
))
1812 /* anything that is not a conversion must match exactly */
1813 if (*fmt
!= '%' && *fmt
) {
1814 if (*fmt
++ != *str
++)
1823 /* skip this conversion.
1824 * advance both strings to next white space
1827 while (!isspace(*fmt
) && *fmt
!= '%' && *fmt
)
1829 while (!isspace(*str
) && *str
)
1834 /* get field width */
1837 field_width
= skip_atoi(&fmt
);
1839 /* get conversion qualifier */
1841 if (*fmt
== 'h' || *fmt
== 'l' || *fmt
== 'L' ||
1842 *fmt
== 'Z' || *fmt
== 'z') {
1844 if (unlikely(qualifier
== *fmt
)) {
1845 if (qualifier
== 'h') {
1848 } else if (qualifier
== 'l') {
1863 char *s
= (char *) va_arg(args
,char*);
1864 if (field_width
== -1)
1868 } while (--field_width
> 0 && *str
);
1874 char *s
= (char *) va_arg(args
, char *);
1875 if(field_width
== -1)
1876 field_width
= INT_MAX
;
1877 /* first, skip leading white space in buffer */
1878 while (isspace(*str
))
1881 /* now copy until next white space */
1882 while (*str
&& !isspace(*str
) && field_width
--) {
1890 /* return number of characters read so far */
1892 int *i
= (int *)va_arg(args
,int*);
1910 /* looking for '%' in str */
1915 /* invalid format; stop here */
1919 /* have some sort of integer conversion.
1920 * first, skip white space in buffer.
1922 while (isspace(*str
))
1926 if (is_sign
&& digit
== '-')
1930 || (base
== 16 && !isxdigit(digit
))
1931 || (base
== 10 && !isdigit(digit
))
1932 || (base
== 8 && (!isdigit(digit
) || digit
> '7'))
1933 || (base
== 0 && !isdigit(digit
)))
1937 case 'H': /* that's 'hh' in format */
1939 signed char *s
= (signed char *) va_arg(args
,signed char *);
1940 *s
= (signed char) simple_strtol(str
,&next
,base
);
1942 unsigned char *s
= (unsigned char *) va_arg(args
, unsigned char *);
1943 *s
= (unsigned char) simple_strtoul(str
, &next
, base
);
1948 short *s
= (short *) va_arg(args
,short *);
1949 *s
= (short) simple_strtol(str
,&next
,base
);
1951 unsigned short *s
= (unsigned short *) va_arg(args
, unsigned short *);
1952 *s
= (unsigned short) simple_strtoul(str
, &next
, base
);
1957 long *l
= (long *) va_arg(args
,long *);
1958 *l
= simple_strtol(str
,&next
,base
);
1960 unsigned long *l
= (unsigned long*) va_arg(args
,unsigned long*);
1961 *l
= simple_strtoul(str
,&next
,base
);
1966 long long *l
= (long long*) va_arg(args
,long long *);
1967 *l
= simple_strtoll(str
,&next
,base
);
1969 unsigned long long *l
= (unsigned long long*) va_arg(args
,unsigned long long*);
1970 *l
= simple_strtoull(str
,&next
,base
);
1976 size_t *s
= (size_t*) va_arg(args
,size_t*);
1977 *s
= (size_t) simple_strtoul(str
,&next
,base
);
1982 int *i
= (int *) va_arg(args
, int*);
1983 *i
= (int) simple_strtol(str
,&next
,base
);
1985 unsigned int *i
= (unsigned int*) va_arg(args
, unsigned int*);
1986 *i
= (unsigned int) simple_strtoul(str
,&next
,base
);
1998 * Now we've come all the way through so either the input string or the
1999 * format ended. In the former case, there can be a %n at the current
2000 * position in the format that needs to be filled.
2002 if (*fmt
== '%' && *(fmt
+ 1) == 'n') {
2003 int *p
= (int *)va_arg(args
, int *);
2009 EXPORT_SYMBOL(vsscanf
);
2012 * sscanf - Unformat a buffer into a list of arguments
2013 * @buf: input buffer
2014 * @fmt: formatting of buffer
2015 * @...: resulting arguments
2017 int sscanf(const char * buf
, const char * fmt
, ...)
2023 i
= vsscanf(buf
,fmt
,args
);
2027 EXPORT_SYMBOL(sscanf
);
This page took 0.074697 seconds and 6 git commands to generate.