blob: 7a299d43987a01c798a7a93b9822c73bece81afc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/lib/vsprintf.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 */
6
7/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
8/*
9 * Wirzenius wrote this portably, Torvalds fucked it up :-)
10 */
11
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080012/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
14 * - changed to provide snprintf and vsnprintf functions
15 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
16 * - scnprintf and vscnprintf
17 */
18
19#include <stdarg.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050020#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/types.h>
22#include <linux/string.h>
23#include <linux/ctype.h>
24#include <linux/kernel.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070025#include <linux/kallsyms.h>
Jan Beulich53809752012-12-17 16:01:31 -080026#include <linux/math64.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070027#include <linux/uaccess.h>
Linus Torvalds332d2e72008-10-20 15:07:34 +110028#include <linux/ioport.h>
Al Viro4b6ccca2013-09-03 12:00:44 -040029#include <linux/dcache.h>
Ryan Mallon312b4e22013-11-12 15:08:51 -080030#include <linux/cred.h>
Joe Perches8a27f7c2009-08-17 12:29:44 +000031#include <net/addrconf.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Tim Schmielau4e57b682005-10-30 15:03:48 -080033#include <asm/page.h> /* for PAGE_SIZE */
James Bottomleydeac93d2008-09-03 20:43:36 -050034#include <asm/sections.h> /* for dereference_function_descriptor() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Andy Shevchenko71dca952014-10-13 15:55:18 -070036#include <linux/string_helpers.h>
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070037#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070038
Linus Torvalds1da177e2005-04-16 15:20:36 -070039/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 * simple_strtoull - convert a string to an unsigned long long
41 * @cp: The start of the string
42 * @endp: A pointer to the end of the parsed string will be placed here
43 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080044 *
45 * This function is obsolete. Please use kstrtoull instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 */
Harvey Harrison22d27052008-10-16 13:40:35 -070047unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070049 unsigned long long result;
50 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070052 cp = _parse_integer_fixup_radix(cp, &base);
53 rv = _parse_integer(cp, base, &result);
54 /* FIXME */
55 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 if (endp)
58 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 return result;
61}
Linus Torvalds1da177e2005-04-16 15:20:36 -070062EXPORT_SYMBOL(simple_strtoull);
63
64/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080065 * simple_strtoul - convert a string to an unsigned long
66 * @cp: The start of the string
67 * @endp: A pointer to the end of the parsed string will be placed here
68 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080069 *
70 * This function is obsolete. Please use kstrtoul instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080071 */
72unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
73{
74 return simple_strtoull(cp, endp, base);
75}
76EXPORT_SYMBOL(simple_strtoul);
77
78/**
79 * simple_strtol - convert a string to a signed long
80 * @cp: The start of the string
81 * @endp: A pointer to the end of the parsed string will be placed here
82 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080083 *
84 * This function is obsolete. Please use kstrtol instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080085 */
86long simple_strtol(const char *cp, char **endp, unsigned int base)
87{
88 if (*cp == '-')
89 return -simple_strtoul(cp + 1, endp, base);
90
91 return simple_strtoul(cp, endp, base);
92}
93EXPORT_SYMBOL(simple_strtol);
94
95/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * simple_strtoll - convert a string to a signed long long
97 * @cp: The start of the string
98 * @endp: A pointer to the end of the parsed string will be placed here
99 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -0800100 *
101 * This function is obsolete. Please use kstrtoll instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 */
Harvey Harrison22d27052008-10-16 13:40:35 -0700103long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800105 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -0700106 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800107
Harvey Harrison22d27052008-10-16 13:40:35 -0700108 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109}
Hans Verkuil98d5ce02010-04-23 13:18:04 -0400110EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Joe Perchescf3b4292010-05-24 14:33:16 -0700112static noinline_for_stack
113int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800115 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800117 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 i = i*10 + *((*s)++) - '0';
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800119 } while (isdigit(**s));
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 return i;
122}
123
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700124/* Decimal conversion is by far the most typical, and is used
125 * for /proc and /sys data. This directly impacts e.g. top performance
126 * with many processes running. We optimize it for speed
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700127 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
128 * (with permission from the author, Douglas W. Jones).
129 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700130
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700131#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
132/* Formats correctly any integer in [0, 999999999] */
Joe Perchescf3b4292010-05-24 14:33:16 -0700133static noinline_for_stack
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700134char *put_dec_full9(char *buf, unsigned q)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700135{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700136 unsigned r;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700137
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800138 /*
139 * Possible ways to approx. divide by 10
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700140 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
141 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
142 * (x * 0x6667) >> 18 x < 43699
143 * (x * 0x3334) >> 17 x < 16389
144 * (x * 0x199a) >> 16 x < 16389
145 * (x * 0x0ccd) >> 15 x < 16389
146 * (x * 0x0667) >> 14 x < 2739
147 * (x * 0x0334) >> 13 x < 1029
148 * (x * 0x019a) >> 12 x < 1029
149 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
150 * (x * 0x0067) >> 10 x < 179
151 * (x * 0x0034) >> 9 x < 69 same
152 * (x * 0x001a) >> 8 x < 69 same
153 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
154 * (x * 0x0007) >> 6 x < 19
155 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800156 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700157 r = (q * (uint64_t)0x1999999a) >> 32;
158 *buf++ = (q - 10 * r) + '0'; /* 1 */
159 q = (r * (uint64_t)0x1999999a) >> 32;
160 *buf++ = (r - 10 * q) + '0'; /* 2 */
161 r = (q * (uint64_t)0x1999999a) >> 32;
162 *buf++ = (q - 10 * r) + '0'; /* 3 */
163 q = (r * (uint64_t)0x1999999a) >> 32;
164 *buf++ = (r - 10 * q) + '0'; /* 4 */
165 r = (q * (uint64_t)0x1999999a) >> 32;
166 *buf++ = (q - 10 * r) + '0'; /* 5 */
167 /* Now value is under 10000, can avoid 64-bit multiply */
168 q = (r * 0x199a) >> 16;
169 *buf++ = (r - 10 * q) + '0'; /* 6 */
170 r = (q * 0xcd) >> 11;
171 *buf++ = (q - 10 * r) + '0'; /* 7 */
172 q = (r * 0xcd) >> 11;
173 *buf++ = (r - 10 * q) + '0'; /* 8 */
174 *buf++ = q + '0'; /* 9 */
175 return buf;
176}
177#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700178
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700179/* Similar to above but do not pad with zeros.
180 * Code can be easily arranged to print 9 digits too, but our callers
181 * always call put_dec_full9() instead when the number has 9 decimal digits.
182 */
183static noinline_for_stack
184char *put_dec_trunc8(char *buf, unsigned r)
185{
186 unsigned q;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700187
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700188 /* Copy of previous function's body with added early returns */
George Spelvincb239d02012-10-04 17:12:30 -0700189 while (r >= 10000) {
190 q = r + '0';
191 r = (r * (uint64_t)0x1999999a) >> 32;
192 *buf++ = q - 10*r;
193 }
194
George Spelvinf4000512012-10-04 17:12:32 -0700195 q = (r * 0x199a) >> 16; /* r <= 9999 */
196 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700197 if (q == 0)
198 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700199 r = (q * 0xcd) >> 11; /* q <= 999 */
200 *buf++ = (q - 10 * r) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700201 if (r == 0)
202 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700203 q = (r * 0xcd) >> 11; /* r <= 99 */
204 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700205 if (q == 0)
206 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700207 *buf++ = q + '0'; /* q <= 9 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700208 return buf;
209}
210
211/* There are two algorithms to print larger numbers.
212 * One is generic: divide by 1000000000 and repeatedly print
213 * groups of (up to) 9 digits. It's conceptually simple,
214 * but requires a (unsigned long long) / 1000000000 division.
215 *
216 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
217 * manipulates them cleverly and generates groups of 4 decimal digits.
218 * It so happens that it does NOT require long long division.
219 *
220 * If long is > 32 bits, division of 64-bit values is relatively easy,
221 * and we will use the first algorithm.
222 * If long long is > 64 bits (strange architecture with VERY large long long),
223 * second algorithm can't be used, and we again use the first one.
224 *
225 * Else (if long is 32 bits and long long is 64 bits) we use second one.
226 */
227
228#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
229
230/* First algorithm: generic */
231
232static
233char *put_dec(char *buf, unsigned long long n)
234{
235 if (n >= 100*1000*1000) {
236 while (n >= 1000*1000*1000)
237 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
238 if (n >= 100*1000*1000)
239 return put_dec_full9(buf, n);
240 }
241 return put_dec_trunc8(buf, n);
242}
243
244#else
245
246/* Second algorithm: valid only for 64-bit long longs */
247
George Spelvine49317d2012-10-04 17:12:27 -0700248/* See comment in put_dec_full9 for choice of constants */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700249static noinline_for_stack
George Spelvin23591722012-10-04 17:12:29 -0700250void put_dec_full4(char *buf, unsigned q)
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700251{
252 unsigned r;
George Spelvine49317d2012-10-04 17:12:27 -0700253 r = (q * 0xccd) >> 15;
George Spelvin23591722012-10-04 17:12:29 -0700254 buf[0] = (q - 10 * r) + '0';
George Spelvine49317d2012-10-04 17:12:27 -0700255 q = (r * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700256 buf[1] = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700257 r = (q * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700258 buf[2] = (q - 10 * r) + '0';
259 buf[3] = r + '0';
260}
261
262/*
263 * Call put_dec_full4 on x % 10000, return x / 10000.
264 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
265 * holds for all x < 1,128,869,999. The largest value this
266 * helper will ever be asked to convert is 1,125,520,955.
267 * (d1 in the put_dec code, assuming n is all-ones).
268 */
269static
270unsigned put_dec_helper4(char *buf, unsigned x)
271{
272 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
273
274 put_dec_full4(buf, x - q * 10000);
275 return q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700276}
277
278/* Based on code by Douglas W. Jones found at
279 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
280 * (with permission from the author).
281 * Performs no 64-bit division and hence should be fast on 32-bit machines.
282 */
283static
284char *put_dec(char *buf, unsigned long long n)
285{
286 uint32_t d3, d2, d1, q, h;
287
288 if (n < 100*1000*1000)
289 return put_dec_trunc8(buf, n);
290
291 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
292 h = (n >> 32);
293 d2 = (h ) & 0xffff;
294 d3 = (h >> 16); /* implicit "& 0xffff" */
295
296 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
George Spelvin23591722012-10-04 17:12:29 -0700297 q = put_dec_helper4(buf, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700298
George Spelvin23591722012-10-04 17:12:29 -0700299 q += 7671 * d3 + 9496 * d2 + 6 * d1;
300 q = put_dec_helper4(buf+4, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700301
George Spelvin23591722012-10-04 17:12:29 -0700302 q += 4749 * d3 + 42 * d2;
303 q = put_dec_helper4(buf+8, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700304
George Spelvin23591722012-10-04 17:12:29 -0700305 q += 281 * d3;
306 buf += 12;
307 if (q)
308 buf = put_dec_trunc8(buf, q);
309 else while (buf[-1] == '0')
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700310 --buf;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800311
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700312 return buf;
313}
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700314
315#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700316
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700317/*
318 * Convert passed number to decimal string.
319 * Returns the length of string. On buffer overflow, returns 0.
320 *
321 * If speed is not important, use snprintf(). It's easy to read the code.
322 */
323int num_to_str(char *buf, int size, unsigned long long num)
324{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700325 char tmp[sizeof(num) * 3];
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700326 int idx, len;
327
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700328 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
329 if (num <= 9) {
330 tmp[0] = '0' + num;
331 len = 1;
332 } else {
333 len = put_dec(tmp, num) - tmp;
334 }
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700335
336 if (len > size)
337 return 0;
338 for (idx = 0; idx < len; ++idx)
339 buf[idx] = tmp[len - idx - 1];
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700340 return len;
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700341}
342
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700343#define SIGN 1 /* unsigned/signed, must be 1 */
344#define ZEROPAD 2 /* pad with zero */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345#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{
Rasmus Villemoese26c12c2015-04-15 16:17:05 -0700386 char tmp[3 * sizeof(num)];
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100387 char sign;
388 char locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100389 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 int i;
Pierre Carrier7c203422012-05-29 15:07:35 -0700391 bool is_zero = num == 0LL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100393 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
394 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100395 locase = (spec.flags & SMALL);
396 if (spec.flags & LEFT)
397 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 sign = 0;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100399 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800400 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800402 num = -(signed long long)num;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100403 spec.field_width--;
404 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 sign = '+';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100406 spec.field_width--;
407 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 sign = ' ';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100409 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 }
411 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700412 if (need_pfx) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100413 if (spec.base == 16)
Pierre Carrier7c203422012-05-29 15:07:35 -0700414 spec.field_width -= 2;
415 else if (!is_zero)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100416 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700418
419 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 i = 0;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700421 if (num < spec.base)
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700422 tmp[i++] = hex_asc_upper[num] | locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100423 else if (spec.base != 10) { /* 8 or 16 */
424 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700425 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800426
427 if (spec.base == 16)
428 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700429 do {
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700430 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700431 num >>= shift;
432 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700433 } else { /* base 10 */
434 i = put_dec(tmp, num) - tmp;
435 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700436
437 /* printing 100 using %2d gives "100", not "00" */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100438 if (i > spec.precision)
439 spec.precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700440 /* leading space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100441 spec.field_width -= spec.precision;
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700442 if (!(spec.flags & (ZEROPAD | LEFT))) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800443 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700444 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 *buf = ' ';
446 ++buf;
447 }
448 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700449 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700451 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 *buf = sign;
453 ++buf;
454 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700455 /* "0x" / "0" prefix */
456 if (need_pfx) {
Pierre Carrier7c203422012-05-29 15:07:35 -0700457 if (spec.base == 16 || !is_zero) {
458 if (buf < end)
459 *buf = '0';
460 ++buf;
461 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100462 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700463 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100464 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 ++buf;
466 }
467 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700468 /* zero or space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100469 if (!(spec.flags & LEFT)) {
470 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
471 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700472 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 *buf = c;
474 ++buf;
475 }
476 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700477 /* hmm even more zero padding? */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100478 while (i <= --spec.precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700479 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 *buf = '0';
481 ++buf;
482 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700483 /* actual digits of result */
484 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700485 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 *buf = tmp[i];
487 ++buf;
488 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700489 /* trailing space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100490 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700491 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 *buf = ' ';
493 ++buf;
494 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800495
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 return buf;
497}
498
Joe Perchescf3b4292010-05-24 14:33:16 -0700499static noinline_for_stack
500char *string(char *buf, char *end, const char *s, struct printf_spec spec)
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700501{
502 int len, i;
503
504 if ((unsigned long)s < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -0800505 s = "(null)";
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700506
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100507 len = strnlen(s, spec.precision);
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700508
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100509 if (!(spec.flags & LEFT)) {
510 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700511 if (buf < end)
512 *buf = ' ';
513 ++buf;
514 }
515 }
516 for (i = 0; i < len; ++i) {
517 if (buf < end)
518 *buf = *s;
519 ++buf; ++s;
520 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100521 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700522 if (buf < end)
523 *buf = ' ';
524 ++buf;
525 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800526
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700527 return buf;
528}
529
Al Viro4b6ccca2013-09-03 12:00:44 -0400530static void widen(char *buf, char *end, unsigned len, unsigned spaces)
531{
532 size_t size;
533 if (buf >= end) /* nowhere to put anything */
534 return;
535 size = end - buf;
536 if (size <= spaces) {
537 memset(buf, ' ', size);
538 return;
539 }
540 if (len) {
541 if (len > size - spaces)
542 len = size - spaces;
543 memmove(buf + spaces, buf, len);
544 }
545 memset(buf, ' ', spaces);
546}
547
548static noinline_for_stack
549char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
550 const char *fmt)
551{
552 const char *array[4], *s;
553 const struct dentry *p;
554 int depth;
555 int i, n;
556
557 switch (fmt[1]) {
558 case '2': case '3': case '4':
559 depth = fmt[1] - '0';
560 break;
561 default:
562 depth = 1;
563 }
564
565 rcu_read_lock();
566 for (i = 0; i < depth; i++, d = p) {
567 p = ACCESS_ONCE(d->d_parent);
568 array[i] = ACCESS_ONCE(d->d_name.name);
569 if (p == d) {
570 if (i)
571 array[i] = "";
572 i++;
573 break;
574 }
575 }
576 s = array[--i];
577 for (n = 0; n != spec.precision; n++, buf++) {
578 char c = *s++;
579 if (!c) {
580 if (!i)
581 break;
582 c = '/';
583 s = array[--i];
584 }
585 if (buf < end)
586 *buf = c;
587 }
588 rcu_read_unlock();
589 if (n < spec.field_width) {
590 /* we want to pad the sucker */
591 unsigned spaces = spec.field_width - n;
592 if (!(spec.flags & LEFT)) {
593 widen(buf - n, end, n, spaces);
594 return buf + spaces;
595 }
596 while (spaces--) {
597 if (buf < end)
598 *buf = ' ';
599 ++buf;
600 }
601 }
602 return buf;
603}
604
Joe Perchescf3b4292010-05-24 14:33:16 -0700605static noinline_for_stack
606char *symbol_string(char *buf, char *end, void *ptr,
Joe Perchesb0d33c22012-12-12 10:18:50 -0800607 struct printf_spec spec, const char *fmt)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700608{
Joe Perchesb0d33c22012-12-12 10:18:50 -0800609 unsigned long value;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700610#ifdef CONFIG_KALLSYMS
611 char sym[KSYM_SYMBOL_LEN];
Joe Perchesb0d33c22012-12-12 10:18:50 -0800612#endif
613
614 if (fmt[1] == 'R')
615 ptr = __builtin_extract_return_addr(ptr);
616 value = (unsigned long)ptr;
617
618#ifdef CONFIG_KALLSYMS
619 if (*fmt == 'B')
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900620 sprint_backtrace(sym, value);
Joe Perchesb0d33c22012-12-12 10:18:50 -0800621 else if (*fmt != 'f' && *fmt != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200622 sprint_symbol(sym, value);
623 else
Stephen Boyd4796dd22012-05-29 15:07:33 -0700624 sprint_symbol_no_offset(sym, value);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800625
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100626 return string(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700627#else
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800628 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100629 spec.flags |= SPECIAL | SMALL | ZEROPAD;
630 spec.base = 16;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800631
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100632 return number(buf, end, value, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700633#endif
634}
635
Joe Perchescf3b4292010-05-24 14:33:16 -0700636static noinline_for_stack
637char *resource_string(char *buf, char *end, struct resource *res,
638 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +1100639{
640#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600641#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +1100642#endif
643
644#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600645#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +1100646#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700647 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100648 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700649 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100650 .precision = -1,
651 .flags = SPECIAL | SMALL | ZEROPAD,
652 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700653 static const struct printf_spec mem_spec = {
654 .base = 16,
655 .field_width = MEM_RSRC_PRINTK_SIZE,
656 .precision = -1,
657 .flags = SPECIAL | SMALL | ZEROPAD,
658 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700659 static const struct printf_spec bus_spec = {
660 .base = 16,
661 .field_width = 2,
662 .precision = -1,
663 .flags = SMALL | ZEROPAD,
664 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700665 static const struct printf_spec dec_spec = {
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600666 .base = 10,
667 .precision = -1,
668 .flags = 0,
669 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700670 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600671 .field_width = -1,
672 .precision = 10,
673 .flags = LEFT,
674 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700675 static const struct printf_spec flag_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600676 .base = 16,
677 .precision = -1,
678 .flags = SPECIAL | SMALL,
679 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600680
681 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
682 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
683#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
684#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700685#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600686#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
687 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
688 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
689
Linus Torvalds332d2e72008-10-20 15:07:34 +1100690 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600691 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700692 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +1100693
694 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700695 if (res->flags & IORESOURCE_IO) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600696 p = string(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700697 specp = &io_spec;
698 } else if (res->flags & IORESOURCE_MEM) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600699 p = string(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700700 specp = &mem_spec;
701 } else if (res->flags & IORESOURCE_IRQ) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600702 p = string(p, pend, "irq ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700703 specp = &dec_spec;
704 } else if (res->flags & IORESOURCE_DMA) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600705 p = string(p, pend, "dma ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700706 specp = &dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700707 } else if (res->flags & IORESOURCE_BUS) {
708 p = string(p, pend, "bus ", str_spec);
709 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700710 } else {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600711 p = string(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700712 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600713 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600714 }
Bjorn Helgaasd19cb802014-02-26 11:25:56 -0700715 if (decode && res->flags & IORESOURCE_UNSET) {
716 p = string(p, pend, "size ", str_spec);
717 p = number(p, pend, resource_size(res), *specp);
718 } else {
719 p = number(p, pend, res->start, *specp);
720 if (res->start != res->end) {
721 *p++ = '-';
722 p = number(p, pend, res->end, *specp);
723 }
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600724 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600725 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600726 if (res->flags & IORESOURCE_MEM_64)
727 p = string(p, pend, " 64bit", str_spec);
728 if (res->flags & IORESOURCE_PREFETCH)
729 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700730 if (res->flags & IORESOURCE_WINDOW)
731 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600732 if (res->flags & IORESOURCE_DISABLED)
733 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600734 } else {
735 p = string(p, pend, " flags ", str_spec);
736 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600737 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100738 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600739 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100740
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100741 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100742}
743
Joe Perchescf3b4292010-05-24 14:33:16 -0700744static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -0700745char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
746 const char *fmt)
747{
Steven Rostedt360603a2013-05-28 15:47:39 -0400748 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -0700749 negative value, fallback to the default */
750 char separator;
751
752 if (spec.field_width == 0)
753 /* nothing to print */
754 return buf;
755
756 if (ZERO_OR_NULL_PTR(addr))
757 /* NULL pointer */
758 return string(buf, end, NULL, spec);
759
760 switch (fmt[1]) {
761 case 'C':
762 separator = ':';
763 break;
764 case 'D':
765 separator = '-';
766 break;
767 case 'N':
768 separator = 0;
769 break;
770 default:
771 separator = ' ';
772 break;
773 }
774
775 if (spec.field_width > 0)
776 len = min_t(int, spec.field_width, 64);
777
778 for (i = 0; i < len && buf < end - 1; i++) {
779 buf = hex_byte_pack(buf, addr[i]);
780
781 if (buf < end && separator && i != len - 1)
782 *buf++ = separator;
783 }
784
785 return buf;
786}
787
788static noinline_for_stack
Tejun Heodbc760b2015-02-13 14:36:53 -0800789char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
790 struct printf_spec spec, const char *fmt)
791{
792 const int CHUNKSZ = 32;
793 int nr_bits = max_t(int, spec.field_width, 0);
794 int i, chunksz;
795 bool first = true;
796
797 /* reused to print numbers */
798 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
799
800 chunksz = nr_bits & (CHUNKSZ - 1);
801 if (chunksz == 0)
802 chunksz = CHUNKSZ;
803
804 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
805 for (; i >= 0; i -= CHUNKSZ) {
806 u32 chunkmask, val;
807 int word, bit;
808
809 chunkmask = ((1ULL << chunksz) - 1);
810 word = i / BITS_PER_LONG;
811 bit = i % BITS_PER_LONG;
812 val = (bitmap[word] >> bit) & chunkmask;
813
814 if (!first) {
815 if (buf < end)
816 *buf = ',';
817 buf++;
818 }
819 first = false;
820
821 spec.field_width = DIV_ROUND_UP(chunksz, 4);
822 buf = number(buf, end, val, spec);
823
824 chunksz = CHUNKSZ;
825 }
826 return buf;
827}
828
829static noinline_for_stack
830char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
831 struct printf_spec spec, const char *fmt)
832{
833 int nr_bits = max_t(int, spec.field_width, 0);
834 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
835 int cur, rbot, rtop;
836 bool first = true;
837
838 /* reused to print numbers */
839 spec = (struct printf_spec){ .base = 10 };
840
841 rbot = cur = find_first_bit(bitmap, nr_bits);
842 while (cur < nr_bits) {
843 rtop = cur;
844 cur = find_next_bit(bitmap, nr_bits, cur + 1);
845 if (cur < nr_bits && cur <= rtop + 1)
846 continue;
847
848 if (!first) {
849 if (buf < end)
850 *buf = ',';
851 buf++;
852 }
853 first = false;
854
855 buf = number(buf, end, rbot, spec);
856 if (rbot < rtop) {
857 if (buf < end)
858 *buf = '-';
859 buf++;
860
861 buf = number(buf, end, rtop, spec);
862 }
863
864 rbot = cur;
865 }
866 return buf;
867}
868
869static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -0700870char *mac_address_string(char *buf, char *end, u8 *addr,
871 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700872{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000873 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700874 char *p = mac_addr;
875 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000876 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700877 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000878
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700879 switch (fmt[1]) {
880 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +0000881 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700882 break;
883
884 case 'R':
885 reversed = true;
886 /* fall through */
887
888 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +0000889 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700890 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000891 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700892
893 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700894 if (reversed)
895 p = hex_byte_pack(p, addr[5 - i]);
896 else
897 p = hex_byte_pack(p, addr[i]);
898
Joe Perches8a27f7c2009-08-17 12:29:44 +0000899 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000900 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700901 }
902 *p = '\0';
903
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100904 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700905}
906
Joe Perchescf3b4292010-05-24 14:33:16 -0700907static noinline_for_stack
908char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700909{
Harvey Harrison689afa72008-10-28 16:04:44 -0700910 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800911 bool leading_zeros = (fmt[0] == 'i');
912 int index;
913 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700914
Joe Perches0159f242010-01-13 20:23:30 -0800915 switch (fmt[2]) {
916 case 'h':
917#ifdef __BIG_ENDIAN
918 index = 0;
919 step = 1;
920#else
921 index = 3;
922 step = -1;
923#endif
924 break;
925 case 'l':
926 index = 3;
927 step = -1;
928 break;
929 case 'n':
930 case 'b':
931 default:
932 index = 0;
933 step = 1;
934 break;
935 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000936 for (i = 0; i < 4; i++) {
937 char temp[3]; /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700938 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000939 if (leading_zeros) {
940 if (digits < 3)
941 *p++ = '0';
942 if (digits < 2)
943 *p++ = '0';
944 }
945 /* reverse the digits in the quad */
946 while (digits--)
947 *p++ = temp[digits];
948 if (i < 3)
949 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -0800950 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000951 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000952 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800953
Joe Perches8a27f7c2009-08-17 12:29:44 +0000954 return p;
955}
956
Joe Perchescf3b4292010-05-24 14:33:16 -0700957static noinline_for_stack
958char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000959{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800960 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000961 unsigned char zerolength[8];
962 int longest = 1;
963 int colonpos = -1;
964 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800965 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000966 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +0000967 bool useIPv4;
968 struct in6_addr in6;
969
970 memcpy(&in6, addr, sizeof(struct in6_addr));
971
972 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000973
974 memset(zerolength, 0, sizeof(zerolength));
975
976 if (useIPv4)
977 range = 6;
978 else
979 range = 8;
980
981 /* find position of longest 0 run */
982 for (i = 0; i < range; i++) {
983 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +0000984 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000985 break;
986 zerolength[i]++;
987 }
988 }
989 for (i = 0; i < range; i++) {
990 if (zerolength[i] > longest) {
991 longest = zerolength[i];
992 colonpos = i;
993 }
994 }
Joe Perches29cf5192011-06-09 11:23:37 -0700995 if (longest == 1) /* don't compress a single 0 */
996 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000997
998 /* emit address */
999 for (i = 0; i < range; i++) {
1000 if (i == colonpos) {
1001 if (needcolon || i == 0)
1002 *p++ = ':';
1003 *p++ = ':';
1004 needcolon = false;
1005 i += longest - 1;
1006 continue;
1007 }
1008 if (needcolon) {
1009 *p++ = ':';
1010 needcolon = false;
1011 }
1012 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +00001013 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001014 hi = word >> 8;
1015 lo = word & 0xff;
1016 if (hi) {
1017 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001018 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001019 else
1020 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001021 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001022 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -08001023 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001024 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001025 else
1026 *p++ = hex_asc_lo(lo);
1027 needcolon = true;
1028 }
1029
1030 if (useIPv4) {
1031 if (needcolon)
1032 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -08001033 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +00001034 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001035 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001036
Joe Perches8a27f7c2009-08-17 12:29:44 +00001037 return p;
1038}
1039
Joe Perchescf3b4292010-05-24 14:33:16 -07001040static noinline_for_stack
1041char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001042{
1043 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001044
Harvey Harrison689afa72008-10-28 16:04:44 -07001045 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001046 p = hex_byte_pack(p, *addr++);
1047 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001048 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -07001049 *p++ = ':';
1050 }
1051 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001052
Joe Perches8a27f7c2009-08-17 12:29:44 +00001053 return p;
1054}
1055
Joe Perchescf3b4292010-05-24 14:33:16 -07001056static noinline_for_stack
1057char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1058 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001059{
1060 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1061
1062 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +00001063 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001064 else
Joe Percheseb78cd22009-09-18 13:04:06 +00001065 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -07001066
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001067 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -07001068}
1069
Joe Perchescf3b4292010-05-24 14:33:16 -07001070static noinline_for_stack
1071char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1072 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -07001073{
Joe Perches8a27f7c2009-08-17 12:29:44 +00001074 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -07001075
Joe Perches0159f242010-01-13 20:23:30 -08001076 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001077
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001078 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001079}
1080
Joe Perchescf3b4292010-05-24 14:33:16 -07001081static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001082char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1083 struct printf_spec spec, const char *fmt)
1084{
1085 bool have_p = false, have_s = false, have_f = false, have_c = false;
1086 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1087 sizeof(":12345") + sizeof("/123456789") +
1088 sizeof("%1234567890")];
1089 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1090 const u8 *addr = (const u8 *) &sa->sin6_addr;
1091 char fmt6[2] = { fmt[0], '6' };
1092 u8 off = 0;
1093
1094 fmt++;
1095 while (isalpha(*++fmt)) {
1096 switch (*fmt) {
1097 case 'p':
1098 have_p = true;
1099 break;
1100 case 'f':
1101 have_f = true;
1102 break;
1103 case 's':
1104 have_s = true;
1105 break;
1106 case 'c':
1107 have_c = true;
1108 break;
1109 }
1110 }
1111
1112 if (have_p || have_s || have_f) {
1113 *p = '[';
1114 off = 1;
1115 }
1116
1117 if (fmt6[0] == 'I' && have_c)
1118 p = ip6_compressed_string(ip6_addr + off, addr);
1119 else
1120 p = ip6_string(ip6_addr + off, addr, fmt6);
1121
1122 if (have_p || have_s || have_f)
1123 *p++ = ']';
1124
1125 if (have_p) {
1126 *p++ = ':';
1127 p = number(p, pend, ntohs(sa->sin6_port), spec);
1128 }
1129 if (have_f) {
1130 *p++ = '/';
1131 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1132 IPV6_FLOWINFO_MASK), spec);
1133 }
1134 if (have_s) {
1135 *p++ = '%';
1136 p = number(p, pend, sa->sin6_scope_id, spec);
1137 }
1138 *p = '\0';
1139
1140 return string(buf, end, ip6_addr, spec);
1141}
1142
1143static noinline_for_stack
1144char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1145 struct printf_spec spec, const char *fmt)
1146{
1147 bool have_p = false;
1148 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1149 char *pend = ip4_addr + sizeof(ip4_addr);
1150 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1151 char fmt4[3] = { fmt[0], '4', 0 };
1152
1153 fmt++;
1154 while (isalpha(*++fmt)) {
1155 switch (*fmt) {
1156 case 'p':
1157 have_p = true;
1158 break;
1159 case 'h':
1160 case 'l':
1161 case 'n':
1162 case 'b':
1163 fmt4[2] = *fmt;
1164 break;
1165 }
1166 }
1167
1168 p = ip4_string(ip4_addr, addr, fmt4);
1169 if (have_p) {
1170 *p++ = ':';
1171 p = number(p, pend, ntohs(sa->sin_port), spec);
1172 }
1173 *p = '\0';
1174
1175 return string(buf, end, ip4_addr, spec);
1176}
1177
1178static noinline_for_stack
Andy Shevchenko71dca952014-10-13 15:55:18 -07001179char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1180 const char *fmt)
1181{
1182 bool found = true;
1183 int count = 1;
1184 unsigned int flags = 0;
1185 int len;
1186
1187 if (spec.field_width == 0)
1188 return buf; /* nothing to print */
1189
1190 if (ZERO_OR_NULL_PTR(addr))
1191 return string(buf, end, NULL, spec); /* NULL pointer */
1192
1193
1194 do {
1195 switch (fmt[count++]) {
1196 case 'a':
1197 flags |= ESCAPE_ANY;
1198 break;
1199 case 'c':
1200 flags |= ESCAPE_SPECIAL;
1201 break;
1202 case 'h':
1203 flags |= ESCAPE_HEX;
1204 break;
1205 case 'n':
1206 flags |= ESCAPE_NULL;
1207 break;
1208 case 'o':
1209 flags |= ESCAPE_OCTAL;
1210 break;
1211 case 'p':
1212 flags |= ESCAPE_NP;
1213 break;
1214 case 's':
1215 flags |= ESCAPE_SPACE;
1216 break;
1217 default:
1218 found = false;
1219 break;
1220 }
1221 } while (found);
1222
1223 if (!flags)
1224 flags = ESCAPE_ANY_NP;
1225
1226 len = spec.field_width < 0 ? 1 : spec.field_width;
1227
1228 /* Ignore the error. We print as many characters as we can */
1229 string_escape_mem(addr, len, &buf, end - buf, flags, NULL);
1230
1231 return buf;
1232}
1233
1234static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001235char *uuid_string(char *buf, char *end, const u8 *addr,
1236 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001237{
1238 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1239 char *p = uuid;
1240 int i;
1241 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1242 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1243 const u8 *index = be;
1244 bool uc = false;
1245
1246 switch (*(++fmt)) {
1247 case 'L':
1248 uc = true; /* fall-through */
1249 case 'l':
1250 index = le;
1251 break;
1252 case 'B':
1253 uc = true;
1254 break;
1255 }
1256
1257 for (i = 0; i < 16; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001258 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001259 switch (i) {
1260 case 3:
1261 case 5:
1262 case 7:
1263 case 9:
1264 *p++ = '-';
1265 break;
1266 }
1267 }
1268
1269 *p = 0;
1270
1271 if (uc) {
1272 p = uuid;
1273 do {
1274 *p = toupper(*p);
1275 } while (*(++p));
1276 }
1277
1278 return string(buf, end, uuid, spec);
1279}
1280
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001281static
1282char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1283 struct printf_spec spec)
1284{
1285 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1286 if (spec.field_width == -1)
1287 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1288 spec.base = 16;
1289
1290 return number(buf, end, *(const netdev_features_t *)addr, spec);
1291}
1292
Joe Perchesaaf07622014-01-23 15:54:17 -08001293static noinline_for_stack
1294char *address_val(char *buf, char *end, const void *addr,
1295 struct printf_spec spec, const char *fmt)
1296{
1297 unsigned long long num;
1298
1299 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1300 spec.base = 16;
1301
1302 switch (fmt[1]) {
1303 case 'd':
1304 num = *(const dma_addr_t *)addr;
1305 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1306 break;
1307 case 'p':
1308 default:
1309 num = *(const phys_addr_t *)addr;
1310 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1311 break;
1312 }
1313
1314 return number(buf, end, num, spec);
1315}
1316
Ingo Molnar411f05f2011-05-12 23:00:28 +02001317int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001318
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001319/*
1320 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1321 * by an extra set of alphanumeric characters that are extended format
1322 * specifiers.
1323 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001324 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001325 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001326 * - 'F' For symbolic function descriptor pointers with offset
1327 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001328 * - 'S' For symbolic direct pointers with offset
1329 * - 's' For symbolic direct pointers without offset
Joe Perchesb0d33c22012-12-12 10:18:50 -08001330 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001331 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001332 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1333 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Tejun Heodbc760b2015-02-13 14:36:53 -08001334 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1335 * width which must be explicitly specified either as part of the
1336 * format string '%32b[l]' or through '%*b[l]', [l] selects
1337 * range-list format instead of hex format
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001338 * - 'M' For a 6-byte MAC address, it prints the address in the
1339 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00001340 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00001341 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08001342 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07001343 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001344 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1345 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1346 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02001347 * [S][pfs]
1348 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1349 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00001350 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1351 * IPv6 omits the colons (01020304...0f)
1352 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02001353 * [S][pfs]
1354 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1355 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1356 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1357 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07001358 * http://tools.ietf.org/html/rfc5952
Andy Shevchenko71dca952014-10-13 15:55:18 -07001359 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1360 * of the following flags (see string_escape_mem() for the
1361 * details):
1362 * a - ESCAPE_ANY
1363 * c - ESCAPE_SPECIAL
1364 * h - ESCAPE_HEX
1365 * n - ESCAPE_NULL
1366 * o - ESCAPE_OCTAL
1367 * p - ESCAPE_NP
1368 * s - ESCAPE_SPACE
1369 * By default ESCAPE_ANY_NP is used.
Joe Perches9ac6e442009-12-14 18:01:09 -08001370 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1371 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1372 * Options for %pU are:
1373 * b big endian lower case hex (default)
1374 * B big endian UPPER case hex
1375 * l little endian lower case hex
1376 * L little endian UPPER case hex
1377 * big endian output byte order is:
1378 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1379 * little endian output byte order is:
1380 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00001381 * - 'V' For a struct va_format which contains a format string * and va_list *,
1382 * call vsnprintf(->format, *->va_list).
1383 * Implements a "recursive vsnprintf".
1384 * Do not use this feature without some mechanism to verify the
1385 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001386 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001387 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07001388 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1389 * a certain separator (' ' by default):
1390 * C colon
1391 * D dash
1392 * N no separator
1393 * The maximum supported length is 64 bytes of the input. Consider
1394 * to use print_hex_dump() for the larger input.
Joe Perchesaaf07622014-01-23 15:54:17 -08001395 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1396 * (default assumed to be phys_addr_t, passed by reference)
Olof Johanssonc0d92a52013-11-12 15:09:50 -08001397 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1398 * - 'D[234]' Same as 'd' but for a struct file
Joe Perches9ac6e442009-12-14 18:01:09 -08001399 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001400 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1401 * function pointers are really function descriptors, which contain a
1402 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001403 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001404static noinline_for_stack
1405char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1406 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001407{
Grant Likely725fe002012-05-31 16:26:08 -07001408 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1409
Kees Cook9f36e2c2011-03-22 16:34:22 -07001410 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -07001411 /*
1412 * Print (null) with the same width as a pointer so it makes
1413 * tabular output look nice.
1414 */
1415 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001416 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001417 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -07001418 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -08001419
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001420 switch (*fmt) {
1421 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001422 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001423 ptr = dereference_function_descriptor(ptr);
1424 /* Fallthrough */
1425 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08001426 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001427 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08001428 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001429 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001430 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001431 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07001432 case 'h':
1433 return hex_string(buf, end, ptr, spec, fmt);
Tejun Heodbc760b2015-02-13 14:36:53 -08001434 case 'b':
1435 switch (fmt[1]) {
1436 case 'l':
1437 return bitmap_list_string(buf, end, ptr, spec, fmt);
1438 default:
1439 return bitmap_string(buf, end, ptr, spec, fmt);
1440 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001441 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1442 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001443 /* [mM]F (FDDI) */
1444 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00001445 return mac_address_string(buf, end, ptr, spec, fmt);
1446 case 'I': /* Formatted IP supported
1447 * 4: 1.2.3.4
1448 * 6: 0001:0203:...:0708
1449 * 6c: 1::708 or 1::1.2.3.4
1450 */
1451 case 'i': /* Contiguous:
1452 * 4: 001.002.003.004
1453 * 6: 000102...0f
1454 */
1455 switch (fmt[1]) {
1456 case '6':
1457 return ip6_addr_string(buf, end, ptr, spec, fmt);
1458 case '4':
1459 return ip4_addr_string(buf, end, ptr, spec, fmt);
Daniel Borkmann10679642013-06-28 19:49:39 +02001460 case 'S': {
1461 const union {
1462 struct sockaddr raw;
1463 struct sockaddr_in v4;
1464 struct sockaddr_in6 v6;
1465 } *sa = ptr;
1466
1467 switch (sa->raw.sa_family) {
1468 case AF_INET:
1469 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1470 case AF_INET6:
1471 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1472 default:
1473 return string(buf, end, "(invalid address)", spec);
1474 }}
Joe Perches8a27f7c2009-08-17 12:29:44 +00001475 }
Harvey Harrison4aa99602008-10-29 12:49:58 -07001476 break;
Andy Shevchenko71dca952014-10-13 15:55:18 -07001477 case 'E':
1478 return escaped_string(buf, end, ptr, spec, fmt);
Joe Perches9ac6e442009-12-14 18:01:09 -08001479 case 'U':
1480 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00001481 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +00001482 {
1483 va_list va;
1484
1485 va_copy(va, *((struct va_format *)ptr)->va);
1486 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1487 ((struct va_format *)ptr)->fmt, va);
1488 va_end(va);
1489 return buf;
1490 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001491 case 'K':
1492 /*
1493 * %pK cannot be used in IRQ context because its test
1494 * for CAP_SYSLOG would be meaningless.
1495 */
Dan Rosenberg3715c5302012-07-30 14:40:26 -07001496 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1497 in_nmi())) {
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001498 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001499 spec.field_width = default_width;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001500 return string(buf, end, "pK-error", spec);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001501 }
Ryan Mallon312b4e22013-11-12 15:08:51 -08001502
1503 switch (kptr_restrict) {
1504 case 0:
1505 /* Always print %pK values */
1506 break;
1507 case 1: {
1508 /*
1509 * Only print the real pointer value if the current
1510 * process has CAP_SYSLOG and is running with the
1511 * same credentials it started with. This is because
1512 * access to files is checked at open() time, but %pK
1513 * checks permission at read() time. We don't want to
1514 * leak pointer values if a binary opens a file using
1515 * %pK and then elevates privileges before reading it.
1516 */
1517 const struct cred *cred = current_cred();
1518
1519 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1520 !uid_eq(cred->euid, cred->uid) ||
1521 !gid_eq(cred->egid, cred->gid))
1522 ptr = NULL;
1523 break;
1524 }
1525 case 2:
1526 default:
1527 /* Always print 0's for %pK */
Joe Perches26297602011-03-22 16:34:19 -07001528 ptr = NULL;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001529 break;
1530 }
Joe Perches26297602011-03-22 16:34:19 -07001531 break;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001532
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001533 case 'N':
1534 switch (fmt[1]) {
1535 case 'F':
1536 return netdev_feature_string(buf, end, ptr, spec);
1537 }
1538 break;
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001539 case 'a':
Joe Perchesaaf07622014-01-23 15:54:17 -08001540 return address_val(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04001541 case 'd':
1542 return dentry_name(buf, end, ptr, spec, fmt);
1543 case 'D':
1544 return dentry_name(buf, end,
1545 ((const struct file *)ptr)->f_path.dentry,
1546 spec, fmt);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001547 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001548 spec.flags |= SMALL;
1549 if (spec.field_width == -1) {
Grant Likely725fe002012-05-31 16:26:08 -07001550 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001551 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001552 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001553 spec.base = 16;
1554
1555 return number(buf, end, (unsigned long) ptr, spec);
1556}
1557
1558/*
1559 * Helper function to decode printf style format.
1560 * Each call decode a token from the format and return the
1561 * number of characters read (or likely the delta where it wants
1562 * to go on the next call).
1563 * The decoded token is returned through the parameters
1564 *
1565 * 'h', 'l', or 'L' for integer fields
1566 * 'z' support added 23/7/1999 S.H.
1567 * 'z' changed to 'Z' --davidm 1/25/99
1568 * 't' added for ptrdiff_t
1569 *
1570 * @fmt: the format string
1571 * @type of the token returned
1572 * @flags: various flags such as +, -, # tokens..
1573 * @field_width: overwritten width
1574 * @base: base of the number (octal, hex, ...)
1575 * @precision: precision of a number
1576 * @qualifier: qualifier of a number (long, size_t, ...)
1577 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001578static noinline_for_stack
1579int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001580{
1581 const char *start = fmt;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001582
1583 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01001584 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001585 if (spec->field_width < 0) {
1586 spec->field_width = -spec->field_width;
1587 spec->flags |= LEFT;
1588 }
1589 spec->type = FORMAT_TYPE_NONE;
1590 goto precision;
1591 }
1592
1593 /* we finished early by reading the precision */
1594 if (spec->type == FORMAT_TYPE_PRECISION) {
1595 if (spec->precision < 0)
1596 spec->precision = 0;
1597
1598 spec->type = FORMAT_TYPE_NONE;
1599 goto qualifier;
1600 }
1601
1602 /* By default */
1603 spec->type = FORMAT_TYPE_NONE;
1604
1605 for (; *fmt ; ++fmt) {
1606 if (*fmt == '%')
1607 break;
1608 }
1609
1610 /* Return the current non-format string */
1611 if (fmt != start || !*fmt)
1612 return fmt - start;
1613
1614 /* Process flags */
1615 spec->flags = 0;
1616
1617 while (1) { /* this also skips first '%' */
1618 bool found = true;
1619
1620 ++fmt;
1621
1622 switch (*fmt) {
1623 case '-': spec->flags |= LEFT; break;
1624 case '+': spec->flags |= PLUS; break;
1625 case ' ': spec->flags |= SPACE; break;
1626 case '#': spec->flags |= SPECIAL; break;
1627 case '0': spec->flags |= ZEROPAD; break;
1628 default: found = false;
1629 }
1630
1631 if (!found)
1632 break;
1633 }
1634
1635 /* get field width */
1636 spec->field_width = -1;
1637
1638 if (isdigit(*fmt))
1639 spec->field_width = skip_atoi(&fmt);
1640 else if (*fmt == '*') {
1641 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001642 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001643 return ++fmt - start;
1644 }
1645
1646precision:
1647 /* get the precision */
1648 spec->precision = -1;
1649 if (*fmt == '.') {
1650 ++fmt;
1651 if (isdigit(*fmt)) {
1652 spec->precision = skip_atoi(&fmt);
1653 if (spec->precision < 0)
1654 spec->precision = 0;
1655 } else if (*fmt == '*') {
1656 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001657 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001658 return ++fmt - start;
1659 }
1660 }
1661
1662qualifier:
1663 /* get the conversion qualifier */
1664 spec->qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001665 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1666 _tolower(*fmt) == 'z' || *fmt == 't') {
Zhaoleia4e94ef2009-03-27 17:07:05 +08001667 spec->qualifier = *fmt++;
1668 if (unlikely(spec->qualifier == *fmt)) {
1669 if (spec->qualifier == 'l') {
1670 spec->qualifier = 'L';
1671 ++fmt;
1672 } else if (spec->qualifier == 'h') {
1673 spec->qualifier = 'H';
1674 ++fmt;
1675 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001676 }
1677 }
1678
1679 /* default base */
1680 spec->base = 10;
1681 switch (*fmt) {
1682 case 'c':
1683 spec->type = FORMAT_TYPE_CHAR;
1684 return ++fmt - start;
1685
1686 case 's':
1687 spec->type = FORMAT_TYPE_STR;
1688 return ++fmt - start;
1689
1690 case 'p':
1691 spec->type = FORMAT_TYPE_PTR;
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001692 return ++fmt - start;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001693
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001694 case '%':
1695 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1696 return ++fmt - start;
1697
1698 /* integer number formats - set up the flags and "break" */
1699 case 'o':
1700 spec->base = 8;
1701 break;
1702
1703 case 'x':
1704 spec->flags |= SMALL;
1705
1706 case 'X':
1707 spec->base = 16;
1708 break;
1709
1710 case 'd':
1711 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001712 spec->flags |= SIGN;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001713 case 'u':
1714 break;
1715
Ryan Mallon708d96f2014-04-03 14:48:37 -07001716 case 'n':
1717 /*
1718 * Since %n poses a greater security risk than utility, treat
1719 * it as an invalid format specifier. Warn about its use so
1720 * that new instances don't get added.
1721 */
1722 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1723 /* Fall-through */
1724
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001725 default:
1726 spec->type = FORMAT_TYPE_INVALID;
1727 return fmt - start;
1728 }
1729
1730 if (spec->qualifier == 'L')
1731 spec->type = FORMAT_TYPE_LONG_LONG;
1732 else if (spec->qualifier == 'l') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001733 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1734 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001735 } else if (_tolower(spec->qualifier) == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001736 spec->type = FORMAT_TYPE_SIZE_T;
1737 } else if (spec->qualifier == 't') {
1738 spec->type = FORMAT_TYPE_PTRDIFF;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001739 } else if (spec->qualifier == 'H') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001740 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1741 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001742 } else if (spec->qualifier == 'h') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001743 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1744 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001745 } else {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001746 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1747 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001748 }
1749
1750 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001751}
1752
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753/**
1754 * vsnprintf - Format a string and place it in a buffer
1755 * @buf: The buffer to place the result into
1756 * @size: The size of the buffer, including the trailing null space
1757 * @fmt: The format string to use
1758 * @args: Arguments for the format string
1759 *
Andi Kleen20036fd2008-10-15 22:02:02 -07001760 * This function follows C99 vsnprintf, but has some extensions:
Steven Rostedt91adcd22009-09-16 20:03:06 -04001761 * %pS output the name of a text symbol with offset
1762 * %ps output the name of a text symbol without offset
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001763 * %pF output the name of a function pointer with its offset
1764 * %pf output the name of a function pointer without its offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001765 * %pB output the name of a backtrace symbol with its offset
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001766 * %pR output the address range in a struct resource with decoded flags
1767 * %pr output the address range in a struct resource with raw flags
Tejun Heodbc760b2015-02-13 14:36:53 -08001768 * %pb output the bitmap with field width as the number of bits
1769 * %pbl output the bitmap as range list with field width as the number of bits
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001770 * %pM output a 6-byte MAC address with colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001771 * %pMR output a 6-byte MAC address with colons in reversed order
1772 * %pMF output a 6-byte MAC address with dashes
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001773 * %pm output a 6-byte MAC address without colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001774 * %pmR output a 6-byte MAC address without colons in reversed order
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001775 * %pI4 print an IPv4 address without leading zeros
1776 * %pi4 print an IPv4 address with leading zeros
1777 * %pI6 print an IPv6 address with colons
1778 * %pi6 print an IPv6 address without colons
Jan Engelhardtf996f202011-07-14 18:48:56 +02001779 * %pI6c print an IPv6 address as specified by RFC 5952
Daniel Borkmann10679642013-06-28 19:49:39 +02001780 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1781 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001782 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1783 * case.
Andy Shevchenko71dca952014-10-13 15:55:18 -07001784 * %*pE[achnops] print an escaped buffer
Andy Shevchenko31550a12012-07-30 14:40:27 -07001785 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1786 * bytes of the input)
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001787 * %n is ignored
Andi Kleen20036fd2008-10-15 22:02:02 -07001788 *
Andrew Morton80f548e2012-07-30 14:40:25 -07001789 * ** Please update Documentation/printk-formats.txt when making changes **
1790 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791 * The return value is the number of characters which would
1792 * be generated for the given input, excluding the trailing
1793 * '\0', as per ISO C99. If you want to have the exact
1794 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001795 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 * return is greater than or equal to @size, the resulting
1797 * string is truncated.
1798 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001799 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 */
1801int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1802{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001804 char *str, *end;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001805 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001807 /* Reject out-of-range values early. Large positive sizes are
1808 used for unknown buffer sizes. */
Rasmus Villemoes2aa2f9e2015-02-12 15:01:39 -08001809 if (WARN_ON_ONCE(size > INT_MAX))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
1812 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001813 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001815 /* Make sure end is always >= buf */
1816 if (end < buf) {
1817 end = ((void *)-1);
1818 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 }
1820
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001821 while (*fmt) {
1822 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001823 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001824
1825 fmt += read;
1826
1827 switch (spec.type) {
1828 case FORMAT_TYPE_NONE: {
1829 int copy = read;
1830 if (str < end) {
1831 if (copy > end - str)
1832 copy = end - str;
1833 memcpy(str, old_fmt, copy);
1834 }
1835 str += read;
1836 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 }
1838
Vegard Nossumed681a92009-03-14 12:08:50 +01001839 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001840 spec.field_width = va_arg(args, int);
1841 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001843 case FORMAT_TYPE_PRECISION:
1844 spec.precision = va_arg(args, int);
1845 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
André Goddard Rosad4be1512009-12-14 18:00:59 -08001847 case FORMAT_TYPE_CHAR: {
1848 char c;
1849
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001850 if (!(spec.flags & LEFT)) {
1851 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001852 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 *str = ' ';
1854 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001855
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001857 }
1858 c = (unsigned char) va_arg(args, int);
1859 if (str < end)
1860 *str = c;
1861 ++str;
1862 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001863 if (str < end)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001864 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001866 }
1867 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001868 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001870 case FORMAT_TYPE_STR:
1871 str = string(str, end, va_arg(args, char *), spec);
1872 break;
1873
1874 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001875 str = pointer(fmt, str, end, va_arg(args, void *),
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001876 spec);
1877 while (isalnum(*fmt))
1878 fmt++;
1879 break;
1880
1881 case FORMAT_TYPE_PERCENT_CHAR:
1882 if (str < end)
1883 *str = '%';
1884 ++str;
1885 break;
1886
1887 case FORMAT_TYPE_INVALID:
1888 if (str < end)
1889 *str = '%';
1890 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001891 break;
1892
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001893 default:
1894 switch (spec.type) {
1895 case FORMAT_TYPE_LONG_LONG:
1896 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001898 case FORMAT_TYPE_ULONG:
1899 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001901 case FORMAT_TYPE_LONG:
1902 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001904 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08001905 if (spec.flags & SIGN)
1906 num = va_arg(args, ssize_t);
1907 else
1908 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001909 break;
1910 case FORMAT_TYPE_PTRDIFF:
1911 num = va_arg(args, ptrdiff_t);
1912 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001913 case FORMAT_TYPE_UBYTE:
1914 num = (unsigned char) va_arg(args, int);
1915 break;
1916 case FORMAT_TYPE_BYTE:
1917 num = (signed char) va_arg(args, int);
1918 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001919 case FORMAT_TYPE_USHORT:
1920 num = (unsigned short) va_arg(args, int);
1921 break;
1922 case FORMAT_TYPE_SHORT:
1923 num = (short) va_arg(args, int);
1924 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001925 case FORMAT_TYPE_INT:
1926 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001927 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001929 num = va_arg(args, unsigned int);
1930 }
1931
1932 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001935
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001936 if (size > 0) {
1937 if (str < end)
1938 *str = '\0';
1939 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07001940 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001941 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001942
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001943 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 return str-buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947EXPORT_SYMBOL(vsnprintf);
1948
1949/**
1950 * vscnprintf - Format a string and place it in a buffer
1951 * @buf: The buffer to place the result into
1952 * @size: The size of the buffer, including the trailing null space
1953 * @fmt: The format string to use
1954 * @args: Arguments for the format string
1955 *
1956 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08001957 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 * returns 0.
1959 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001960 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001961 *
1962 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 */
1964int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1965{
1966 int i;
1967
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001968 i = vsnprintf(buf, size, fmt, args);
1969
Anton Arapovb921c692011-01-12 16:59:49 -08001970 if (likely(i < size))
1971 return i;
1972 if (size != 0)
1973 return size - 1;
1974 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976EXPORT_SYMBOL(vscnprintf);
1977
1978/**
1979 * snprintf - Format a string and place it in a buffer
1980 * @buf: The buffer to place the result into
1981 * @size: The size of the buffer, including the trailing null space
1982 * @fmt: The format string to use
1983 * @...: Arguments for the format string
1984 *
1985 * The return value is the number of characters which would be
1986 * generated for the given input, excluding the trailing null,
1987 * as per ISO C99. If the return is greater than or equal to
1988 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07001989 *
1990 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001992int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993{
1994 va_list args;
1995 int i;
1996
1997 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001998 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 return i;
2002}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003EXPORT_SYMBOL(snprintf);
2004
2005/**
2006 * scnprintf - Format a string and place it in a buffer
2007 * @buf: The buffer to place the result into
2008 * @size: The size of the buffer, including the trailing null space
2009 * @fmt: The format string to use
2010 * @...: Arguments for the format string
2011 *
2012 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07002013 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 */
2015
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002016int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017{
2018 va_list args;
2019 int i;
2020
2021 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08002022 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002024
Anton Arapovb921c692011-01-12 16:59:49 -08002025 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026}
2027EXPORT_SYMBOL(scnprintf);
2028
2029/**
2030 * vsprintf - Format a string and place it in a buffer
2031 * @buf: The buffer to place the result into
2032 * @fmt: The format string to use
2033 * @args: Arguments for the format string
2034 *
2035 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002036 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 * buffer overflows.
2038 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002039 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002040 *
2041 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 */
2043int vsprintf(char *buf, const char *fmt, va_list args)
2044{
2045 return vsnprintf(buf, INT_MAX, fmt, args);
2046}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047EXPORT_SYMBOL(vsprintf);
2048
2049/**
2050 * sprintf - Format a string and place it in a buffer
2051 * @buf: The buffer to place the result into
2052 * @fmt: The format string to use
2053 * @...: Arguments for the format string
2054 *
2055 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002056 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07002058 *
2059 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002061int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062{
2063 va_list args;
2064 int i;
2065
2066 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002067 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002069
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 return i;
2071}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072EXPORT_SYMBOL(sprintf);
2073
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002074#ifdef CONFIG_BINARY_PRINTF
2075/*
2076 * bprintf service:
2077 * vbin_printf() - VA arguments to binary data
2078 * bstr_printf() - Binary data to text string
2079 */
2080
2081/**
2082 * vbin_printf - Parse a format string and place args' binary value in a buffer
2083 * @bin_buf: The buffer to place args' binary value
2084 * @size: The size of the buffer(by words(32bits), not characters)
2085 * @fmt: The format string to use
2086 * @args: Arguments for the format string
2087 *
2088 * The format follows C99 vsnprintf, except %n is ignored, and its argument
Masanari Iidada3dae52014-09-09 01:27:23 +09002089 * is skipped.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002090 *
2091 * The return value is the number of words(32bits) which would be generated for
2092 * the given input.
2093 *
2094 * NOTE:
2095 * If the return value is greater than @size, the resulting bin_buf is NOT
2096 * valid for bstr_printf().
2097 */
2098int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2099{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002100 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002101 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002102
2103 str = (char *)bin_buf;
2104 end = (char *)(bin_buf + size);
2105
2106#define save_arg(type) \
2107do { \
2108 if (sizeof(type) == 8) { \
2109 unsigned long long value; \
2110 str = PTR_ALIGN(str, sizeof(u32)); \
2111 value = va_arg(args, unsigned long long); \
2112 if (str + sizeof(type) <= end) { \
2113 *(u32 *)str = *(u32 *)&value; \
2114 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2115 } \
2116 } else { \
2117 unsigned long value; \
2118 str = PTR_ALIGN(str, sizeof(type)); \
2119 value = va_arg(args, int); \
2120 if (str + sizeof(type) <= end) \
2121 *(typeof(type) *)str = (type)value; \
2122 } \
2123 str += sizeof(type); \
2124} while (0)
2125
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002126 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08002127 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002128
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002129 fmt += read;
2130
2131 switch (spec.type) {
2132 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08002133 case FORMAT_TYPE_INVALID:
2134 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002135 break;
2136
Vegard Nossumed681a92009-03-14 12:08:50 +01002137 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002138 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002139 save_arg(int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002140 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002141
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002142 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002143 save_arg(char);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002144 break;
2145
2146 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002147 const char *save_str = va_arg(args, char *);
2148 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08002149
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002150 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2151 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08002152 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08002153 len = strlen(save_str) + 1;
2154 if (str + len < end)
2155 memcpy(str, save_str, len);
2156 str += len;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002157 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002158 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002159
2160 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002161 save_arg(void *);
2162 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002163 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002164 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002165 break;
2166
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002167 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002168 switch (spec.type) {
2169
2170 case FORMAT_TYPE_LONG_LONG:
2171 save_arg(long long);
2172 break;
2173 case FORMAT_TYPE_ULONG:
2174 case FORMAT_TYPE_LONG:
2175 save_arg(unsigned long);
2176 break;
2177 case FORMAT_TYPE_SIZE_T:
2178 save_arg(size_t);
2179 break;
2180 case FORMAT_TYPE_PTRDIFF:
2181 save_arg(ptrdiff_t);
2182 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002183 case FORMAT_TYPE_UBYTE:
2184 case FORMAT_TYPE_BYTE:
2185 save_arg(char);
2186 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002187 case FORMAT_TYPE_USHORT:
2188 case FORMAT_TYPE_SHORT:
2189 save_arg(short);
2190 break;
2191 default:
2192 save_arg(int);
2193 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002194 }
2195 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002196
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002197 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002198#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002199}
2200EXPORT_SYMBOL_GPL(vbin_printf);
2201
2202/**
2203 * bstr_printf - Format a string from binary arguments and place it in a buffer
2204 * @buf: The buffer to place the result into
2205 * @size: The size of the buffer, including the trailing null space
2206 * @fmt: The format string to use
2207 * @bin_buf: Binary arguments for the format string
2208 *
2209 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2210 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2211 * a binary buffer that generated by vbin_printf.
2212 *
2213 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002214 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002215 *
2216 * The return value is the number of characters which would
2217 * be generated for the given input, excluding the trailing
2218 * '\0', as per ISO C99. If you want to have the exact
2219 * number of characters written into @buf as return value
2220 * (not including the trailing '\0'), use vscnprintf(). If the
2221 * return is greater than or equal to @size, the resulting
2222 * string is truncated.
2223 */
2224int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2225{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002226 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002227 char *str, *end;
2228 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002229
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07002230 if (WARN_ON_ONCE((int) size < 0))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002231 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002232
2233 str = buf;
2234 end = buf + size;
2235
2236#define get_arg(type) \
2237({ \
2238 typeof(type) value; \
2239 if (sizeof(type) == 8) { \
2240 args = PTR_ALIGN(args, sizeof(u32)); \
2241 *(u32 *)&value = *(u32 *)args; \
2242 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2243 } else { \
2244 args = PTR_ALIGN(args, sizeof(type)); \
2245 value = *(typeof(type) *)args; \
2246 } \
2247 args += sizeof(type); \
2248 value; \
2249})
2250
2251 /* Make sure end is always >= buf */
2252 if (end < buf) {
2253 end = ((void *)-1);
2254 size = end - buf;
2255 }
2256
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002257 while (*fmt) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002258 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002259 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002260
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002261 fmt += read;
2262
2263 switch (spec.type) {
2264 case FORMAT_TYPE_NONE: {
2265 int copy = read;
2266 if (str < end) {
2267 if (copy > end - str)
2268 copy = end - str;
2269 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002270 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002271 str += read;
2272 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002273 }
2274
Vegard Nossumed681a92009-03-14 12:08:50 +01002275 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002276 spec.field_width = get_arg(int);
2277 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002278
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002279 case FORMAT_TYPE_PRECISION:
2280 spec.precision = get_arg(int);
2281 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002282
André Goddard Rosad4be1512009-12-14 18:00:59 -08002283 case FORMAT_TYPE_CHAR: {
2284 char c;
2285
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002286 if (!(spec.flags & LEFT)) {
2287 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002288 if (str < end)
2289 *str = ' ';
2290 ++str;
2291 }
2292 }
2293 c = (unsigned char) get_arg(char);
2294 if (str < end)
2295 *str = c;
2296 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002297 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002298 if (str < end)
2299 *str = ' ';
2300 ++str;
2301 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002302 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002303 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002304
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002305 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002306 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002307 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002308 str = string(str, end, (char *)str_arg, spec);
2309 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002310 }
2311
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002312 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002313 str = pointer(fmt, str, end, get_arg(void *), spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002314 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002315 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002316 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002317
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002318 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002319 case FORMAT_TYPE_INVALID:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002320 if (str < end)
2321 *str = '%';
2322 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002323 break;
2324
André Goddard Rosad4be1512009-12-14 18:00:59 -08002325 default: {
2326 unsigned long long num;
2327
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002328 switch (spec.type) {
2329
2330 case FORMAT_TYPE_LONG_LONG:
2331 num = get_arg(long long);
2332 break;
2333 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002334 case FORMAT_TYPE_LONG:
2335 num = get_arg(unsigned long);
2336 break;
2337 case FORMAT_TYPE_SIZE_T:
2338 num = get_arg(size_t);
2339 break;
2340 case FORMAT_TYPE_PTRDIFF:
2341 num = get_arg(ptrdiff_t);
2342 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002343 case FORMAT_TYPE_UBYTE:
2344 num = get_arg(unsigned char);
2345 break;
2346 case FORMAT_TYPE_BYTE:
2347 num = get_arg(signed char);
2348 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002349 case FORMAT_TYPE_USHORT:
2350 num = get_arg(unsigned short);
2351 break;
2352 case FORMAT_TYPE_SHORT:
2353 num = get_arg(short);
2354 break;
2355 case FORMAT_TYPE_UINT:
2356 num = get_arg(unsigned int);
2357 break;
2358 default:
2359 num = get_arg(int);
2360 }
2361
2362 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08002363 } /* default: */
2364 } /* switch(spec.type) */
2365 } /* while(*fmt) */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002366
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002367 if (size > 0) {
2368 if (str < end)
2369 *str = '\0';
2370 else
2371 end[-1] = '\0';
2372 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002373
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002374#undef get_arg
2375
2376 /* the trailing null byte doesn't count towards the total */
2377 return str - buf;
2378}
2379EXPORT_SYMBOL_GPL(bstr_printf);
2380
2381/**
2382 * bprintf - Parse a format string and place args' binary value in a buffer
2383 * @bin_buf: The buffer to place args' binary value
2384 * @size: The size of the buffer(by words(32bits), not characters)
2385 * @fmt: The format string to use
2386 * @...: Arguments for the format string
2387 *
2388 * The function returns the number of words(u32) written
2389 * into @bin_buf.
2390 */
2391int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2392{
2393 va_list args;
2394 int ret;
2395
2396 va_start(args, fmt);
2397 ret = vbin_printf(bin_buf, size, fmt, args);
2398 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002399
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002400 return ret;
2401}
2402EXPORT_SYMBOL_GPL(bprintf);
2403
2404#endif /* CONFIG_BINARY_PRINTF */
2405
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406/**
2407 * vsscanf - Unformat a buffer into a list of arguments
2408 * @buf: input buffer
2409 * @fmt: format of buffer
2410 * @args: arguments
2411 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002412int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413{
2414 const char *str = buf;
2415 char *next;
2416 char digit;
2417 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08002418 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08002419 unsigned int base;
2420 union {
2421 long long s;
2422 unsigned long long u;
2423 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08002424 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002425 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426
Jan Beulichda990752012-10-04 17:13:24 -07002427 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 /* skip any white space in format */
2429 /* white space in format matchs any amount of
2430 * white space, including none, in the input.
2431 */
2432 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08002433 fmt = skip_spaces(++fmt);
2434 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435 }
2436
2437 /* anything that is not a conversion must match exactly */
2438 if (*fmt != '%' && *fmt) {
2439 if (*fmt++ != *str++)
2440 break;
2441 continue;
2442 }
2443
2444 if (!*fmt)
2445 break;
2446 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002447
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 /* skip this conversion.
2449 * advance both strings to next white space
2450 */
2451 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07002452 if (!*str)
2453 break;
Andy Spencer8fccae22009-10-01 15:44:27 -07002454 while (!isspace(*fmt) && *fmt != '%' && *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002455 fmt++;
2456 while (!isspace(*str) && *str)
2457 str++;
2458 continue;
2459 }
2460
2461 /* get field width */
2462 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08002463 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08002465 if (field_width <= 0)
2466 break;
2467 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468
2469 /* get conversion qualifier */
2470 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002471 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2472 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 qualifier = *fmt++;
2474 if (unlikely(qualifier == *fmt)) {
2475 if (qualifier == 'h') {
2476 qualifier = 'H';
2477 fmt++;
2478 } else if (qualifier == 'l') {
2479 qualifier = 'L';
2480 fmt++;
2481 }
2482 }
2483 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484
Jan Beulichda990752012-10-04 17:13:24 -07002485 if (!*fmt)
2486 break;
2487
2488 if (*fmt == 'n') {
2489 /* return number of characters read so far */
2490 *va_arg(args, int *) = str - buf;
2491 ++fmt;
2492 continue;
2493 }
2494
2495 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496 break;
2497
André Goddard Rosad4be1512009-12-14 18:00:59 -08002498 base = 10;
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002499 is_sign = false;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002500
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002501 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 case 'c':
2503 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002504 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 if (field_width == -1)
2506 field_width = 1;
2507 do {
2508 *s++ = *str++;
2509 } while (--field_width > 0 && *str);
2510 num++;
2511 }
2512 continue;
2513 case 's':
2514 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002515 char *s = (char *)va_arg(args, char *);
2516 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07002517 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002519 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
2521 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002522 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002524 *s = '\0';
2525 num++;
2526 }
2527 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528 case 'o':
2529 base = 8;
2530 break;
2531 case 'x':
2532 case 'X':
2533 base = 16;
2534 break;
2535 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002536 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 case 'd':
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002538 is_sign = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 case 'u':
2540 break;
2541 case '%':
2542 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002543 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 return num;
2545 continue;
2546 default:
2547 /* invalid format; stop here */
2548 return num;
2549 }
2550
2551 /* have some sort of integer conversion.
2552 * first, skip white space in buffer.
2553 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002554 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555
2556 digit = *str;
2557 if (is_sign && digit == '-')
2558 digit = *(str + 1);
2559
2560 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002561 || (base == 16 && !isxdigit(digit))
2562 || (base == 10 && !isdigit(digit))
2563 || (base == 8 && (!isdigit(digit) || digit > '7'))
2564 || (base == 0 && !isdigit(digit)))
2565 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
Jan Beulich53809752012-12-17 16:01:31 -08002567 if (is_sign)
2568 val.s = qualifier != 'L' ?
2569 simple_strtol(str, &next, base) :
2570 simple_strtoll(str, &next, base);
2571 else
2572 val.u = qualifier != 'L' ?
2573 simple_strtoul(str, &next, base) :
2574 simple_strtoull(str, &next, base);
2575
2576 if (field_width > 0 && next - str > field_width) {
2577 if (base == 0)
2578 _parse_integer_fixup_radix(str, &base);
2579 while (next - str > field_width) {
2580 if (is_sign)
2581 val.s = div_s64(val.s, base);
2582 else
2583 val.u = div_u64(val.u, base);
2584 --next;
2585 }
2586 }
2587
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002588 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002589 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08002590 if (is_sign)
2591 *va_arg(args, signed char *) = val.s;
2592 else
2593 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 break;
2595 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08002596 if (is_sign)
2597 *va_arg(args, short *) = val.s;
2598 else
2599 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002600 break;
2601 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08002602 if (is_sign)
2603 *va_arg(args, long *) = val.s;
2604 else
2605 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 break;
2607 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08002608 if (is_sign)
2609 *va_arg(args, long long *) = val.s;
2610 else
2611 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 break;
2613 case 'Z':
2614 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08002615 *va_arg(args, size_t *) = val.u;
2616 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 default:
Jan Beulich53809752012-12-17 16:01:31 -08002618 if (is_sign)
2619 *va_arg(args, int *) = val.s;
2620 else
2621 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622 break;
2623 }
2624 num++;
2625
2626 if (!next)
2627 break;
2628 str = next;
2629 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002630
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 return num;
2632}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633EXPORT_SYMBOL(vsscanf);
2634
2635/**
2636 * sscanf - Unformat a buffer into a list of arguments
2637 * @buf: input buffer
2638 * @fmt: formatting of buffer
2639 * @...: resulting arguments
2640 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002641int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642{
2643 va_list args;
2644 int i;
2645
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002646 va_start(args, fmt);
2647 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002649
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 return i;
2651}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652EXPORT_SYMBOL(sscanf);