blob: 26559bdb4c49737a2d0e33006476f6a9be94385f [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>
Joe Perches8a27f7c2009-08-17 12:29:44 +000030#include <net/addrconf.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Tim Schmielau4e57b682005-10-30 15:03:48 -080032#include <asm/page.h> /* for PAGE_SIZE */
James Bottomleydeac93d2008-09-03 20:43:36 -050033#include <asm/sections.h> /* for dereference_function_descriptor() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070035#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070036
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 * simple_strtoull - convert a string to an unsigned long long
39 * @cp: The start of the string
40 * @endp: A pointer to the end of the parsed string will be placed here
41 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080042 *
43 * This function is obsolete. Please use kstrtoull instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 */
Harvey Harrison22d27052008-10-16 13:40:35 -070045unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070046{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070047 unsigned long long result;
48 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070050 cp = _parse_integer_fixup_radix(cp, &base);
51 rv = _parse_integer(cp, base, &result);
52 /* FIXME */
53 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 if (endp)
56 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080057
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 return result;
59}
Linus Torvalds1da177e2005-04-16 15:20:36 -070060EXPORT_SYMBOL(simple_strtoull);
61
62/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080063 * simple_strtoul - convert a string to an unsigned long
64 * @cp: The start of the string
65 * @endp: A pointer to the end of the parsed string will be placed here
66 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080067 *
68 * This function is obsolete. Please use kstrtoul instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080069 */
70unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
71{
72 return simple_strtoull(cp, endp, base);
73}
74EXPORT_SYMBOL(simple_strtoul);
75
76/**
77 * simple_strtol - convert a string to a signed long
78 * @cp: The start of the string
79 * @endp: A pointer to the end of the parsed string will be placed here
80 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080081 *
82 * This function is obsolete. Please use kstrtol instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080083 */
84long simple_strtol(const char *cp, char **endp, unsigned int base)
85{
86 if (*cp == '-')
87 return -simple_strtoul(cp + 1, endp, base);
88
89 return simple_strtoul(cp, endp, base);
90}
91EXPORT_SYMBOL(simple_strtol);
92
93/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 * simple_strtoll - convert a string to a signed long long
95 * @cp: The start of the string
96 * @endp: A pointer to the end of the parsed string will be placed here
97 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080098 *
99 * This function is obsolete. Please use kstrtoll instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 */
Harvey Harrison22d27052008-10-16 13:40:35 -0700101long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800103 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -0700104 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800105
Harvey Harrison22d27052008-10-16 13:40:35 -0700106 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107}
Hans Verkuil98d5ce02010-04-23 13:18:04 -0400108EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Joe Perchescf3b4292010-05-24 14:33:16 -0700110static noinline_for_stack
111int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800113 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115 while (isdigit(**s))
116 i = i*10 + *((*s)++) - '0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 return i;
119}
120
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700121/* Decimal conversion is by far the most typical, and is used
122 * for /proc and /sys data. This directly impacts e.g. top performance
123 * with many processes running. We optimize it for speed
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700124 * using ideas described at <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
125 * (with permission from the author, Douglas W. Jones).
126 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700127
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700128#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
129/* Formats correctly any integer in [0, 999999999] */
Joe Perchescf3b4292010-05-24 14:33:16 -0700130static noinline_for_stack
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700131char *put_dec_full9(char *buf, unsigned q)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700132{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700133 unsigned r;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700134
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800135 /*
136 * Possible ways to approx. divide by 10
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700137 * (x * 0x1999999a) >> 32 x < 1073741829 (multiply must be 64-bit)
138 * (x * 0xcccd) >> 19 x < 81920 (x < 262149 when 64-bit mul)
139 * (x * 0x6667) >> 18 x < 43699
140 * (x * 0x3334) >> 17 x < 16389
141 * (x * 0x199a) >> 16 x < 16389
142 * (x * 0x0ccd) >> 15 x < 16389
143 * (x * 0x0667) >> 14 x < 2739
144 * (x * 0x0334) >> 13 x < 1029
145 * (x * 0x019a) >> 12 x < 1029
146 * (x * 0x00cd) >> 11 x < 1029 shorter code than * 0x67 (on i386)
147 * (x * 0x0067) >> 10 x < 179
148 * (x * 0x0034) >> 9 x < 69 same
149 * (x * 0x001a) >> 8 x < 69 same
150 * (x * 0x000d) >> 7 x < 69 same, shortest code (on i386)
151 * (x * 0x0007) >> 6 x < 19
152 * See <http://www.cs.uiowa.edu/~jones/bcd/divide.html>
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800153 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700154 r = (q * (uint64_t)0x1999999a) >> 32;
155 *buf++ = (q - 10 * r) + '0'; /* 1 */
156 q = (r * (uint64_t)0x1999999a) >> 32;
157 *buf++ = (r - 10 * q) + '0'; /* 2 */
158 r = (q * (uint64_t)0x1999999a) >> 32;
159 *buf++ = (q - 10 * r) + '0'; /* 3 */
160 q = (r * (uint64_t)0x1999999a) >> 32;
161 *buf++ = (r - 10 * q) + '0'; /* 4 */
162 r = (q * (uint64_t)0x1999999a) >> 32;
163 *buf++ = (q - 10 * r) + '0'; /* 5 */
164 /* Now value is under 10000, can avoid 64-bit multiply */
165 q = (r * 0x199a) >> 16;
166 *buf++ = (r - 10 * q) + '0'; /* 6 */
167 r = (q * 0xcd) >> 11;
168 *buf++ = (q - 10 * r) + '0'; /* 7 */
169 q = (r * 0xcd) >> 11;
170 *buf++ = (r - 10 * q) + '0'; /* 8 */
171 *buf++ = q + '0'; /* 9 */
172 return buf;
173}
174#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700175
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700176/* Similar to above but do not pad with zeros.
177 * Code can be easily arranged to print 9 digits too, but our callers
178 * always call put_dec_full9() instead when the number has 9 decimal digits.
179 */
180static noinline_for_stack
181char *put_dec_trunc8(char *buf, unsigned r)
182{
183 unsigned q;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700184
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700185 /* Copy of previous function's body with added early returns */
George Spelvincb239d02012-10-04 17:12:30 -0700186 while (r >= 10000) {
187 q = r + '0';
188 r = (r * (uint64_t)0x1999999a) >> 32;
189 *buf++ = q - 10*r;
190 }
191
George Spelvinf4000512012-10-04 17:12:32 -0700192 q = (r * 0x199a) >> 16; /* r <= 9999 */
193 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700194 if (q == 0)
195 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700196 r = (q * 0xcd) >> 11; /* q <= 999 */
197 *buf++ = (q - 10 * r) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700198 if (r == 0)
199 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700200 q = (r * 0xcd) >> 11; /* r <= 99 */
201 *buf++ = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700202 if (q == 0)
203 return buf;
George Spelvinf4000512012-10-04 17:12:32 -0700204 *buf++ = q + '0'; /* q <= 9 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700205 return buf;
206}
207
208/* There are two algorithms to print larger numbers.
209 * One is generic: divide by 1000000000 and repeatedly print
210 * groups of (up to) 9 digits. It's conceptually simple,
211 * but requires a (unsigned long long) / 1000000000 division.
212 *
213 * Second algorithm splits 64-bit unsigned long long into 16-bit chunks,
214 * manipulates them cleverly and generates groups of 4 decimal digits.
215 * It so happens that it does NOT require long long division.
216 *
217 * If long is > 32 bits, division of 64-bit values is relatively easy,
218 * and we will use the first algorithm.
219 * If long long is > 64 bits (strange architecture with VERY large long long),
220 * second algorithm can't be used, and we again use the first one.
221 *
222 * Else (if long is 32 bits and long long is 64 bits) we use second one.
223 */
224
225#if BITS_PER_LONG != 32 || BITS_PER_LONG_LONG != 64
226
227/* First algorithm: generic */
228
229static
230char *put_dec(char *buf, unsigned long long n)
231{
232 if (n >= 100*1000*1000) {
233 while (n >= 1000*1000*1000)
234 buf = put_dec_full9(buf, do_div(n, 1000*1000*1000));
235 if (n >= 100*1000*1000)
236 return put_dec_full9(buf, n);
237 }
238 return put_dec_trunc8(buf, n);
239}
240
241#else
242
243/* Second algorithm: valid only for 64-bit long longs */
244
George Spelvine49317d2012-10-04 17:12:27 -0700245/* See comment in put_dec_full9 for choice of constants */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700246static noinline_for_stack
George Spelvin23591722012-10-04 17:12:29 -0700247void put_dec_full4(char *buf, unsigned q)
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700248{
249 unsigned r;
George Spelvine49317d2012-10-04 17:12:27 -0700250 r = (q * 0xccd) >> 15;
George Spelvin23591722012-10-04 17:12:29 -0700251 buf[0] = (q - 10 * r) + '0';
George Spelvine49317d2012-10-04 17:12:27 -0700252 q = (r * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700253 buf[1] = (r - 10 * q) + '0';
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700254 r = (q * 0xcd) >> 11;
George Spelvin23591722012-10-04 17:12:29 -0700255 buf[2] = (q - 10 * r) + '0';
256 buf[3] = r + '0';
257}
258
259/*
260 * Call put_dec_full4 on x % 10000, return x / 10000.
261 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
262 * holds for all x < 1,128,869,999. The largest value this
263 * helper will ever be asked to convert is 1,125,520,955.
264 * (d1 in the put_dec code, assuming n is all-ones).
265 */
266static
267unsigned put_dec_helper4(char *buf, unsigned x)
268{
269 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
270
271 put_dec_full4(buf, x - q * 10000);
272 return q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700273}
274
275/* Based on code by Douglas W. Jones found at
276 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
277 * (with permission from the author).
278 * Performs no 64-bit division and hence should be fast on 32-bit machines.
279 */
280static
281char *put_dec(char *buf, unsigned long long n)
282{
283 uint32_t d3, d2, d1, q, h;
284
285 if (n < 100*1000*1000)
286 return put_dec_trunc8(buf, n);
287
288 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
289 h = (n >> 32);
290 d2 = (h ) & 0xffff;
291 d3 = (h >> 16); /* implicit "& 0xffff" */
292
293 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
George Spelvin23591722012-10-04 17:12:29 -0700294 q = put_dec_helper4(buf, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700295
George Spelvin23591722012-10-04 17:12:29 -0700296 q += 7671 * d3 + 9496 * d2 + 6 * d1;
297 q = put_dec_helper4(buf+4, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700298
George Spelvin23591722012-10-04 17:12:29 -0700299 q += 4749 * d3 + 42 * d2;
300 q = put_dec_helper4(buf+8, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700301
George Spelvin23591722012-10-04 17:12:29 -0700302 q += 281 * d3;
303 buf += 12;
304 if (q)
305 buf = put_dec_trunc8(buf, q);
306 else while (buf[-1] == '0')
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700307 --buf;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800308
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700309 return buf;
310}
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700311
312#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700313
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700314/*
315 * Convert passed number to decimal string.
316 * Returns the length of string. On buffer overflow, returns 0.
317 *
318 * If speed is not important, use snprintf(). It's easy to read the code.
319 */
320int num_to_str(char *buf, int size, unsigned long long num)
321{
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700322 char tmp[sizeof(num) * 3];
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700323 int idx, len;
324
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700325 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
326 if (num <= 9) {
327 tmp[0] = '0' + num;
328 len = 1;
329 } else {
330 len = put_dec(tmp, num) - tmp;
331 }
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700332
333 if (len > size)
334 return 0;
335 for (idx = 0; idx < len; ++idx)
336 buf[idx] = tmp[len - idx - 1];
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700337 return len;
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700338}
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#define ZEROPAD 1 /* pad with zero */
341#define SIGN 2 /* unsigned/signed long */
342#define PLUS 4 /* show plus */
343#define SPACE 8 /* space if plus */
344#define LEFT 16 /* left justified */
Bjorn Helgaasb89dc5d2010-03-05 10:47:31 -0700345#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
346#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100348enum format_type {
349 FORMAT_TYPE_NONE, /* Just a string part */
Vegard Nossumed681a92009-03-14 12:08:50 +0100350 FORMAT_TYPE_WIDTH,
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100351 FORMAT_TYPE_PRECISION,
352 FORMAT_TYPE_CHAR,
353 FORMAT_TYPE_STR,
354 FORMAT_TYPE_PTR,
355 FORMAT_TYPE_PERCENT_CHAR,
356 FORMAT_TYPE_INVALID,
357 FORMAT_TYPE_LONG_LONG,
358 FORMAT_TYPE_ULONG,
359 FORMAT_TYPE_LONG,
Zhaoleia4e94ef2009-03-27 17:07:05 +0800360 FORMAT_TYPE_UBYTE,
361 FORMAT_TYPE_BYTE,
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100362 FORMAT_TYPE_USHORT,
363 FORMAT_TYPE_SHORT,
364 FORMAT_TYPE_UINT,
365 FORMAT_TYPE_INT,
366 FORMAT_TYPE_NRCHARS,
367 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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-03-06 17:21:50 +0100513 len = strnlen(s, spec.precision);
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700514
Frederic Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-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 Weisbeckerfef20d9c2009-03-06 17:21:50 +0100654 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700655 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d9c2009-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 Helgaas4da0b662010-03-05 10:47:37 -0700721 p = number(p, pend, res->start, *specp);
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600722 if (res->start != res->end) {
723 *p++ = '-';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700724 p = number(p, pend, res->end, *specp);
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600725 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600726 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600727 if (res->flags & IORESOURCE_MEM_64)
728 p = string(p, pend, " 64bit", str_spec);
729 if (res->flags & IORESOURCE_PREFETCH)
730 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700731 if (res->flags & IORESOURCE_WINDOW)
732 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600733 if (res->flags & IORESOURCE_DISABLED)
734 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600735 } else {
736 p = string(p, pend, " flags ", str_spec);
737 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600738 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100739 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600740 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100741
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100742 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100743}
744
Joe Perchescf3b4292010-05-24 14:33:16 -0700745static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -0700746char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
747 const char *fmt)
748{
Steven Rostedt360603a2013-05-28 15:47:39 -0400749 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -0700750 negative value, fallback to the default */
751 char separator;
752
753 if (spec.field_width == 0)
754 /* nothing to print */
755 return buf;
756
757 if (ZERO_OR_NULL_PTR(addr))
758 /* NULL pointer */
759 return string(buf, end, NULL, spec);
760
761 switch (fmt[1]) {
762 case 'C':
763 separator = ':';
764 break;
765 case 'D':
766 separator = '-';
767 break;
768 case 'N':
769 separator = 0;
770 break;
771 default:
772 separator = ' ';
773 break;
774 }
775
776 if (spec.field_width > 0)
777 len = min_t(int, spec.field_width, 64);
778
779 for (i = 0; i < len && buf < end - 1; i++) {
780 buf = hex_byte_pack(buf, addr[i]);
781
782 if (buf < end && separator && i != len - 1)
783 *buf++ = separator;
784 }
785
786 return buf;
787}
788
789static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -0700790char *mac_address_string(char *buf, char *end, u8 *addr,
791 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700792{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000793 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700794 char *p = mac_addr;
795 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000796 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700797 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000798
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700799 switch (fmt[1]) {
800 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +0000801 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700802 break;
803
804 case 'R':
805 reversed = true;
806 /* fall through */
807
808 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +0000809 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700810 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000811 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700812
813 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700814 if (reversed)
815 p = hex_byte_pack(p, addr[5 - i]);
816 else
817 p = hex_byte_pack(p, addr[i]);
818
Joe Perches8a27f7c2009-08-17 12:29:44 +0000819 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000820 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700821 }
822 *p = '\0';
823
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100824 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700825}
826
Joe Perchescf3b4292010-05-24 14:33:16 -0700827static noinline_for_stack
828char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700829{
Harvey Harrison689afa72008-10-28 16:04:44 -0700830 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800831 bool leading_zeros = (fmt[0] == 'i');
832 int index;
833 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700834
Joe Perches0159f242010-01-13 20:23:30 -0800835 switch (fmt[2]) {
836 case 'h':
837#ifdef __BIG_ENDIAN
838 index = 0;
839 step = 1;
840#else
841 index = 3;
842 step = -1;
843#endif
844 break;
845 case 'l':
846 index = 3;
847 step = -1;
848 break;
849 case 'n':
850 case 'b':
851 default:
852 index = 0;
853 step = 1;
854 break;
855 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000856 for (i = 0; i < 4; i++) {
857 char temp[3]; /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700858 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000859 if (leading_zeros) {
860 if (digits < 3)
861 *p++ = '0';
862 if (digits < 2)
863 *p++ = '0';
864 }
865 /* reverse the digits in the quad */
866 while (digits--)
867 *p++ = temp[digits];
868 if (i < 3)
869 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -0800870 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000871 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000872 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800873
Joe Perches8a27f7c2009-08-17 12:29:44 +0000874 return p;
875}
876
Joe Perchescf3b4292010-05-24 14:33:16 -0700877static noinline_for_stack
878char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000879{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800880 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000881 unsigned char zerolength[8];
882 int longest = 1;
883 int colonpos = -1;
884 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800885 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000886 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +0000887 bool useIPv4;
888 struct in6_addr in6;
889
890 memcpy(&in6, addr, sizeof(struct in6_addr));
891
892 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000893
894 memset(zerolength, 0, sizeof(zerolength));
895
896 if (useIPv4)
897 range = 6;
898 else
899 range = 8;
900
901 /* find position of longest 0 run */
902 for (i = 0; i < range; i++) {
903 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +0000904 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000905 break;
906 zerolength[i]++;
907 }
908 }
909 for (i = 0; i < range; i++) {
910 if (zerolength[i] > longest) {
911 longest = zerolength[i];
912 colonpos = i;
913 }
914 }
Joe Perches29cf5192011-06-09 11:23:37 -0700915 if (longest == 1) /* don't compress a single 0 */
916 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000917
918 /* emit address */
919 for (i = 0; i < range; i++) {
920 if (i == colonpos) {
921 if (needcolon || i == 0)
922 *p++ = ':';
923 *p++ = ':';
924 needcolon = false;
925 i += longest - 1;
926 continue;
927 }
928 if (needcolon) {
929 *p++ = ':';
930 needcolon = false;
931 }
932 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +0000933 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000934 hi = word >> 8;
935 lo = word & 0xff;
936 if (hi) {
937 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700938 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000939 else
940 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700941 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000942 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -0800943 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700944 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000945 else
946 *p++ = hex_asc_lo(lo);
947 needcolon = true;
948 }
949
950 if (useIPv4) {
951 if (needcolon)
952 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -0800953 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +0000954 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000955 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800956
Joe Perches8a27f7c2009-08-17 12:29:44 +0000957 return p;
958}
959
Joe Perchescf3b4292010-05-24 14:33:16 -0700960static noinline_for_stack
961char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000962{
963 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800964
Harvey Harrison689afa72008-10-28 16:04:44 -0700965 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700966 p = hex_byte_pack(p, *addr++);
967 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000968 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -0700969 *p++ = ':';
970 }
971 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800972
Joe Perches8a27f7c2009-08-17 12:29:44 +0000973 return p;
974}
975
Joe Perchescf3b4292010-05-24 14:33:16 -0700976static noinline_for_stack
977char *ip6_addr_string(char *buf, char *end, const u8 *addr,
978 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000979{
980 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
981
982 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +0000983 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000984 else
Joe Percheseb78cd22009-09-18 13:04:06 +0000985 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -0700986
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100987 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -0700988}
989
Joe Perchescf3b4292010-05-24 14:33:16 -0700990static noinline_for_stack
991char *ip4_addr_string(char *buf, char *end, const u8 *addr,
992 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -0700993{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000994 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -0700995
Joe Perches0159f242010-01-13 20:23:30 -0800996 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -0700997
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100998 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -0700999}
1000
Joe Perchescf3b4292010-05-24 14:33:16 -07001001static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001002char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1003 struct printf_spec spec, const char *fmt)
1004{
1005 bool have_p = false, have_s = false, have_f = false, have_c = false;
1006 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1007 sizeof(":12345") + sizeof("/123456789") +
1008 sizeof("%1234567890")];
1009 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1010 const u8 *addr = (const u8 *) &sa->sin6_addr;
1011 char fmt6[2] = { fmt[0], '6' };
1012 u8 off = 0;
1013
1014 fmt++;
1015 while (isalpha(*++fmt)) {
1016 switch (*fmt) {
1017 case 'p':
1018 have_p = true;
1019 break;
1020 case 'f':
1021 have_f = true;
1022 break;
1023 case 's':
1024 have_s = true;
1025 break;
1026 case 'c':
1027 have_c = true;
1028 break;
1029 }
1030 }
1031
1032 if (have_p || have_s || have_f) {
1033 *p = '[';
1034 off = 1;
1035 }
1036
1037 if (fmt6[0] == 'I' && have_c)
1038 p = ip6_compressed_string(ip6_addr + off, addr);
1039 else
1040 p = ip6_string(ip6_addr + off, addr, fmt6);
1041
1042 if (have_p || have_s || have_f)
1043 *p++ = ']';
1044
1045 if (have_p) {
1046 *p++ = ':';
1047 p = number(p, pend, ntohs(sa->sin6_port), spec);
1048 }
1049 if (have_f) {
1050 *p++ = '/';
1051 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1052 IPV6_FLOWINFO_MASK), spec);
1053 }
1054 if (have_s) {
1055 *p++ = '%';
1056 p = number(p, pend, sa->sin6_scope_id, spec);
1057 }
1058 *p = '\0';
1059
1060 return string(buf, end, ip6_addr, spec);
1061}
1062
1063static noinline_for_stack
1064char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1065 struct printf_spec spec, const char *fmt)
1066{
1067 bool have_p = false;
1068 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1069 char *pend = ip4_addr + sizeof(ip4_addr);
1070 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1071 char fmt4[3] = { fmt[0], '4', 0 };
1072
1073 fmt++;
1074 while (isalpha(*++fmt)) {
1075 switch (*fmt) {
1076 case 'p':
1077 have_p = true;
1078 break;
1079 case 'h':
1080 case 'l':
1081 case 'n':
1082 case 'b':
1083 fmt4[2] = *fmt;
1084 break;
1085 }
1086 }
1087
1088 p = ip4_string(ip4_addr, addr, fmt4);
1089 if (have_p) {
1090 *p++ = ':';
1091 p = number(p, pend, ntohs(sa->sin_port), spec);
1092 }
1093 *p = '\0';
1094
1095 return string(buf, end, ip4_addr, spec);
1096}
1097
1098static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001099char *uuid_string(char *buf, char *end, const u8 *addr,
1100 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001101{
1102 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
1103 char *p = uuid;
1104 int i;
1105 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
1106 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
1107 const u8 *index = be;
1108 bool uc = false;
1109
1110 switch (*(++fmt)) {
1111 case 'L':
1112 uc = true; /* fall-through */
1113 case 'l':
1114 index = le;
1115 break;
1116 case 'B':
1117 uc = true;
1118 break;
1119 }
1120
1121 for (i = 0; i < 16; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001122 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001123 switch (i) {
1124 case 3:
1125 case 5:
1126 case 7:
1127 case 9:
1128 *p++ = '-';
1129 break;
1130 }
1131 }
1132
1133 *p = 0;
1134
1135 if (uc) {
1136 p = uuid;
1137 do {
1138 *p = toupper(*p);
1139 } while (*(++p));
1140 }
1141
1142 return string(buf, end, uuid, spec);
1143}
1144
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001145static
1146char *netdev_feature_string(char *buf, char *end, const u8 *addr,
1147 struct printf_spec spec)
1148{
1149 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1150 if (spec.field_width == -1)
1151 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
1152 spec.base = 16;
1153
1154 return number(buf, end, *(const netdev_features_t *)addr, spec);
1155}
1156
Ingo Molnar411f05f2011-05-12 23:00:28 +02001157int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001158
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001159/*
1160 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1161 * by an extra set of alphanumeric characters that are extended format
1162 * specifiers.
1163 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001164 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001165 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001166 * - 'F' For symbolic function descriptor pointers with offset
1167 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001168 * - 'S' For symbolic direct pointers with offset
1169 * - 's' For symbolic direct pointers without offset
Joe Perchesb0d33c22012-12-12 10:18:50 -08001170 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001171 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001172 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1173 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001174 * - 'M' For a 6-byte MAC address, it prints the address in the
1175 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00001176 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00001177 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08001178 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07001179 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001180 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1181 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1182 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02001183 * [S][pfs]
1184 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1185 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00001186 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1187 * IPv6 omits the colons (01020304...0f)
1188 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02001189 * [S][pfs]
1190 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1191 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1192 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1193 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07001194 * http://tools.ietf.org/html/rfc5952
Joe Perches9ac6e442009-12-14 18:01:09 -08001195 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1196 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1197 * Options for %pU are:
1198 * b big endian lower case hex (default)
1199 * B big endian UPPER case hex
1200 * l little endian lower case hex
1201 * L little endian UPPER case hex
1202 * big endian output byte order is:
1203 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1204 * little endian output byte order is:
1205 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00001206 * - 'V' For a struct va_format which contains a format string * and va_list *,
1207 * call vsnprintf(->format, *->va_list).
1208 * Implements a "recursive vsnprintf".
1209 * Do not use this feature without some mechanism to verify the
1210 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001211 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001212 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07001213 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1214 * a certain separator (' ' by default):
1215 * C colon
1216 * D dash
1217 * N no separator
1218 * The maximum supported length is 64 bytes of the input. Consider
1219 * to use print_hex_dump() for the larger input.
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001220 * - 'a' For a phys_addr_t type and its derivative types (passed by reference)
Joe Perches9ac6e442009-12-14 18:01:09 -08001221 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001222 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1223 * function pointers are really function descriptors, which contain a
1224 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001225 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001226static noinline_for_stack
1227char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1228 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001229{
Grant Likely725fe002012-05-31 16:26:08 -07001230 int default_width = 2 * sizeof(void *) + (spec.flags & SPECIAL ? 2 : 0);
1231
Kees Cook9f36e2c2011-03-22 16:34:22 -07001232 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -07001233 /*
1234 * Print (null) with the same width as a pointer so it makes
1235 * tabular output look nice.
1236 */
1237 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001238 spec.field_width = default_width;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001239 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -07001240 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -08001241
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001242 switch (*fmt) {
1243 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001244 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001245 ptr = dereference_function_descriptor(ptr);
1246 /* Fallthrough */
1247 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08001248 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001249 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08001250 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001251 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001252 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001253 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07001254 case 'h':
1255 return hex_string(buf, end, ptr, spec, fmt);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001256 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1257 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001258 /* [mM]F (FDDI) */
1259 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00001260 return mac_address_string(buf, end, ptr, spec, fmt);
1261 case 'I': /* Formatted IP supported
1262 * 4: 1.2.3.4
1263 * 6: 0001:0203:...:0708
1264 * 6c: 1::708 or 1::1.2.3.4
1265 */
1266 case 'i': /* Contiguous:
1267 * 4: 001.002.003.004
1268 * 6: 000102...0f
1269 */
1270 switch (fmt[1]) {
1271 case '6':
1272 return ip6_addr_string(buf, end, ptr, spec, fmt);
1273 case '4':
1274 return ip4_addr_string(buf, end, ptr, spec, fmt);
Daniel Borkmann10679642013-06-28 19:49:39 +02001275 case 'S': {
1276 const union {
1277 struct sockaddr raw;
1278 struct sockaddr_in v4;
1279 struct sockaddr_in6 v6;
1280 } *sa = ptr;
1281
1282 switch (sa->raw.sa_family) {
1283 case AF_INET:
1284 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1285 case AF_INET6:
1286 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1287 default:
1288 return string(buf, end, "(invalid address)", spec);
1289 }}
Joe Perches8a27f7c2009-08-17 12:29:44 +00001290 }
Harvey Harrison4aa99602008-10-29 12:49:58 -07001291 break;
Joe Perches9ac6e442009-12-14 18:01:09 -08001292 case 'U':
1293 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00001294 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +00001295 {
1296 va_list va;
1297
1298 va_copy(va, *((struct va_format *)ptr)->va);
1299 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1300 ((struct va_format *)ptr)->fmt, va);
1301 va_end(va);
1302 return buf;
1303 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001304 case 'K':
1305 /*
1306 * %pK cannot be used in IRQ context because its test
1307 * for CAP_SYSLOG would be meaningless.
1308 */
Dan Rosenberg3715c5302012-07-30 14:40:26 -07001309 if (kptr_restrict && (in_irq() || in_serving_softirq() ||
1310 in_nmi())) {
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001311 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001312 spec.field_width = default_width;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001313 return string(buf, end, "pK-error", spec);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001314 }
Joe Perches26297602011-03-22 16:34:19 -07001315 if (!((kptr_restrict == 0) ||
1316 (kptr_restrict == 1 &&
1317 has_capability_noaudit(current, CAP_SYSLOG))))
1318 ptr = NULL;
1319 break;
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001320 case 'N':
1321 switch (fmt[1]) {
1322 case 'F':
1323 return netdev_feature_string(buf, end, ptr, spec);
1324 }
1325 break;
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001326 case 'a':
1327 spec.flags |= SPECIAL | SMALL | ZEROPAD;
1328 spec.field_width = sizeof(phys_addr_t) * 2 + 2;
1329 spec.base = 16;
1330 return number(buf, end,
1331 (unsigned long long) *((phys_addr_t *)ptr), spec);
Al Viro4b6ccca2013-09-03 12:00:44 -04001332 case 'd':
1333 return dentry_name(buf, end, ptr, spec, fmt);
1334 case 'D':
1335 return dentry_name(buf, end,
1336 ((const struct file *)ptr)->f_path.dentry,
1337 spec, fmt);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001338 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001339 spec.flags |= SMALL;
1340 if (spec.field_width == -1) {
Grant Likely725fe002012-05-31 16:26:08 -07001341 spec.field_width = default_width;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001342 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001343 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001344 spec.base = 16;
1345
1346 return number(buf, end, (unsigned long) ptr, spec);
1347}
1348
1349/*
1350 * Helper function to decode printf style format.
1351 * Each call decode a token from the format and return the
1352 * number of characters read (or likely the delta where it wants
1353 * to go on the next call).
1354 * The decoded token is returned through the parameters
1355 *
1356 * 'h', 'l', or 'L' for integer fields
1357 * 'z' support added 23/7/1999 S.H.
1358 * 'z' changed to 'Z' --davidm 1/25/99
1359 * 't' added for ptrdiff_t
1360 *
1361 * @fmt: the format string
1362 * @type of the token returned
1363 * @flags: various flags such as +, -, # tokens..
1364 * @field_width: overwritten width
1365 * @base: base of the number (octal, hex, ...)
1366 * @precision: precision of a number
1367 * @qualifier: qualifier of a number (long, size_t, ...)
1368 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001369static noinline_for_stack
1370int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001371{
1372 const char *start = fmt;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001373
1374 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01001375 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001376 if (spec->field_width < 0) {
1377 spec->field_width = -spec->field_width;
1378 spec->flags |= LEFT;
1379 }
1380 spec->type = FORMAT_TYPE_NONE;
1381 goto precision;
1382 }
1383
1384 /* we finished early by reading the precision */
1385 if (spec->type == FORMAT_TYPE_PRECISION) {
1386 if (spec->precision < 0)
1387 spec->precision = 0;
1388
1389 spec->type = FORMAT_TYPE_NONE;
1390 goto qualifier;
1391 }
1392
1393 /* By default */
1394 spec->type = FORMAT_TYPE_NONE;
1395
1396 for (; *fmt ; ++fmt) {
1397 if (*fmt == '%')
1398 break;
1399 }
1400
1401 /* Return the current non-format string */
1402 if (fmt != start || !*fmt)
1403 return fmt - start;
1404
1405 /* Process flags */
1406 spec->flags = 0;
1407
1408 while (1) { /* this also skips first '%' */
1409 bool found = true;
1410
1411 ++fmt;
1412
1413 switch (*fmt) {
1414 case '-': spec->flags |= LEFT; break;
1415 case '+': spec->flags |= PLUS; break;
1416 case ' ': spec->flags |= SPACE; break;
1417 case '#': spec->flags |= SPECIAL; break;
1418 case '0': spec->flags |= ZEROPAD; break;
1419 default: found = false;
1420 }
1421
1422 if (!found)
1423 break;
1424 }
1425
1426 /* get field width */
1427 spec->field_width = -1;
1428
1429 if (isdigit(*fmt))
1430 spec->field_width = skip_atoi(&fmt);
1431 else if (*fmt == '*') {
1432 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001433 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001434 return ++fmt - start;
1435 }
1436
1437precision:
1438 /* get the precision */
1439 spec->precision = -1;
1440 if (*fmt == '.') {
1441 ++fmt;
1442 if (isdigit(*fmt)) {
1443 spec->precision = skip_atoi(&fmt);
1444 if (spec->precision < 0)
1445 spec->precision = 0;
1446 } else if (*fmt == '*') {
1447 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001448 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001449 return ++fmt - start;
1450 }
1451 }
1452
1453qualifier:
1454 /* get the conversion qualifier */
1455 spec->qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001456 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1457 _tolower(*fmt) == 'z' || *fmt == 't') {
Zhaoleia4e94ef2009-03-27 17:07:05 +08001458 spec->qualifier = *fmt++;
1459 if (unlikely(spec->qualifier == *fmt)) {
1460 if (spec->qualifier == 'l') {
1461 spec->qualifier = 'L';
1462 ++fmt;
1463 } else if (spec->qualifier == 'h') {
1464 spec->qualifier = 'H';
1465 ++fmt;
1466 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001467 }
1468 }
1469
1470 /* default base */
1471 spec->base = 10;
1472 switch (*fmt) {
1473 case 'c':
1474 spec->type = FORMAT_TYPE_CHAR;
1475 return ++fmt - start;
1476
1477 case 's':
1478 spec->type = FORMAT_TYPE_STR;
1479 return ++fmt - start;
1480
1481 case 'p':
1482 spec->type = FORMAT_TYPE_PTR;
1483 return fmt - start;
1484 /* skip alnum */
1485
1486 case 'n':
1487 spec->type = FORMAT_TYPE_NRCHARS;
1488 return ++fmt - start;
1489
1490 case '%':
1491 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1492 return ++fmt - start;
1493
1494 /* integer number formats - set up the flags and "break" */
1495 case 'o':
1496 spec->base = 8;
1497 break;
1498
1499 case 'x':
1500 spec->flags |= SMALL;
1501
1502 case 'X':
1503 spec->base = 16;
1504 break;
1505
1506 case 'd':
1507 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001508 spec->flags |= SIGN;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001509 case 'u':
1510 break;
1511
1512 default:
1513 spec->type = FORMAT_TYPE_INVALID;
1514 return fmt - start;
1515 }
1516
1517 if (spec->qualifier == 'L')
1518 spec->type = FORMAT_TYPE_LONG_LONG;
1519 else if (spec->qualifier == 'l') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001520 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001521 spec->type = FORMAT_TYPE_LONG;
1522 else
1523 spec->type = FORMAT_TYPE_ULONG;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001524 } else if (_tolower(spec->qualifier) == 'z') {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001525 spec->type = FORMAT_TYPE_SIZE_T;
1526 } else if (spec->qualifier == 't') {
1527 spec->type = FORMAT_TYPE_PTRDIFF;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001528 } else if (spec->qualifier == 'H') {
1529 if (spec->flags & SIGN)
1530 spec->type = FORMAT_TYPE_BYTE;
1531 else
1532 spec->type = FORMAT_TYPE_UBYTE;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001533 } else if (spec->qualifier == 'h') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001534 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001535 spec->type = FORMAT_TYPE_SHORT;
1536 else
1537 spec->type = FORMAT_TYPE_USHORT;
1538 } else {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001539 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001540 spec->type = FORMAT_TYPE_INT;
1541 else
1542 spec->type = FORMAT_TYPE_UINT;
1543 }
1544
1545 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001546}
1547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548/**
1549 * vsnprintf - Format a string and place it in a buffer
1550 * @buf: The buffer to place the result into
1551 * @size: The size of the buffer, including the trailing null space
1552 * @fmt: The format string to use
1553 * @args: Arguments for the format string
1554 *
Andi Kleen20036fd2008-10-15 22:02:02 -07001555 * This function follows C99 vsnprintf, but has some extensions:
Steven Rostedt91adcd22009-09-16 20:03:06 -04001556 * %pS output the name of a text symbol with offset
1557 * %ps output the name of a text symbol without offset
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001558 * %pF output the name of a function pointer with its offset
1559 * %pf output the name of a function pointer without its offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001560 * %pB output the name of a backtrace symbol with its offset
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001561 * %pR output the address range in a struct resource with decoded flags
1562 * %pr output the address range in a struct resource with raw flags
1563 * %pM output a 6-byte MAC address with colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001564 * %pMR output a 6-byte MAC address with colons in reversed order
1565 * %pMF output a 6-byte MAC address with dashes
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001566 * %pm output a 6-byte MAC address without colons
Andy Shevchenko7c591542012-10-04 17:12:33 -07001567 * %pmR output a 6-byte MAC address without colons in reversed order
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001568 * %pI4 print an IPv4 address without leading zeros
1569 * %pi4 print an IPv4 address with leading zeros
1570 * %pI6 print an IPv6 address with colons
1571 * %pi6 print an IPv6 address without colons
Jan Engelhardtf996f202011-07-14 18:48:56 +02001572 * %pI6c print an IPv6 address as specified by RFC 5952
Daniel Borkmann10679642013-06-28 19:49:39 +02001573 * %pIS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
1574 * %piS depending on sa_family of 'struct sockaddr *' print IPv4/IPv6 address
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001575 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1576 * case.
Andy Shevchenko31550a12012-07-30 14:40:27 -07001577 * %*ph[CDN] a variable-length hex string with a separator (supports up to 64
1578 * bytes of the input)
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001579 * %n is ignored
Andi Kleen20036fd2008-10-15 22:02:02 -07001580 *
Andrew Morton80f548e2012-07-30 14:40:25 -07001581 * ** Please update Documentation/printk-formats.txt when making changes **
1582 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 * The return value is the number of characters which would
1584 * be generated for the given input, excluding the trailing
1585 * '\0', as per ISO C99. If you want to have the exact
1586 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001587 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 * return is greater than or equal to @size, the resulting
1589 * string is truncated.
1590 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001591 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 */
1593int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1594{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001596 char *str, *end;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001597 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001599 /* Reject out-of-range values early. Large positive sizes are
1600 used for unknown buffer sizes. */
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07001601 if (WARN_ON_ONCE((int) size < 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603
1604 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001605 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001607 /* Make sure end is always >= buf */
1608 if (end < buf) {
1609 end = ((void *)-1);
1610 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 }
1612
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001613 while (*fmt) {
1614 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001615 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001616
1617 fmt += read;
1618
1619 switch (spec.type) {
1620 case FORMAT_TYPE_NONE: {
1621 int copy = read;
1622 if (str < end) {
1623 if (copy > end - str)
1624 copy = end - str;
1625 memcpy(str, old_fmt, copy);
1626 }
1627 str += read;
1628 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 }
1630
Vegard Nossumed681a92009-03-14 12:08:50 +01001631 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001632 spec.field_width = va_arg(args, int);
1633 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001635 case FORMAT_TYPE_PRECISION:
1636 spec.precision = va_arg(args, int);
1637 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
André Goddard Rosad4be1512009-12-14 18:00:59 -08001639 case FORMAT_TYPE_CHAR: {
1640 char c;
1641
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001642 if (!(spec.flags & LEFT)) {
1643 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001644 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 *str = ' ';
1646 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001647
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001649 }
1650 c = (unsigned char) va_arg(args, int);
1651 if (str < end)
1652 *str = c;
1653 ++str;
1654 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001655 if (str < end)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001656 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001658 }
1659 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001660 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001662 case FORMAT_TYPE_STR:
1663 str = string(str, end, va_arg(args, char *), spec);
1664 break;
1665
1666 case FORMAT_TYPE_PTR:
1667 str = pointer(fmt+1, str, end, va_arg(args, void *),
1668 spec);
1669 while (isalnum(*fmt))
1670 fmt++;
1671 break;
1672
1673 case FORMAT_TYPE_PERCENT_CHAR:
1674 if (str < end)
1675 *str = '%';
1676 ++str;
1677 break;
1678
1679 case FORMAT_TYPE_INVALID:
1680 if (str < end)
1681 *str = '%';
1682 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001683 break;
1684
1685 case FORMAT_TYPE_NRCHARS: {
Joe Perchesef0658f2010-03-06 17:10:14 -08001686 u8 qualifier = spec.qualifier;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001687
1688 if (qualifier == 'l') {
1689 long *ip = va_arg(args, long *);
1690 *ip = (str - buf);
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001691 } else if (_tolower(qualifier) == 'z') {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001692 size_t *ip = va_arg(args, size_t *);
1693 *ip = (str - buf);
1694 } else {
1695 int *ip = va_arg(args, int *);
1696 *ip = (str - buf);
1697 }
1698 break;
1699 }
1700
1701 default:
1702 switch (spec.type) {
1703 case FORMAT_TYPE_LONG_LONG:
1704 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001706 case FORMAT_TYPE_ULONG:
1707 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001709 case FORMAT_TYPE_LONG:
1710 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001712 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08001713 if (spec.flags & SIGN)
1714 num = va_arg(args, ssize_t);
1715 else
1716 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001717 break;
1718 case FORMAT_TYPE_PTRDIFF:
1719 num = va_arg(args, ptrdiff_t);
1720 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001721 case FORMAT_TYPE_UBYTE:
1722 num = (unsigned char) va_arg(args, int);
1723 break;
1724 case FORMAT_TYPE_BYTE:
1725 num = (signed char) va_arg(args, int);
1726 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001727 case FORMAT_TYPE_USHORT:
1728 num = (unsigned short) va_arg(args, int);
1729 break;
1730 case FORMAT_TYPE_SHORT:
1731 num = (short) va_arg(args, int);
1732 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001733 case FORMAT_TYPE_INT:
1734 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001735 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 default:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001737 num = va_arg(args, unsigned int);
1738 }
1739
1740 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001743
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001744 if (size > 0) {
1745 if (str < end)
1746 *str = '\0';
1747 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07001748 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001749 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001750
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001751 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 return str-buf;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001753
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755EXPORT_SYMBOL(vsnprintf);
1756
1757/**
1758 * vscnprintf - Format a string and place it in a buffer
1759 * @buf: The buffer to place the result into
1760 * @size: The size of the buffer, including the trailing null space
1761 * @fmt: The format string to use
1762 * @args: Arguments for the format string
1763 *
1764 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08001765 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 * returns 0.
1767 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001768 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001769 *
1770 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 */
1772int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1773{
1774 int i;
1775
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001776 i = vsnprintf(buf, size, fmt, args);
1777
Anton Arapovb921c692011-01-12 16:59:49 -08001778 if (likely(i < size))
1779 return i;
1780 if (size != 0)
1781 return size - 1;
1782 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784EXPORT_SYMBOL(vscnprintf);
1785
1786/**
1787 * snprintf - Format a string and place it in a buffer
1788 * @buf: The buffer to place the result into
1789 * @size: The size of the buffer, including the trailing null space
1790 * @fmt: The format string to use
1791 * @...: Arguments for the format string
1792 *
1793 * The return value is the number of characters which would be
1794 * generated for the given input, excluding the trailing null,
1795 * as per ISO C99. If the return is greater than or equal to
1796 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07001797 *
1798 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001800int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801{
1802 va_list args;
1803 int i;
1804
1805 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001806 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001808
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 return i;
1810}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811EXPORT_SYMBOL(snprintf);
1812
1813/**
1814 * scnprintf - Format a string and place it in a buffer
1815 * @buf: The buffer to place the result into
1816 * @size: The size of the buffer, including the trailing null space
1817 * @fmt: The format string to use
1818 * @...: Arguments for the format string
1819 *
1820 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07001821 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 */
1823
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001824int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825{
1826 va_list args;
1827 int i;
1828
1829 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08001830 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001832
Anton Arapovb921c692011-01-12 16:59:49 -08001833 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834}
1835EXPORT_SYMBOL(scnprintf);
1836
1837/**
1838 * vsprintf - Format a string and place it in a buffer
1839 * @buf: The buffer to place the result into
1840 * @fmt: The format string to use
1841 * @args: Arguments for the format string
1842 *
1843 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001844 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 * buffer overflows.
1846 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001847 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001848 *
1849 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 */
1851int vsprintf(char *buf, const char *fmt, va_list args)
1852{
1853 return vsnprintf(buf, INT_MAX, fmt, args);
1854}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855EXPORT_SYMBOL(vsprintf);
1856
1857/**
1858 * sprintf - Format a string and place it in a buffer
1859 * @buf: The buffer to place the result into
1860 * @fmt: The format string to use
1861 * @...: Arguments for the format string
1862 *
1863 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001864 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07001866 *
1867 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001869int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870{
1871 va_list args;
1872 int i;
1873
1874 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001875 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001877
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 return i;
1879}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880EXPORT_SYMBOL(sprintf);
1881
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001882#ifdef CONFIG_BINARY_PRINTF
1883/*
1884 * bprintf service:
1885 * vbin_printf() - VA arguments to binary data
1886 * bstr_printf() - Binary data to text string
1887 */
1888
1889/**
1890 * vbin_printf - Parse a format string and place args' binary value in a buffer
1891 * @bin_buf: The buffer to place args' binary value
1892 * @size: The size of the buffer(by words(32bits), not characters)
1893 * @fmt: The format string to use
1894 * @args: Arguments for the format string
1895 *
1896 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1897 * is skiped.
1898 *
1899 * The return value is the number of words(32bits) which would be generated for
1900 * the given input.
1901 *
1902 * NOTE:
1903 * If the return value is greater than @size, the resulting bin_buf is NOT
1904 * valid for bstr_printf().
1905 */
1906int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1907{
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001908 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001909 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001910
1911 str = (char *)bin_buf;
1912 end = (char *)(bin_buf + size);
1913
1914#define save_arg(type) \
1915do { \
1916 if (sizeof(type) == 8) { \
1917 unsigned long long value; \
1918 str = PTR_ALIGN(str, sizeof(u32)); \
1919 value = va_arg(args, unsigned long long); \
1920 if (str + sizeof(type) <= end) { \
1921 *(u32 *)str = *(u32 *)&value; \
1922 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1923 } \
1924 } else { \
1925 unsigned long value; \
1926 str = PTR_ALIGN(str, sizeof(type)); \
1927 value = va_arg(args, int); \
1928 if (str + sizeof(type) <= end) \
1929 *(typeof(type) *)str = (type)value; \
1930 } \
1931 str += sizeof(type); \
1932} while (0)
1933
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001934 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08001935 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001936
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001937 fmt += read;
1938
1939 switch (spec.type) {
1940 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08001941 case FORMAT_TYPE_INVALID:
1942 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001943 break;
1944
Vegard Nossumed681a92009-03-14 12:08:50 +01001945 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001946 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001947 save_arg(int);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001948 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001949
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001950 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001951 save_arg(char);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001952 break;
1953
1954 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001955 const char *save_str = va_arg(args, char *);
1956 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08001957
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001958 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1959 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08001960 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08001961 len = strlen(save_str) + 1;
1962 if (str + len < end)
1963 memcpy(str, save_str, len);
1964 str += len;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001965 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001966 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001967
1968 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001969 save_arg(void *);
1970 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001971 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001972 fmt++;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001973 break;
1974
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001975 case FORMAT_TYPE_NRCHARS: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001976 /* skip %n 's argument */
Joe Perchesef0658f2010-03-06 17:10:14 -08001977 u8 qualifier = spec.qualifier;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001978 void *skip_arg;
1979 if (qualifier == 'l')
1980 skip_arg = va_arg(args, long *);
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001981 else if (_tolower(qualifier) == 'z')
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001982 skip_arg = va_arg(args, size_t *);
1983 else
1984 skip_arg = va_arg(args, int *);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001985 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001986 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001987
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001988 default:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001989 switch (spec.type) {
1990
1991 case FORMAT_TYPE_LONG_LONG:
1992 save_arg(long long);
1993 break;
1994 case FORMAT_TYPE_ULONG:
1995 case FORMAT_TYPE_LONG:
1996 save_arg(unsigned long);
1997 break;
1998 case FORMAT_TYPE_SIZE_T:
1999 save_arg(size_t);
2000 break;
2001 case FORMAT_TYPE_PTRDIFF:
2002 save_arg(ptrdiff_t);
2003 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002004 case FORMAT_TYPE_UBYTE:
2005 case FORMAT_TYPE_BYTE:
2006 save_arg(char);
2007 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002008 case FORMAT_TYPE_USHORT:
2009 case FORMAT_TYPE_SHORT:
2010 save_arg(short);
2011 break;
2012 default:
2013 save_arg(int);
2014 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002015 }
2016 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002017
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002018 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002019#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002020}
2021EXPORT_SYMBOL_GPL(vbin_printf);
2022
2023/**
2024 * bstr_printf - Format a string from binary arguments and place it in a buffer
2025 * @buf: The buffer to place the result into
2026 * @size: The size of the buffer, including the trailing null space
2027 * @fmt: The format string to use
2028 * @bin_buf: Binary arguments for the format string
2029 *
2030 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2031 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2032 * a binary buffer that generated by vbin_printf.
2033 *
2034 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002035 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002036 *
2037 * The return value is the number of characters which would
2038 * be generated for the given input, excluding the trailing
2039 * '\0', as per ISO C99. If you want to have the exact
2040 * number of characters written into @buf as return value
2041 * (not including the trailing '\0'), use vscnprintf(). If the
2042 * return is greater than or equal to @size, the resulting
2043 * string is truncated.
2044 */
2045int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2046{
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002047 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002048 char *str, *end;
2049 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002050
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07002051 if (WARN_ON_ONCE((int) size < 0))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002052 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002053
2054 str = buf;
2055 end = buf + size;
2056
2057#define get_arg(type) \
2058({ \
2059 typeof(type) value; \
2060 if (sizeof(type) == 8) { \
2061 args = PTR_ALIGN(args, sizeof(u32)); \
2062 *(u32 *)&value = *(u32 *)args; \
2063 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2064 } else { \
2065 args = PTR_ALIGN(args, sizeof(type)); \
2066 value = *(typeof(type) *)args; \
2067 } \
2068 args += sizeof(type); \
2069 value; \
2070})
2071
2072 /* Make sure end is always >= buf */
2073 if (end < buf) {
2074 end = ((void *)-1);
2075 size = end - buf;
2076 }
2077
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002078 while (*fmt) {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002079 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002080 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002081
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002082 fmt += read;
2083
2084 switch (spec.type) {
2085 case FORMAT_TYPE_NONE: {
2086 int copy = read;
2087 if (str < end) {
2088 if (copy > end - str)
2089 copy = end - str;
2090 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002091 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002092 str += read;
2093 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002094 }
2095
Vegard Nossumed681a92009-03-14 12:08:50 +01002096 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002097 spec.field_width = get_arg(int);
2098 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002099
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002100 case FORMAT_TYPE_PRECISION:
2101 spec.precision = get_arg(int);
2102 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002103
André Goddard Rosad4be1512009-12-14 18:00:59 -08002104 case FORMAT_TYPE_CHAR: {
2105 char c;
2106
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002107 if (!(spec.flags & LEFT)) {
2108 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002109 if (str < end)
2110 *str = ' ';
2111 ++str;
2112 }
2113 }
2114 c = (unsigned char) get_arg(char);
2115 if (str < end)
2116 *str = c;
2117 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002118 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002119 if (str < end)
2120 *str = ' ';
2121 ++str;
2122 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002123 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002124 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002125
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002126 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002127 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002128 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002129 str = string(str, end, (char *)str_arg, spec);
2130 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002131 }
2132
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002133 case FORMAT_TYPE_PTR:
2134 str = pointer(fmt+1, str, end, get_arg(void *), spec);
2135 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002136 fmt++;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002137 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002138
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002139 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002140 case FORMAT_TYPE_INVALID:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002141 if (str < end)
2142 *str = '%';
2143 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002144 break;
2145
2146 case FORMAT_TYPE_NRCHARS:
2147 /* skip */
2148 break;
2149
André Goddard Rosad4be1512009-12-14 18:00:59 -08002150 default: {
2151 unsigned long long num;
2152
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002153 switch (spec.type) {
2154
2155 case FORMAT_TYPE_LONG_LONG:
2156 num = get_arg(long long);
2157 break;
2158 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002159 case FORMAT_TYPE_LONG:
2160 num = get_arg(unsigned long);
2161 break;
2162 case FORMAT_TYPE_SIZE_T:
2163 num = get_arg(size_t);
2164 break;
2165 case FORMAT_TYPE_PTRDIFF:
2166 num = get_arg(ptrdiff_t);
2167 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002168 case FORMAT_TYPE_UBYTE:
2169 num = get_arg(unsigned char);
2170 break;
2171 case FORMAT_TYPE_BYTE:
2172 num = get_arg(signed char);
2173 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002174 case FORMAT_TYPE_USHORT:
2175 num = get_arg(unsigned short);
2176 break;
2177 case FORMAT_TYPE_SHORT:
2178 num = get_arg(short);
2179 break;
2180 case FORMAT_TYPE_UINT:
2181 num = get_arg(unsigned int);
2182 break;
2183 default:
2184 num = get_arg(int);
2185 }
2186
2187 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08002188 } /* default: */
2189 } /* switch(spec.type) */
2190 } /* while(*fmt) */
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002191
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002192 if (size > 0) {
2193 if (str < end)
2194 *str = '\0';
2195 else
2196 end[-1] = '\0';
2197 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002198
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002199#undef get_arg
2200
2201 /* the trailing null byte doesn't count towards the total */
2202 return str - buf;
2203}
2204EXPORT_SYMBOL_GPL(bstr_printf);
2205
2206/**
2207 * bprintf - Parse a format string and place args' binary value in a buffer
2208 * @bin_buf: The buffer to place args' binary value
2209 * @size: The size of the buffer(by words(32bits), not characters)
2210 * @fmt: The format string to use
2211 * @...: Arguments for the format string
2212 *
2213 * The function returns the number of words(u32) written
2214 * into @bin_buf.
2215 */
2216int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2217{
2218 va_list args;
2219 int ret;
2220
2221 va_start(args, fmt);
2222 ret = vbin_printf(bin_buf, size, fmt, args);
2223 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002224
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002225 return ret;
2226}
2227EXPORT_SYMBOL_GPL(bprintf);
2228
2229#endif /* CONFIG_BINARY_PRINTF */
2230
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231/**
2232 * vsscanf - Unformat a buffer into a list of arguments
2233 * @buf: input buffer
2234 * @fmt: format of buffer
2235 * @args: arguments
2236 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002237int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238{
2239 const char *str = buf;
2240 char *next;
2241 char digit;
2242 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08002243 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08002244 unsigned int base;
2245 union {
2246 long long s;
2247 unsigned long long u;
2248 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08002249 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002250 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251
Jan Beulichda990752012-10-04 17:13:24 -07002252 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 /* skip any white space in format */
2254 /* white space in format matchs any amount of
2255 * white space, including none, in the input.
2256 */
2257 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08002258 fmt = skip_spaces(++fmt);
2259 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 }
2261
2262 /* anything that is not a conversion must match exactly */
2263 if (*fmt != '%' && *fmt) {
2264 if (*fmt++ != *str++)
2265 break;
2266 continue;
2267 }
2268
2269 if (!*fmt)
2270 break;
2271 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002272
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 /* skip this conversion.
2274 * advance both strings to next white space
2275 */
2276 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07002277 if (!*str)
2278 break;
Andy Spencer8fccae22009-10-01 15:44:27 -07002279 while (!isspace(*fmt) && *fmt != '%' && *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 fmt++;
2281 while (!isspace(*str) && *str)
2282 str++;
2283 continue;
2284 }
2285
2286 /* get field width */
2287 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08002288 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08002290 if (field_width <= 0)
2291 break;
2292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293
2294 /* get conversion qualifier */
2295 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002296 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2297 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 qualifier = *fmt++;
2299 if (unlikely(qualifier == *fmt)) {
2300 if (qualifier == 'h') {
2301 qualifier = 'H';
2302 fmt++;
2303 } else if (qualifier == 'l') {
2304 qualifier = 'L';
2305 fmt++;
2306 }
2307 }
2308 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309
Jan Beulichda990752012-10-04 17:13:24 -07002310 if (!*fmt)
2311 break;
2312
2313 if (*fmt == 'n') {
2314 /* return number of characters read so far */
2315 *va_arg(args, int *) = str - buf;
2316 ++fmt;
2317 continue;
2318 }
2319
2320 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 break;
2322
André Goddard Rosad4be1512009-12-14 18:00:59 -08002323 base = 10;
2324 is_sign = 0;
2325
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002326 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 case 'c':
2328 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002329 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 if (field_width == -1)
2331 field_width = 1;
2332 do {
2333 *s++ = *str++;
2334 } while (--field_width > 0 && *str);
2335 num++;
2336 }
2337 continue;
2338 case 's':
2339 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002340 char *s = (char *)va_arg(args, char *);
2341 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07002342 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002344 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345
2346 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002347 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002348 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 *s = '\0';
2350 num++;
2351 }
2352 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353 case 'o':
2354 base = 8;
2355 break;
2356 case 'x':
2357 case 'X':
2358 base = 16;
2359 break;
2360 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002361 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 case 'd':
2363 is_sign = 1;
2364 case 'u':
2365 break;
2366 case '%':
2367 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002368 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 return num;
2370 continue;
2371 default:
2372 /* invalid format; stop here */
2373 return num;
2374 }
2375
2376 /* have some sort of integer conversion.
2377 * first, skip white space in buffer.
2378 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002379 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380
2381 digit = *str;
2382 if (is_sign && digit == '-')
2383 digit = *(str + 1);
2384
2385 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002386 || (base == 16 && !isxdigit(digit))
2387 || (base == 10 && !isdigit(digit))
2388 || (base == 8 && (!isdigit(digit) || digit > '7'))
2389 || (base == 0 && !isdigit(digit)))
2390 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002391
Jan Beulich53809752012-12-17 16:01:31 -08002392 if (is_sign)
2393 val.s = qualifier != 'L' ?
2394 simple_strtol(str, &next, base) :
2395 simple_strtoll(str, &next, base);
2396 else
2397 val.u = qualifier != 'L' ?
2398 simple_strtoul(str, &next, base) :
2399 simple_strtoull(str, &next, base);
2400
2401 if (field_width > 0 && next - str > field_width) {
2402 if (base == 0)
2403 _parse_integer_fixup_radix(str, &base);
2404 while (next - str > field_width) {
2405 if (is_sign)
2406 val.s = div_s64(val.s, base);
2407 else
2408 val.u = div_u64(val.u, base);
2409 --next;
2410 }
2411 }
2412
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002413 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002414 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08002415 if (is_sign)
2416 *va_arg(args, signed char *) = val.s;
2417 else
2418 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002419 break;
2420 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08002421 if (is_sign)
2422 *va_arg(args, short *) = val.s;
2423 else
2424 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 break;
2426 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08002427 if (is_sign)
2428 *va_arg(args, long *) = val.s;
2429 else
2430 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 break;
2432 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08002433 if (is_sign)
2434 *va_arg(args, long long *) = val.s;
2435 else
2436 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002437 break;
2438 case 'Z':
2439 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08002440 *va_arg(args, size_t *) = val.u;
2441 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 default:
Jan Beulich53809752012-12-17 16:01:31 -08002443 if (is_sign)
2444 *va_arg(args, int *) = val.s;
2445 else
2446 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 break;
2448 }
2449 num++;
2450
2451 if (!next)
2452 break;
2453 str = next;
2454 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002455
Linus Torvalds1da177e2005-04-16 15:20:36 -07002456 return num;
2457}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458EXPORT_SYMBOL(vsscanf);
2459
2460/**
2461 * sscanf - Unformat a buffer into a list of arguments
2462 * @buf: input buffer
2463 * @fmt: formatting of buffer
2464 * @...: resulting arguments
2465 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002466int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467{
2468 va_list args;
2469 int i;
2470
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002471 va_start(args, fmt);
2472 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002474
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 return i;
2476}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477EXPORT_SYMBOL(sscanf);