blob: 6fe2c84eb055695ffb80e766bd2d6fda1005b315 [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
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070036#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070037
Linus Torvalds1da177e2005-04-16 15:20:36 -070038/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 * simple_strtoull - convert a string to an unsigned long long
40 * @cp: The start of the string
41 * @endp: A pointer to the end of the parsed string will be placed here
42 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080043 *
44 * This function is obsolete. Please use kstrtoull instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 */
Harvey Harrison22d27052008-10-16 13:40:35 -070046unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070048 unsigned long long result;
49 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070051 cp = _parse_integer_fixup_radix(cp, &base);
52 rv = _parse_integer(cp, base, &result);
53 /* FIXME */
54 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 if (endp)
57 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080058
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 return result;
60}
Linus Torvalds1da177e2005-04-16 15:20:36 -070061EXPORT_SYMBOL(simple_strtoull);
62
63/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080064 * simple_strtoul - convert a string to an unsigned long
65 * @cp: The start of the string
66 * @endp: A pointer to the end of the parsed string will be placed here
67 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080068 *
69 * This function is obsolete. Please use kstrtoul instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080070 */
71unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
72{
73 return simple_strtoull(cp, endp, base);
74}
75EXPORT_SYMBOL(simple_strtoul);
76
77/**
78 * simple_strtol - convert a string to a signed long
79 * @cp: The start of the string
80 * @endp: A pointer to the end of the parsed string will be placed here
81 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080082 *
83 * This function is obsolete. Please use kstrtol instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080084 */
85long simple_strtol(const char *cp, char **endp, unsigned int base)
86{
87 if (*cp == '-')
88 return -simple_strtoul(cp + 1, endp, base);
89
90 return simple_strtoul(cp, endp, base);
91}
92EXPORT_SYMBOL(simple_strtol);
93
94/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * simple_strtoll - convert a string to a signed long long
96 * @cp: The start of the string
97 * @endp: A pointer to the end of the parsed string will be placed here
98 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080099 *
100 * This function is obsolete. Please use kstrtoll instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 */
Harvey Harrison22d27052008-10-16 13:40:35 -0700102long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800104 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -0700105 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800106
Harvey Harrison22d27052008-10-16 13:40:35 -0700107 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108}
Hans Verkuil98d5ce02010-04-23 13:18:04 -0400109EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Joe Perchescf3b4292010-05-24 14:33:16 -0700111static noinline_for_stack
112int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800114 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
116 while (isdigit(**s))
117 i = i*10 + *((*s)++) - '0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800118
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 return i;
120}
121
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700122/* Decimal conversion is by far the most typical, and is used
123 * for /proc and /sys data. This directly impacts e.g. top performance
124 * with many processes running. We optimize it for speed
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700125 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
126 * (with permission from the author, Douglas W. Jones).
127 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700128
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700129#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
130/* Formats correctly any integer in [0, 999999999] */
Joe Perchescf3b4292010-05-24 14:33:16 -0700131static noinline_for_stack
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700132char *put_dec_full9(char *buf, unsigned q)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700133{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700134 unsigned r;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700135
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800136 /*
137 * Possible ways to approx. divide by 10
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700138 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
139 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
140 * (x * 0x6667) >> 18 x < 43699
141 * (x * 0x3334) >> 17 x < 16389
142 * (x * 0x199a) >> 16 x < 16389
143 * (x * 0x0ccd) >> 15 x < 16389
144 * (x * 0x0667) >> 14 x < 2739
145 * (x * 0x0334) >> 13 x < 1029
146 * (x * 0x019a) >> 12 x < 1029
147 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
148 * (x * 0x0067) >> 10 x < 179
149 * (x * 0x0034) >> 9 x < 69 same
150 * (x * 0x001a) >> 8 x < 69 same
151 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
152 * (x * 0x0007) >> 6 x < 19
153 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800154 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700155 r = (q * (uint64_t)0x1999999a) >> 32;
156 *buf++ = (q - 10 * r) + '0'; /* 1 */
157 q = (r * (uint64_t)0x1999999a) >> 32;
158 *buf++ = (r - 10 * q) + '0'; /* 2 */
159 r = (q * (uint64_t)0x1999999a) >> 32;
160 *buf++ = (q - 10 * r) + '0'; /* 3 */
161 q = (r * (uint64_t)0x1999999a) >> 32;
162 *buf++ = (r - 10 * q) + '0'; /* 4 */
163 r = (q * (uint64_t)0x1999999a) >> 32;
164 *buf++ = (q - 10 * r) + '0'; /* 5 */
165 /* Now value is under 10000, can avoid 64-bit multiply */
166 q = (r * 0x199a) >> 16;
167 *buf++ = (r - 10 * q) + '0'; /* 6 */
168 r = (q * 0xcd) >> 11;
169 *buf++ = (q - 10 * r) + '0'; /* 7 */
170 q = (r * 0xcd) >> 11;
171 *buf++ = (r - 10 * q) + '0'; /* 8 */
172 *buf++ = q + '0'; /* 9 */
173 return buf;
174}
175#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700176
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700177/* Similar to above but do not pad with zeros.
178 * Code can be easily arranged to print 9 digits too, but our callers
179 * always call put_dec_full9() instead when the number has 9 decimal digits.
180 */
181static noinline_for_stack
182char *put_dec_trunc8(char *buf, unsigned r)
183{
184 unsigned q;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700185
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700186 /* Copy of previous function's body with added early returns */
George Spelvincb239d02012-10-04 17:12:30 -0700187 while (r >= 10000) {
188 q = r + '0';
189 r = (r * (uint64_t)0x1999999a) >> 32;
190 *buf++ = q - 10*r;
191 }
192
George Spelvinf4000512012-10-04 17:12:32 -0700193 q = (r * 0x199a) >> 16; /* r <= 9999 */
194 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700195 if (q == 0)
196 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700197 r = (q * 0xcd) >> 11; /* q <= 999 */
198 *buf++ = (q - 10 * r) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700199 if (r == 0)
200 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700201 q = (r * 0xcd) >> 11; /* r <= 99 */
202 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700203 if (q == 0)
204 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700205 *buf++ = q + '0'; /* q <= 9 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700206 return buf;
207}
208
209/* There are two algorithms to print larger numbers.
210 * One is generic: divide by 1000000000 and repeatedly print
211 * groups of (up to) 9 digits. It's conceptually simple,
212 * but requires a (unsigned long long) / 1000000000 division.
213 *
214 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
215 * manipulates them cleverly and generates groups of 4 decimal digits.
216 * It so happens that it does NOT require long long division.
217 *
218 * If long is > 32 bits, division of 64-bit values is relatively easy,
219 * and we will use the first algorithm.
220 * If long long is > 64 bits (strange architecture with VERY large long long),
221 * second algorithm can't be used, and we again use the first one.
222 *
223 * Else (if long is 32 bits and long long is 64 bits) we use second one.
224 */
225
226#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
227
228/* First algorithm: generic */
229
230static
231char *put_dec(char *buf, unsigned long long n)
232{
233 if (n >= 100*1000*1000) {
234 while (n >= 1000*1000*1000)
235 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
236 if (n >= 100*1000*1000)
237 return put_dec_full9(buf, n);
238 }
239 return put_dec_trunc8(buf, n);
240}
241
242#else
243
244/* Second algorithm: valid only for 64-bit long longs */
245
George Spelvine49317d2012-10-04 17:12:27 -0700246/* See comment in put_dec_full9 for choice of constants */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700247static noinline_for_stack
George Spelvin23591722012-10-04 17:12:29 -0700248void put_dec_full4(char *buf, unsigned q)
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700249{
250 unsigned r;
George Spelvine49317d2012-10-04 17:12:27 -0700251 r = (q * 0xccd) >> 15;
George Spelvin23591722012-10-04 17:12:29 -0700252 buf[0] = (q - 10 * r) + '0';
George Spelvine49317d2012-10-04 17:12:27 -0700253 q = (r * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700254 buf[1] = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700255 r = (q * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700256 buf[2] = (q - 10 * r) + '0';
257 buf[3] = r + '0';
258}
259
260/*
261 * Call put_dec_full4 on x % 10000, return x / 10000.
262 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
263 * holds for all x < 1,128,869,999. The largest value this
264 * helper will ever be asked to convert is 1,125,520,955.
265 * (d1 in the put_dec code, assuming n is all-ones).
266 */
267static
268unsigned put_dec_helper4(char *buf, unsigned x)
269{
270 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
271
272 put_dec_full4(buf, x - q * 10000);
273 return q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700274}
275
276/* Based on code by Douglas W. Jones found at
277 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
278 * (with permission from the author).
279 * Performs no 64-bit division and hence should be fast on 32-bit machines.
280 */
281static
282char *put_dec(char *buf, unsigned long long n)
283{
284 uint32_t d3, d2, d1, q, h;
285
286 if (n < 100*1000*1000)
287 return put_dec_trunc8(buf, n);
288
289 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
290 h = (n >> 32);
291 d2 = (h ) & 0xffff;
292 d3 = (h >> 16); /* implicit "& 0xffff" */
293
294 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
George Spelvin23591722012-10-04 17:12:29 -0700295 q = put_dec_helper4(buf, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700296
George Spelvin23591722012-10-04 17:12:29 -0700297 q += 7671 * d3 + 9496 * d2 + 6 * d1;
298 q = put_dec_helper4(buf+4, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700299
George Spelvin23591722012-10-04 17:12:29 -0700300 q += 4749 * d3 + 42 * d2;
301 q = put_dec_helper4(buf+8, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700302
George Spelvin23591722012-10-04 17:12:29 -0700303 q += 281 * d3;
304 buf += 12;
305 if (q)
306 buf = put_dec_trunc8(buf, q);
307 else while (buf[-1] == '0')
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700308 --buf;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800309
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700310 return buf;
311}
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700312
313#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700314
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700315/*
316 * Convert passed number to decimal string.
317 * Returns the length of string. On buffer overflow, returns 0.
318 *
319 * If speed is not important, use snprintf(). It's easy to read the code.
320 */
321int num_to_str(char *buf, int size, unsigned long long num)
322{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700323 char tmp[sizeof(num) * 3];
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700324 int idx, len;
325
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700326 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
327 if (num <= 9) {
328 tmp[0] = '0' + num;
329 len = 1;
330 } else {
331 len = put_dec(tmp, num) - tmp;
332 }
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700333
334 if (len > size)
335 return 0;
336 for (idx = 0; idx < len; ++idx)
337 buf[idx] = tmp[len - idx - 1];
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700338 return len;
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700339}
340
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341#define ZEROPAD 1 /* pad with zero */
342#define SIGN 2 /* unsigned/signed long */
343#define PLUS 4 /* show plus */
344#define SPACE 8 /* space if plus */
345#define LEFT 16 /* left justified */
Bjorn Helgaasb89dc5d2010-03-05 10:47:31 -0700346#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
347#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100349enum format_type {
350 FORMAT_TYPE_NONE, /* Just a string part */
Vegard Nossumed681a92009-03-14 12:08:50 +0100351 FORMAT_TYPE_WIDTH,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100352 FORMAT_TYPE_PRECISION,
353 FORMAT_TYPE_CHAR,
354 FORMAT_TYPE_STR,
355 FORMAT_TYPE_PTR,
356 FORMAT_TYPE_PERCENT_CHAR,
357 FORMAT_TYPE_INVALID,
358 FORMAT_TYPE_LONG_LONG,
359 FORMAT_TYPE_ULONG,
360 FORMAT_TYPE_LONG,
Zhaoleia4e94ef2009-03-27 17:07:05 +0800361 FORMAT_TYPE_UBYTE,
362 FORMAT_TYPE_BYTE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100363 FORMAT_TYPE_USHORT,
364 FORMAT_TYPE_SHORT,
365 FORMAT_TYPE_UINT,
366 FORMAT_TYPE_INT,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100367 FORMAT_TYPE_SIZE_T,
368 FORMAT_TYPE_PTRDIFF
369};
370
371struct printf_spec {
Joe Perches4e310fd2010-04-14 09:27:40 -0700372 u8 type; /* format_type enum */
Joe Perchesef0658f2010-03-06 17:10:14 -0800373 u8 flags; /* flags to number() */
Joe Perches4e310fd2010-04-14 09:27:40 -0700374 u8 base; /* number base, 8, 10 or 16 only */
375 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
376 s16 field_width; /* width of output field */
377 s16 precision; /* # of digits/chars */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100378};
379
Joe Perchescf3b4292010-05-24 14:33:16 -0700380static noinline_for_stack
381char *number(char *buf, char *end, unsigned long long num,
382 struct printf_spec spec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383{
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100384 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
385 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
386
387 char tmp[66];
388 char sign;
389 char locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100390 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 int i;
Pierre Carrier7c203422012-05-29 15:07:35 -0700392 bool is_zero = num == 0LL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100394 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
395 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100396 locase = (spec.flags & SMALL);
397 if (spec.flags & LEFT)
398 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 sign = 0;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100400 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800401 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800403 num = -(signed long long)num;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100404 spec.field_width--;
405 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 sign = '+';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100407 spec.field_width--;
408 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 sign = ' ';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100410 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 }
412 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700413 if (need_pfx) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100414 if (spec.base == 16)
Pierre Carrier7c203422012-05-29 15:07:35 -0700415 spec.field_width -= 2;
416 else if (!is_zero)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100417 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700419
420 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 i = 0;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700422 if (num < spec.base)
423 tmp[i++] = digits[num] | locase;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700424 /* Generic code, for any base:
425 else do {
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100426 tmp[i++] = (digits[do_div(num,base)] | locase);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700427 } while (num != 0);
428 */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100429 else if (spec.base != 10) { /* 8 or 16 */
430 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700431 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800432
433 if (spec.base == 16)
434 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700435 do {
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100436 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700437 num >>= shift;
438 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700439 } else { /* base 10 */
440 i = put_dec(tmp, num) - tmp;
441 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700442
443 /* printing 100 using %2d gives "100", not "00" */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100444 if (i > spec.precision)
445 spec.precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700446 /* leading space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100447 spec.field_width -= spec.precision;
448 if (!(spec.flags & (ZEROPAD+LEFT))) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800449 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700450 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 *buf = ' ';
452 ++buf;
453 }
454 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700455 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700457 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 *buf = sign;
459 ++buf;
460 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700461 /* "0x" / "0" prefix */
462 if (need_pfx) {
Pierre Carrier7c203422012-05-29 15:07:35 -0700463 if (spec.base == 16 || !is_zero) {
464 if (buf < end)
465 *buf = '0';
466 ++buf;
467 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100468 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700469 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100470 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 ++buf;
472 }
473 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700474 /* zero or space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100475 if (!(spec.flags & LEFT)) {
476 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
477 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700478 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 *buf = c;
480 ++buf;
481 }
482 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700483 /* hmm even more zero padding? */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100484 while (i <= --spec.precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700485 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 *buf = '0';
487 ++buf;
488 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700489 /* actual digits of result */
490 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700491 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 *buf = tmp[i];
493 ++buf;
494 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700495 /* trailing space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100496 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700497 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 *buf = ' ';
499 ++buf;
500 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 return buf;
503}
504
Joe Perchescf3b4292010-05-24 14:33:16 -0700505static noinline_for_stack
506char *string(char *buf, char *end, const char *s, struct printf_spec spec)
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700507{
508 int len, i;
509
510 if ((unsigned long)s < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -0800511 s = "(null)";
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700512
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100513 len = strnlen(s, spec.precision);
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700514
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100515 if (!(spec.flags & LEFT)) {
516 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700517 if (buf < end)
518 *buf = ' ';
519 ++buf;
520 }
521 }
522 for (i = 0; i < len; ++i) {
523 if (buf < end)
524 *buf = *s;
525 ++buf; ++s;
526 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100527 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700528 if (buf < end)
529 *buf = ' ';
530 ++buf;
531 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800532
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700533 return buf;
534}
535
Al Viro4b6ccca2013-09-03 12:00:44 -0400536static void widen(char *buf, char *end, unsigned len, unsigned spaces)
537{
538 size_t size;
539 if (buf >= end) /* nowhere to put anything */
540 return;
541 size = end - buf;
542 if (size <= spaces) {
543 memset(buf, ' ', size);
544 return;
545 }
546 if (len) {
547 if (len > size - spaces)
548 len = size - spaces;
549 memmove(buf + spaces, buf, len);
550 }
551 memset(buf, ' ', spaces);
552}
553
554static noinline_for_stack
555char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
556 const char *fmt)
557{
558 const char *array[4], *s;
559 const struct dentry *p;
560 int depth;
561 int i, n;
562
563 switch (fmt[1]) {
564 case '2': case '3': case '4':
565 depth = fmt[1] - '0';
566 break;
567 default:
568 depth = 1;
569 }
570
571 rcu_read_lock();
572 for (i = 0; i < depth; i++, d = p) {
573 p = ACCESS_ONCE(d->d_parent);
574 array[i] = ACCESS_ONCE(d->d_name.name);
575 if (p == d) {
576 if (i)
577 array[i] = "";
578 i++;
579 break;
580 }
581 }
582 s = array[--i];
583 for (n = 0; n != spec.precision; n++, buf++) {
584 char c = *s++;
585 if (!c) {
586 if (!i)
587 break;
588 c = '/';
589 s = array[--i];
590 }
591 if (buf < end)
592 *buf = c;
593 }
594 rcu_read_unlock();
595 if (n < spec.field_width) {
596 /* we want to pad the sucker */
597 unsigned spaces = spec.field_width - n;
598 if (!(spec.flags & LEFT)) {
599 widen(buf - n, end, n, spaces);
600 return buf + spaces;
601 }
602 while (spaces--) {
603 if (buf < end)
604 *buf = ' ';
605 ++buf;
606 }
607 }
608 return buf;
609}
610
Joe Perchescf3b4292010-05-24 14:33:16 -0700611static noinline_for_stack
612char *symbol_string(char *buf, char *end, void *ptr,
Joe Perchesb0d33c22012-12-12 10:18:50 -0800613 struct printf_spec spec, const char *fmt)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700614{
Joe Perchesb0d33c22012-12-12 10:18:50 -0800615 unsigned long value;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700616#ifdef CONFIG_KALLSYMS
617 char sym[KSYM_SYMBOL_LEN];
Joe Perchesb0d33c22012-12-12 10:18:50 -0800618#endif
619
620 if (fmt[1] == 'R')
621 ptr = __builtin_extract_return_addr(ptr);
622 value = (unsigned long)ptr;
623
624#ifdef CONFIG_KALLSYMS
625 if (*fmt == 'B')
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900626 sprint_backtrace(sym, value);
Joe Perchesb0d33c22012-12-12 10:18:50 -0800627 else if (*fmt != 'f' && *fmt != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200628 sprint_symbol(sym, value);
629 else
Stephen Boyd4796dd22012-05-29 15:07:33 -0700630 sprint_symbol_no_offset(sym, value);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800631
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100632 return string(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700633#else
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800634 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100635 spec.flags |= SPECIAL | SMALL | ZEROPAD;
636 spec.base = 16;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800637
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100638 return number(buf, end, value, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700639#endif
640}
641
Joe Perchescf3b4292010-05-24 14:33:16 -0700642static noinline_for_stack
643char *resource_string(char *buf, char *end, struct resource *res,
644 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +1100645{
646#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600647#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +1100648#endif
649
650#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600651#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +1100652#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700653 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100654 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700655 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100656 .precision = -1,
657 .flags = SPECIAL | SMALL | ZEROPAD,
658 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700659 static const struct printf_spec mem_spec = {
660 .base = 16,
661 .field_width = MEM_RSRC_PRINTK_SIZE,
662 .precision = -1,
663 .flags = SPECIAL | SMALL | ZEROPAD,
664 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700665 static const struct printf_spec bus_spec = {
666 .base = 16,
667 .field_width = 2,
668 .precision = -1,
669 .flags = SMALL | ZEROPAD,
670 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700671 static const struct printf_spec dec_spec = {
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600672 .base = 10,
673 .precision = -1,
674 .flags = 0,
675 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700676 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600677 .field_width = -1,
678 .precision = 10,
679 .flags = LEFT,
680 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700681 static const struct printf_spec flag_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600682 .base = 16,
683 .precision = -1,
684 .flags = SPECIAL | SMALL,
685 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600686
687 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
688 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
689#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
690#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700691#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600692#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
693 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
694 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
695
Linus Torvalds332d2e72008-10-20 15:07:34 +1100696 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600697 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700698 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +1100699
700 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700701 if (res->flags & IORESOURCE_IO) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600702 p = string(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700703 specp = &io_spec;
704 } else if (res->flags & IORESOURCE_MEM) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600705 p = string(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700706 specp = &mem_spec;
707 } else if (res->flags & IORESOURCE_IRQ) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600708 p = string(p, pend, "irq ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700709 specp = &dec_spec;
710 } else if (res->flags & IORESOURCE_DMA) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600711 p = string(p, pend, "dma ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700712 specp = &dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700713 } else if (res->flags & IORESOURCE_BUS) {
714 p = string(p, pend, "bus ", str_spec);
715 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700716 } else {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600717 p = string(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700718 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600719 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600720 }
Bjorn Helgaasd19cb802014-02-26 11:25:56 -0700721 if (decode && res->flags & IORESOURCE_UNSET) {
722 p = string(p, pend, "size ", str_spec);
723 p = number(p, pend, resource_size(res), *specp);
724 } else {
725 p = number(p, pend, res->start, *specp);
726 if (res->start != res->end) {
727 *p++ = '-';
728 p = number(p, pend, res->end, *specp);
729 }
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600730 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600731 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600732 if (res->flags & IORESOURCE_MEM_64)
733 p = string(p, pend, " 64bit", str_spec);
734 if (res->flags & IORESOURCE_PREFETCH)
735 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700736 if (res->flags & IORESOURCE_WINDOW)
737 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600738 if (res->flags & IORESOURCE_DISABLED)
739 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600740 } else {
741 p = string(p, pend, " flags ", str_spec);
742 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600743 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100744 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600745 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100746
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100747 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100748}
749
Joe Perchescf3b4292010-05-24 14:33:16 -0700750static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -0700751char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
752 const char *fmt)
753{
Steven Rostedt360603a2013-05-28 15:47:39 -0400754 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -0700755 negative value, fallback to the default */
756 char separator;
757
758 if (spec.field_width == 0)
759 /* nothing to print */
760 return buf;
761
762 if (ZERO_OR_NULL_PTR(addr))
763 /* NULL pointer */
764 return string(buf, end, NULL, spec);
765
766 switch (fmt[1]) {
767 case 'C':
768 separator = ':';
769 break;
770 case 'D':
771 separator = '-';
772 break;
773 case 'N':
774 separator = 0;
775 break;
776 default:
777 separator = ' ';
778 break;
779 }
780
781 if (spec.field_width > 0)
782 len = min_t(int, spec.field_width, 64);
783
784 for (i = 0; i < len && buf < end - 1; i++) {
785 buf = hex_byte_pack(buf, addr[i]);
786
787 if (buf < end && separator && i != len - 1)
788 *buf++ = separator;
789 }
790
791 return buf;
792}
793
794static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -0700795char *mac_address_string(char *buf, char *end, u8 *addr,
796 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700797{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000798 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700799 char *p = mac_addr;
800 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000801 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700802 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000803
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700804 switch (fmt[1]) {
805 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +0000806 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700807 break;
808
809 case 'R':
810 reversed = true;
811 /* fall through */
812
813 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +0000814 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700815 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000816 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700817
818 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700819 if (reversed)
820 p = hex_byte_pack(p, addr[5 - i]);
821 else
822 p = hex_byte_pack(p, addr[i]);
823
Joe Perches8a27f7c2009-08-17 12:29:44 +0000824 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000825 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700826 }
827 *p = '\0';
828
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100829 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700830}
831
Joe Perchescf3b4292010-05-24 14:33:16 -0700832static noinline_for_stack
833char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700834{
Harvey Harrison689afa72008-10-28 16:04:44 -0700835 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800836 bool leading_zeros = (fmt[0] == 'i');
837 int index;
838 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700839
Joe Perches0159f242010-01-13 20:23:30 -0800840 switch (fmt[2]) {
841 case 'h':
842#ifdef __BIG_ENDIAN
843 index = 0;
844 step = 1;
845#else
846 index = 3;
847 step = -1;
848#endif
849 break;
850 case 'l':
851 index = 3;
852 step = -1;
853 break;
854 case 'n':
855 case 'b':
856 default:
857 index = 0;
858 step = 1;
859 break;
860 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000861 for (i = 0; i < 4; i++) {
862 char temp[3]; /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700863 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000864 if (leading_zeros) {
865 if (digits < 3)
866 *p++ = '0';
867 if (digits < 2)
868 *p++ = '0';
869 }
870 /* reverse the digits in the quad */
871 while (digits--)
872 *p++ = temp[digits];
873 if (i < 3)
874 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -0800875 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000876 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000877 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800878
Joe Perches8a27f7c2009-08-17 12:29:44 +0000879 return p;
880}
881
Joe Perchescf3b4292010-05-24 14:33:16 -0700882static noinline_for_stack
883char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000884{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800885 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000886 unsigned char zerolength[8];
887 int longest = 1;
888 int colonpos = -1;
889 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800890 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000891 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +0000892 bool useIPv4;
893 struct in6_addr in6;
894
895 memcpy(&in6, addr, sizeof(struct in6_addr));
896
897 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000898
899 memset(zerolength, 0, sizeof(zerolength));
900
901 if (useIPv4)
902 range = 6;
903 else
904 range = 8;
905
906 /* find position of longest 0 run */
907 for (i = 0; i < range; i++) {
908 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +0000909 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000910 break;
911 zerolength[i]++;
912 }
913 }
914 for (i = 0; i < range; i++) {
915 if (zerolength[i] > longest) {
916 longest = zerolength[i];
917 colonpos = i;
918 }
919 }
Joe Perches29cf5192011-06-09 11:23:37 -0700920 if (longest == 1) /* don't compress a single 0 */
921 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000922
923 /* emit address */
924 for (i = 0; i < range; i++) {
925 if (i == colonpos) {
926 if (needcolon || i == 0)
927 *p++ = ':';
928 *p++ = ':';
929 needcolon = false;
930 i += longest - 1;
931 continue;
932 }
933 if (needcolon) {
934 *p++ = ':';
935 needcolon = false;
936 }
937 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +0000938 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000939 hi = word >> 8;
940 lo = word & 0xff;
941 if (hi) {
942 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700943 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000944 else
945 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700946 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000947 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -0800948 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700949 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000950 else
951 *p++ = hex_asc_lo(lo);
952 needcolon = true;
953 }
954
955 if (useIPv4) {
956 if (needcolon)
957 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -0800958 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +0000959 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000960 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800961
Joe Perches8a27f7c2009-08-17 12:29:44 +0000962 return p;
963}
964
Joe Perchescf3b4292010-05-24 14:33:16 -0700965static noinline_for_stack
966char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000967{
968 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800969
Harvey Harrison689afa72008-10-28 16:04:44 -0700970 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700971 p = hex_byte_pack(p, *addr++);
972 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000973 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -0700974 *p++ = ':';
975 }
976 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800977
Joe Perches8a27f7c2009-08-17 12:29:44 +0000978 return p;
979}
980
Joe Perchescf3b4292010-05-24 14:33:16 -0700981static noinline_for_stack
982char *ip6_addr_string(char *buf, char *end, const u8 *addr,
983 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000984{
985 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
986
987 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +0000988 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000989 else
Joe Percheseb78cd22009-09-18 13:04:06 +0000990 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -0700991
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100992 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -0700993}
994
Joe Perchescf3b4292010-05-24 14:33:16 -0700995static noinline_for_stack
996char *ip4_addr_string(char *buf, char *end, const u8 *addr,
997 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -0700998{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000999 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -07001000
Joe Perches0159f242010-01-13 20:23:30 -08001001 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001002
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001003 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001004}
1005
Joe Perchescf3b4292010-05-24 14:33:16 -07001006static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001007char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1008 struct printf_spec spec, const char *fmt)
1009{
1010 bool have_p = false, have_s = false, have_f = false, have_c = false;
1011 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1012 sizeof(":12345") + sizeof("/123456789") +
1013 sizeof("%1234567890")];
1014 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1015 const u8 *addr = (const u8 *) &sa->sin6_addr;
1016 char fmt6[2] = { fmt[0], '6' };
1017 u8 off = 0;
1018
1019 fmt++;
1020 while (isalpha(*++fmt)) {
1021 switch (*fmt) {
1022 case 'p':
1023 have_p = true;
1024 break;
1025 case 'f':
1026 have_f = true;
1027 break;
1028 case 's':
1029 have_s = true;
1030 break;
1031 case 'c':
1032 have_c = true;
1033 break;
1034 }
1035 }
1036
1037 if (have_p || have_s || have_f) {
1038 *p = '[';
1039 off = 1;
1040 }
1041
1042 if (fmt6[0] == 'I' && have_c)
1043 p = ip6_compressed_string(ip6_addr + off, addr);
1044 else
1045 p = ip6_string(ip6_addr + off, addr, fmt6);
1046
1047 if (have_p || have_s || have_f)
1048 *p++ = ']';
1049
1050 if (have_p) {
1051 *p++ = ':';
1052 p = number(p, pend, ntohs(sa->sin6_port), spec);
1053 }
1054 if (have_f) {
1055 *p++ = '/';
1056 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1057 IPV6_FLOWINFO_MASK), spec);
1058 }
1059 if (have_s) {
1060 *p++ = '%';
1061 p = number(p, pend, sa->sin6_scope_id, spec);
1062 }
1063 *p = '\0';
1064
1065 return string(buf, end, ip6_addr, spec);
1066}
1067
1068static noinline_for_stack
1069char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1070 struct printf_spec spec, const char *fmt)
1071{
1072 bool have_p = false;
1073 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1074 char *pend = ip4_addr + sizeof(ip4_addr);
1075 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1076 char fmt4[3] = { fmt[0], '4', 0 };
1077
1078 fmt++;
1079 while (isalpha(*++fmt)) {
1080 switch (*fmt) {
1081 case 'p':
1082 have_p = true;
1083 break;
1084 case 'h':
1085 case 'l':
1086 case 'n':
1087 case 'b':
1088 fmt4[2] = *fmt;
1089 break;
1090 }
1091 }
1092
1093 p = ip4_string(ip4_addr, addr, fmt4);
1094 if (have_p) {
1095 *p++ = ':';
1096 p = number(p, pend, ntohs(sa->sin_port), spec);
1097 }
1098 *p = '\0';
1099
1100 return string(buf, end, ip4_addr, spec);
1101}
1102
1103static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001104char *uuid_string(char *buf, char *end, const u8 *addr,
1105 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001106{
1107 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1108 char *p = uuid;
1109 int i;
1110 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1111 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1112 const u8 *index = be;
1113 bool uc = false;
1114
1115 switch (*(++fmt)) {
1116 case 'L':
1117 uc = true; /* fall-through */
1118 case 'l':
1119 index = le;
1120 break;
1121 case 'B':
1122 uc = true;
1123 break;
1124 }
1125
1126 for (i = 0; i < 16; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001127 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001128 switch (i) {
1129 case 3:
1130 case 5:
1131 case 7:
1132 case 9:
1133 *p++ = '-';
1134 break;
1135 }
1136 }
1137
1138 *p = 0;
1139
1140 if (uc) {
1141 p = uuid;
1142 do {
1143 *p = toupper(*p);
1144 } while (*(++p));
1145 }
1146
1147 return string(buf, end, uuid, spec);
1148}
1149
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001150static
1151char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1152 struct printf_spec spec)
1153{
1154 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1155 if (spec.field_width == -1)
1156 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1157 spec.base = 16;
1158
1159 return number(buf, end, *(const netdev_features_t *)addr, spec);
1160}
1161
Joe Perchesaaf07622014-01-23 15:54:17 -08001162static noinline_for_stack
1163char *address_val(char *buf, char *end, const void *addr,
1164 struct printf_spec spec, const char *fmt)
1165{
1166 unsigned long long num;
1167
1168 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1169 spec.base = 16;
1170
1171 switch (fmt[1]) {
1172 case 'd':
1173 num = *(const dma_addr_t *)addr;
1174 spec.field_width = sizeof(dma_addr_t) * 2 + 2;
1175 break;
1176 case 'p':
1177 default:
1178 num = *(const phys_addr_t *)addr;
1179 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1180 break;
1181 }
1182
1183 return number(buf, end, num, spec);
1184}
1185
Ingo Molnar411f05f2011-05-12 23:00:28 +02001186int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001187
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001188/*
1189 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1190 * by an extra set of alphanumeric characters that are extended format
1191 * specifiers.
1192 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001193 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001194 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001195 * - 'F' For symbolic function descriptor pointers with offset
1196 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001197 * - 'S' For symbolic direct pointers with offset
1198 * - 's' For symbolic direct pointers without offset
Joe Perchesb0d33c22012-12-12 10:18:50 -08001199 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001200 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001201 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1202 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001203 * - 'M' For a 6-byte MAC address, it prints the address in the
1204 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00001205 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00001206 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08001207 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07001208 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001209 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1210 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1211 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02001212 * [S][pfs]
1213 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1214 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00001215 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1216 * IPv6 omits the colons (01020304...0f)
1217 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02001218 * [S][pfs]
1219 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1220 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1221 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1222 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07001223 * http://tools.ietf.org/html/rfc5952
Joe Perches9ac6e442009-12-14 18:01:09 -08001224 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1225 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1226 * Options for %pU are:
1227 * b big endian lower case hex (default)
1228 * B big endian UPPER case hex
1229 * l little endian lower case hex
1230 * L little endian UPPER case hex
1231 * big endian output byte order is:
1232 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1233 * little endian output byte order is:
1234 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00001235 * - 'V' For a struct va_format which contains a format string * and va_list *,
1236 * call vsnprintf(->format, *->va_list).
1237 * Implements a "recursive vsnprintf".
1238 * Do not use this feature without some mechanism to verify the
1239 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001240 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001241 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07001242 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1243 * a certain separator (' ' by default):
1244 * C colon
1245 * D dash
1246 * N no separator
1247 * The maximum supported length is 64 bytes of the input. Consider
1248 * to use print_hex_dump() for the larger input.
Joe Perchesaaf07622014-01-23 15:54:17 -08001249 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1250 * (default assumed to be phys_addr_t, passed by reference)
Olof Johanssonc0d92a52013-11-12 15:09:50 -08001251 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1252 * - 'D[234]' Same as 'd' but for a struct file
Joe Perches9ac6e442009-12-14 18:01:09 -08001253 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001254 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1255 * function pointers are really function descriptors, which contain a
1256 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001257 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001258static noinline_for_stack
1259char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1260 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001261{
Grant Likely725fe002012-05-31 16:26:08 -07001262 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1263
Kees Cook9f36e2c2011-03-22 16:34:22 -07001264 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -07001265 /*
1266 * Print (null) with the same width as a pointer so it makes
1267 * tabular output look nice.
1268 */
1269 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001270 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001271 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -07001272 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -08001273
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001274 switch (*fmt) {
1275 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001276 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001277 ptr = dereference_function_descriptor(ptr);
1278 /* Fallthrough */
1279 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08001280 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001281 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08001282 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001283 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001284 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001285 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07001286 case 'h':
1287 return hex_string(buf, end, ptr, spec, fmt);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001288 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1289 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001290 /* [mM]F (FDDI) */
1291 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00001292 return mac_address_string(buf, end, ptr, spec, fmt);
1293 case 'I': /* Formatted IP supported
1294 * 4: 1.2.3.4
1295 * 6: 0001:0203:...:0708
1296 * 6c: 1::708 or 1::1.2.3.4
1297 */
1298 case 'i': /* Contiguous:
1299 * 4: 001.002.003.004
1300 * 6: 000102...0f
1301 */
1302 switch (fmt[1]) {
1303 case '6':
1304 return ip6_addr_string(buf, end, ptr, spec, fmt);
1305 case '4':
1306 return ip4_addr_string(buf, end, ptr, spec, fmt);
Daniel Borkmann10679642013-06-28 19:49:39 +02001307 case 'S': {
1308 const union {
1309 struct sockaddr raw;
1310 struct sockaddr_in v4;
1311 struct sockaddr_in6 v6;
1312 } *sa = ptr;
1313
1314 switch (sa->raw.sa_family) {
1315 case AF_INET:
1316 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1317 case AF_INET6:
1318 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1319 default:
1320 return string(buf, end, "(invalid address)", spec);
1321 }}
Joe Perches8a27f7c2009-08-17 12:29:44 +00001322 }
Harvey Harrison4aa99602008-10-29 12:49:58 -07001323 break;
Joe Perches9ac6e442009-12-14 18:01:09 -08001324 case 'U':
1325 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00001326 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +00001327 {
1328 va_list va;
1329
1330 va_copy(va, *((struct va_format *)ptr)->va);
1331 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1332 ((struct va_format *)ptr)->fmt, va);
1333 va_end(va);
1334 return buf;
1335 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001336 case 'K':
1337 /*
1338 * %pK cannot be used in IRQ context because its test
1339 * for CAP_SYSLOG would be meaningless.
1340 */
Dan Rosenberg3715c5302012-07-30 14:40:26 -07001341 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1342 in_nmi())) {
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001343 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001344 spec.field_width = default_width;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001345 return string(buf, end, "pK-error", spec);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001346 }
Ryan Mallon312b4e22013-11-12 15:08:51 -08001347
1348 switch (kptr_restrict) {
1349 case 0:
1350 /* Always print %pK values */
1351 break;
1352 case 1: {
1353 /*
1354 * Only print the real pointer value if the current
1355 * process has CAP_SYSLOG and is running with the
1356 * same credentials it started with. This is because
1357 * access to files is checked at open() time, but %pK
1358 * checks permission at read() time. We don't want to
1359 * leak pointer values if a binary opens a file using
1360 * %pK and then elevates privileges before reading it.
1361 */
1362 const struct cred *cred = current_cred();
1363
1364 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1365 !uid_eq(cred->euid, cred->uid) ||
1366 !gid_eq(cred->egid, cred->gid))
1367 ptr = NULL;
1368 break;
1369 }
1370 case 2:
1371 default:
1372 /* Always print 0's for %pK */
Joe Perches26297602011-03-22 16:34:19 -07001373 ptr = NULL;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001374 break;
1375 }
Joe Perches26297602011-03-22 16:34:19 -07001376 break;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001377
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001378 case 'N':
1379 switch (fmt[1]) {
1380 case 'F':
1381 return netdev_feature_string(buf, end, ptr, spec);
1382 }
1383 break;
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001384 case 'a':
Joe Perchesaaf07622014-01-23 15:54:17 -08001385 return address_val(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04001386 case 'd':
1387 return dentry_name(buf, end, ptr, spec, fmt);
1388 case 'D':
1389 return dentry_name(buf, end,
1390 ((const struct file *)ptr)->f_path.dentry,
1391 spec, fmt);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001392 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001393 spec.flags |= SMALL;
1394 if (spec.field_width == -1) {
Grant Likely725fe002012-05-31 16:26:08 -07001395 spec.field_width = default_width;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001396 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001397 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001398 spec.base = 16;
1399
1400 return number(buf, end, (unsigned long) ptr, spec);
1401}
1402
1403/*
1404 * Helper function to decode printf style format.
1405 * Each call decode a token from the format and return the
1406 * number of characters read (or likely the delta where it wants
1407 * to go on the next call).
1408 * The decoded token is returned through the parameters
1409 *
1410 * 'h', 'l', or 'L' for integer fields
1411 * 'z' support added 23/7/1999 S.H.
1412 * 'z' changed to 'Z' --davidm 1/25/99
1413 * 't' added for ptrdiff_t
1414 *
1415 * @fmt: the format string
1416 * @type of the token returned
1417 * @flags: various flags such as +, -, # tokens..
1418 * @field_width: overwritten width
1419 * @base: base of the number (octal, hex, ...)
1420 * @precision: precision of a number
1421 * @qualifier: qualifier of a number (long, size_t, ...)
1422 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001423static noinline_for_stack
1424int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001425{
1426 const char *start = fmt;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001427
1428 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01001429 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001430 if (spec->field_width < 0) {
1431 spec->field_width = -spec->field_width;
1432 spec->flags |= LEFT;
1433 }
1434 spec->type = FORMAT_TYPE_NONE;
1435 goto precision;
1436 }
1437
1438 /* we finished early by reading the precision */
1439 if (spec->type == FORMAT_TYPE_PRECISION) {
1440 if (spec->precision < 0)
1441 spec->precision = 0;
1442
1443 spec->type = FORMAT_TYPE_NONE;
1444 goto qualifier;
1445 }
1446
1447 /* By default */
1448 spec->type = FORMAT_TYPE_NONE;
1449
1450 for (; *fmt ; ++fmt) {
1451 if (*fmt == '%')
1452 break;
1453 }
1454
1455 /* Return the current non-format string */
1456 if (fmt != start || !*fmt)
1457 return fmt - start;
1458
1459 /* Process flags */
1460 spec->flags = 0;
1461
1462 while (1) { /* this also skips first '%' */
1463 bool found = true;
1464
1465 ++fmt;
1466
1467 switch (*fmt) {
1468 case '-': spec->flags |= LEFT; break;
1469 case '+': spec->flags |= PLUS; break;
1470 case ' ': spec->flags |= SPACE; break;
1471 case '#': spec->flags |= SPECIAL; break;
1472 case '0': spec->flags |= ZEROPAD; break;
1473 default: found = false;
1474 }
1475
1476 if (!found)
1477 break;
1478 }
1479
1480 /* get field width */
1481 spec->field_width = -1;
1482
1483 if (isdigit(*fmt))
1484 spec->field_width = skip_atoi(&fmt);
1485 else if (*fmt == '*') {
1486 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001487 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001488 return ++fmt - start;
1489 }
1490
1491precision:
1492 /* get the precision */
1493 spec->precision = -1;
1494 if (*fmt == '.') {
1495 ++fmt;
1496 if (isdigit(*fmt)) {
1497 spec->precision = skip_atoi(&fmt);
1498 if (spec->precision < 0)
1499 spec->precision = 0;
1500 } else if (*fmt == '*') {
1501 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001502 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001503 return ++fmt - start;
1504 }
1505 }
1506
1507qualifier:
1508 /* get the conversion qualifier */
1509 spec->qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001510 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1511 _tolower(*fmt) == 'z' || *fmt == 't') {
Zhaoleia4e94ef2009-03-27 17:07:05 +08001512 spec->qualifier = *fmt++;
1513 if (unlikely(spec->qualifier == *fmt)) {
1514 if (spec->qualifier == 'l') {
1515 spec->qualifier = 'L';
1516 ++fmt;
1517 } else if (spec->qualifier == 'h') {
1518 spec->qualifier = 'H';
1519 ++fmt;
1520 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001521 }
1522 }
1523
1524 /* default base */
1525 spec->base = 10;
1526 switch (*fmt) {
1527 case 'c':
1528 spec->type = FORMAT_TYPE_CHAR;
1529 return ++fmt - start;
1530
1531 case 's':
1532 spec->type = FORMAT_TYPE_STR;
1533 return ++fmt - start;
1534
1535 case 'p':
1536 spec->type = FORMAT_TYPE_PTR;
1537 return fmt - start;
1538 /* skip alnum */
1539
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001540 case '%':
1541 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1542 return ++fmt - start;
1543
1544 /* integer number formats - set up the flags and "break" */
1545 case 'o':
1546 spec->base = 8;
1547 break;
1548
1549 case 'x':
1550 spec->flags |= SMALL;
1551
1552 case 'X':
1553 spec->base = 16;
1554 break;
1555
1556 case 'd':
1557 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001558 spec->flags |= SIGN;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001559 case 'u':
1560 break;
1561
Ryan Mallon708d96f2014-04-03 14:48:37 -07001562 case 'n':
1563 /*
1564 * Since %n poses a greater security risk than utility, treat
1565 * it as an invalid format specifier. Warn about its use so
1566 * that new instances don't get added.
1567 */
1568 WARN_ONCE(1, "Please remove ignored %%n in '%s'\n", fmt);
1569 /* Fall-through */
1570
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001571 default:
1572 spec->type = FORMAT_TYPE_INVALID;
1573 return fmt - start;
1574 }
1575
1576 if (spec->qualifier == 'L')
1577 spec->type = FORMAT_TYPE_LONG_LONG;
1578 else if (spec->qualifier == 'l') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001579 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001580 spec->type = FORMAT_TYPE_LONG;
1581 else
1582 spec->type = FORMAT_TYPE_ULONG;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001583 } else if (_tolower(spec->qualifier) == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001584 spec->type = FORMAT_TYPE_SIZE_T;
1585 } else if (spec->qualifier == 't') {
1586 spec->type = FORMAT_TYPE_PTRDIFF;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001587 } else if (spec->qualifier == 'H') {
1588 if (spec->flags & SIGN)
1589 spec->type = FORMAT_TYPE_BYTE;
1590 else
1591 spec->type = FORMAT_TYPE_UBYTE;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001592 } else if (spec->qualifier == 'h') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001593 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001594 spec->type = FORMAT_TYPE_SHORT;
1595 else
1596 spec->type = FORMAT_TYPE_USHORT;
1597 } else {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001598 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001599 spec->type = FORMAT_TYPE_INT;
1600 else
1601 spec->type = FORMAT_TYPE_UINT;
1602 }
1603
1604 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001605}
1606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607/**
1608 * vsnprintf - Format a string and place it in a buffer
1609 * @buf: The buffer to place the result into
1610 * @size: The size of the buffer, including the trailing null space
1611 * @fmt: The format string to use
1612 * @args: Arguments for the format string
1613 *
Andi Kleen20036fd2008-10-15 22:02:02 -07001614 * This function follows C99 vsnprintf, but has some extensions:
Steven Rostedt91adcd22009-09-16 20:03:06 -04001615 * %pS output the name of a text symbol with offset
1616 * %ps output the name of a text symbol without offset
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001617 * %pF output the name of a function pointer with its offset
1618 * %pf output the name of a function pointer without its offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001619 * %pB output the name of a backtrace symbol with its offset
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001620 * %pR output the address range in a struct resource with decoded flags
1621 * %pr output the address range in a struct resource with raw flags
1622 * %pM output a 6-byte MAC address with colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001623 * %pMR output a 6-byte MAC address with colons in reversed order
1624 * %pMF output a 6-byte MAC address with dashes
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001625 * %pm output a 6-byte MAC address without colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001626 * %pmR output a 6-byte MAC address without colons in reversed order
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001627 * %pI4 print an IPv4 address without leading zeros
1628 * %pi4 print an IPv4 address with leading zeros
1629 * %pI6 print an IPv6 address with colons
1630 * %pi6 print an IPv6 address without colons
Jan Engelhardtf996f202011-07-14 18:48:56 +02001631 * %pI6c print an IPv6 address as specified by RFC 5952
Daniel Borkmann10679642013-06-28 19:49:39 +02001632 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1633 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001634 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1635 * case.
Andy Shevchenko31550a12012-07-30 14:40:27 -07001636 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1637 * bytes of the input)
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001638 * %n is ignored
Andi Kleen20036fd2008-10-15 22:02:02 -07001639 *
Andrew Morton80f548e2012-07-30 14:40:25 -07001640 * ** Please update Documentation/printk-formats.txt when making changes **
1641 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 * The return value is the number of characters which would
1643 * be generated for the given input, excluding the trailing
1644 * '\0', as per ISO C99. If you want to have the exact
1645 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001646 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 * return is greater than or equal to @size, the resulting
1648 * string is truncated.
1649 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001650 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 */
1652int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1653{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001655 char *str, *end;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001656 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001658 /* Reject out-of-range values early. Large positive sizes are
1659 used for unknown buffer sizes. */
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07001660 if (WARN_ON_ONCE((int) size < 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662
1663 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001664 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001666 /* Make sure end is always >= buf */
1667 if (end < buf) {
1668 end = ((void *)-1);
1669 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 }
1671
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001672 while (*fmt) {
1673 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001674 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001675
1676 fmt += read;
1677
1678 switch (spec.type) {
1679 case FORMAT_TYPE_NONE: {
1680 int copy = read;
1681 if (str < end) {
1682 if (copy > end - str)
1683 copy = end - str;
1684 memcpy(str, old_fmt, copy);
1685 }
1686 str += read;
1687 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 }
1689
Vegard Nossumed681a92009-03-14 12:08:50 +01001690 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001691 spec.field_width = va_arg(args, int);
1692 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001694 case FORMAT_TYPE_PRECISION:
1695 spec.precision = va_arg(args, int);
1696 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697
André Goddard Rosad4be1512009-12-14 18:00:59 -08001698 case FORMAT_TYPE_CHAR: {
1699 char c;
1700
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001701 if (!(spec.flags & LEFT)) {
1702 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001703 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 *str = ' ';
1705 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001706
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001708 }
1709 c = (unsigned char) va_arg(args, int);
1710 if (str < end)
1711 *str = c;
1712 ++str;
1713 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001714 if (str < end)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001715 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001717 }
1718 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001719 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001721 case FORMAT_TYPE_STR:
1722 str = string(str, end, va_arg(args, char *), spec);
1723 break;
1724
1725 case FORMAT_TYPE_PTR:
1726 str = pointer(fmt+1, str, end, va_arg(args, void *),
1727 spec);
1728 while (isalnum(*fmt))
1729 fmt++;
1730 break;
1731
1732 case FORMAT_TYPE_PERCENT_CHAR:
1733 if (str < end)
1734 *str = '%';
1735 ++str;
1736 break;
1737
1738 case FORMAT_TYPE_INVALID:
1739 if (str < end)
1740 *str = '%';
1741 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001742 break;
1743
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001744 default:
1745 switch (spec.type) {
1746 case FORMAT_TYPE_LONG_LONG:
1747 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001749 case FORMAT_TYPE_ULONG:
1750 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001752 case FORMAT_TYPE_LONG:
1753 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001755 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08001756 if (spec.flags & SIGN)
1757 num = va_arg(args, ssize_t);
1758 else
1759 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001760 break;
1761 case FORMAT_TYPE_PTRDIFF:
1762 num = va_arg(args, ptrdiff_t);
1763 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001764 case FORMAT_TYPE_UBYTE:
1765 num = (unsigned char) va_arg(args, int);
1766 break;
1767 case FORMAT_TYPE_BYTE:
1768 num = (signed char) va_arg(args, int);
1769 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001770 case FORMAT_TYPE_USHORT:
1771 num = (unsigned short) va_arg(args, int);
1772 break;
1773 case FORMAT_TYPE_SHORT:
1774 num = (short) va_arg(args, int);
1775 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001776 case FORMAT_TYPE_INT:
1777 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001778 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001780 num = va_arg(args, unsigned int);
1781 }
1782
1783 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001786
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001787 if (size > 0) {
1788 if (str < end)
1789 *str = '\0';
1790 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07001791 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001792 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001793
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001794 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 return str-buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798EXPORT_SYMBOL(vsnprintf);
1799
1800/**
1801 * vscnprintf - Format a string and place it in a buffer
1802 * @buf: The buffer to place the result into
1803 * @size: The size of the buffer, including the trailing null space
1804 * @fmt: The format string to use
1805 * @args: Arguments for the format string
1806 *
1807 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08001808 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 * returns 0.
1810 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001811 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001812 *
1813 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 */
1815int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1816{
1817 int i;
1818
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001819 i = vsnprintf(buf, size, fmt, args);
1820
Anton Arapovb921c692011-01-12 16:59:49 -08001821 if (likely(i < size))
1822 return i;
1823 if (size != 0)
1824 return size - 1;
1825 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827EXPORT_SYMBOL(vscnprintf);
1828
1829/**
1830 * snprintf - Format a string and place it in a buffer
1831 * @buf: The buffer to place the result into
1832 * @size: The size of the buffer, including the trailing null space
1833 * @fmt: The format string to use
1834 * @...: Arguments for the format string
1835 *
1836 * The return value is the number of characters which would be
1837 * generated for the given input, excluding the trailing null,
1838 * as per ISO C99. If the return is greater than or equal to
1839 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07001840 *
1841 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001843int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844{
1845 va_list args;
1846 int i;
1847
1848 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001849 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001851
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 return i;
1853}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854EXPORT_SYMBOL(snprintf);
1855
1856/**
1857 * scnprintf - Format a string and place it in a buffer
1858 * @buf: The buffer to place the result into
1859 * @size: The size of the buffer, including the trailing null space
1860 * @fmt: The format string to use
1861 * @...: Arguments for the format string
1862 *
1863 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07001864 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 */
1866
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001867int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868{
1869 va_list args;
1870 int i;
1871
1872 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08001873 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001875
Anton Arapovb921c692011-01-12 16:59:49 -08001876 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877}
1878EXPORT_SYMBOL(scnprintf);
1879
1880/**
1881 * vsprintf - Format a string and place it in a buffer
1882 * @buf: The buffer to place the result into
1883 * @fmt: The format string to use
1884 * @args: Arguments for the format string
1885 *
1886 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001887 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 * buffer overflows.
1889 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001890 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001891 *
1892 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 */
1894int vsprintf(char *buf, const char *fmt, va_list args)
1895{
1896 return vsnprintf(buf, INT_MAX, fmt, args);
1897}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898EXPORT_SYMBOL(vsprintf);
1899
1900/**
1901 * sprintf - Format a string and place it in a buffer
1902 * @buf: The buffer to place the result into
1903 * @fmt: The format string to use
1904 * @...: Arguments for the format string
1905 *
1906 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001907 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07001909 *
1910 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001912int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913{
1914 va_list args;
1915 int i;
1916
1917 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001918 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001920
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921 return i;
1922}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923EXPORT_SYMBOL(sprintf);
1924
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001925#ifdef CONFIG_BINARY_PRINTF
1926/*
1927 * bprintf service:
1928 * vbin_printf() - VA arguments to binary data
1929 * bstr_printf() - Binary data to text string
1930 */
1931
1932/**
1933 * vbin_printf - Parse a format string and place args' binary value in a buffer
1934 * @bin_buf: The buffer to place args' binary value
1935 * @size: The size of the buffer(by words(32bits), not characters)
1936 * @fmt: The format string to use
1937 * @args: Arguments for the format string
1938 *
1939 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1940 * is skiped.
1941 *
1942 * The return value is the number of words(32bits) which would be generated for
1943 * the given input.
1944 *
1945 * NOTE:
1946 * If the return value is greater than @size, the resulting bin_buf is NOT
1947 * valid for bstr_printf().
1948 */
1949int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1950{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001951 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001952 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001953
1954 str = (char *)bin_buf;
1955 end = (char *)(bin_buf + size);
1956
1957#define save_arg(type) \
1958do { \
1959 if (sizeof(type) == 8) { \
1960 unsigned long long value; \
1961 str = PTR_ALIGN(str, sizeof(u32)); \
1962 value = va_arg(args, unsigned long long); \
1963 if (str + sizeof(type) <= end) { \
1964 *(u32 *)str = *(u32 *)&value; \
1965 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1966 } \
1967 } else { \
1968 unsigned long value; \
1969 str = PTR_ALIGN(str, sizeof(type)); \
1970 value = va_arg(args, int); \
1971 if (str + sizeof(type) <= end) \
1972 *(typeof(type) *)str = (type)value; \
1973 } \
1974 str += sizeof(type); \
1975} while (0)
1976
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001977 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08001978 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001979
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001980 fmt += read;
1981
1982 switch (spec.type) {
1983 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08001984 case FORMAT_TYPE_INVALID:
1985 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001986 break;
1987
Vegard Nossumed681a92009-03-14 12:08:50 +01001988 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001989 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001990 save_arg(int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001991 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001992
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001993 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001994 save_arg(char);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001995 break;
1996
1997 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001998 const char *save_str = va_arg(args, char *);
1999 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08002000
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002001 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2002 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08002003 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08002004 len = strlen(save_str) + 1;
2005 if (str + len < end)
2006 memcpy(str, save_str, len);
2007 str += len;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002008 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002009 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002010
2011 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002012 save_arg(void *);
2013 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002014 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002015 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002016 break;
2017
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002018 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002019 switch (spec.type) {
2020
2021 case FORMAT_TYPE_LONG_LONG:
2022 save_arg(long long);
2023 break;
2024 case FORMAT_TYPE_ULONG:
2025 case FORMAT_TYPE_LONG:
2026 save_arg(unsigned long);
2027 break;
2028 case FORMAT_TYPE_SIZE_T:
2029 save_arg(size_t);
2030 break;
2031 case FORMAT_TYPE_PTRDIFF:
2032 save_arg(ptrdiff_t);
2033 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002034 case FORMAT_TYPE_UBYTE:
2035 case FORMAT_TYPE_BYTE:
2036 save_arg(char);
2037 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002038 case FORMAT_TYPE_USHORT:
2039 case FORMAT_TYPE_SHORT:
2040 save_arg(short);
2041 break;
2042 default:
2043 save_arg(int);
2044 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002045 }
2046 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002047
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002048 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002049#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002050}
2051EXPORT_SYMBOL_GPL(vbin_printf);
2052
2053/**
2054 * bstr_printf - Format a string from binary arguments and place it in a buffer
2055 * @buf: The buffer to place the result into
2056 * @size: The size of the buffer, including the trailing null space
2057 * @fmt: The format string to use
2058 * @bin_buf: Binary arguments for the format string
2059 *
2060 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2061 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2062 * a binary buffer that generated by vbin_printf.
2063 *
2064 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002065 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002066 *
2067 * The return value is the number of characters which would
2068 * be generated for the given input, excluding the trailing
2069 * '\0', as per ISO C99. If you want to have the exact
2070 * number of characters written into @buf as return value
2071 * (not including the trailing '\0'), use vscnprintf(). If the
2072 * return is greater than or equal to @size, the resulting
2073 * string is truncated.
2074 */
2075int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2076{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002077 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002078 char *str, *end;
2079 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002080
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07002081 if (WARN_ON_ONCE((int) size < 0))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002082 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002083
2084 str = buf;
2085 end = buf + size;
2086
2087#define get_arg(type) \
2088({ \
2089 typeof(type) value; \
2090 if (sizeof(type) == 8) { \
2091 args = PTR_ALIGN(args, sizeof(u32)); \
2092 *(u32 *)&value = *(u32 *)args; \
2093 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2094 } else { \
2095 args = PTR_ALIGN(args, sizeof(type)); \
2096 value = *(typeof(type) *)args; \
2097 } \
2098 args += sizeof(type); \
2099 value; \
2100})
2101
2102 /* Make sure end is always >= buf */
2103 if (end < buf) {
2104 end = ((void *)-1);
2105 size = end - buf;
2106 }
2107
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002108 while (*fmt) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002109 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002110 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002111
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002112 fmt += read;
2113
2114 switch (spec.type) {
2115 case FORMAT_TYPE_NONE: {
2116 int copy = read;
2117 if (str < end) {
2118 if (copy > end - str)
2119 copy = end - str;
2120 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002121 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002122 str += read;
2123 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002124 }
2125
Vegard Nossumed681a92009-03-14 12:08:50 +01002126 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002127 spec.field_width = get_arg(int);
2128 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002129
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002130 case FORMAT_TYPE_PRECISION:
2131 spec.precision = get_arg(int);
2132 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002133
André Goddard Rosad4be1512009-12-14 18:00:59 -08002134 case FORMAT_TYPE_CHAR: {
2135 char c;
2136
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002137 if (!(spec.flags & LEFT)) {
2138 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002139 if (str < end)
2140 *str = ' ';
2141 ++str;
2142 }
2143 }
2144 c = (unsigned char) get_arg(char);
2145 if (str < end)
2146 *str = c;
2147 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002148 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002149 if (str < end)
2150 *str = ' ';
2151 ++str;
2152 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002153 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002154 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002155
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002156 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002157 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002158 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002159 str = string(str, end, (char *)str_arg, spec);
2160 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002161 }
2162
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002163 case FORMAT_TYPE_PTR:
2164 str = pointer(fmt+1, str, end, get_arg(void *), spec);
2165 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002166 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002167 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002168
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002169 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002170 case FORMAT_TYPE_INVALID:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002171 if (str < end)
2172 *str = '%';
2173 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002174 break;
2175
André Goddard Rosad4be1512009-12-14 18:00:59 -08002176 default: {
2177 unsigned long long num;
2178
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002179 switch (spec.type) {
2180
2181 case FORMAT_TYPE_LONG_LONG:
2182 num = get_arg(long long);
2183 break;
2184 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002185 case FORMAT_TYPE_LONG:
2186 num = get_arg(unsigned long);
2187 break;
2188 case FORMAT_TYPE_SIZE_T:
2189 num = get_arg(size_t);
2190 break;
2191 case FORMAT_TYPE_PTRDIFF:
2192 num = get_arg(ptrdiff_t);
2193 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002194 case FORMAT_TYPE_UBYTE:
2195 num = get_arg(unsigned char);
2196 break;
2197 case FORMAT_TYPE_BYTE:
2198 num = get_arg(signed char);
2199 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002200 case FORMAT_TYPE_USHORT:
2201 num = get_arg(unsigned short);
2202 break;
2203 case FORMAT_TYPE_SHORT:
2204 num = get_arg(short);
2205 break;
2206 case FORMAT_TYPE_UINT:
2207 num = get_arg(unsigned int);
2208 break;
2209 default:
2210 num = get_arg(int);
2211 }
2212
2213 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08002214 } /* default: */
2215 } /* switch(spec.type) */
2216 } /* while(*fmt) */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002217
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002218 if (size > 0) {
2219 if (str < end)
2220 *str = '\0';
2221 else
2222 end[-1] = '\0';
2223 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002224
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002225#undef get_arg
2226
2227 /* the trailing null byte doesn't count towards the total */
2228 return str - buf;
2229}
2230EXPORT_SYMBOL_GPL(bstr_printf);
2231
2232/**
2233 * bprintf - Parse a format string and place args' binary value in a buffer
2234 * @bin_buf: The buffer to place args' binary value
2235 * @size: The size of the buffer(by words(32bits), not characters)
2236 * @fmt: The format string to use
2237 * @...: Arguments for the format string
2238 *
2239 * The function returns the number of words(u32) written
2240 * into @bin_buf.
2241 */
2242int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2243{
2244 va_list args;
2245 int ret;
2246
2247 va_start(args, fmt);
2248 ret = vbin_printf(bin_buf, size, fmt, args);
2249 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002250
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002251 return ret;
2252}
2253EXPORT_SYMBOL_GPL(bprintf);
2254
2255#endif /* CONFIG_BINARY_PRINTF */
2256
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257/**
2258 * vsscanf - Unformat a buffer into a list of arguments
2259 * @buf: input buffer
2260 * @fmt: format of buffer
2261 * @args: arguments
2262 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002263int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264{
2265 const char *str = buf;
2266 char *next;
2267 char digit;
2268 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08002269 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08002270 unsigned int base;
2271 union {
2272 long long s;
2273 unsigned long long u;
2274 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08002275 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002276 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277
Jan Beulichda990752012-10-04 17:13:24 -07002278 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 /* skip any white space in format */
2280 /* white space in format matchs any amount of
2281 * white space, including none, in the input.
2282 */
2283 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08002284 fmt = skip_spaces(++fmt);
2285 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 }
2287
2288 /* anything that is not a conversion must match exactly */
2289 if (*fmt != '%' && *fmt) {
2290 if (*fmt++ != *str++)
2291 break;
2292 continue;
2293 }
2294
2295 if (!*fmt)
2296 break;
2297 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002298
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 /* skip this conversion.
2300 * advance both strings to next white space
2301 */
2302 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07002303 if (!*str)
2304 break;
Andy Spencer8fccae22009-10-01 15:44:27 -07002305 while (!isspace(*fmt) && *fmt != '%' && *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 fmt++;
2307 while (!isspace(*str) && *str)
2308 str++;
2309 continue;
2310 }
2311
2312 /* get field width */
2313 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08002314 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08002316 if (field_width <= 0)
2317 break;
2318 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
2320 /* get conversion qualifier */
2321 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002322 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2323 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 qualifier = *fmt++;
2325 if (unlikely(qualifier == *fmt)) {
2326 if (qualifier == 'h') {
2327 qualifier = 'H';
2328 fmt++;
2329 } else if (qualifier == 'l') {
2330 qualifier = 'L';
2331 fmt++;
2332 }
2333 }
2334 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335
Jan Beulichda990752012-10-04 17:13:24 -07002336 if (!*fmt)
2337 break;
2338
2339 if (*fmt == 'n') {
2340 /* return number of characters read so far */
2341 *va_arg(args, int *) = str - buf;
2342 ++fmt;
2343 continue;
2344 }
2345
2346 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 break;
2348
André Goddard Rosad4be1512009-12-14 18:00:59 -08002349 base = 10;
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002350 is_sign = false;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002351
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002352 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 case 'c':
2354 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002355 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002356 if (field_width == -1)
2357 field_width = 1;
2358 do {
2359 *s++ = *str++;
2360 } while (--field_width > 0 && *str);
2361 num++;
2362 }
2363 continue;
2364 case 's':
2365 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002366 char *s = (char *)va_arg(args, char *);
2367 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07002368 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002370 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371
2372 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002373 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 *s = '\0';
2376 num++;
2377 }
2378 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 case 'o':
2380 base = 8;
2381 break;
2382 case 'x':
2383 case 'X':
2384 base = 16;
2385 break;
2386 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002387 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388 case 'd':
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002389 is_sign = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002390 case 'u':
2391 break;
2392 case '%':
2393 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002394 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 return num;
2396 continue;
2397 default:
2398 /* invalid format; stop here */
2399 return num;
2400 }
2401
2402 /* have some sort of integer conversion.
2403 * first, skip white space in buffer.
2404 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002405 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002406
2407 digit = *str;
2408 if (is_sign && digit == '-')
2409 digit = *(str + 1);
2410
2411 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002412 || (base == 16 && !isxdigit(digit))
2413 || (base == 10 && !isdigit(digit))
2414 || (base == 8 && (!isdigit(digit) || digit > '7'))
2415 || (base == 0 && !isdigit(digit)))
2416 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002417
Jan Beulich53809752012-12-17 16:01:31 -08002418 if (is_sign)
2419 val.s = qualifier != 'L' ?
2420 simple_strtol(str, &next, base) :
2421 simple_strtoll(str, &next, base);
2422 else
2423 val.u = qualifier != 'L' ?
2424 simple_strtoul(str, &next, base) :
2425 simple_strtoull(str, &next, base);
2426
2427 if (field_width > 0 && next - str > field_width) {
2428 if (base == 0)
2429 _parse_integer_fixup_radix(str, &base);
2430 while (next - str > field_width) {
2431 if (is_sign)
2432 val.s = div_s64(val.s, base);
2433 else
2434 val.u = div_u64(val.u, base);
2435 --next;
2436 }
2437 }
2438
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002439 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08002441 if (is_sign)
2442 *va_arg(args, signed char *) = val.s;
2443 else
2444 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002445 break;
2446 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08002447 if (is_sign)
2448 *va_arg(args, short *) = val.s;
2449 else
2450 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002451 break;
2452 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08002453 if (is_sign)
2454 *va_arg(args, long *) = val.s;
2455 else
2456 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 break;
2458 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08002459 if (is_sign)
2460 *va_arg(args, long long *) = val.s;
2461 else
2462 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 break;
2464 case 'Z':
2465 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08002466 *va_arg(args, size_t *) = val.u;
2467 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 default:
Jan Beulich53809752012-12-17 16:01:31 -08002469 if (is_sign)
2470 *va_arg(args, int *) = val.s;
2471 else
2472 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 break;
2474 }
2475 num++;
2476
2477 if (!next)
2478 break;
2479 str = next;
2480 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002481
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 return num;
2483}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484EXPORT_SYMBOL(vsscanf);
2485
2486/**
2487 * sscanf - Unformat a buffer into a list of arguments
2488 * @buf: input buffer
2489 * @fmt: formatting of buffer
2490 * @...: resulting arguments
2491 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002492int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493{
2494 va_list args;
2495 int i;
2496
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002497 va_start(args, fmt);
2498 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002499 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002500
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 return i;
2502}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503EXPORT_SYMBOL(sscanf);