blob: 2753f9261115e8beb3e4bef7c1d28101905cd810 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/lib/vsprintf.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
6
7/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
8/*
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
10 */
11
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080012/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * 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
17 */
18
19#include <stdarg.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050020#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/types.h>
22#include <linux/string.h>
23#include <linux/ctype.h>
24#include <linux/kernel.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070025#include <linux/kallsyms.h>
Jan Beulich53809752012-12-17 16:01:31 -080026#include <linux/math64.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070027#include <linux/uaccess.h>
Linus Torvalds332d2e72008-10-20 15:07:34 +110028#include <linux/ioport.h>
Al Viro4b6ccca2013-09-03 12:00:44 -040029#include <linux/dcache.h>
Ryan Mallon312b4e22013-11-12 15:08:51 -080030#include <linux/cred.h>
Joe Perches8a27f7c2009-08-17 12:29:44 +000031#include <net/addrconf.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Tim Schmielau4e57b682005-10-30 15:03:48 -080033#include <asm/page.h> /* for PAGE_SIZE */
James Bottomleydeac93d2008-09-03 20:43:36 -050034#include <asm/sections.h> /* for dereference_function_descriptor() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Andy Shevchenko71dca952014-10-13 15:55:18 -070036#include <linux/string_helpers.h>
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070037#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070038
Linus Torvalds1da177e2005-04-16 15:20:36 -070039/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 * simple_strtoull - convert a string to an unsigned long long
41 * @cp: The start of the string
42 * @endp: A pointer to the end of the parsed string will be placed here
43 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080044 *
45 * This function is obsolete. Please use kstrtoull instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 */
Harvey Harrison22d27052008-10-16 13:40:35 -070047unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070049 unsigned long long result;
50 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070052 cp = _parse_integer_fixup_radix(cp, &base);
53 rv = _parse_integer(cp, base, &result);
54 /* FIXME */
55 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 if (endp)
58 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 return result;
61}
Linus Torvalds1da177e2005-04-16 15:20:36 -070062EXPORT_SYMBOL(simple_strtoull);
63
64/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080065 * simple_strtoul - convert a string to an unsigned long
66 * @cp: The start of the string
67 * @endp: A pointer to the end of the parsed string will be placed here
68 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080069 *
70 * This function is obsolete. Please use kstrtoul instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080071 */
72unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
73{
74 return simple_strtoull(cp, endp, base);
75}
76EXPORT_SYMBOL(simple_strtoul);
77
78/**
79 * simple_strtol - convert a string to a signed long
80 * @cp: The start of the string
81 * @endp: A pointer to the end of the parsed string will be placed here
82 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080083 *
84 * This function is obsolete. Please use kstrtol instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080085 */
86long simple_strtol(const char *cp, char **endp, unsigned int base)
87{
88 if (*cp == '-')
89 return -simple_strtoul(cp + 1, endp, base);
90
91 return simple_strtoul(cp, endp, base);
92}
93EXPORT_SYMBOL(simple_strtol);
94
95/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * simple_strtoll - convert a string to a signed 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
Eldad Zack462e4712012-12-17 16:03:05 -0800100 *
101 * This function is obsolete. Please use kstrtoll instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 */
Harvey Harrison22d27052008-10-16 13:40:35 -0700103long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800105 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -0700106 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800107
Harvey Harrison22d27052008-10-16 13:40:35 -0700108 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109}
Hans Verkuil98d5ce02010-04-23 13:18:04 -0400110EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Joe Perchescf3b4292010-05-24 14:33:16 -0700112static noinline_for_stack
113int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800115 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800117 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 i = i*10 + *((*s)++) - '0';
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800119 } while (isdigit(**s));
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 return i;
122}
123
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700124/* Decimal conversion is by far the most typical, and is used
125 * for /proc and /sys data. This directly impacts e.g. top performance
126 * with many processes running. We optimize it for speed
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700127 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
128 * (with permission from the author, Douglas W. Jones).
129 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700130
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700131#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
132/* Formats correctly any integer in [0, 999999999] */
Joe Perchescf3b4292010-05-24 14:33:16 -0700133static noinline_for_stack
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700134char *put_dec_full9(char *buf, unsigned q)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700135{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700136 unsigned r;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700137
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800138 /*
139 * Possible ways to approx. divide by 10
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700140 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
141 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
142 * (x * 0x6667) >> 18 x < 43699
143 * (x * 0x3334) >> 17 x < 16389
144 * (x * 0x199a) >> 16 x < 16389
145 * (x * 0x0ccd) >> 15 x < 16389
146 * (x * 0x0667) >> 14 x < 2739
147 * (x * 0x0334) >> 13 x < 1029
148 * (x * 0x019a) >> 12 x < 1029
149 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
150 * (x * 0x0067) >> 10 x < 179
151 * (x * 0x0034) >> 9 x < 69 same
152 * (x * 0x001a) >> 8 x < 69 same
153 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
154 * (x * 0x0007) >> 6 x < 19
155 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800156 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700157 r = (q * (uint64_t)0x1999999a) >> 32;
158 *buf++ = (q - 10 * r) + '0'; /* 1 */
159 q = (r * (uint64_t)0x1999999a) >> 32;
160 *buf++ = (r - 10 * q) + '0'; /* 2 */
161 r = (q * (uint64_t)0x1999999a) >> 32;
162 *buf++ = (q - 10 * r) + '0'; /* 3 */
163 q = (r * (uint64_t)0x1999999a) >> 32;
164 *buf++ = (r - 10 * q) + '0'; /* 4 */
165 r = (q * (uint64_t)0x1999999a) >> 32;
166 *buf++ = (q - 10 * r) + '0'; /* 5 */
167 /* Now value is under 10000, can avoid 64-bit multiply */
168 q = (r * 0x199a) >> 16;
169 *buf++ = (r - 10 * q) + '0'; /* 6 */
170 r = (q * 0xcd) >> 11;
171 *buf++ = (q - 10 * r) + '0'; /* 7 */
172 q = (r * 0xcd) >> 11;
173 *buf++ = (r - 10 * q) + '0'; /* 8 */
174 *buf++ = q + '0'; /* 9 */
175 return buf;
176}
177#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700178
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700179/* Similar to above but do not pad with zeros.
180 * Code can be easily arranged to print 9 digits too, but our callers
181 * always call put_dec_full9() instead when the number has 9 decimal digits.
182 */
183static noinline_for_stack
184char *put_dec_trunc8(char *buf, unsigned r)
185{
186 unsigned q;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700187
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700188 /* Copy of previous function's body with added early returns */
George Spelvincb239d02012-10-04 17:12:30 -0700189 while (r >= 10000) {
190 q = r + '0';
191 r = (r * (uint64_t)0x1999999a) >> 32;
192 *buf++ = q - 10*r;
193 }
194
George Spelvinf4000512012-10-04 17:12:32 -0700195 q = (r * 0x199a) >> 16; /* r <= 9999 */
196 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700197 if (q == 0)
198 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700199 r = (q * 0xcd) >> 11; /* q <= 999 */
200 *buf++ = (q - 10 * r) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700201 if (r == 0)
202 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700203 q = (r * 0xcd) >> 11; /* r <= 99 */
204 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700205 if (q == 0)
206 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700207 *buf++ = q + '0'; /* q <= 9 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700208 return buf;
209}
210
211/* There are two algorithms to print larger numbers.
212 * One is generic: divide by 1000000000 and repeatedly print
213 * groups of (up to) 9 digits. It's conceptually simple,
214 * but requires a (unsigned long long) / 1000000000 division.
215 *
216 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
217 * manipulates them cleverly and generates groups of 4 decimal digits.
218 * It so happens that it does NOT require long long division.
219 *
220 * If long is > 32 bits, division of 64-bit values is relatively easy,
221 * and we will use the first algorithm.
222 * If long long is > 64 bits (strange architecture with VERY large long long),
223 * second algorithm can't be used, and we again use the first one.
224 *
225 * Else (if long is 32 bits and long long is 64 bits) we use second one.
226 */
227
228#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
229
230/* First algorithm: generic */
231
232static
233char *put_dec(char *buf, unsigned long long n)
234{
235 if (n >= 100*1000*1000) {
236 while (n >= 1000*1000*1000)
237 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
238 if (n >= 100*1000*1000)
239 return put_dec_full9(buf, n);
240 }
241 return put_dec_trunc8(buf, n);
242}
243
244#else
245
246/* Second algorithm: valid only for 64-bit long longs */
247
George Spelvine49317d2012-10-04 17:12:27 -0700248/* See comment in put_dec_full9 for choice of constants */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700249static noinline_for_stack
George Spelvin23591722012-10-04 17:12:29 -0700250void put_dec_full4(char *buf, unsigned q)
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700251{
252 unsigned r;
George Spelvine49317d2012-10-04 17:12:27 -0700253 r = (q * 0xccd) >> 15;
George Spelvin23591722012-10-04 17:12:29 -0700254 buf[0] = (q - 10 * r) + '0';
George Spelvine49317d2012-10-04 17:12:27 -0700255 q = (r * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700256 buf[1] = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700257 r = (q * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700258 buf[2] = (q - 10 * r) + '0';
259 buf[3] = r + '0';
260}
261
262/*
263 * Call put_dec_full4 on x % 10000, return x / 10000.
264 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
265 * holds for all x < 1,128,869,999. The largest value this
266 * helper will ever be asked to convert is 1,125,520,955.
267 * (d1 in the put_dec code, assuming n is all-ones).
268 */
269static
270unsigned put_dec_helper4(char *buf, unsigned x)
271{
272 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
273
274 put_dec_full4(buf, x - q * 10000);
275 return q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700276}
277
278/* Based on code by Douglas W. Jones found at
279 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
280 * (with permission from the author).
281 * Performs no 64-bit division and hence should be fast on 32-bit machines.
282 */
283static
284char *put_dec(char *buf, unsigned long long n)
285{
286 uint32_t d3, d2, d1, q, h;
287
288 if (n < 100*1000*1000)
289 return put_dec_trunc8(buf, n);
290
291 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
292 h = (n >> 32);
293 d2 = (h ) & 0xffff;
294 d3 = (h >> 16); /* implicit "& 0xffff" */
295
296 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
George Spelvin23591722012-10-04 17:12:29 -0700297 q = put_dec_helper4(buf, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700298
George Spelvin23591722012-10-04 17:12:29 -0700299 q += 7671 * d3 + 9496 * d2 + 6 * d1;
300 q = put_dec_helper4(buf+4, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700301
George Spelvin23591722012-10-04 17:12:29 -0700302 q += 4749 * d3 + 42 * d2;
303 q = put_dec_helper4(buf+8, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700304
George Spelvin23591722012-10-04 17:12:29 -0700305 q += 281 * d3;
306 buf += 12;
307 if (q)
308 buf = put_dec_trunc8(buf, q);
309 else while (buf[-1] == '0')
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700310 --buf;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800311
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700312 return buf;
313}
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700314
315#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700316
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700317/*
318 * Convert passed number to decimal string.
319 * Returns the length of string. On buffer overflow, returns 0.
320 *
321 * If speed is not important, use snprintf(). It's easy to read the code.
322 */
323int num_to_str(char *buf, int size, unsigned long long num)
324{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700325 char tmp[sizeof(num) * 3];
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700326 int idx, len;
327
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700328 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
329 if (num <= 9) {
330 tmp[0] = '0' + num;
331 len = 1;
332 } else {
333 len = put_dec(tmp, num) - tmp;
334 }
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700335
336 if (len > size)
337 return 0;
338 for (idx = 0; idx < len; ++idx)
339 buf[idx] = tmp[len - idx - 1];
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700340 return len;
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700341}
342
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700343#define SIGN 1 /* unsigned/signed, must be 1 */
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700344#define LEFT 2 /* left justified */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345#define PLUS 4 /* show plus */
346#define SPACE 8 /* space if plus */
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700347#define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
Bjorn Helgaasb89dc5d2010-03-05 10:47:31 -0700348#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
349#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100351enum format_type {
352 FORMAT_TYPE_NONE, /* Just a string part */
Vegard Nossumed681a92009-03-14 12:08:50 +0100353 FORMAT_TYPE_WIDTH,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100354 FORMAT_TYPE_PRECISION,
355 FORMAT_TYPE_CHAR,
356 FORMAT_TYPE_STR,
357 FORMAT_TYPE_PTR,
358 FORMAT_TYPE_PERCENT_CHAR,
359 FORMAT_TYPE_INVALID,
360 FORMAT_TYPE_LONG_LONG,
361 FORMAT_TYPE_ULONG,
362 FORMAT_TYPE_LONG,
Zhaoleia4e94ef2009-03-27 17:07:05 +0800363 FORMAT_TYPE_UBYTE,
364 FORMAT_TYPE_BYTE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100365 FORMAT_TYPE_USHORT,
366 FORMAT_TYPE_SHORT,
367 FORMAT_TYPE_UINT,
368 FORMAT_TYPE_INT,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100369 FORMAT_TYPE_SIZE_T,
370 FORMAT_TYPE_PTRDIFF
371};
372
373struct printf_spec {
Joe Perches4e310fd2010-04-14 09:27:40 -0700374 u8 type; /* format_type enum */
Joe Perchesef0658f2010-03-06 17:10:14 -0800375 u8 flags; /* flags to number() */
Joe Perches4e310fd2010-04-14 09:27:40 -0700376 u8 base; /* number base, 8, 10 or 16 only */
377 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
378 s16 field_width; /* width of output field */
379 s16 precision; /* # of digits/chars */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100380};
381
Joe Perchescf3b4292010-05-24 14:33:16 -0700382static noinline_for_stack
383char *number(char *buf, char *end, unsigned long long num,
384 struct printf_spec spec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Rasmus Villemoese26c12c2015-04-15 16:17:05 -0700386 char tmp[3 * sizeof(num)];
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100387 char sign;
388 char locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100389 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 int i;
Pierre Carrier7c203422012-05-29 15:07:35 -0700391 bool is_zero = num == 0LL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100393 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
394 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100395 locase = (spec.flags & SMALL);
396 if (spec.flags & LEFT)
397 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 sign = 0;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100399 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800400 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800402 num = -(signed long long)num;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100403 spec.field_width--;
404 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 sign = '+';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100406 spec.field_width--;
407 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 sign = ' ';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100409 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 }
411 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700412 if (need_pfx) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100413 if (spec.base == 16)
Pierre Carrier7c203422012-05-29 15:07:35 -0700414 spec.field_width -= 2;
415 else if (!is_zero)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100416 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700418
419 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 i = 0;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700421 if (num < spec.base)
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700422 tmp[i++] = hex_asc_upper[num] | locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100423 else if (spec.base != 10) { /* 8 or 16 */
424 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700425 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800426
427 if (spec.base == 16)
428 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700429 do {
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700430 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700431 num >>= shift;
432 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700433 } else { /* base 10 */
434 i = put_dec(tmp, num) - tmp;
435 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700436
437 /* printing 100 using %2d gives "100", not "00" */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100438 if (i > spec.precision)
439 spec.precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700440 /* leading space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100441 spec.field_width -= spec.precision;
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700442 if (!(spec.flags & (ZEROPAD | LEFT))) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800443 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700444 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 *buf = ' ';
446 ++buf;
447 }
448 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700449 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700451 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 *buf = sign;
453 ++buf;
454 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700455 /* "0x" / "0" prefix */
456 if (need_pfx) {
Pierre Carrier7c203422012-05-29 15:07:35 -0700457 if (spec.base == 16 || !is_zero) {
458 if (buf < end)
459 *buf = '0';
460 ++buf;
461 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100462 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700463 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100464 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 ++buf;
466 }
467 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700468 /* zero or space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100469 if (!(spec.flags & LEFT)) {
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700470 char c = ' ' + (spec.flags & ZEROPAD);
471 BUILD_BUG_ON(' ' + ZEROPAD != '0');
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100472 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700473 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 *buf = c;
475 ++buf;
476 }
477 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700478 /* hmm even more zero padding? */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100479 while (i <= --spec.precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700480 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 *buf = '0';
482 ++buf;
483 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700484 /* actual digits of result */
485 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700486 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 *buf = tmp[i];
488 ++buf;
489 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700490 /* trailing space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100491 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700492 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 *buf = ' ';
494 ++buf;
495 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 return buf;
498}
499
Joe Perchescf3b4292010-05-24 14:33:16 -0700500static noinline_for_stack
501char *string(char *buf, char *end, const char *s, struct printf_spec spec)
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700502{
503 int len, i;
504
505 if ((unsigned long)s < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -0800506 s = "(null)";
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700507
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100508 len = strnlen(s, spec.precision);
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700509
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100510 if (!(spec.flags & LEFT)) {
511 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700512 if (buf < end)
513 *buf = ' ';
514 ++buf;
515 }
516 }
517 for (i = 0; i < len; ++i) {
518 if (buf < end)
519 *buf = *s;
520 ++buf; ++s;
521 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100522 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700523 if (buf < end)
524 *buf = ' ';
525 ++buf;
526 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800527
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700528 return buf;
529}
530
Al Viro4b6ccca2013-09-03 12:00:44 -0400531static void widen(char *buf, char *end, unsigned len, unsigned spaces)
532{
533 size_t size;
534 if (buf >= end) /* nowhere to put anything */
535 return;
536 size = end - buf;
537 if (size <= spaces) {
538 memset(buf, ' ', size);
539 return;
540 }
541 if (len) {
542 if (len > size - spaces)
543 len = size - spaces;
544 memmove(buf + spaces, buf, len);
545 }
546 memset(buf, ' ', spaces);
547}
548
549static noinline_for_stack
550char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
551 const char *fmt)
552{
553 const char *array[4], *s;
554 const struct dentry *p;
555 int depth;
556 int i, n;
557
558 switch (fmt[1]) {
559 case '2': case '3': case '4':
560 depth = fmt[1] - '0';
561 break;
562 default:
563 depth = 1;
564 }
565
566 rcu_read_lock();
567 for (i = 0; i < depth; i++, d = p) {
568 p = ACCESS_ONCE(d->d_parent);
569 array[i] = ACCESS_ONCE(d->d_name.name);
570 if (p == d) {
571 if (i)
572 array[i] = "";
573 i++;
574 break;
575 }
576 }
577 s = array[--i];
578 for (n = 0; n != spec.precision; n++, buf++) {
579 char c = *s++;
580 if (!c) {
581 if (!i)
582 break;
583 c = '/';
584 s = array[--i];
585 }
586 if (buf < end)
587 *buf = c;
588 }
589 rcu_read_unlock();
590 if (n < spec.field_width) {
591 /* we want to pad the sucker */
592 unsigned spaces = spec.field_width - n;
593 if (!(spec.flags & LEFT)) {
594 widen(buf - n, end, n, spaces);
595 return buf + spaces;
596 }
597 while (spaces--) {
598 if (buf < end)
599 *buf = ' ';
600 ++buf;
601 }
602 }
603 return buf;
604}
605
Joe Perchescf3b4292010-05-24 14:33:16 -0700606static noinline_for_stack
607char *symbol_string(char *buf, char *end, void *ptr,
Joe Perchesb0d33c22012-12-12 10:18:50 -0800608 struct printf_spec spec, const char *fmt)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700609{
Joe Perchesb0d33c22012-12-12 10:18:50 -0800610 unsigned long value;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700611#ifdef CONFIG_KALLSYMS
612 char sym[KSYM_SYMBOL_LEN];
Joe Perchesb0d33c22012-12-12 10:18:50 -0800613#endif
614
615 if (fmt[1] == 'R')
616 ptr = __builtin_extract_return_addr(ptr);
617 value = (unsigned long)ptr;
618
619#ifdef CONFIG_KALLSYMS
620 if (*fmt == 'B')
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900621 sprint_backtrace(sym, value);
Joe Perchesb0d33c22012-12-12 10:18:50 -0800622 else if (*fmt != 'f' && *fmt != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200623 sprint_symbol(sym, value);
624 else
Stephen Boyd4796dd22012-05-29 15:07:33 -0700625 sprint_symbol_no_offset(sym, value);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800626
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100627 return string(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700628#else
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800629 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100630 spec.flags |= SPECIAL | SMALL | ZEROPAD;
631 spec.base = 16;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800632
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100633 return number(buf, end, value, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700634#endif
635}
636
Joe Perchescf3b4292010-05-24 14:33:16 -0700637static noinline_for_stack
638char *resource_string(char *buf, char *end, struct resource *res,
639 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +1100640{
641#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600642#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +1100643#endif
644
645#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600646#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +1100647#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700648 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100649 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700650 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100651 .precision = -1,
652 .flags = SPECIAL | SMALL | ZEROPAD,
653 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700654 static const struct printf_spec mem_spec = {
655 .base = 16,
656 .field_width = MEM_RSRC_PRINTK_SIZE,
657 .precision = -1,
658 .flags = SPECIAL | SMALL | ZEROPAD,
659 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700660 static const struct printf_spec bus_spec = {
661 .base = 16,
662 .field_width = 2,
663 .precision = -1,
664 .flags = SMALL | ZEROPAD,
665 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700666 static const struct printf_spec dec_spec = {
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600667 .base = 10,
668 .precision = -1,
669 .flags = 0,
670 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700671 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600672 .field_width = -1,
673 .precision = 10,
674 .flags = LEFT,
675 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700676 static const struct printf_spec flag_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600677 .base = 16,
678 .precision = -1,
679 .flags = SPECIAL | SMALL,
680 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600681
682 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
683 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
684#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
685#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700686#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600687#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
688 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
689 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
690
Linus Torvalds332d2e72008-10-20 15:07:34 +1100691 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600692 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700693 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +1100694
695 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700696 if (res->flags & IORESOURCE_IO) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600697 p = string(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700698 specp = &io_spec;
699 } else if (res->flags & IORESOURCE_MEM) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600700 p = string(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700701 specp = &mem_spec;
702 } else if (res->flags & IORESOURCE_IRQ) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600703 p = string(p, pend, "irq ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700704 specp = &dec_spec;
705 } else if (res->flags & IORESOURCE_DMA) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600706 p = string(p, pend, "dma ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700707 specp = &dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700708 } else if (res->flags & IORESOURCE_BUS) {
709 p = string(p, pend, "bus ", str_spec);
710 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700711 } else {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600712 p = string(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700713 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600714 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600715 }
Bjorn Helgaasd19cb802014-02-26 11:25:56 -0700716 if (decode && res->flags & IORESOURCE_UNSET) {
717 p = string(p, pend, "size ", str_spec);
718 p = number(p, pend, resource_size(res), *specp);
719 } else {
720 p = number(p, pend, res->start, *specp);
721 if (res->start != res->end) {
722 *p++ = '-';
723 p = number(p, pend, res->end, *specp);
724 }
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600725 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600726 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600727 if (res->flags & IORESOURCE_MEM_64)
728 p = string(p, pend, " 64bit", str_spec);
729 if (res->flags & IORESOURCE_PREFETCH)
730 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700731 if (res->flags & IORESOURCE_WINDOW)
732 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600733 if (res->flags & IORESOURCE_DISABLED)
734 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600735 } else {
736 p = string(p, pend, " flags ", str_spec);
737 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600738 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100739 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600740 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100741
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100742 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100743}
744
Joe Perchescf3b4292010-05-24 14:33:16 -0700745static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -0700746char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
747 const char *fmt)
748{
Steven Rostedt360603a2013-05-28 15:47:39 -0400749 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -0700750 negative value, fallback to the default */
751 char separator;
752
753 if (spec.field_width == 0)
754 /* nothing to print */
755 return buf;
756
757 if (ZERO_OR_NULL_PTR(addr))
758 /* NULL pointer */
759 return string(buf, end, NULL, spec);
760
761 switch (fmt[1]) {
762 case 'C':
763 separator = ':';
764 break;
765 case 'D':
766 separator = '-';
767 break;
768 case 'N':
769 separator = 0;
770 break;
771 default:
772 separator = ' ';
773 break;
774 }
775
776 if (spec.field_width > 0)
777 len = min_t(int, spec.field_width, 64);
778
779 for (i = 0; i < len && buf < end - 1; i++) {
780 buf = hex_byte_pack(buf, addr[i]);
781
782 if (buf < end && separator && i != len - 1)
783 *buf++ = separator;
784 }
785
786 return buf;
787}
788
789static noinline_for_stack
Tejun Heodbc760b2015-02-13 14:36:53 -0800790char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
791 struct printf_spec spec, const char *fmt)
792{
793 const int CHUNKSZ = 32;
794 int nr_bits = max_t(int, spec.field_width, 0);
795 int i, chunksz;
796 bool first = true;
797
798 /* reused to print numbers */
799 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
800
801 chunksz = nr_bits & (CHUNKSZ - 1);
802 if (chunksz == 0)
803 chunksz = CHUNKSZ;
804
805 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
806 for (; i >= 0; i -= CHUNKSZ) {
807 u32 chunkmask, val;
808 int word, bit;
809
810 chunkmask = ((1ULL << chunksz) - 1);
811 word = i / BITS_PER_LONG;
812 bit = i % BITS_PER_LONG;
813 val = (bitmap[word] >> bit) & chunkmask;
814
815 if (!first) {
816 if (buf < end)
817 *buf = ',';
818 buf++;
819 }
820 first = false;
821
822 spec.field_width = DIV_ROUND_UP(chunksz, 4);
823 buf = number(buf, end, val, spec);
824
825 chunksz = CHUNKSZ;
826 }
827 return buf;
828}
829
830static noinline_for_stack
831char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
832 struct printf_spec spec, const char *fmt)
833{
834 int nr_bits = max_t(int, spec.field_width, 0);
835 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
836 int cur, rbot, rtop;
837 bool first = true;
838
839 /* reused to print numbers */
840 spec = (struct printf_spec){ .base = 10 };
841
842 rbot = cur = find_first_bit(bitmap, nr_bits);
843 while (cur < nr_bits) {
844 rtop = cur;
845 cur = find_next_bit(bitmap, nr_bits, cur + 1);
846 if (cur < nr_bits && cur <= rtop + 1)
847 continue;
848
849 if (!first) {
850 if (buf < end)
851 *buf = ',';
852 buf++;
853 }
854 first = false;
855
856 buf = number(buf, end, rbot, spec);
857 if (rbot < rtop) {
858 if (buf < end)
859 *buf = '-';
860 buf++;
861
862 buf = number(buf, end, rtop, spec);
863 }
864
865 rbot = cur;
866 }
867 return buf;
868}
869
870static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -0700871char *mac_address_string(char *buf, char *end, u8 *addr,
872 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700873{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000874 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700875 char *p = mac_addr;
876 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000877 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700878 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000879
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700880 switch (fmt[1]) {
881 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +0000882 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700883 break;
884
885 case 'R':
886 reversed = true;
887 /* fall through */
888
889 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +0000890 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700891 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000892 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700893
894 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700895 if (reversed)
896 p = hex_byte_pack(p, addr[5 - i]);
897 else
898 p = hex_byte_pack(p, addr[i]);
899
Joe Perches8a27f7c2009-08-17 12:29:44 +0000900 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000901 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700902 }
903 *p = '\0';
904
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100905 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700906}
907
Joe Perchescf3b4292010-05-24 14:33:16 -0700908static noinline_for_stack
909char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700910{
Harvey Harrison689afa72008-10-28 16:04:44 -0700911 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800912 bool leading_zeros = (fmt[0] == 'i');
913 int index;
914 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700915
Joe Perches0159f242010-01-13 20:23:30 -0800916 switch (fmt[2]) {
917 case 'h':
918#ifdef __BIG_ENDIAN
919 index = 0;
920 step = 1;
921#else
922 index = 3;
923 step = -1;
924#endif
925 break;
926 case 'l':
927 index = 3;
928 step = -1;
929 break;
930 case 'n':
931 case 'b':
932 default:
933 index = 0;
934 step = 1;
935 break;
936 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000937 for (i = 0; i < 4; i++) {
938 char temp[3]; /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700939 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000940 if (leading_zeros) {
941 if (digits < 3)
942 *p++ = '0';
943 if (digits < 2)
944 *p++ = '0';
945 }
946 /* reverse the digits in the quad */
947 while (digits--)
948 *p++ = temp[digits];
949 if (i < 3)
950 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -0800951 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000952 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000953 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800954
Joe Perches8a27f7c2009-08-17 12:29:44 +0000955 return p;
956}
957
Joe Perchescf3b4292010-05-24 14:33:16 -0700958static noinline_for_stack
959char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000960{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800961 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000962 unsigned char zerolength[8];
963 int longest = 1;
964 int colonpos = -1;
965 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800966 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000967 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +0000968 bool useIPv4;
969 struct in6_addr in6;
970
971 memcpy(&in6, addr, sizeof(struct in6_addr));
972
973 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000974
975 memset(zerolength, 0, sizeof(zerolength));
976
977 if (useIPv4)
978 range = 6;
979 else
980 range = 8;
981
982 /* find position of longest 0 run */
983 for (i = 0; i < range; i++) {
984 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +0000985 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000986 break;
987 zerolength[i]++;
988 }
989 }
990 for (i = 0; i < range; i++) {
991 if (zerolength[i] > longest) {
992 longest = zerolength[i];
993 colonpos = i;
994 }
995 }
Joe Perches29cf5192011-06-09 11:23:37 -0700996 if (longest == 1) /* don't compress a single 0 */
997 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000998
999 /* emit address */
1000 for (i = 0; i < range; i++) {
1001 if (i == colonpos) {
1002 if (needcolon || i == 0)
1003 *p++ = ':';
1004 *p++ = ':';
1005 needcolon = false;
1006 i += longest - 1;
1007 continue;
1008 }
1009 if (needcolon) {
1010 *p++ = ':';
1011 needcolon = false;
1012 }
1013 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +00001014 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001015 hi = word >> 8;
1016 lo = word & 0xff;
1017 if (hi) {
1018 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001019 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001020 else
1021 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001022 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001023 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -08001024 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001025 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001026 else
1027 *p++ = hex_asc_lo(lo);
1028 needcolon = true;
1029 }
1030
1031 if (useIPv4) {
1032 if (needcolon)
1033 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -08001034 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +00001035 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001036 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001037
Joe Perches8a27f7c2009-08-17 12:29:44 +00001038 return p;
1039}
1040
Joe Perchescf3b4292010-05-24 14:33:16 -07001041static noinline_for_stack
1042char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001043{
1044 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001045
Harvey Harrison689afa72008-10-28 16:04:44 -07001046 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001047 p = hex_byte_pack(p, *addr++);
1048 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001049 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -07001050 *p++ = ':';
1051 }
1052 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001053
Joe Perches8a27f7c2009-08-17 12:29:44 +00001054 return p;
1055}
1056
Joe Perchescf3b4292010-05-24 14:33:16 -07001057static noinline_for_stack
1058char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1059 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001060{
1061 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1062
1063 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +00001064 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001065 else
Joe Percheseb78cd22009-09-18 13:04:06 +00001066 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -07001067
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001068 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -07001069}
1070
Joe Perchescf3b4292010-05-24 14:33:16 -07001071static noinline_for_stack
1072char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1073 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -07001074{
Joe Perches8a27f7c2009-08-17 12:29:44 +00001075 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -07001076
Joe Perches0159f242010-01-13 20:23:30 -08001077 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001078
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001079 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001080}
1081
Joe Perchescf3b4292010-05-24 14:33:16 -07001082static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001083char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1084 struct printf_spec spec, const char *fmt)
1085{
1086 bool have_p = false, have_s = false, have_f = false, have_c = false;
1087 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1088 sizeof(":12345") + sizeof("/123456789") +
1089 sizeof("%1234567890")];
1090 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1091 const u8 *addr = (const u8 *) &sa->sin6_addr;
1092 char fmt6[2] = { fmt[0], '6' };
1093 u8 off = 0;
1094
1095 fmt++;
1096 while (isalpha(*++fmt)) {
1097 switch (*fmt) {
1098 case 'p':
1099 have_p = true;
1100 break;
1101 case 'f':
1102 have_f = true;
1103 break;
1104 case 's':
1105 have_s = true;
1106 break;
1107 case 'c':
1108 have_c = true;
1109 break;
1110 }
1111 }
1112
1113 if (have_p || have_s || have_f) {
1114 *p = '[';
1115 off = 1;
1116 }
1117
1118 if (fmt6[0] == 'I' && have_c)
1119 p = ip6_compressed_string(ip6_addr + off, addr);
1120 else
1121 p = ip6_string(ip6_addr + off, addr, fmt6);
1122
1123 if (have_p || have_s || have_f)
1124 *p++ = ']';
1125
1126 if (have_p) {
1127 *p++ = ':';
1128 p = number(p, pend, ntohs(sa->sin6_port), spec);
1129 }
1130 if (have_f) {
1131 *p++ = '/';
1132 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1133 IPV6_FLOWINFO_MASK), spec);
1134 }
1135 if (have_s) {
1136 *p++ = '%';
1137 p = number(p, pend, sa->sin6_scope_id, spec);
1138 }
1139 *p = '\0';
1140
1141 return string(buf, end, ip6_addr, spec);
1142}
1143
1144static noinline_for_stack
1145char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1146 struct printf_spec spec, const char *fmt)
1147{
1148 bool have_p = false;
1149 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1150 char *pend = ip4_addr + sizeof(ip4_addr);
1151 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1152 char fmt4[3] = { fmt[0], '4', 0 };
1153
1154 fmt++;
1155 while (isalpha(*++fmt)) {
1156 switch (*fmt) {
1157 case 'p':
1158 have_p = true;
1159 break;
1160 case 'h':
1161 case 'l':
1162 case 'n':
1163 case 'b':
1164 fmt4[2] = *fmt;
1165 break;
1166 }
1167 }
1168
1169 p = ip4_string(ip4_addr, addr, fmt4);
1170 if (have_p) {
1171 *p++ = ':';
1172 p = number(p, pend, ntohs(sa->sin_port), spec);
1173 }
1174 *p = '\0';
1175
1176 return string(buf, end, ip4_addr, spec);
1177}
1178
1179static noinline_for_stack
Andy Shevchenko71dca952014-10-13 15:55:18 -07001180char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1181 const char *fmt)
1182{
1183 bool found = true;
1184 int count = 1;
1185 unsigned int flags = 0;
1186 int len;
1187
1188 if (spec.field_width == 0)
1189 return buf; /* nothing to print */
1190
1191 if (ZERO_OR_NULL_PTR(addr))
1192 return string(buf, end, NULL, spec); /* NULL pointer */
1193
1194
1195 do {
1196 switch (fmt[count++]) {
1197 case 'a':
1198 flags |= ESCAPE_ANY;
1199 break;
1200 case 'c':
1201 flags |= ESCAPE_SPECIAL;
1202 break;
1203 case 'h':
1204 flags |= ESCAPE_HEX;
1205 break;
1206 case 'n':
1207 flags |= ESCAPE_NULL;
1208 break;
1209 case 'o':
1210 flags |= ESCAPE_OCTAL;
1211 break;
1212 case 'p':
1213 flags |= ESCAPE_NP;
1214 break;
1215 case 's':
1216 flags |= ESCAPE_SPACE;
1217 break;
1218 default:
1219 found = false;
1220 break;
1221 }
1222 } while (found);
1223
1224 if (!flags)
1225 flags = ESCAPE_ANY_NP;
1226
1227 len = spec.field_width < 0 ? 1 : spec.field_width;
1228
1229 /* Ignore the error. We print as many characters as we can */
1230 string_escape_mem(addr, len, &buf, end - buf, flags, NULL);
1231
1232 return buf;
1233}
1234
1235static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001236char *uuid_string(char *buf, char *end, const u8 *addr,
1237 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001238{
1239 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1240 char *p = uuid;
1241 int i;
1242 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1243 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1244 const u8 *index = be;
1245 bool uc = false;
1246
1247 switch (*(++fmt)) {
1248 case 'L':
1249 uc = true; /* fall-through */
1250 case 'l':
1251 index = le;
1252 break;
1253 case 'B':
1254 uc = true;
1255 break;
1256 }
1257
1258 for (i = 0; i < 16; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001259 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001260 switch (i) {
1261 case 3:
1262 case 5:
1263 case 7:
1264 case 9:
1265 *p++ = '-';
1266 break;
1267 }
1268 }
1269
1270 *p = 0;
1271
1272 if (uc) {
1273 p = uuid;
1274 do {
1275 *p = toupper(*p);
1276 } while (*(++p));
1277 }
1278
1279 return string(buf, end, uuid, spec);
1280}
1281
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001282static
1283char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1284 struct printf_spec spec)
1285{
1286 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1287 if (spec.field_width == -1)
1288 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1289 spec.base = 16;
1290
1291 return number(buf, end, *(const netdev_features_t *)addr, spec);
1292}
1293
Joe Perchesaaf07622014-01-23 15:54:17 -08001294static noinline_for_stack
1295char *address_val(char *buf, char *end, const void *addr,
1296 struct printf_spec spec, const char *fmt)
1297{
1298 unsigned long long num;
1299
1300 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1301 spec.base = 16;
1302
1303 switch (fmt[1]) {
1304 case 'd':
1305 num = *(const dma_addr_t *)addr;
1306 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1307 break;
1308 case 'p':
1309 default:
1310 num = *(const phys_addr_t *)addr;
1311 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1312 break;
1313 }
1314
1315 return number(buf, end, num, spec);
1316}
1317
Ingo Molnar411f05f2011-05-12 23:00:28 +02001318int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001319
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001320/*
1321 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1322 * by an extra set of alphanumeric characters that are extended format
1323 * specifiers.
1324 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001325 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001326 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001327 * - 'F' For symbolic function descriptor pointers with offset
1328 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001329 * - 'S' For symbolic direct pointers with offset
1330 * - 's' For symbolic direct pointers without offset
Joe Perchesb0d33c22012-12-12 10:18:50 -08001331 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001332 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001333 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1334 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Tejun Heodbc760b2015-02-13 14:36:53 -08001335 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1336 * width which must be explicitly specified either as part of the
1337 * format string '%32b[l]' or through '%*b[l]', [l] selects
1338 * range-list format instead of hex format
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001339 * - 'M' For a 6-byte MAC address, it prints the address in the
1340 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00001341 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00001342 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08001343 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07001344 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001345 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1346 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1347 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02001348 * [S][pfs]
1349 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1350 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00001351 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1352 * IPv6 omits the colons (01020304...0f)
1353 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02001354 * [S][pfs]
1355 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1356 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1357 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1358 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07001359 * http://tools.ietf.org/html/rfc5952
Andy Shevchenko71dca952014-10-13 15:55:18 -07001360 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1361 * of the following flags (see string_escape_mem() for the
1362 * details):
1363 * a - ESCAPE_ANY
1364 * c - ESCAPE_SPECIAL
1365 * h - ESCAPE_HEX
1366 * n - ESCAPE_NULL
1367 * o - ESCAPE_OCTAL
1368 * p - ESCAPE_NP
1369 * s - ESCAPE_SPACE
1370 * By default ESCAPE_ANY_NP is used.
Joe Perches9ac6e442009-12-14 18:01:09 -08001371 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1372 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1373 * Options for %pU are:
1374 * b big endian lower case hex (default)
1375 * B big endian UPPER case hex
1376 * l little endian lower case hex
1377 * L little endian UPPER case hex
1378 * big endian output byte order is:
1379 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1380 * little endian output byte order is:
1381 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00001382 * - 'V' For a struct va_format which contains a format string * and va_list *,
1383 * call vsnprintf(->format, *->va_list).
1384 * Implements a "recursive vsnprintf".
1385 * Do not use this feature without some mechanism to verify the
1386 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001387 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001388 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07001389 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1390 * a certain separator (' ' by default):
1391 * C colon
1392 * D dash
1393 * N no separator
1394 * The maximum supported length is 64 bytes of the input. Consider
1395 * to use print_hex_dump() for the larger input.
Joe Perchesaaf07622014-01-23 15:54:17 -08001396 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1397 * (default assumed to be phys_addr_t, passed by reference)
Olof Johanssonc0d92a52013-11-12 15:09:50 -08001398 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1399 * - 'D[234]' Same as 'd' but for a struct file
Joe Perches9ac6e442009-12-14 18:01:09 -08001400 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001401 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1402 * function pointers are really function descriptors, which contain a
1403 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001404 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001405static noinline_for_stack
1406char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1407 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001408{
Grant Likely725fe002012-05-31 16:26:08 -07001409 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1410
Kees Cook9f36e2c2011-03-22 16:34:22 -07001411 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -07001412 /*
1413 * Print (null) with the same width as a pointer so it makes
1414 * tabular output look nice.
1415 */
1416 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001417 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001418 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -07001419 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -08001420
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001421 switch (*fmt) {
1422 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001423 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001424 ptr = dereference_function_descriptor(ptr);
1425 /* Fallthrough */
1426 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08001427 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001428 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08001429 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001430 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001431 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001432 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07001433 case 'h':
1434 return hex_string(buf, end, ptr, spec, fmt);
Tejun Heodbc760b2015-02-13 14:36:53 -08001435 case 'b':
1436 switch (fmt[1]) {
1437 case 'l':
1438 return bitmap_list_string(buf, end, ptr, spec, fmt);
1439 default:
1440 return bitmap_string(buf, end, ptr, spec, fmt);
1441 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001442 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1443 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001444 /* [mM]F (FDDI) */
1445 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00001446 return mac_address_string(buf, end, ptr, spec, fmt);
1447 case 'I': /* Formatted IP supported
1448 * 4: 1.2.3.4
1449 * 6: 0001:0203:...:0708
1450 * 6c: 1::708 or 1::1.2.3.4
1451 */
1452 case 'i': /* Contiguous:
1453 * 4: 001.002.003.004
1454 * 6: 000102...0f
1455 */
1456 switch (fmt[1]) {
1457 case '6':
1458 return ip6_addr_string(buf, end, ptr, spec, fmt);
1459 case '4':
1460 return ip4_addr_string(buf, end, ptr, spec, fmt);
Daniel Borkmann10679642013-06-28 19:49:39 +02001461 case 'S': {
1462 const union {
1463 struct sockaddr raw;
1464 struct sockaddr_in v4;
1465 struct sockaddr_in6 v6;
1466 } *sa = ptr;
1467
1468 switch (sa->raw.sa_family) {
1469 case AF_INET:
1470 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1471 case AF_INET6:
1472 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1473 default:
1474 return string(buf, end, "(invalid address)", spec);
1475 }}
Joe Perches8a27f7c2009-08-17 12:29:44 +00001476 }
Harvey Harrison4aa99602008-10-29 12:49:58 -07001477 break;
Andy Shevchenko71dca952014-10-13 15:55:18 -07001478 case 'E':
1479 return escaped_string(buf, end, ptr, spec, fmt);
Joe Perches9ac6e442009-12-14 18:01:09 -08001480 case 'U':
1481 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00001482 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +00001483 {
1484 va_list va;
1485
1486 va_copy(va, *((struct va_format *)ptr)->va);
1487 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1488 ((struct va_format *)ptr)->fmt, va);
1489 va_end(va);
1490 return buf;
1491 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001492 case 'K':
1493 /*
1494 * %pK cannot be used in IRQ context because its test
1495 * for CAP_SYSLOG would be meaningless.
1496 */
Dan Rosenberg3715c5302012-07-30 14:40:26 -07001497 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1498 in_nmi())) {
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001499 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001500 spec.field_width = default_width;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001501 return string(buf, end, "pK-error", spec);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001502 }
Ryan Mallon312b4e22013-11-12 15:08:51 -08001503
1504 switch (kptr_restrict) {
1505 case 0:
1506 /* Always print %pK values */
1507 break;
1508 case 1: {
1509 /*
1510 * Only print the real pointer value if the current
1511 * process has CAP_SYSLOG and is running with the
1512 * same credentials it started with. This is because
1513 * access to files is checked at open() time, but %pK
1514 * checks permission at read() time. We don't want to
1515 * leak pointer values if a binary opens a file using
1516 * %pK and then elevates privileges before reading it.
1517 */
1518 const struct cred *cred = current_cred();
1519
1520 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1521 !uid_eq(cred->euid, cred->uid) ||
1522 !gid_eq(cred->egid, cred->gid))
1523 ptr = NULL;
1524 break;
1525 }
1526 case 2:
1527 default:
1528 /* Always print 0's for %pK */
Joe Perches26297602011-03-22 16:34:19 -07001529 ptr = NULL;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001530 break;
1531 }
Joe Perches26297602011-03-22 16:34:19 -07001532 break;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001533
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001534 case 'N':
1535 switch (fmt[1]) {
1536 case 'F':
1537 return netdev_feature_string(buf, end, ptr, spec);
1538 }
1539 break;
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001540 case 'a':
Joe Perchesaaf07622014-01-23 15:54:17 -08001541 return address_val(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04001542 case 'd':
1543 return dentry_name(buf, end, ptr, spec, fmt);
1544 case 'D':
1545 return dentry_name(buf, end,
1546 ((const struct file *)ptr)->f_path.dentry,
1547 spec, fmt);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001548 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001549 spec.flags |= SMALL;
1550 if (spec.field_width == -1) {
Grant Likely725fe002012-05-31 16:26:08 -07001551 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001552 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001553 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001554 spec.base = 16;
1555
1556 return number(buf, end, (unsigned long) ptr, spec);
1557}
1558
1559/*
1560 * Helper function to decode printf style format.
1561 * Each call decode a token from the format and return the
1562 * number of characters read (or likely the delta where it wants
1563 * to go on the next call).
1564 * The decoded token is returned through the parameters
1565 *
1566 * 'h', 'l', or 'L' for integer fields
1567 * 'z' support added 23/7/1999 S.H.
1568 * 'z' changed to 'Z' --davidm 1/25/99
1569 * 't' added for ptrdiff_t
1570 *
1571 * @fmt: the format string
1572 * @type of the token returned
1573 * @flags: various flags such as +, -, # tokens..
1574 * @field_width: overwritten width
1575 * @base: base of the number (octal, hex, ...)
1576 * @precision: precision of a number
1577 * @qualifier: qualifier of a number (long, size_t, ...)
1578 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001579static noinline_for_stack
1580int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001581{
1582 const char *start = fmt;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001583
1584 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01001585 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001586 if (spec->field_width < 0) {
1587 spec->field_width = -spec->field_width;
1588 spec->flags |= LEFT;
1589 }
1590 spec->type = FORMAT_TYPE_NONE;
1591 goto precision;
1592 }
1593
1594 /* we finished early by reading the precision */
1595 if (spec->type == FORMAT_TYPE_PRECISION) {
1596 if (spec->precision < 0)
1597 spec->precision = 0;
1598
1599 spec->type = FORMAT_TYPE_NONE;
1600 goto qualifier;
1601 }
1602
1603 /* By default */
1604 spec->type = FORMAT_TYPE_NONE;
1605
1606 for (; *fmt ; ++fmt) {
1607 if (*fmt == '%')
1608 break;
1609 }
1610
1611 /* Return the current non-format string */
1612 if (fmt != start || !*fmt)
1613 return fmt - start;
1614
1615 /* Process flags */
1616 spec->flags = 0;
1617
1618 while (1) { /* this also skips first '%' */
1619 bool found = true;
1620
1621 ++fmt;
1622
1623 switch (*fmt) {
1624 case '-': spec->flags |= LEFT; break;
1625 case '+': spec->flags |= PLUS; break;
1626 case ' ': spec->flags |= SPACE; break;
1627 case '#': spec->flags |= SPECIAL; break;
1628 case '0': spec->flags |= ZEROPAD; break;
1629 default: found = false;
1630 }
1631
1632 if (!found)
1633 break;
1634 }
1635
1636 /* get field width */
1637 spec->field_width = -1;
1638
1639 if (isdigit(*fmt))
1640 spec->field_width = skip_atoi(&fmt);
1641 else if (*fmt == '*') {
1642 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001643 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001644 return ++fmt - start;
1645 }
1646
1647precision:
1648 /* get the precision */
1649 spec->precision = -1;
1650 if (*fmt == '.') {
1651 ++fmt;
1652 if (isdigit(*fmt)) {
1653 spec->precision = skip_atoi(&fmt);
1654 if (spec->precision < 0)
1655 spec->precision = 0;
1656 } else if (*fmt == '*') {
1657 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001658 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001659 return ++fmt - start;
1660 }
1661 }
1662
1663qualifier:
1664 /* get the conversion qualifier */
1665 spec->qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001666 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1667 _tolower(*fmt) == 'z' || *fmt == 't') {
Zhaoleia4e94ef2009-03-27 17:07:05 +08001668 spec->qualifier = *fmt++;
1669 if (unlikely(spec->qualifier == *fmt)) {
1670 if (spec->qualifier == 'l') {
1671 spec->qualifier = 'L';
1672 ++fmt;
1673 } else if (spec->qualifier == 'h') {
1674 spec->qualifier = 'H';
1675 ++fmt;
1676 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001677 }
1678 }
1679
1680 /* default base */
1681 spec->base = 10;
1682 switch (*fmt) {
1683 case 'c':
1684 spec->type = FORMAT_TYPE_CHAR;
1685 return ++fmt - start;
1686
1687 case 's':
1688 spec->type = FORMAT_TYPE_STR;
1689 return ++fmt - start;
1690
1691 case 'p':
1692 spec->type = FORMAT_TYPE_PTR;
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001693 return ++fmt - start;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001694
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001695 case '%':
1696 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1697 return ++fmt - start;
1698
1699 /* integer number formats - set up the flags and "break" */
1700 case 'o':
1701 spec->base = 8;
1702 break;
1703
1704 case 'x':
1705 spec->flags |= SMALL;
1706
1707 case 'X':
1708 spec->base = 16;
1709 break;
1710
1711 case 'd':
1712 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001713 spec->flags |= SIGN;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001714 case 'u':
1715 break;
1716
Ryan Mallon708d96f2014-04-03 14:48:37 -07001717 case 'n':
1718 /*
1719 * Since %n poses a greater security risk than utility, treat
1720 * it as an invalid format specifier. Warn about its use so
1721 * that new instances don't get added.
1722 */
1723 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1724 /* Fall-through */
1725
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001726 default:
1727 spec->type = FORMAT_TYPE_INVALID;
1728 return fmt - start;
1729 }
1730
1731 if (spec->qualifier == 'L')
1732 spec->type = FORMAT_TYPE_LONG_LONG;
1733 else if (spec->qualifier == 'l') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001734 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1735 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001736 } else if (_tolower(spec->qualifier) == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001737 spec->type = FORMAT_TYPE_SIZE_T;
1738 } else if (spec->qualifier == 't') {
1739 spec->type = FORMAT_TYPE_PTRDIFF;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001740 } else if (spec->qualifier == 'H') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001741 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1742 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001743 } else if (spec->qualifier == 'h') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001744 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1745 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001746 } else {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001747 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1748 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001749 }
1750
1751 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001752}
1753
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754/**
1755 * vsnprintf - Format a string and place it in a buffer
1756 * @buf: The buffer to place the result into
1757 * @size: The size of the buffer, including the trailing null space
1758 * @fmt: The format string to use
1759 * @args: Arguments for the format string
1760 *
Andi Kleen20036fd2008-10-15 22:02:02 -07001761 * This function follows C99 vsnprintf, but has some extensions:
Steven Rostedt91adcd22009-09-16 20:03:06 -04001762 * %pS output the name of a text symbol with offset
1763 * %ps output the name of a text symbol without offset
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001764 * %pF output the name of a function pointer with its offset
1765 * %pf output the name of a function pointer without its offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001766 * %pB output the name of a backtrace symbol with its offset
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001767 * %pR output the address range in a struct resource with decoded flags
1768 * %pr output the address range in a struct resource with raw flags
Tejun Heodbc760b2015-02-13 14:36:53 -08001769 * %pb output the bitmap with field width as the number of bits
1770 * %pbl output the bitmap as range list with field width as the number of bits
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001771 * %pM output a 6-byte MAC address with colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001772 * %pMR output a 6-byte MAC address with colons in reversed order
1773 * %pMF output a 6-byte MAC address with dashes
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001774 * %pm output a 6-byte MAC address without colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001775 * %pmR output a 6-byte MAC address without colons in reversed order
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001776 * %pI4 print an IPv4 address without leading zeros
1777 * %pi4 print an IPv4 address with leading zeros
1778 * %pI6 print an IPv6 address with colons
1779 * %pi6 print an IPv6 address without colons
Jan Engelhardtf996f202011-07-14 18:48:56 +02001780 * %pI6c print an IPv6 address as specified by RFC 5952
Daniel Borkmann10679642013-06-28 19:49:39 +02001781 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1782 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001783 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1784 * case.
Andy Shevchenko71dca952014-10-13 15:55:18 -07001785 * %*pE[achnops] print an escaped buffer
Andy Shevchenko31550a12012-07-30 14:40:27 -07001786 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1787 * bytes of the input)
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001788 * %n is ignored
Andi Kleen20036fd2008-10-15 22:02:02 -07001789 *
Andrew Morton80f548e2012-07-30 14:40:25 -07001790 * ** Please update Documentation/printk-formats.txt when making changes **
1791 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 * The return value is the number of characters which would
1793 * be generated for the given input, excluding the trailing
1794 * '\0', as per ISO C99. If you want to have the exact
1795 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001796 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 * return is greater than or equal to @size, the resulting
1798 * string is truncated.
1799 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001800 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 */
1802int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1803{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001805 char *str, *end;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001806 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001808 /* Reject out-of-range values early. Large positive sizes are
1809 used for unknown buffer sizes. */
Rasmus Villemoes2aa2f9e2015-02-12 15:01:39 -08001810 if (WARN_ON_ONCE(size > INT_MAX))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812
1813 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001814 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001816 /* Make sure end is always >= buf */
1817 if (end < buf) {
1818 end = ((void *)-1);
1819 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 }
1821
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001822 while (*fmt) {
1823 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001824 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001825
1826 fmt += read;
1827
1828 switch (spec.type) {
1829 case FORMAT_TYPE_NONE: {
1830 int copy = read;
1831 if (str < end) {
1832 if (copy > end - str)
1833 copy = end - str;
1834 memcpy(str, old_fmt, copy);
1835 }
1836 str += read;
1837 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 }
1839
Vegard Nossumed681a92009-03-14 12:08:50 +01001840 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001841 spec.field_width = va_arg(args, int);
1842 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001844 case FORMAT_TYPE_PRECISION:
1845 spec.precision = va_arg(args, int);
1846 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847
André Goddard Rosad4be1512009-12-14 18:00:59 -08001848 case FORMAT_TYPE_CHAR: {
1849 char c;
1850
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001851 if (!(spec.flags & LEFT)) {
1852 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001853 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 *str = ' ';
1855 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001856
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001858 }
1859 c = (unsigned char) va_arg(args, int);
1860 if (str < end)
1861 *str = c;
1862 ++str;
1863 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001864 if (str < end)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001865 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001867 }
1868 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001869 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001871 case FORMAT_TYPE_STR:
1872 str = string(str, end, va_arg(args, char *), spec);
1873 break;
1874
1875 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001876 str = pointer(fmt, str, end, va_arg(args, void *),
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001877 spec);
1878 while (isalnum(*fmt))
1879 fmt++;
1880 break;
1881
1882 case FORMAT_TYPE_PERCENT_CHAR:
1883 if (str < end)
1884 *str = '%';
1885 ++str;
1886 break;
1887
1888 case FORMAT_TYPE_INVALID:
1889 if (str < end)
1890 *str = '%';
1891 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001892 break;
1893
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001894 default:
1895 switch (spec.type) {
1896 case FORMAT_TYPE_LONG_LONG:
1897 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001899 case FORMAT_TYPE_ULONG:
1900 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001902 case FORMAT_TYPE_LONG:
1903 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001905 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08001906 if (spec.flags & SIGN)
1907 num = va_arg(args, ssize_t);
1908 else
1909 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001910 break;
1911 case FORMAT_TYPE_PTRDIFF:
1912 num = va_arg(args, ptrdiff_t);
1913 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001914 case FORMAT_TYPE_UBYTE:
1915 num = (unsigned char) va_arg(args, int);
1916 break;
1917 case FORMAT_TYPE_BYTE:
1918 num = (signed char) va_arg(args, int);
1919 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001920 case FORMAT_TYPE_USHORT:
1921 num = (unsigned short) va_arg(args, int);
1922 break;
1923 case FORMAT_TYPE_SHORT:
1924 num = (short) va_arg(args, int);
1925 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001926 case FORMAT_TYPE_INT:
1927 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001928 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001930 num = va_arg(args, unsigned int);
1931 }
1932
1933 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001936
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001937 if (size > 0) {
1938 if (str < end)
1939 *str = '\0';
1940 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07001941 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001942 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001943
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001944 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 return str-buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001946
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948EXPORT_SYMBOL(vsnprintf);
1949
1950/**
1951 * vscnprintf - Format a string and place it in a buffer
1952 * @buf: The buffer to place the result into
1953 * @size: The size of the buffer, including the trailing null space
1954 * @fmt: The format string to use
1955 * @args: Arguments for the format string
1956 *
1957 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08001958 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 * returns 0.
1960 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001961 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001962 *
1963 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 */
1965int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1966{
1967 int i;
1968
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001969 i = vsnprintf(buf, size, fmt, args);
1970
Anton Arapovb921c692011-01-12 16:59:49 -08001971 if (likely(i < size))
1972 return i;
1973 if (size != 0)
1974 return size - 1;
1975 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977EXPORT_SYMBOL(vscnprintf);
1978
1979/**
1980 * snprintf - Format a string and place it in a buffer
1981 * @buf: The buffer to place the result into
1982 * @size: The size of the buffer, including the trailing null space
1983 * @fmt: The format string to use
1984 * @...: Arguments for the format string
1985 *
1986 * The return value is the number of characters which would be
1987 * generated for the given input, excluding the trailing null,
1988 * as per ISO C99. If the return is greater than or equal to
1989 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07001990 *
1991 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001993int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994{
1995 va_list args;
1996 int i;
1997
1998 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001999 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002001
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 return i;
2003}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004EXPORT_SYMBOL(snprintf);
2005
2006/**
2007 * scnprintf - Format a string and place it in a buffer
2008 * @buf: The buffer to place the result into
2009 * @size: The size of the buffer, including the trailing null space
2010 * @fmt: The format string to use
2011 * @...: Arguments for the format string
2012 *
2013 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07002014 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 */
2016
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002017int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018{
2019 va_list args;
2020 int i;
2021
2022 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08002023 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002025
Anton Arapovb921c692011-01-12 16:59:49 -08002026 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027}
2028EXPORT_SYMBOL(scnprintf);
2029
2030/**
2031 * vsprintf - Format a string and place it in a buffer
2032 * @buf: The buffer to place the result into
2033 * @fmt: The format string to use
2034 * @args: Arguments for the format string
2035 *
2036 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002037 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 * buffer overflows.
2039 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002040 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002041 *
2042 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 */
2044int vsprintf(char *buf, const char *fmt, va_list args)
2045{
2046 return vsnprintf(buf, INT_MAX, fmt, args);
2047}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048EXPORT_SYMBOL(vsprintf);
2049
2050/**
2051 * sprintf - Format a string and place it in a buffer
2052 * @buf: The buffer to place the result into
2053 * @fmt: The format string to use
2054 * @...: Arguments for the format string
2055 *
2056 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002057 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07002059 *
2060 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002062int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063{
2064 va_list args;
2065 int i;
2066
2067 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002068 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002070
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 return i;
2072}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073EXPORT_SYMBOL(sprintf);
2074
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002075#ifdef CONFIG_BINARY_PRINTF
2076/*
2077 * bprintf service:
2078 * vbin_printf() - VA arguments to binary data
2079 * bstr_printf() - Binary data to text string
2080 */
2081
2082/**
2083 * vbin_printf - Parse a format string and place args' binary value in a buffer
2084 * @bin_buf: The buffer to place args' binary value
2085 * @size: The size of the buffer(by words(32bits), not characters)
2086 * @fmt: The format string to use
2087 * @args: Arguments for the format string
2088 *
2089 * The format follows C99 vsnprintf, except %n is ignored, and its argument
Masanari Iidada3dae52014-09-09 01:27:23 +09002090 * is skipped.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002091 *
2092 * The return value is the number of words(32bits) which would be generated for
2093 * the given input.
2094 *
2095 * NOTE:
2096 * If the return value is greater than @size, the resulting bin_buf is NOT
2097 * valid for bstr_printf().
2098 */
2099int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2100{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002101 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002102 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002103
2104 str = (char *)bin_buf;
2105 end = (char *)(bin_buf + size);
2106
2107#define save_arg(type) \
2108do { \
2109 if (sizeof(type) == 8) { \
2110 unsigned long long value; \
2111 str = PTR_ALIGN(str, sizeof(u32)); \
2112 value = va_arg(args, unsigned long long); \
2113 if (str + sizeof(type) <= end) { \
2114 *(u32 *)str = *(u32 *)&value; \
2115 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2116 } \
2117 } else { \
2118 unsigned long value; \
2119 str = PTR_ALIGN(str, sizeof(type)); \
2120 value = va_arg(args, int); \
2121 if (str + sizeof(type) <= end) \
2122 *(typeof(type) *)str = (type)value; \
2123 } \
2124 str += sizeof(type); \
2125} while (0)
2126
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002127 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08002128 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002129
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002130 fmt += read;
2131
2132 switch (spec.type) {
2133 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08002134 case FORMAT_TYPE_INVALID:
2135 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002136 break;
2137
Vegard Nossumed681a92009-03-14 12:08:50 +01002138 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002139 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002140 save_arg(int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002141 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002142
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002143 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002144 save_arg(char);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002145 break;
2146
2147 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002148 const char *save_str = va_arg(args, char *);
2149 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08002150
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002151 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2152 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08002153 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08002154 len = strlen(save_str) + 1;
2155 if (str + len < end)
2156 memcpy(str, save_str, len);
2157 str += len;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002158 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002159 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002160
2161 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002162 save_arg(void *);
2163 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002164 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002165 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002166 break;
2167
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002168 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002169 switch (spec.type) {
2170
2171 case FORMAT_TYPE_LONG_LONG:
2172 save_arg(long long);
2173 break;
2174 case FORMAT_TYPE_ULONG:
2175 case FORMAT_TYPE_LONG:
2176 save_arg(unsigned long);
2177 break;
2178 case FORMAT_TYPE_SIZE_T:
2179 save_arg(size_t);
2180 break;
2181 case FORMAT_TYPE_PTRDIFF:
2182 save_arg(ptrdiff_t);
2183 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002184 case FORMAT_TYPE_UBYTE:
2185 case FORMAT_TYPE_BYTE:
2186 save_arg(char);
2187 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002188 case FORMAT_TYPE_USHORT:
2189 case FORMAT_TYPE_SHORT:
2190 save_arg(short);
2191 break;
2192 default:
2193 save_arg(int);
2194 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002195 }
2196 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002197
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002198 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002199#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002200}
2201EXPORT_SYMBOL_GPL(vbin_printf);
2202
2203/**
2204 * bstr_printf - Format a string from binary arguments and place it in a buffer
2205 * @buf: The buffer to place the result into
2206 * @size: The size of the buffer, including the trailing null space
2207 * @fmt: The format string to use
2208 * @bin_buf: Binary arguments for the format string
2209 *
2210 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2211 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2212 * a binary buffer that generated by vbin_printf.
2213 *
2214 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002215 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002216 *
2217 * The return value is the number of characters which would
2218 * be generated for the given input, excluding the trailing
2219 * '\0', as per ISO C99. If you want to have the exact
2220 * number of characters written into @buf as return value
2221 * (not including the trailing '\0'), use vscnprintf(). If the
2222 * return is greater than or equal to @size, the resulting
2223 * string is truncated.
2224 */
2225int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2226{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002227 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002228 char *str, *end;
2229 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002230
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07002231 if (WARN_ON_ONCE((int) size < 0))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002232 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002233
2234 str = buf;
2235 end = buf + size;
2236
2237#define get_arg(type) \
2238({ \
2239 typeof(type) value; \
2240 if (sizeof(type) == 8) { \
2241 args = PTR_ALIGN(args, sizeof(u32)); \
2242 *(u32 *)&value = *(u32 *)args; \
2243 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2244 } else { \
2245 args = PTR_ALIGN(args, sizeof(type)); \
2246 value = *(typeof(type) *)args; \
2247 } \
2248 args += sizeof(type); \
2249 value; \
2250})
2251
2252 /* Make sure end is always >= buf */
2253 if (end < buf) {
2254 end = ((void *)-1);
2255 size = end - buf;
2256 }
2257
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002258 while (*fmt) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002259 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002260 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002261
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002262 fmt += read;
2263
2264 switch (spec.type) {
2265 case FORMAT_TYPE_NONE: {
2266 int copy = read;
2267 if (str < end) {
2268 if (copy > end - str)
2269 copy = end - str;
2270 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002271 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002272 str += read;
2273 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002274 }
2275
Vegard Nossumed681a92009-03-14 12:08:50 +01002276 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002277 spec.field_width = get_arg(int);
2278 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002279
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002280 case FORMAT_TYPE_PRECISION:
2281 spec.precision = get_arg(int);
2282 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002283
André Goddard Rosad4be1512009-12-14 18:00:59 -08002284 case FORMAT_TYPE_CHAR: {
2285 char c;
2286
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002287 if (!(spec.flags & LEFT)) {
2288 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002289 if (str < end)
2290 *str = ' ';
2291 ++str;
2292 }
2293 }
2294 c = (unsigned char) get_arg(char);
2295 if (str < end)
2296 *str = c;
2297 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002298 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002299 if (str < end)
2300 *str = ' ';
2301 ++str;
2302 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002303 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002304 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002305
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002306 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002307 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002308 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002309 str = string(str, end, (char *)str_arg, spec);
2310 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002311 }
2312
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002313 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002314 str = pointer(fmt, str, end, get_arg(void *), spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002315 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002316 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002317 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002318
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002319 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002320 case FORMAT_TYPE_INVALID:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002321 if (str < end)
2322 *str = '%';
2323 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002324 break;
2325
André Goddard Rosad4be1512009-12-14 18:00:59 -08002326 default: {
2327 unsigned long long num;
2328
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002329 switch (spec.type) {
2330
2331 case FORMAT_TYPE_LONG_LONG:
2332 num = get_arg(long long);
2333 break;
2334 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002335 case FORMAT_TYPE_LONG:
2336 num = get_arg(unsigned long);
2337 break;
2338 case FORMAT_TYPE_SIZE_T:
2339 num = get_arg(size_t);
2340 break;
2341 case FORMAT_TYPE_PTRDIFF:
2342 num = get_arg(ptrdiff_t);
2343 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002344 case FORMAT_TYPE_UBYTE:
2345 num = get_arg(unsigned char);
2346 break;
2347 case FORMAT_TYPE_BYTE:
2348 num = get_arg(signed char);
2349 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002350 case FORMAT_TYPE_USHORT:
2351 num = get_arg(unsigned short);
2352 break;
2353 case FORMAT_TYPE_SHORT:
2354 num = get_arg(short);
2355 break;
2356 case FORMAT_TYPE_UINT:
2357 num = get_arg(unsigned int);
2358 break;
2359 default:
2360 num = get_arg(int);
2361 }
2362
2363 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08002364 } /* default: */
2365 } /* switch(spec.type) */
2366 } /* while(*fmt) */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002367
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002368 if (size > 0) {
2369 if (str < end)
2370 *str = '\0';
2371 else
2372 end[-1] = '\0';
2373 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002374
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002375#undef get_arg
2376
2377 /* the trailing null byte doesn't count towards the total */
2378 return str - buf;
2379}
2380EXPORT_SYMBOL_GPL(bstr_printf);
2381
2382/**
2383 * bprintf - Parse a format string and place args' binary value in a buffer
2384 * @bin_buf: The buffer to place args' binary value
2385 * @size: The size of the buffer(by words(32bits), not characters)
2386 * @fmt: The format string to use
2387 * @...: Arguments for the format string
2388 *
2389 * The function returns the number of words(u32) written
2390 * into @bin_buf.
2391 */
2392int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2393{
2394 va_list args;
2395 int ret;
2396
2397 va_start(args, fmt);
2398 ret = vbin_printf(bin_buf, size, fmt, args);
2399 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002400
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002401 return ret;
2402}
2403EXPORT_SYMBOL_GPL(bprintf);
2404
2405#endif /* CONFIG_BINARY_PRINTF */
2406
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407/**
2408 * vsscanf - Unformat a buffer into a list of arguments
2409 * @buf: input buffer
2410 * @fmt: format of buffer
2411 * @args: arguments
2412 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002413int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414{
2415 const char *str = buf;
2416 char *next;
2417 char digit;
2418 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08002419 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08002420 unsigned int base;
2421 union {
2422 long long s;
2423 unsigned long long u;
2424 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08002425 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002426 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427
Jan Beulichda990752012-10-04 17:13:24 -07002428 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 /* skip any white space in format */
2430 /* white space in format matchs any amount of
2431 * white space, including none, in the input.
2432 */
2433 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08002434 fmt = skip_spaces(++fmt);
2435 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 }
2437
2438 /* anything that is not a conversion must match exactly */
2439 if (*fmt != '%' && *fmt) {
2440 if (*fmt++ != *str++)
2441 break;
2442 continue;
2443 }
2444
2445 if (!*fmt)
2446 break;
2447 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002448
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 /* skip this conversion.
2450 * advance both strings to next white space
2451 */
2452 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07002453 if (!*str)
2454 break;
Andy Spencer8fccae22009-10-01 15:44:27 -07002455 while (!isspace(*fmt) && *fmt != '%' && *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 fmt++;
2457 while (!isspace(*str) && *str)
2458 str++;
2459 continue;
2460 }
2461
2462 /* get field width */
2463 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08002464 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08002466 if (field_width <= 0)
2467 break;
2468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469
2470 /* get conversion qualifier */
2471 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002472 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2473 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474 qualifier = *fmt++;
2475 if (unlikely(qualifier == *fmt)) {
2476 if (qualifier == 'h') {
2477 qualifier = 'H';
2478 fmt++;
2479 } else if (qualifier == 'l') {
2480 qualifier = 'L';
2481 fmt++;
2482 }
2483 }
2484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
Jan Beulichda990752012-10-04 17:13:24 -07002486 if (!*fmt)
2487 break;
2488
2489 if (*fmt == 'n') {
2490 /* return number of characters read so far */
2491 *va_arg(args, int *) = str - buf;
2492 ++fmt;
2493 continue;
2494 }
2495
2496 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497 break;
2498
André Goddard Rosad4be1512009-12-14 18:00:59 -08002499 base = 10;
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002500 is_sign = false;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002501
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002502 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503 case 'c':
2504 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002505 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 if (field_width == -1)
2507 field_width = 1;
2508 do {
2509 *s++ = *str++;
2510 } while (--field_width > 0 && *str);
2511 num++;
2512 }
2513 continue;
2514 case 's':
2515 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002516 char *s = (char *)va_arg(args, char *);
2517 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07002518 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002520 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521
2522 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002523 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 *s = '\0';
2526 num++;
2527 }
2528 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 case 'o':
2530 base = 8;
2531 break;
2532 case 'x':
2533 case 'X':
2534 base = 16;
2535 break;
2536 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002537 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 case 'd':
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002539 is_sign = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 case 'u':
2541 break;
2542 case '%':
2543 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002544 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 return num;
2546 continue;
2547 default:
2548 /* invalid format; stop here */
2549 return num;
2550 }
2551
2552 /* have some sort of integer conversion.
2553 * first, skip white space in buffer.
2554 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002555 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556
2557 digit = *str;
2558 if (is_sign && digit == '-')
2559 digit = *(str + 1);
2560
2561 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002562 || (base == 16 && !isxdigit(digit))
2563 || (base == 10 && !isdigit(digit))
2564 || (base == 8 && (!isdigit(digit) || digit > '7'))
2565 || (base == 0 && !isdigit(digit)))
2566 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567
Jan Beulich53809752012-12-17 16:01:31 -08002568 if (is_sign)
2569 val.s = qualifier != 'L' ?
2570 simple_strtol(str, &next, base) :
2571 simple_strtoll(str, &next, base);
2572 else
2573 val.u = qualifier != 'L' ?
2574 simple_strtoul(str, &next, base) :
2575 simple_strtoull(str, &next, base);
2576
2577 if (field_width > 0 && next - str > field_width) {
2578 if (base == 0)
2579 _parse_integer_fixup_radix(str, &base);
2580 while (next - str > field_width) {
2581 if (is_sign)
2582 val.s = div_s64(val.s, base);
2583 else
2584 val.u = div_u64(val.u, base);
2585 --next;
2586 }
2587 }
2588
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002589 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08002591 if (is_sign)
2592 *va_arg(args, signed char *) = val.s;
2593 else
2594 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 break;
2596 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08002597 if (is_sign)
2598 *va_arg(args, short *) = val.s;
2599 else
2600 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 break;
2602 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08002603 if (is_sign)
2604 *va_arg(args, long *) = val.s;
2605 else
2606 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002607 break;
2608 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08002609 if (is_sign)
2610 *va_arg(args, long long *) = val.s;
2611 else
2612 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613 break;
2614 case 'Z':
2615 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08002616 *va_arg(args, size_t *) = val.u;
2617 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618 default:
Jan Beulich53809752012-12-17 16:01:31 -08002619 if (is_sign)
2620 *va_arg(args, int *) = val.s;
2621 else
2622 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 break;
2624 }
2625 num++;
2626
2627 if (!next)
2628 break;
2629 str = next;
2630 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002631
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 return num;
2633}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634EXPORT_SYMBOL(vsscanf);
2635
2636/**
2637 * sscanf - Unformat a buffer into a list of arguments
2638 * @buf: input buffer
2639 * @fmt: formatting of buffer
2640 * @...: resulting arguments
2641 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002642int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643{
2644 va_list args;
2645 int i;
2646
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002647 va_start(args, fmt);
2648 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002650
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 return i;
2652}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653EXPORT_SYMBOL(sscanf);