blob: b235c96167d32e80add7999f7833684abd54040b [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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343#define ZEROPAD 1 /* pad with zero */
344#define SIGN 2 /* unsigned/signed long */
345#define PLUS 4 /* show plus */
346#define SPACE 8 /* space if plus */
347#define LEFT 16 /* left justified */
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{
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100386 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
387 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
388
389 char tmp[66];
390 char sign;
391 char locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100392 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 int i;
Pierre Carrier7c203422012-05-29 15:07:35 -0700394 bool is_zero = num == 0LL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100396 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
397 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100398 locase = (spec.flags & SMALL);
399 if (spec.flags & LEFT)
400 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 sign = 0;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100402 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800403 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800405 num = -(signed long long)num;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100406 spec.field_width--;
407 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 sign = '+';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100409 spec.field_width--;
410 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 sign = ' ';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100412 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 }
414 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700415 if (need_pfx) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100416 if (spec.base == 16)
Pierre Carrier7c203422012-05-29 15:07:35 -0700417 spec.field_width -= 2;
418 else if (!is_zero)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100419 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700421
422 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 i = 0;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700424 if (num < spec.base)
425 tmp[i++] = digits[num] | locase;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700426 /* Generic code, for any base:
427 else do {
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100428 tmp[i++] = (digits[do_div(num,base)] | locase);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700429 } while (num != 0);
430 */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100431 else if (spec.base != 10) { /* 8 or 16 */
432 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700433 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800434
435 if (spec.base == 16)
436 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700437 do {
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100438 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700439 num >>= shift;
440 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700441 } else { /* base 10 */
442 i = put_dec(tmp, num) - tmp;
443 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700444
445 /* printing 100 using %2d gives "100", not "00" */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100446 if (i > spec.precision)
447 spec.precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700448 /* leading space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100449 spec.field_width -= spec.precision;
450 if (!(spec.flags & (ZEROPAD+LEFT))) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800451 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700452 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 *buf = ' ';
454 ++buf;
455 }
456 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700457 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700459 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 *buf = sign;
461 ++buf;
462 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700463 /* "0x" / "0" prefix */
464 if (need_pfx) {
Pierre Carrier7c203422012-05-29 15:07:35 -0700465 if (spec.base == 16 || !is_zero) {
466 if (buf < end)
467 *buf = '0';
468 ++buf;
469 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100470 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700471 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100472 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 ++buf;
474 }
475 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700476 /* zero or space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100477 if (!(spec.flags & LEFT)) {
478 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
479 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700480 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 *buf = c;
482 ++buf;
483 }
484 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700485 /* hmm even more zero padding? */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100486 while (i <= --spec.precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700487 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 *buf = '0';
489 ++buf;
490 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700491 /* actual digits of result */
492 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700493 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 *buf = tmp[i];
495 ++buf;
496 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700497 /* trailing space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100498 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700499 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 *buf = ' ';
501 ++buf;
502 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 return buf;
505}
506
Joe Perchescf3b4292010-05-24 14:33:16 -0700507static noinline_for_stack
508char *string(char *buf, char *end, const char *s, struct printf_spec spec)
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700509{
510 int len, i;
511
512 if ((unsigned long)s < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -0800513 s = "(null)";
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700514
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100515 len = strnlen(s, spec.precision);
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700516
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100517 if (!(spec.flags & LEFT)) {
518 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700519 if (buf < end)
520 *buf = ' ';
521 ++buf;
522 }
523 }
524 for (i = 0; i < len; ++i) {
525 if (buf < end)
526 *buf = *s;
527 ++buf; ++s;
528 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100529 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700530 if (buf < end)
531 *buf = ' ';
532 ++buf;
533 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800534
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700535 return buf;
536}
537
Al Viro4b6ccca2013-09-03 12:00:44 -0400538static void widen(char *buf, char *end, unsigned len, unsigned spaces)
539{
540 size_t size;
541 if (buf >= end) /* nowhere to put anything */
542 return;
543 size = end - buf;
544 if (size <= spaces) {
545 memset(buf, ' ', size);
546 return;
547 }
548 if (len) {
549 if (len > size - spaces)
550 len = size - spaces;
551 memmove(buf + spaces, buf, len);
552 }
553 memset(buf, ' ', spaces);
554}
555
556static noinline_for_stack
557char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
558 const char *fmt)
559{
560 const char *array[4], *s;
561 const struct dentry *p;
562 int depth;
563 int i, n;
564
565 switch (fmt[1]) {
566 case '2': case '3': case '4':
567 depth = fmt[1] - '0';
568 break;
569 default:
570 depth = 1;
571 }
572
573 rcu_read_lock();
574 for (i = 0; i < depth; i++, d = p) {
575 p = ACCESS_ONCE(d->d_parent);
576 array[i] = ACCESS_ONCE(d->d_name.name);
577 if (p == d) {
578 if (i)
579 array[i] = "";
580 i++;
581 break;
582 }
583 }
584 s = array[--i];
585 for (n = 0; n != spec.precision; n++, buf++) {
586 char c = *s++;
587 if (!c) {
588 if (!i)
589 break;
590 c = '/';
591 s = array[--i];
592 }
593 if (buf < end)
594 *buf = c;
595 }
596 rcu_read_unlock();
597 if (n < spec.field_width) {
598 /* we want to pad the sucker */
599 unsigned spaces = spec.field_width - n;
600 if (!(spec.flags & LEFT)) {
601 widen(buf - n, end, n, spaces);
602 return buf + spaces;
603 }
604 while (spaces--) {
605 if (buf < end)
606 *buf = ' ';
607 ++buf;
608 }
609 }
610 return buf;
611}
612
Joe Perchescf3b4292010-05-24 14:33:16 -0700613static noinline_for_stack
614char *symbol_string(char *buf, char *end, void *ptr,
Joe Perchesb0d33c22012-12-12 10:18:50 -0800615 struct printf_spec spec, const char *fmt)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700616{
Joe Perchesb0d33c22012-12-12 10:18:50 -0800617 unsigned long value;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700618#ifdef CONFIG_KALLSYMS
619 char sym[KSYM_SYMBOL_LEN];
Joe Perchesb0d33c22012-12-12 10:18:50 -0800620#endif
621
622 if (fmt[1] == 'R')
623 ptr = __builtin_extract_return_addr(ptr);
624 value = (unsigned long)ptr;
625
626#ifdef CONFIG_KALLSYMS
627 if (*fmt == 'B')
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900628 sprint_backtrace(sym, value);
Joe Perchesb0d33c22012-12-12 10:18:50 -0800629 else if (*fmt != 'f' && *fmt != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200630 sprint_symbol(sym, value);
631 else
Stephen Boyd4796dd22012-05-29 15:07:33 -0700632 sprint_symbol_no_offset(sym, value);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800633
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100634 return string(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700635#else
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800636 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100637 spec.flags |= SPECIAL | SMALL | ZEROPAD;
638 spec.base = 16;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800639
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100640 return number(buf, end, value, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700641#endif
642}
643
Joe Perchescf3b4292010-05-24 14:33:16 -0700644static noinline_for_stack
645char *resource_string(char *buf, char *end, struct resource *res,
646 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +1100647{
648#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600649#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +1100650#endif
651
652#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600653#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +1100654#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700655 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100656 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700657 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100658 .precision = -1,
659 .flags = SPECIAL | SMALL | ZEROPAD,
660 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700661 static const struct printf_spec mem_spec = {
662 .base = 16,
663 .field_width = MEM_RSRC_PRINTK_SIZE,
664 .precision = -1,
665 .flags = SPECIAL | SMALL | ZEROPAD,
666 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700667 static const struct printf_spec bus_spec = {
668 .base = 16,
669 .field_width = 2,
670 .precision = -1,
671 .flags = SMALL | ZEROPAD,
672 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700673 static const struct printf_spec dec_spec = {
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600674 .base = 10,
675 .precision = -1,
676 .flags = 0,
677 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700678 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600679 .field_width = -1,
680 .precision = 10,
681 .flags = LEFT,
682 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700683 static const struct printf_spec flag_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600684 .base = 16,
685 .precision = -1,
686 .flags = SPECIAL | SMALL,
687 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600688
689 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
690 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
691#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
692#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700693#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600694#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
695 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
696 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
697
Linus Torvalds332d2e72008-10-20 15:07:34 +1100698 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600699 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700700 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +1100701
702 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700703 if (res->flags & IORESOURCE_IO) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600704 p = string(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700705 specp = &io_spec;
706 } else if (res->flags & IORESOURCE_MEM) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600707 p = string(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700708 specp = &mem_spec;
709 } else if (res->flags & IORESOURCE_IRQ) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600710 p = string(p, pend, "irq ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700711 specp = &dec_spec;
712 } else if (res->flags & IORESOURCE_DMA) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600713 p = string(p, pend, "dma ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700714 specp = &dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700715 } else if (res->flags & IORESOURCE_BUS) {
716 p = string(p, pend, "bus ", str_spec);
717 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700718 } else {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600719 p = string(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700720 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600721 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600722 }
Bjorn Helgaasd19cb802014-02-26 11:25:56 -0700723 if (decode && res->flags & IORESOURCE_UNSET) {
724 p = string(p, pend, "size ", str_spec);
725 p = number(p, pend, resource_size(res), *specp);
726 } else {
727 p = number(p, pend, res->start, *specp);
728 if (res->start != res->end) {
729 *p++ = '-';
730 p = number(p, pend, res->end, *specp);
731 }
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600732 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600733 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600734 if (res->flags & IORESOURCE_MEM_64)
735 p = string(p, pend, " 64bit", str_spec);
736 if (res->flags & IORESOURCE_PREFETCH)
737 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700738 if (res->flags & IORESOURCE_WINDOW)
739 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600740 if (res->flags & IORESOURCE_DISABLED)
741 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600742 } else {
743 p = string(p, pend, " flags ", str_spec);
744 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600745 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100746 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600747 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100748
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100749 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100750}
751
Joe Perchescf3b4292010-05-24 14:33:16 -0700752static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -0700753char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
754 const char *fmt)
755{
Steven Rostedt360603a2013-05-28 15:47:39 -0400756 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -0700757 negative value, fallback to the default */
758 char separator;
759
760 if (spec.field_width == 0)
761 /* nothing to print */
762 return buf;
763
764 if (ZERO_OR_NULL_PTR(addr))
765 /* NULL pointer */
766 return string(buf, end, NULL, spec);
767
768 switch (fmt[1]) {
769 case 'C':
770 separator = ':';
771 break;
772 case 'D':
773 separator = '-';
774 break;
775 case 'N':
776 separator = 0;
777 break;
778 default:
779 separator = ' ';
780 break;
781 }
782
783 if (spec.field_width > 0)
784 len = min_t(int, spec.field_width, 64);
785
786 for (i = 0; i < len && buf < end - 1; i++) {
787 buf = hex_byte_pack(buf, addr[i]);
788
789 if (buf < end && separator && i != len - 1)
790 *buf++ = separator;
791 }
792
793 return buf;
794}
795
796static noinline_for_stack
Tejun Heodbc760b2015-02-13 14:36:53 -0800797char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
798 struct printf_spec spec, const char *fmt)
799{
800 const int CHUNKSZ = 32;
801 int nr_bits = max_t(int, spec.field_width, 0);
802 int i, chunksz;
803 bool first = true;
804
805 /* reused to print numbers */
806 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
807
808 chunksz = nr_bits & (CHUNKSZ - 1);
809 if (chunksz == 0)
810 chunksz = CHUNKSZ;
811
812 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
813 for (; i >= 0; i -= CHUNKSZ) {
814 u32 chunkmask, val;
815 int word, bit;
816
817 chunkmask = ((1ULL << chunksz) - 1);
818 word = i / BITS_PER_LONG;
819 bit = i % BITS_PER_LONG;
820 val = (bitmap[word] >> bit) & chunkmask;
821
822 if (!first) {
823 if (buf < end)
824 *buf = ',';
825 buf++;
826 }
827 first = false;
828
829 spec.field_width = DIV_ROUND_UP(chunksz, 4);
830 buf = number(buf, end, val, spec);
831
832 chunksz = CHUNKSZ;
833 }
834 return buf;
835}
836
837static noinline_for_stack
838char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
839 struct printf_spec spec, const char *fmt)
840{
841 int nr_bits = max_t(int, spec.field_width, 0);
842 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
843 int cur, rbot, rtop;
844 bool first = true;
845
846 /* reused to print numbers */
847 spec = (struct printf_spec){ .base = 10 };
848
849 rbot = cur = find_first_bit(bitmap, nr_bits);
850 while (cur < nr_bits) {
851 rtop = cur;
852 cur = find_next_bit(bitmap, nr_bits, cur + 1);
853 if (cur < nr_bits && cur <= rtop + 1)
854 continue;
855
856 if (!first) {
857 if (buf < end)
858 *buf = ',';
859 buf++;
860 }
861 first = false;
862
863 buf = number(buf, end, rbot, spec);
864 if (rbot < rtop) {
865 if (buf < end)
866 *buf = '-';
867 buf++;
868
869 buf = number(buf, end, rtop, spec);
870 }
871
872 rbot = cur;
873 }
874 return buf;
875}
876
877static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -0700878char *mac_address_string(char *buf, char *end, u8 *addr,
879 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700880{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000881 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700882 char *p = mac_addr;
883 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000884 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700885 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000886
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700887 switch (fmt[1]) {
888 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +0000889 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700890 break;
891
892 case 'R':
893 reversed = true;
894 /* fall through */
895
896 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +0000897 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700898 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000899 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700900
901 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700902 if (reversed)
903 p = hex_byte_pack(p, addr[5 - i]);
904 else
905 p = hex_byte_pack(p, addr[i]);
906
Joe Perches8a27f7c2009-08-17 12:29:44 +0000907 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000908 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700909 }
910 *p = '\0';
911
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100912 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700913}
914
Joe Perchescf3b4292010-05-24 14:33:16 -0700915static noinline_for_stack
916char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700917{
Harvey Harrison689afa72008-10-28 16:04:44 -0700918 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800919 bool leading_zeros = (fmt[0] == 'i');
920 int index;
921 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700922
Joe Perches0159f242010-01-13 20:23:30 -0800923 switch (fmt[2]) {
924 case 'h':
925#ifdef __BIG_ENDIAN
926 index = 0;
927 step = 1;
928#else
929 index = 3;
930 step = -1;
931#endif
932 break;
933 case 'l':
934 index = 3;
935 step = -1;
936 break;
937 case 'n':
938 case 'b':
939 default:
940 index = 0;
941 step = 1;
942 break;
943 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000944 for (i = 0; i < 4; i++) {
945 char temp[3]; /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700946 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000947 if (leading_zeros) {
948 if (digits < 3)
949 *p++ = '0';
950 if (digits < 2)
951 *p++ = '0';
952 }
953 /* reverse the digits in the quad */
954 while (digits--)
955 *p++ = temp[digits];
956 if (i < 3)
957 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -0800958 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000959 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000960 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800961
Joe Perches8a27f7c2009-08-17 12:29:44 +0000962 return p;
963}
964
Joe Perchescf3b4292010-05-24 14:33:16 -0700965static noinline_for_stack
966char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000967{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800968 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000969 unsigned char zerolength[8];
970 int longest = 1;
971 int colonpos = -1;
972 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800973 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000974 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +0000975 bool useIPv4;
976 struct in6_addr in6;
977
978 memcpy(&in6, addr, sizeof(struct in6_addr));
979
980 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000981
982 memset(zerolength, 0, sizeof(zerolength));
983
984 if (useIPv4)
985 range = 6;
986 else
987 range = 8;
988
989 /* find position of longest 0 run */
990 for (i = 0; i < range; i++) {
991 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +0000992 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000993 break;
994 zerolength[i]++;
995 }
996 }
997 for (i = 0; i < range; i++) {
998 if (zerolength[i] > longest) {
999 longest = zerolength[i];
1000 colonpos = i;
1001 }
1002 }
Joe Perches29cf5192011-06-09 11:23:37 -07001003 if (longest == 1) /* don't compress a single 0 */
1004 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001005
1006 /* emit address */
1007 for (i = 0; i < range; i++) {
1008 if (i == colonpos) {
1009 if (needcolon || i == 0)
1010 *p++ = ':';
1011 *p++ = ':';
1012 needcolon = false;
1013 i += longest - 1;
1014 continue;
1015 }
1016 if (needcolon) {
1017 *p++ = ':';
1018 needcolon = false;
1019 }
1020 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +00001021 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001022 hi = word >> 8;
1023 lo = word & 0xff;
1024 if (hi) {
1025 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001026 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001027 else
1028 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001029 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001030 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -08001031 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001032 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001033 else
1034 *p++ = hex_asc_lo(lo);
1035 needcolon = true;
1036 }
1037
1038 if (useIPv4) {
1039 if (needcolon)
1040 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -08001041 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +00001042 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001043 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001044
Joe Perches8a27f7c2009-08-17 12:29:44 +00001045 return p;
1046}
1047
Joe Perchescf3b4292010-05-24 14:33:16 -07001048static noinline_for_stack
1049char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001050{
1051 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001052
Harvey Harrison689afa72008-10-28 16:04:44 -07001053 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001054 p = hex_byte_pack(p, *addr++);
1055 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001056 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -07001057 *p++ = ':';
1058 }
1059 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001060
Joe Perches8a27f7c2009-08-17 12:29:44 +00001061 return p;
1062}
1063
Joe Perchescf3b4292010-05-24 14:33:16 -07001064static noinline_for_stack
1065char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1066 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001067{
1068 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1069
1070 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +00001071 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001072 else
Joe Percheseb78cd22009-09-18 13:04:06 +00001073 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -07001074
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001075 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -07001076}
1077
Joe Perchescf3b4292010-05-24 14:33:16 -07001078static noinline_for_stack
1079char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1080 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -07001081{
Joe Perches8a27f7c2009-08-17 12:29:44 +00001082 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -07001083
Joe Perches0159f242010-01-13 20:23:30 -08001084 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001085
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001086 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001087}
1088
Joe Perchescf3b4292010-05-24 14:33:16 -07001089static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001090char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1091 struct printf_spec spec, const char *fmt)
1092{
1093 bool have_p = false, have_s = false, have_f = false, have_c = false;
1094 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1095 sizeof(":12345") + sizeof("/123456789") +
1096 sizeof("%1234567890")];
1097 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1098 const u8 *addr = (const u8 *) &sa->sin6_addr;
1099 char fmt6[2] = { fmt[0], '6' };
1100 u8 off = 0;
1101
1102 fmt++;
1103 while (isalpha(*++fmt)) {
1104 switch (*fmt) {
1105 case 'p':
1106 have_p = true;
1107 break;
1108 case 'f':
1109 have_f = true;
1110 break;
1111 case 's':
1112 have_s = true;
1113 break;
1114 case 'c':
1115 have_c = true;
1116 break;
1117 }
1118 }
1119
1120 if (have_p || have_s || have_f) {
1121 *p = '[';
1122 off = 1;
1123 }
1124
1125 if (fmt6[0] == 'I' && have_c)
1126 p = ip6_compressed_string(ip6_addr + off, addr);
1127 else
1128 p = ip6_string(ip6_addr + off, addr, fmt6);
1129
1130 if (have_p || have_s || have_f)
1131 *p++ = ']';
1132
1133 if (have_p) {
1134 *p++ = ':';
1135 p = number(p, pend, ntohs(sa->sin6_port), spec);
1136 }
1137 if (have_f) {
1138 *p++ = '/';
1139 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1140 IPV6_FLOWINFO_MASK), spec);
1141 }
1142 if (have_s) {
1143 *p++ = '%';
1144 p = number(p, pend, sa->sin6_scope_id, spec);
1145 }
1146 *p = '\0';
1147
1148 return string(buf, end, ip6_addr, spec);
1149}
1150
1151static noinline_for_stack
1152char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1153 struct printf_spec spec, const char *fmt)
1154{
1155 bool have_p = false;
1156 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1157 char *pend = ip4_addr + sizeof(ip4_addr);
1158 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1159 char fmt4[3] = { fmt[0], '4', 0 };
1160
1161 fmt++;
1162 while (isalpha(*++fmt)) {
1163 switch (*fmt) {
1164 case 'p':
1165 have_p = true;
1166 break;
1167 case 'h':
1168 case 'l':
1169 case 'n':
1170 case 'b':
1171 fmt4[2] = *fmt;
1172 break;
1173 }
1174 }
1175
1176 p = ip4_string(ip4_addr, addr, fmt4);
1177 if (have_p) {
1178 *p++ = ':';
1179 p = number(p, pend, ntohs(sa->sin_port), spec);
1180 }
1181 *p = '\0';
1182
1183 return string(buf, end, ip4_addr, spec);
1184}
1185
1186static noinline_for_stack
Andy Shevchenko71dca952014-10-13 15:55:18 -07001187char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1188 const char *fmt)
1189{
1190 bool found = true;
1191 int count = 1;
1192 unsigned int flags = 0;
1193 int len;
1194
1195 if (spec.field_width == 0)
1196 return buf; /* nothing to print */
1197
1198 if (ZERO_OR_NULL_PTR(addr))
1199 return string(buf, end, NULL, spec); /* NULL pointer */
1200
1201
1202 do {
1203 switch (fmt[count++]) {
1204 case 'a':
1205 flags |= ESCAPE_ANY;
1206 break;
1207 case 'c':
1208 flags |= ESCAPE_SPECIAL;
1209 break;
1210 case 'h':
1211 flags |= ESCAPE_HEX;
1212 break;
1213 case 'n':
1214 flags |= ESCAPE_NULL;
1215 break;
1216 case 'o':
1217 flags |= ESCAPE_OCTAL;
1218 break;
1219 case 'p':
1220 flags |= ESCAPE_NP;
1221 break;
1222 case 's':
1223 flags |= ESCAPE_SPACE;
1224 break;
1225 default:
1226 found = false;
1227 break;
1228 }
1229 } while (found);
1230
1231 if (!flags)
1232 flags = ESCAPE_ANY_NP;
1233
1234 len = spec.field_width < 0 ? 1 : spec.field_width;
1235
1236 /* Ignore the error. We print as many characters as we can */
1237 string_escape_mem(addr, len, &buf, end - buf, flags, NULL);
1238
1239 return buf;
1240}
1241
1242static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001243char *uuid_string(char *buf, char *end, const u8 *addr,
1244 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001245{
1246 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1247 char *p = uuid;
1248 int i;
1249 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1250 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1251 const u8 *index = be;
1252 bool uc = false;
1253
1254 switch (*(++fmt)) {
1255 case 'L':
1256 uc = true; /* fall-through */
1257 case 'l':
1258 index = le;
1259 break;
1260 case 'B':
1261 uc = true;
1262 break;
1263 }
1264
1265 for (i = 0; i < 16; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001266 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001267 switch (i) {
1268 case 3:
1269 case 5:
1270 case 7:
1271 case 9:
1272 *p++ = '-';
1273 break;
1274 }
1275 }
1276
1277 *p = 0;
1278
1279 if (uc) {
1280 p = uuid;
1281 do {
1282 *p = toupper(*p);
1283 } while (*(++p));
1284 }
1285
1286 return string(buf, end, uuid, spec);
1287}
1288
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001289static
1290char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1291 struct printf_spec spec)
1292{
1293 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1294 if (spec.field_width == -1)
1295 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1296 spec.base = 16;
1297
1298 return number(buf, end, *(const netdev_features_t *)addr, spec);
1299}
1300
Joe Perchesaaf07622014-01-23 15:54:17 -08001301static noinline_for_stack
1302char *address_val(char *buf, char *end, const void *addr,
1303 struct printf_spec spec, const char *fmt)
1304{
1305 unsigned long long num;
1306
1307 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1308 spec.base = 16;
1309
1310 switch (fmt[1]) {
1311 case 'd':
1312 num = *(const dma_addr_t *)addr;
1313 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1314 break;
1315 case 'p':
1316 default:
1317 num = *(const phys_addr_t *)addr;
1318 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1319 break;
1320 }
1321
1322 return number(buf, end, num, spec);
1323}
1324
Ingo Molnar411f05f2011-05-12 23:00:28 +02001325int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001326
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001327/*
1328 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1329 * by an extra set of alphanumeric characters that are extended format
1330 * specifiers.
1331 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001332 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001333 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001334 * - 'F' For symbolic function descriptor pointers with offset
1335 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001336 * - 'S' For symbolic direct pointers with offset
1337 * - 's' For symbolic direct pointers without offset
Joe Perchesb0d33c22012-12-12 10:18:50 -08001338 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001339 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001340 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1341 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Tejun Heodbc760b2015-02-13 14:36:53 -08001342 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1343 * width which must be explicitly specified either as part of the
1344 * format string '%32b[l]' or through '%*b[l]', [l] selects
1345 * range-list format instead of hex format
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001346 * - 'M' For a 6-byte MAC address, it prints the address in the
1347 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00001348 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00001349 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08001350 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07001351 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001352 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1353 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1354 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02001355 * [S][pfs]
1356 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1357 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00001358 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1359 * IPv6 omits the colons (01020304...0f)
1360 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02001361 * [S][pfs]
1362 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1363 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1364 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1365 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07001366 * http://tools.ietf.org/html/rfc5952
Andy Shevchenko71dca952014-10-13 15:55:18 -07001367 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1368 * of the following flags (see string_escape_mem() for the
1369 * details):
1370 * a - ESCAPE_ANY
1371 * c - ESCAPE_SPECIAL
1372 * h - ESCAPE_HEX
1373 * n - ESCAPE_NULL
1374 * o - ESCAPE_OCTAL
1375 * p - ESCAPE_NP
1376 * s - ESCAPE_SPACE
1377 * By default ESCAPE_ANY_NP is used.
Joe Perches9ac6e442009-12-14 18:01:09 -08001378 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1379 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1380 * Options for %pU are:
1381 * b big endian lower case hex (default)
1382 * B big endian UPPER case hex
1383 * l little endian lower case hex
1384 * L little endian UPPER case hex
1385 * big endian output byte order is:
1386 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1387 * little endian output byte order is:
1388 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00001389 * - 'V' For a struct va_format which contains a format string * and va_list *,
1390 * call vsnprintf(->format, *->va_list).
1391 * Implements a "recursive vsnprintf".
1392 * Do not use this feature without some mechanism to verify the
1393 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001394 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001395 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07001396 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1397 * a certain separator (' ' by default):
1398 * C colon
1399 * D dash
1400 * N no separator
1401 * The maximum supported length is 64 bytes of the input. Consider
1402 * to use print_hex_dump() for the larger input.
Joe Perchesaaf07622014-01-23 15:54:17 -08001403 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1404 * (default assumed to be phys_addr_t, passed by reference)
Olof Johanssonc0d92a52013-11-12 15:09:50 -08001405 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1406 * - 'D[234]' Same as 'd' but for a struct file
Joe Perches9ac6e442009-12-14 18:01:09 -08001407 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001408 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1409 * function pointers are really function descriptors, which contain a
1410 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001411 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001412static noinline_for_stack
1413char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1414 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001415{
Grant Likely725fe002012-05-31 16:26:08 -07001416 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1417
Kees Cook9f36e2c2011-03-22 16:34:22 -07001418 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -07001419 /*
1420 * Print (null) with the same width as a pointer so it makes
1421 * tabular output look nice.
1422 */
1423 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001424 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001425 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -07001426 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -08001427
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001428 switch (*fmt) {
1429 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001430 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001431 ptr = dereference_function_descriptor(ptr);
1432 /* Fallthrough */
1433 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08001434 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001435 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08001436 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001437 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001438 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001439 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07001440 case 'h':
1441 return hex_string(buf, end, ptr, spec, fmt);
Tejun Heodbc760b2015-02-13 14:36:53 -08001442 case 'b':
1443 switch (fmt[1]) {
1444 case 'l':
1445 return bitmap_list_string(buf, end, ptr, spec, fmt);
1446 default:
1447 return bitmap_string(buf, end, ptr, spec, fmt);
1448 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001449 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1450 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001451 /* [mM]F (FDDI) */
1452 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00001453 return mac_address_string(buf, end, ptr, spec, fmt);
1454 case 'I': /* Formatted IP supported
1455 * 4: 1.2.3.4
1456 * 6: 0001:0203:...:0708
1457 * 6c: 1::708 or 1::1.2.3.4
1458 */
1459 case 'i': /* Contiguous:
1460 * 4: 001.002.003.004
1461 * 6: 000102...0f
1462 */
1463 switch (fmt[1]) {
1464 case '6':
1465 return ip6_addr_string(buf, end, ptr, spec, fmt);
1466 case '4':
1467 return ip4_addr_string(buf, end, ptr, spec, fmt);
Daniel Borkmann10679642013-06-28 19:49:39 +02001468 case 'S': {
1469 const union {
1470 struct sockaddr raw;
1471 struct sockaddr_in v4;
1472 struct sockaddr_in6 v6;
1473 } *sa = ptr;
1474
1475 switch (sa->raw.sa_family) {
1476 case AF_INET:
1477 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1478 case AF_INET6:
1479 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1480 default:
1481 return string(buf, end, "(invalid address)", spec);
1482 }}
Joe Perches8a27f7c2009-08-17 12:29:44 +00001483 }
Harvey Harrison4aa99602008-10-29 12:49:58 -07001484 break;
Andy Shevchenko71dca952014-10-13 15:55:18 -07001485 case 'E':
1486 return escaped_string(buf, end, ptr, spec, fmt);
Joe Perches9ac6e442009-12-14 18:01:09 -08001487 case 'U':
1488 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00001489 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +00001490 {
1491 va_list va;
1492
1493 va_copy(va, *((struct va_format *)ptr)->va);
1494 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1495 ((struct va_format *)ptr)->fmt, va);
1496 va_end(va);
1497 return buf;
1498 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001499 case 'K':
1500 /*
1501 * %pK cannot be used in IRQ context because its test
1502 * for CAP_SYSLOG would be meaningless.
1503 */
Dan Rosenberg3715c5302012-07-30 14:40:26 -07001504 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1505 in_nmi())) {
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001506 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001507 spec.field_width = default_width;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001508 return string(buf, end, "pK-error", spec);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001509 }
Ryan Mallon312b4e22013-11-12 15:08:51 -08001510
1511 switch (kptr_restrict) {
1512 case 0:
1513 /* Always print %pK values */
1514 break;
1515 case 1: {
1516 /*
1517 * Only print the real pointer value if the current
1518 * process has CAP_SYSLOG and is running with the
1519 * same credentials it started with. This is because
1520 * access to files is checked at open() time, but %pK
1521 * checks permission at read() time. We don't want to
1522 * leak pointer values if a binary opens a file using
1523 * %pK and then elevates privileges before reading it.
1524 */
1525 const struct cred *cred = current_cred();
1526
1527 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1528 !uid_eq(cred->euid, cred->uid) ||
1529 !gid_eq(cred->egid, cred->gid))
1530 ptr = NULL;
1531 break;
1532 }
1533 case 2:
1534 default:
1535 /* Always print 0's for %pK */
Joe Perches26297602011-03-22 16:34:19 -07001536 ptr = NULL;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001537 break;
1538 }
Joe Perches26297602011-03-22 16:34:19 -07001539 break;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001540
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001541 case 'N':
1542 switch (fmt[1]) {
1543 case 'F':
1544 return netdev_feature_string(buf, end, ptr, spec);
1545 }
1546 break;
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001547 case 'a':
Joe Perchesaaf07622014-01-23 15:54:17 -08001548 return address_val(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04001549 case 'd':
1550 return dentry_name(buf, end, ptr, spec, fmt);
1551 case 'D':
1552 return dentry_name(buf, end,
1553 ((const struct file *)ptr)->f_path.dentry,
1554 spec, fmt);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001555 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001556 spec.flags |= SMALL;
1557 if (spec.field_width == -1) {
Grant Likely725fe002012-05-31 16:26:08 -07001558 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001559 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001560 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001561 spec.base = 16;
1562
1563 return number(buf, end, (unsigned long) ptr, spec);
1564}
1565
1566/*
1567 * Helper function to decode printf style format.
1568 * Each call decode a token from the format and return the
1569 * number of characters read (or likely the delta where it wants
1570 * to go on the next call).
1571 * The decoded token is returned through the parameters
1572 *
1573 * 'h', 'l', or 'L' for integer fields
1574 * 'z' support added 23/7/1999 S.H.
1575 * 'z' changed to 'Z' --davidm 1/25/99
1576 * 't' added for ptrdiff_t
1577 *
1578 * @fmt: the format string
1579 * @type of the token returned
1580 * @flags: various flags such as +, -, # tokens..
1581 * @field_width: overwritten width
1582 * @base: base of the number (octal, hex, ...)
1583 * @precision: precision of a number
1584 * @qualifier: qualifier of a number (long, size_t, ...)
1585 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001586static noinline_for_stack
1587int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001588{
1589 const char *start = fmt;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001590
1591 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01001592 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001593 if (spec->field_width < 0) {
1594 spec->field_width = -spec->field_width;
1595 spec->flags |= LEFT;
1596 }
1597 spec->type = FORMAT_TYPE_NONE;
1598 goto precision;
1599 }
1600
1601 /* we finished early by reading the precision */
1602 if (spec->type == FORMAT_TYPE_PRECISION) {
1603 if (spec->precision < 0)
1604 spec->precision = 0;
1605
1606 spec->type = FORMAT_TYPE_NONE;
1607 goto qualifier;
1608 }
1609
1610 /* By default */
1611 spec->type = FORMAT_TYPE_NONE;
1612
1613 for (; *fmt ; ++fmt) {
1614 if (*fmt == '%')
1615 break;
1616 }
1617
1618 /* Return the current non-format string */
1619 if (fmt != start || !*fmt)
1620 return fmt - start;
1621
1622 /* Process flags */
1623 spec->flags = 0;
1624
1625 while (1) { /* this also skips first '%' */
1626 bool found = true;
1627
1628 ++fmt;
1629
1630 switch (*fmt) {
1631 case '-': spec->flags |= LEFT; break;
1632 case '+': spec->flags |= PLUS; break;
1633 case ' ': spec->flags |= SPACE; break;
1634 case '#': spec->flags |= SPECIAL; break;
1635 case '0': spec->flags |= ZEROPAD; break;
1636 default: found = false;
1637 }
1638
1639 if (!found)
1640 break;
1641 }
1642
1643 /* get field width */
1644 spec->field_width = -1;
1645
1646 if (isdigit(*fmt))
1647 spec->field_width = skip_atoi(&fmt);
1648 else if (*fmt == '*') {
1649 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001650 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001651 return ++fmt - start;
1652 }
1653
1654precision:
1655 /* get the precision */
1656 spec->precision = -1;
1657 if (*fmt == '.') {
1658 ++fmt;
1659 if (isdigit(*fmt)) {
1660 spec->precision = skip_atoi(&fmt);
1661 if (spec->precision < 0)
1662 spec->precision = 0;
1663 } else if (*fmt == '*') {
1664 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001665 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001666 return ++fmt - start;
1667 }
1668 }
1669
1670qualifier:
1671 /* get the conversion qualifier */
1672 spec->qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001673 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1674 _tolower(*fmt) == 'z' || *fmt == 't') {
Zhaoleia4e94ef2009-03-27 17:07:05 +08001675 spec->qualifier = *fmt++;
1676 if (unlikely(spec->qualifier == *fmt)) {
1677 if (spec->qualifier == 'l') {
1678 spec->qualifier = 'L';
1679 ++fmt;
1680 } else if (spec->qualifier == 'h') {
1681 spec->qualifier = 'H';
1682 ++fmt;
1683 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001684 }
1685 }
1686
1687 /* default base */
1688 spec->base = 10;
1689 switch (*fmt) {
1690 case 'c':
1691 spec->type = FORMAT_TYPE_CHAR;
1692 return ++fmt - start;
1693
1694 case 's':
1695 spec->type = FORMAT_TYPE_STR;
1696 return ++fmt - start;
1697
1698 case 'p':
1699 spec->type = FORMAT_TYPE_PTR;
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001700 return ++fmt - start;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001701
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001702 case '%':
1703 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1704 return ++fmt - start;
1705
1706 /* integer number formats - set up the flags and "break" */
1707 case 'o':
1708 spec->base = 8;
1709 break;
1710
1711 case 'x':
1712 spec->flags |= SMALL;
1713
1714 case 'X':
1715 spec->base = 16;
1716 break;
1717
1718 case 'd':
1719 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001720 spec->flags |= SIGN;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001721 case 'u':
1722 break;
1723
Ryan Mallon708d96f2014-04-03 14:48:37 -07001724 case 'n':
1725 /*
1726 * Since %n poses a greater security risk than utility, treat
1727 * it as an invalid format specifier. Warn about its use so
1728 * that new instances don't get added.
1729 */
1730 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1731 /* Fall-through */
1732
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001733 default:
1734 spec->type = FORMAT_TYPE_INVALID;
1735 return fmt - start;
1736 }
1737
1738 if (spec->qualifier == 'L')
1739 spec->type = FORMAT_TYPE_LONG_LONG;
1740 else if (spec->qualifier == 'l') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001741 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001742 spec->type = FORMAT_TYPE_LONG;
1743 else
1744 spec->type = FORMAT_TYPE_ULONG;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001745 } else if (_tolower(spec->qualifier) == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001746 spec->type = FORMAT_TYPE_SIZE_T;
1747 } else if (spec->qualifier == 't') {
1748 spec->type = FORMAT_TYPE_PTRDIFF;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001749 } else if (spec->qualifier == 'H') {
1750 if (spec->flags & SIGN)
1751 spec->type = FORMAT_TYPE_BYTE;
1752 else
1753 spec->type = FORMAT_TYPE_UBYTE;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001754 } else if (spec->qualifier == 'h') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001755 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001756 spec->type = FORMAT_TYPE_SHORT;
1757 else
1758 spec->type = FORMAT_TYPE_USHORT;
1759 } else {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001760 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001761 spec->type = FORMAT_TYPE_INT;
1762 else
1763 spec->type = FORMAT_TYPE_UINT;
1764 }
1765
1766 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001767}
1768
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769/**
1770 * vsnprintf - Format a string and place it in a buffer
1771 * @buf: The buffer to place the result into
1772 * @size: The size of the buffer, including the trailing null space
1773 * @fmt: The format string to use
1774 * @args: Arguments for the format string
1775 *
Andi Kleen20036fd2008-10-15 22:02:02 -07001776 * This function follows C99 vsnprintf, but has some extensions:
Steven Rostedt91adcd22009-09-16 20:03:06 -04001777 * %pS output the name of a text symbol with offset
1778 * %ps output the name of a text symbol without offset
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001779 * %pF output the name of a function pointer with its offset
1780 * %pf output the name of a function pointer without its offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001781 * %pB output the name of a backtrace symbol with its offset
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001782 * %pR output the address range in a struct resource with decoded flags
1783 * %pr output the address range in a struct resource with raw flags
Tejun Heodbc760b2015-02-13 14:36:53 -08001784 * %pb output the bitmap with field width as the number of bits
1785 * %pbl output the bitmap as range list with field width as the number of bits
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001786 * %pM output a 6-byte MAC address with colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001787 * %pMR output a 6-byte MAC address with colons in reversed order
1788 * %pMF output a 6-byte MAC address with dashes
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001789 * %pm output a 6-byte MAC address without colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001790 * %pmR output a 6-byte MAC address without colons in reversed order
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001791 * %pI4 print an IPv4 address without leading zeros
1792 * %pi4 print an IPv4 address with leading zeros
1793 * %pI6 print an IPv6 address with colons
1794 * %pi6 print an IPv6 address without colons
Jan Engelhardtf996f202011-07-14 18:48:56 +02001795 * %pI6c print an IPv6 address as specified by RFC 5952
Daniel Borkmann10679642013-06-28 19:49:39 +02001796 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1797 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001798 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1799 * case.
Andy Shevchenko71dca952014-10-13 15:55:18 -07001800 * %*pE[achnops] print an escaped buffer
Andy Shevchenko31550a12012-07-30 14:40:27 -07001801 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1802 * bytes of the input)
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001803 * %n is ignored
Andi Kleen20036fd2008-10-15 22:02:02 -07001804 *
Andrew Morton80f548e2012-07-30 14:40:25 -07001805 * ** Please update Documentation/printk-formats.txt when making changes **
1806 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 * The return value is the number of characters which would
1808 * be generated for the given input, excluding the trailing
1809 * '\0', as per ISO C99. If you want to have the exact
1810 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001811 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 * return is greater than or equal to @size, the resulting
1813 * string is truncated.
1814 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001815 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 */
1817int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1818{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001820 char *str, *end;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001821 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001823 /* Reject out-of-range values early. Large positive sizes are
1824 used for unknown buffer sizes. */
Rasmus Villemoes2aa2f9e2015-02-12 15:01:39 -08001825 if (WARN_ON_ONCE(size > INT_MAX))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
1828 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001829 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001831 /* Make sure end is always >= buf */
1832 if (end < buf) {
1833 end = ((void *)-1);
1834 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 }
1836
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001837 while (*fmt) {
1838 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001839 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001840
1841 fmt += read;
1842
1843 switch (spec.type) {
1844 case FORMAT_TYPE_NONE: {
1845 int copy = read;
1846 if (str < end) {
1847 if (copy > end - str)
1848 copy = end - str;
1849 memcpy(str, old_fmt, copy);
1850 }
1851 str += read;
1852 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 }
1854
Vegard Nossumed681a92009-03-14 12:08:50 +01001855 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001856 spec.field_width = va_arg(args, int);
1857 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001859 case FORMAT_TYPE_PRECISION:
1860 spec.precision = va_arg(args, int);
1861 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
André Goddard Rosad4be1512009-12-14 18:00:59 -08001863 case FORMAT_TYPE_CHAR: {
1864 char c;
1865
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001866 if (!(spec.flags & LEFT)) {
1867 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001868 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 *str = ' ';
1870 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001871
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001873 }
1874 c = (unsigned char) va_arg(args, int);
1875 if (str < end)
1876 *str = c;
1877 ++str;
1878 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001879 if (str < end)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001880 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001882 }
1883 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001884 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001886 case FORMAT_TYPE_STR:
1887 str = string(str, end, va_arg(args, char *), spec);
1888 break;
1889
1890 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001891 str = pointer(fmt, str, end, va_arg(args, void *),
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001892 spec);
1893 while (isalnum(*fmt))
1894 fmt++;
1895 break;
1896
1897 case FORMAT_TYPE_PERCENT_CHAR:
1898 if (str < end)
1899 *str = '%';
1900 ++str;
1901 break;
1902
1903 case FORMAT_TYPE_INVALID:
1904 if (str < end)
1905 *str = '%';
1906 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001907 break;
1908
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001909 default:
1910 switch (spec.type) {
1911 case FORMAT_TYPE_LONG_LONG:
1912 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001914 case FORMAT_TYPE_ULONG:
1915 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001917 case FORMAT_TYPE_LONG:
1918 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001920 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08001921 if (spec.flags & SIGN)
1922 num = va_arg(args, ssize_t);
1923 else
1924 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001925 break;
1926 case FORMAT_TYPE_PTRDIFF:
1927 num = va_arg(args, ptrdiff_t);
1928 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001929 case FORMAT_TYPE_UBYTE:
1930 num = (unsigned char) va_arg(args, int);
1931 break;
1932 case FORMAT_TYPE_BYTE:
1933 num = (signed char) va_arg(args, int);
1934 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001935 case FORMAT_TYPE_USHORT:
1936 num = (unsigned short) va_arg(args, int);
1937 break;
1938 case FORMAT_TYPE_SHORT:
1939 num = (short) va_arg(args, int);
1940 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001941 case FORMAT_TYPE_INT:
1942 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001943 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001945 num = va_arg(args, unsigned int);
1946 }
1947
1948 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001951
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001952 if (size > 0) {
1953 if (str < end)
1954 *str = '\0';
1955 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07001956 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001957 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001958
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001959 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 return str-buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001961
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963EXPORT_SYMBOL(vsnprintf);
1964
1965/**
1966 * vscnprintf - Format a string and place it in a buffer
1967 * @buf: The buffer to place the result into
1968 * @size: The size of the buffer, including the trailing null space
1969 * @fmt: The format string to use
1970 * @args: Arguments for the format string
1971 *
1972 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08001973 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 * returns 0.
1975 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001976 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001977 *
1978 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 */
1980int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1981{
1982 int i;
1983
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001984 i = vsnprintf(buf, size, fmt, args);
1985
Anton Arapovb921c692011-01-12 16:59:49 -08001986 if (likely(i < size))
1987 return i;
1988 if (size != 0)
1989 return size - 1;
1990 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992EXPORT_SYMBOL(vscnprintf);
1993
1994/**
1995 * snprintf - Format a string and place it in a buffer
1996 * @buf: The buffer to place the result into
1997 * @size: The size of the buffer, including the trailing null space
1998 * @fmt: The format string to use
1999 * @...: Arguments for the format string
2000 *
2001 * The return value is the number of characters which would be
2002 * generated for the given input, excluding the trailing null,
2003 * as per ISO C99. If the return is greater than or equal to
2004 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07002005 *
2006 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002008int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009{
2010 va_list args;
2011 int i;
2012
2013 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002014 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002016
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 return i;
2018}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019EXPORT_SYMBOL(snprintf);
2020
2021/**
2022 * scnprintf - Format a string and place it in a buffer
2023 * @buf: The buffer to place the result into
2024 * @size: The size of the buffer, including the trailing null space
2025 * @fmt: The format string to use
2026 * @...: Arguments for the format string
2027 *
2028 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07002029 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 */
2031
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002032int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033{
2034 va_list args;
2035 int i;
2036
2037 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08002038 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002040
Anton Arapovb921c692011-01-12 16:59:49 -08002041 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042}
2043EXPORT_SYMBOL(scnprintf);
2044
2045/**
2046 * vsprintf - Format a string and place it in a buffer
2047 * @buf: The buffer to place the result into
2048 * @fmt: The format string to use
2049 * @args: Arguments for the format string
2050 *
2051 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002052 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 * buffer overflows.
2054 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002055 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002056 *
2057 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 */
2059int vsprintf(char *buf, const char *fmt, va_list args)
2060{
2061 return vsnprintf(buf, INT_MAX, fmt, args);
2062}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063EXPORT_SYMBOL(vsprintf);
2064
2065/**
2066 * sprintf - Format a string and place it in a buffer
2067 * @buf: The buffer to place the result into
2068 * @fmt: The format string to use
2069 * @...: Arguments for the format string
2070 *
2071 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002072 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07002074 *
2075 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002077int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078{
2079 va_list args;
2080 int i;
2081
2082 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002083 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002085
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 return i;
2087}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088EXPORT_SYMBOL(sprintf);
2089
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002090#ifdef CONFIG_BINARY_PRINTF
2091/*
2092 * bprintf service:
2093 * vbin_printf() - VA arguments to binary data
2094 * bstr_printf() - Binary data to text string
2095 */
2096
2097/**
2098 * vbin_printf - Parse a format string and place args' binary value in a buffer
2099 * @bin_buf: The buffer to place args' binary value
2100 * @size: The size of the buffer(by words(32bits), not characters)
2101 * @fmt: The format string to use
2102 * @args: Arguments for the format string
2103 *
2104 * The format follows C99 vsnprintf, except %n is ignored, and its argument
Masanari Iidada3dae52014-09-09 01:27:23 +09002105 * is skipped.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002106 *
2107 * The return value is the number of words(32bits) which would be generated for
2108 * the given input.
2109 *
2110 * NOTE:
2111 * If the return value is greater than @size, the resulting bin_buf is NOT
2112 * valid for bstr_printf().
2113 */
2114int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2115{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002116 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002117 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002118
2119 str = (char *)bin_buf;
2120 end = (char *)(bin_buf + size);
2121
2122#define save_arg(type) \
2123do { \
2124 if (sizeof(type) == 8) { \
2125 unsigned long long value; \
2126 str = PTR_ALIGN(str, sizeof(u32)); \
2127 value = va_arg(args, unsigned long long); \
2128 if (str + sizeof(type) <= end) { \
2129 *(u32 *)str = *(u32 *)&value; \
2130 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2131 } \
2132 } else { \
2133 unsigned long value; \
2134 str = PTR_ALIGN(str, sizeof(type)); \
2135 value = va_arg(args, int); \
2136 if (str + sizeof(type) <= end) \
2137 *(typeof(type) *)str = (type)value; \
2138 } \
2139 str += sizeof(type); \
2140} while (0)
2141
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002142 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08002143 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002144
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002145 fmt += read;
2146
2147 switch (spec.type) {
2148 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08002149 case FORMAT_TYPE_INVALID:
2150 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002151 break;
2152
Vegard Nossumed681a92009-03-14 12:08:50 +01002153 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002154 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002155 save_arg(int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002156 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002157
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002158 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002159 save_arg(char);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002160 break;
2161
2162 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002163 const char *save_str = va_arg(args, char *);
2164 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08002165
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002166 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2167 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08002168 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08002169 len = strlen(save_str) + 1;
2170 if (str + len < end)
2171 memcpy(str, save_str, len);
2172 str += len;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002173 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002174 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002175
2176 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002177 save_arg(void *);
2178 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002179 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002180 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002181 break;
2182
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002183 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002184 switch (spec.type) {
2185
2186 case FORMAT_TYPE_LONG_LONG:
2187 save_arg(long long);
2188 break;
2189 case FORMAT_TYPE_ULONG:
2190 case FORMAT_TYPE_LONG:
2191 save_arg(unsigned long);
2192 break;
2193 case FORMAT_TYPE_SIZE_T:
2194 save_arg(size_t);
2195 break;
2196 case FORMAT_TYPE_PTRDIFF:
2197 save_arg(ptrdiff_t);
2198 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002199 case FORMAT_TYPE_UBYTE:
2200 case FORMAT_TYPE_BYTE:
2201 save_arg(char);
2202 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002203 case FORMAT_TYPE_USHORT:
2204 case FORMAT_TYPE_SHORT:
2205 save_arg(short);
2206 break;
2207 default:
2208 save_arg(int);
2209 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002210 }
2211 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002212
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002213 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002214#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002215}
2216EXPORT_SYMBOL_GPL(vbin_printf);
2217
2218/**
2219 * bstr_printf - Format a string from binary arguments and place it in a buffer
2220 * @buf: The buffer to place the result into
2221 * @size: The size of the buffer, including the trailing null space
2222 * @fmt: The format string to use
2223 * @bin_buf: Binary arguments for the format string
2224 *
2225 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2226 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2227 * a binary buffer that generated by vbin_printf.
2228 *
2229 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002230 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002231 *
2232 * The return value is the number of characters which would
2233 * be generated for the given input, excluding the trailing
2234 * '\0', as per ISO C99. If you want to have the exact
2235 * number of characters written into @buf as return value
2236 * (not including the trailing '\0'), use vscnprintf(). If the
2237 * return is greater than or equal to @size, the resulting
2238 * string is truncated.
2239 */
2240int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2241{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002242 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002243 char *str, *end;
2244 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002245
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07002246 if (WARN_ON_ONCE((int) size < 0))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002247 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002248
2249 str = buf;
2250 end = buf + size;
2251
2252#define get_arg(type) \
2253({ \
2254 typeof(type) value; \
2255 if (sizeof(type) == 8) { \
2256 args = PTR_ALIGN(args, sizeof(u32)); \
2257 *(u32 *)&value = *(u32 *)args; \
2258 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2259 } else { \
2260 args = PTR_ALIGN(args, sizeof(type)); \
2261 value = *(typeof(type) *)args; \
2262 } \
2263 args += sizeof(type); \
2264 value; \
2265})
2266
2267 /* Make sure end is always >= buf */
2268 if (end < buf) {
2269 end = ((void *)-1);
2270 size = end - buf;
2271 }
2272
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002273 while (*fmt) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002274 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002275 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002276
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002277 fmt += read;
2278
2279 switch (spec.type) {
2280 case FORMAT_TYPE_NONE: {
2281 int copy = read;
2282 if (str < end) {
2283 if (copy > end - str)
2284 copy = end - str;
2285 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002286 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002287 str += read;
2288 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002289 }
2290
Vegard Nossumed681a92009-03-14 12:08:50 +01002291 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002292 spec.field_width = get_arg(int);
2293 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002294
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002295 case FORMAT_TYPE_PRECISION:
2296 spec.precision = get_arg(int);
2297 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002298
André Goddard Rosad4be1512009-12-14 18:00:59 -08002299 case FORMAT_TYPE_CHAR: {
2300 char c;
2301
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002302 if (!(spec.flags & LEFT)) {
2303 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002304 if (str < end)
2305 *str = ' ';
2306 ++str;
2307 }
2308 }
2309 c = (unsigned char) get_arg(char);
2310 if (str < end)
2311 *str = c;
2312 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002313 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002314 if (str < end)
2315 *str = ' ';
2316 ++str;
2317 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002318 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002319 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002320
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002321 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002322 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002323 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002324 str = string(str, end, (char *)str_arg, spec);
2325 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002326 }
2327
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002328 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002329 str = pointer(fmt, str, end, get_arg(void *), spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002330 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002331 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002332 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002333
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002334 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002335 case FORMAT_TYPE_INVALID:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002336 if (str < end)
2337 *str = '%';
2338 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002339 break;
2340
André Goddard Rosad4be1512009-12-14 18:00:59 -08002341 default: {
2342 unsigned long long num;
2343
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002344 switch (spec.type) {
2345
2346 case FORMAT_TYPE_LONG_LONG:
2347 num = get_arg(long long);
2348 break;
2349 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002350 case FORMAT_TYPE_LONG:
2351 num = get_arg(unsigned long);
2352 break;
2353 case FORMAT_TYPE_SIZE_T:
2354 num = get_arg(size_t);
2355 break;
2356 case FORMAT_TYPE_PTRDIFF:
2357 num = get_arg(ptrdiff_t);
2358 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002359 case FORMAT_TYPE_UBYTE:
2360 num = get_arg(unsigned char);
2361 break;
2362 case FORMAT_TYPE_BYTE:
2363 num = get_arg(signed char);
2364 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002365 case FORMAT_TYPE_USHORT:
2366 num = get_arg(unsigned short);
2367 break;
2368 case FORMAT_TYPE_SHORT:
2369 num = get_arg(short);
2370 break;
2371 case FORMAT_TYPE_UINT:
2372 num = get_arg(unsigned int);
2373 break;
2374 default:
2375 num = get_arg(int);
2376 }
2377
2378 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08002379 } /* default: */
2380 } /* switch(spec.type) */
2381 } /* while(*fmt) */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002382
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002383 if (size > 0) {
2384 if (str < end)
2385 *str = '\0';
2386 else
2387 end[-1] = '\0';
2388 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002389
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002390#undef get_arg
2391
2392 /* the trailing null byte doesn't count towards the total */
2393 return str - buf;
2394}
2395EXPORT_SYMBOL_GPL(bstr_printf);
2396
2397/**
2398 * bprintf - Parse a format string and place args' binary value in a buffer
2399 * @bin_buf: The buffer to place args' binary value
2400 * @size: The size of the buffer(by words(32bits), not characters)
2401 * @fmt: The format string to use
2402 * @...: Arguments for the format string
2403 *
2404 * The function returns the number of words(u32) written
2405 * into @bin_buf.
2406 */
2407int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2408{
2409 va_list args;
2410 int ret;
2411
2412 va_start(args, fmt);
2413 ret = vbin_printf(bin_buf, size, fmt, args);
2414 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002415
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002416 return ret;
2417}
2418EXPORT_SYMBOL_GPL(bprintf);
2419
2420#endif /* CONFIG_BINARY_PRINTF */
2421
Linus Torvalds1da177e2005-04-16 15:20:36 -07002422/**
2423 * vsscanf - Unformat a buffer into a list of arguments
2424 * @buf: input buffer
2425 * @fmt: format of buffer
2426 * @args: arguments
2427 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002428int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429{
2430 const char *str = buf;
2431 char *next;
2432 char digit;
2433 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08002434 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08002435 unsigned int base;
2436 union {
2437 long long s;
2438 unsigned long long u;
2439 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08002440 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002441 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442
Jan Beulichda990752012-10-04 17:13:24 -07002443 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 /* skip any white space in format */
2445 /* white space in format matchs any amount of
2446 * white space, including none, in the input.
2447 */
2448 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08002449 fmt = skip_spaces(++fmt);
2450 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 }
2452
2453 /* anything that is not a conversion must match exactly */
2454 if (*fmt != '%' && *fmt) {
2455 if (*fmt++ != *str++)
2456 break;
2457 continue;
2458 }
2459
2460 if (!*fmt)
2461 break;
2462 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002463
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 /* skip this conversion.
2465 * advance both strings to next white space
2466 */
2467 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07002468 if (!*str)
2469 break;
Andy Spencer8fccae22009-10-01 15:44:27 -07002470 while (!isspace(*fmt) && *fmt != '%' && *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 fmt++;
2472 while (!isspace(*str) && *str)
2473 str++;
2474 continue;
2475 }
2476
2477 /* get field width */
2478 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08002479 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08002481 if (field_width <= 0)
2482 break;
2483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484
2485 /* get conversion qualifier */
2486 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002487 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2488 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 qualifier = *fmt++;
2490 if (unlikely(qualifier == *fmt)) {
2491 if (qualifier == 'h') {
2492 qualifier = 'H';
2493 fmt++;
2494 } else if (qualifier == 'l') {
2495 qualifier = 'L';
2496 fmt++;
2497 }
2498 }
2499 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500
Jan Beulichda990752012-10-04 17:13:24 -07002501 if (!*fmt)
2502 break;
2503
2504 if (*fmt == 'n') {
2505 /* return number of characters read so far */
2506 *va_arg(args, int *) = str - buf;
2507 ++fmt;
2508 continue;
2509 }
2510
2511 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 break;
2513
André Goddard Rosad4be1512009-12-14 18:00:59 -08002514 base = 10;
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002515 is_sign = false;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002516
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002517 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 case 'c':
2519 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002520 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 if (field_width == -1)
2522 field_width = 1;
2523 do {
2524 *s++ = *str++;
2525 } while (--field_width > 0 && *str);
2526 num++;
2527 }
2528 continue;
2529 case 's':
2530 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002531 char *s = (char *)va_arg(args, char *);
2532 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07002533 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002535 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536
2537 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002538 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 *s = '\0';
2541 num++;
2542 }
2543 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 case 'o':
2545 base = 8;
2546 break;
2547 case 'x':
2548 case 'X':
2549 base = 16;
2550 break;
2551 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002552 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 case 'd':
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002554 is_sign = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 case 'u':
2556 break;
2557 case '%':
2558 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002559 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560 return num;
2561 continue;
2562 default:
2563 /* invalid format; stop here */
2564 return num;
2565 }
2566
2567 /* have some sort of integer conversion.
2568 * first, skip white space in buffer.
2569 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002570 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571
2572 digit = *str;
2573 if (is_sign && digit == '-')
2574 digit = *(str + 1);
2575
2576 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002577 || (base == 16 && !isxdigit(digit))
2578 || (base == 10 && !isdigit(digit))
2579 || (base == 8 && (!isdigit(digit) || digit > '7'))
2580 || (base == 0 && !isdigit(digit)))
2581 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582
Jan Beulich53809752012-12-17 16:01:31 -08002583 if (is_sign)
2584 val.s = qualifier != 'L' ?
2585 simple_strtol(str, &next, base) :
2586 simple_strtoll(str, &next, base);
2587 else
2588 val.u = qualifier != 'L' ?
2589 simple_strtoul(str, &next, base) :
2590 simple_strtoull(str, &next, base);
2591
2592 if (field_width > 0 && next - str > field_width) {
2593 if (base == 0)
2594 _parse_integer_fixup_radix(str, &base);
2595 while (next - str > field_width) {
2596 if (is_sign)
2597 val.s = div_s64(val.s, base);
2598 else
2599 val.u = div_u64(val.u, base);
2600 --next;
2601 }
2602 }
2603
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002604 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002605 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08002606 if (is_sign)
2607 *va_arg(args, signed char *) = val.s;
2608 else
2609 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 break;
2611 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08002612 if (is_sign)
2613 *va_arg(args, short *) = val.s;
2614 else
2615 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002616 break;
2617 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08002618 if (is_sign)
2619 *va_arg(args, long *) = val.s;
2620 else
2621 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 break;
2623 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08002624 if (is_sign)
2625 *va_arg(args, long long *) = val.s;
2626 else
2627 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002628 break;
2629 case 'Z':
2630 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08002631 *va_arg(args, size_t *) = val.u;
2632 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 default:
Jan Beulich53809752012-12-17 16:01:31 -08002634 if (is_sign)
2635 *va_arg(args, int *) = val.s;
2636 else
2637 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 break;
2639 }
2640 num++;
2641
2642 if (!next)
2643 break;
2644 str = next;
2645 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002646
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 return num;
2648}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649EXPORT_SYMBOL(vsscanf);
2650
2651/**
2652 * sscanf - Unformat a buffer into a list of arguments
2653 * @buf: input buffer
2654 * @fmt: formatting of buffer
2655 * @...: resulting arguments
2656 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002657int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658{
2659 va_list args;
2660 int i;
2661
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002662 va_start(args, fmt);
2663 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002665
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 return i;
2667}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668EXPORT_SYMBOL(sscanf);