blob: 38e612e66da5993f7b1eb92065ebfec45216d83c [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>
20#include <linux/module.h>
21#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>
26#include <linux/uaccess.h>
Linus Torvalds332d2e72008-10-20 15:07:34 +110027#include <linux/ioport.h>
Joe Perches8a27f7c2009-08-17 12:29:44 +000028#include <net/addrconf.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Tim Schmielau4e57b682005-10-30 15:03:48 -080030#include <asm/page.h> /* for PAGE_SIZE */
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <asm/div64.h>
James Bottomleydeac93d2008-09-03 20:43:36 -050032#include <asm/sections.h> /* for dereference_function_descriptor() */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070034#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070035
Linus Torvalds1da177e2005-04-16 15:20:36 -070036/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 * simple_strtoull - convert a string to an unsigned long long
38 * @cp: The start of the string
39 * @endp: A pointer to the end of the parsed string will be placed here
40 * @base: The number base to use
41 */
Harvey Harrison22d27052008-10-16 13:40:35 -070042unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070044 unsigned long long result;
45 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070047 cp = _parse_integer_fixup_radix(cp, &base);
48 rv = _parse_integer(cp, base, &result);
49 /* FIXME */
50 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 if (endp)
53 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 return result;
56}
Linus Torvalds1da177e2005-04-16 15:20:36 -070057EXPORT_SYMBOL(simple_strtoull);
58
59/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080060 * simple_strtoul - convert a string to an unsigned long
61 * @cp: The start of the string
62 * @endp: A pointer to the end of the parsed string will be placed here
63 * @base: The number base to use
64 */
65unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
66{
67 return simple_strtoull(cp, endp, base);
68}
69EXPORT_SYMBOL(simple_strtoul);
70
71/**
72 * simple_strtol - convert a string to a signed long
73 * @cp: The start of the string
74 * @endp: A pointer to the end of the parsed string will be placed here
75 * @base: The number base to use
76 */
77long simple_strtol(const char *cp, char **endp, unsigned int base)
78{
79 if (*cp == '-')
80 return -simple_strtoul(cp + 1, endp, base);
81
82 return simple_strtoul(cp, endp, base);
83}
84EXPORT_SYMBOL(simple_strtol);
85
86/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * simple_strtoll - convert a string to a signed long long
88 * @cp: The start of the string
89 * @endp: A pointer to the end of the parsed string will be placed here
90 * @base: The number base to use
91 */
Harvey Harrison22d27052008-10-16 13:40:35 -070092long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080094 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -070095 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080096
Harvey Harrison22d27052008-10-16 13:40:35 -070097 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098}
Hans Verkuil98d5ce02010-04-23 13:18:04 -040099EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Joe Perchescf3b4292010-05-24 14:33:16 -0700101static noinline_for_stack
102int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800104 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106 while (isdigit(**s))
107 i = i*10 + *((*s)++) - '0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 return i;
110}
111
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700112/* Decimal conversion is by far the most typical, and is used
113 * for /proc and /sys data. This directly impacts e.g. top performance
114 * with many processes running. We optimize it for speed
115 * using code from
116 * http://www.cs.uiowa.edu/~jones/bcd/decimal.html
117 * (with permission from the author, Douglas W. Jones). */
118
119/* Formats correctly any integer in [0,99999].
120 * Outputs from one to five digits depending on input.
121 * On i386 gcc 4.1.2 -O2: ~250 bytes of code. */
Joe Perchescf3b4292010-05-24 14:33:16 -0700122static noinline_for_stack
123char *put_dec_trunc(char *buf, unsigned q)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700124{
125 unsigned d3, d2, d1, d0;
126 d1 = (q>>4) & 0xf;
127 d2 = (q>>8) & 0xf;
128 d3 = (q>>12);
129
130 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
131 q = (d0 * 0xcd) >> 11;
132 d0 = d0 - 10*q;
133 *buf++ = d0 + '0'; /* least significant digit */
134 d1 = q + 9*d3 + 5*d2 + d1;
135 if (d1 != 0) {
136 q = (d1 * 0xcd) >> 11;
137 d1 = d1 - 10*q;
138 *buf++ = d1 + '0'; /* next digit */
139
140 d2 = q + 2*d2;
141 if ((d2 != 0) || (d3 != 0)) {
142 q = (d2 * 0xd) >> 7;
143 d2 = d2 - 10*q;
144 *buf++ = d2 + '0'; /* next digit */
145
146 d3 = q + 4*d3;
147 if (d3 != 0) {
148 q = (d3 * 0xcd) >> 11;
149 d3 = d3 - 10*q;
150 *buf++ = d3 + '0'; /* next digit */
151 if (q != 0)
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800152 *buf++ = q + '0'; /* most sign. digit */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700153 }
154 }
155 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800156
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700157 return buf;
158}
159/* Same with if's removed. Always emits five digits */
Joe Perchescf3b4292010-05-24 14:33:16 -0700160static noinline_for_stack
161char *put_dec_full(char *buf, unsigned q)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700162{
163 /* BTW, if q is in [0,9999], 8-bit ints will be enough, */
164 /* but anyway, gcc produces better code with full-sized ints */
165 unsigned d3, d2, d1, d0;
166 d1 = (q>>4) & 0xf;
167 d2 = (q>>8) & 0xf;
168 d3 = (q>>12);
169
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800170 /*
171 * Possible ways to approx. divide by 10
172 * gcc -O2 replaces multiply with shifts and adds
173 * (x * 0xcd) >> 11: 11001101 - shorter code than * 0x67 (on i386)
174 * (x * 0x67) >> 10: 1100111
175 * (x * 0x34) >> 9: 110100 - same
176 * (x * 0x1a) >> 8: 11010 - same
177 * (x * 0x0d) >> 7: 1101 - same, shortest code (on i386)
178 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700179 d0 = 6*(d3 + d2 + d1) + (q & 0xf);
180 q = (d0 * 0xcd) >> 11;
181 d0 = d0 - 10*q;
182 *buf++ = d0 + '0';
183 d1 = q + 9*d3 + 5*d2 + d1;
184 q = (d1 * 0xcd) >> 11;
185 d1 = d1 - 10*q;
186 *buf++ = d1 + '0';
187
188 d2 = q + 2*d2;
189 q = (d2 * 0xd) >> 7;
190 d2 = d2 - 10*q;
191 *buf++ = d2 + '0';
192
193 d3 = q + 4*d3;
194 q = (d3 * 0xcd) >> 11; /* - shorter code */
195 /* q = (d3 * 0x67) >> 10; - would also work */
196 d3 = d3 - 10*q;
197 *buf++ = d3 + '0';
198 *buf++ = q + '0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800199
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700200 return buf;
201}
202/* No inlining helps gcc to use registers better */
Joe Perchescf3b4292010-05-24 14:33:16 -0700203static noinline_for_stack
204char *put_dec(char *buf, unsigned long long num)
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700205{
206 while (1) {
207 unsigned rem;
208 if (num < 100000)
209 return put_dec_trunc(buf, num);
210 rem = do_div(num, 100000);
211 buf = put_dec_full(buf, rem);
212 }
213}
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#define ZEROPAD 1 /* pad with zero */
216#define SIGN 2 /* unsigned/signed long */
217#define PLUS 4 /* show plus */
218#define SPACE 8 /* space if plus */
219#define LEFT 16 /* left justified */
Bjorn Helgaasb89dc5d2010-03-05 10:47:31 -0700220#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
221#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100223enum format_type {
224 FORMAT_TYPE_NONE, /* Just a string part */
Vegard Nossumed681a92009-03-14 12:08:50 +0100225 FORMAT_TYPE_WIDTH,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100226 FORMAT_TYPE_PRECISION,
227 FORMAT_TYPE_CHAR,
228 FORMAT_TYPE_STR,
229 FORMAT_TYPE_PTR,
230 FORMAT_TYPE_PERCENT_CHAR,
231 FORMAT_TYPE_INVALID,
232 FORMAT_TYPE_LONG_LONG,
233 FORMAT_TYPE_ULONG,
234 FORMAT_TYPE_LONG,
Zhaoleia4e94ef2009-03-27 17:07:05 +0800235 FORMAT_TYPE_UBYTE,
236 FORMAT_TYPE_BYTE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100237 FORMAT_TYPE_USHORT,
238 FORMAT_TYPE_SHORT,
239 FORMAT_TYPE_UINT,
240 FORMAT_TYPE_INT,
241 FORMAT_TYPE_NRCHARS,
242 FORMAT_TYPE_SIZE_T,
243 FORMAT_TYPE_PTRDIFF
244};
245
246struct printf_spec {
Joe Perches4e310fd2010-04-14 09:27:40 -0700247 u8 type; /* format_type enum */
Joe Perchesef0658f2010-03-06 17:10:14 -0800248 u8 flags; /* flags to number() */
Joe Perches4e310fd2010-04-14 09:27:40 -0700249 u8 base; /* number base, 8, 10 or 16 only */
250 u8 qualifier; /* number qualifier, one of 'hHlLtzZ' */
251 s16 field_width; /* width of output field */
252 s16 precision; /* # of digits/chars */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100253};
254
Joe Perchescf3b4292010-05-24 14:33:16 -0700255static noinline_for_stack
256char *number(char *buf, char *end, unsigned long long num,
257 struct printf_spec spec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258{
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100259 /* we are called with base 8, 10 or 16, only, thus don't need "G..." */
260 static const char digits[16] = "0123456789ABCDEF"; /* "GHIJKLMNOPQRSTUVWXYZ"; */
261
262 char tmp[66];
263 char sign;
264 char locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100265 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 int i;
267
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100268 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
269 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100270 locase = (spec.flags & SMALL);
271 if (spec.flags & LEFT)
272 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 sign = 0;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100274 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800275 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800277 num = -(signed long long)num;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100278 spec.field_width--;
279 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 sign = '+';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100281 spec.field_width--;
282 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 sign = ' ';
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100284 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 }
286 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700287 if (need_pfx) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100288 spec.field_width--;
289 if (spec.base == 16)
290 spec.field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700292
293 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 i = 0;
295 if (num == 0)
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700296 tmp[i++] = '0';
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700297 /* Generic code, for any base:
298 else do {
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100299 tmp[i++] = (digits[do_div(num,base)] | locase);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700300 } while (num != 0);
301 */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100302 else if (spec.base != 10) { /* 8 or 16 */
303 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700304 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800305
306 if (spec.base == 16)
307 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700308 do {
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100309 tmp[i++] = (digits[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700310 num >>= shift;
311 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700312 } else { /* base 10 */
313 i = put_dec(tmp, num) - tmp;
314 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700315
316 /* printing 100 using %2d gives "100", not "00" */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100317 if (i > spec.precision)
318 spec.precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700319 /* leading space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100320 spec.field_width -= spec.precision;
321 if (!(spec.flags & (ZEROPAD+LEFT))) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800322 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700323 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 *buf = ' ';
325 ++buf;
326 }
327 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700328 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700330 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 *buf = sign;
332 ++buf;
333 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700334 /* "0x" / "0" prefix */
335 if (need_pfx) {
336 if (buf < end)
337 *buf = '0';
338 ++buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100339 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700340 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100341 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 ++buf;
343 }
344 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700345 /* zero or space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100346 if (!(spec.flags & LEFT)) {
347 char c = (spec.flags & ZEROPAD) ? '0' : ' ';
348 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700349 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 *buf = c;
351 ++buf;
352 }
353 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700354 /* hmm even more zero padding? */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100355 while (i <= --spec.precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700356 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 *buf = '0';
358 ++buf;
359 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700360 /* actual digits of result */
361 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700362 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 *buf = tmp[i];
364 ++buf;
365 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700366 /* trailing space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100367 while (--spec.field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700368 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 *buf = ' ';
370 ++buf;
371 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 return buf;
374}
375
Joe Perchescf3b4292010-05-24 14:33:16 -0700376static noinline_for_stack
377char *string(char *buf, char *end, const char *s, struct printf_spec spec)
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700378{
379 int len, i;
380
381 if ((unsigned long)s < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -0800382 s = "(null)";
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700383
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100384 len = strnlen(s, spec.precision);
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700385
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100386 if (!(spec.flags & LEFT)) {
387 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700388 if (buf < end)
389 *buf = ' ';
390 ++buf;
391 }
392 }
393 for (i = 0; i < len; ++i) {
394 if (buf < end)
395 *buf = *s;
396 ++buf; ++s;
397 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100398 while (len < spec.field_width--) {
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700399 if (buf < end)
400 *buf = ' ';
401 ++buf;
402 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800403
Linus Torvalds0f9bfa52008-07-06 16:06:25 -0700404 return buf;
405}
406
Joe Perchescf3b4292010-05-24 14:33:16 -0700407static noinline_for_stack
408char *symbol_string(char *buf, char *end, void *ptr,
409 struct printf_spec spec, char ext)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700410{
411 unsigned long value = (unsigned long) ptr;
412#ifdef CONFIG_KALLSYMS
413 char sym[KSYM_SYMBOL_LEN];
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900414 if (ext == 'B')
415 sprint_backtrace(sym, value);
416 else if (ext != 'f' && ext != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200417 sprint_symbol(sym, value);
418 else
419 kallsyms_lookup(value, NULL, NULL, NULL, sym);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800420
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100421 return string(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700422#else
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800423 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100424 spec.flags |= SPECIAL | SMALL | ZEROPAD;
425 spec.base = 16;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800426
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100427 return number(buf, end, value, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700428#endif
429}
430
Joe Perchescf3b4292010-05-24 14:33:16 -0700431static noinline_for_stack
432char *resource_string(char *buf, char *end, struct resource *res,
433 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +1100434{
435#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600436#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +1100437#endif
438
439#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600440#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +1100441#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700442 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100443 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700444 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100445 .precision = -1,
446 .flags = SPECIAL | SMALL | ZEROPAD,
447 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700448 static const struct printf_spec mem_spec = {
449 .base = 16,
450 .field_width = MEM_RSRC_PRINTK_SIZE,
451 .precision = -1,
452 .flags = SPECIAL | SMALL | ZEROPAD,
453 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700454 static const struct printf_spec bus_spec = {
455 .base = 16,
456 .field_width = 2,
457 .precision = -1,
458 .flags = SMALL | ZEROPAD,
459 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700460 static const struct printf_spec dec_spec = {
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600461 .base = 10,
462 .precision = -1,
463 .flags = 0,
464 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700465 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600466 .field_width = -1,
467 .precision = 10,
468 .flags = LEFT,
469 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700470 static const struct printf_spec flag_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600471 .base = 16,
472 .precision = -1,
473 .flags = SPECIAL | SMALL,
474 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600475
476 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
477 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
478#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
479#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700480#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600481#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
482 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
483 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
484
Linus Torvalds332d2e72008-10-20 15:07:34 +1100485 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600486 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700487 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +1100488
489 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700490 if (res->flags & IORESOURCE_IO) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600491 p = string(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700492 specp = &io_spec;
493 } else if (res->flags & IORESOURCE_MEM) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600494 p = string(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700495 specp = &mem_spec;
496 } else if (res->flags & IORESOURCE_IRQ) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600497 p = string(p, pend, "irq ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700498 specp = &dec_spec;
499 } else if (res->flags & IORESOURCE_DMA) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600500 p = string(p, pend, "dma ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700501 specp = &dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700502 } else if (res->flags & IORESOURCE_BUS) {
503 p = string(p, pend, "bus ", str_spec);
504 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700505 } else {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600506 p = string(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700507 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600508 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600509 }
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700510 p = number(p, pend, res->start, *specp);
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600511 if (res->start != res->end) {
512 *p++ = '-';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700513 p = number(p, pend, res->end, *specp);
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600514 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600515 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600516 if (res->flags & IORESOURCE_MEM_64)
517 p = string(p, pend, " 64bit", str_spec);
518 if (res->flags & IORESOURCE_PREFETCH)
519 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700520 if (res->flags & IORESOURCE_WINDOW)
521 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600522 if (res->flags & IORESOURCE_DISABLED)
523 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600524 } else {
525 p = string(p, pend, " flags ", str_spec);
526 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600527 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100528 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600529 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100530
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100531 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100532}
533
Joe Perchescf3b4292010-05-24 14:33:16 -0700534static noinline_for_stack
535char *mac_address_string(char *buf, char *end, u8 *addr,
536 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700537{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000538 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700539 char *p = mac_addr;
540 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000541 char separator;
542
543 if (fmt[1] == 'F') { /* FDDI canonical format */
Joe Perchesbc7259a2010-01-07 11:43:50 +0000544 separator = '-';
545 } else {
Joe Perchesbc7259a2010-01-07 11:43:50 +0000546 separator = ':';
547 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700548
549 for (i = 0; i < 6; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700550 p = hex_byte_pack(p, addr[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000551 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000552 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700553 }
554 *p = '\0';
555
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100556 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700557}
558
Joe Perchescf3b4292010-05-24 14:33:16 -0700559static noinline_for_stack
560char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700561{
Harvey Harrison689afa72008-10-28 16:04:44 -0700562 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800563 bool leading_zeros = (fmt[0] == 'i');
564 int index;
565 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700566
Joe Perches0159f242010-01-13 20:23:30 -0800567 switch (fmt[2]) {
568 case 'h':
569#ifdef __BIG_ENDIAN
570 index = 0;
571 step = 1;
572#else
573 index = 3;
574 step = -1;
575#endif
576 break;
577 case 'l':
578 index = 3;
579 step = -1;
580 break;
581 case 'n':
582 case 'b':
583 default:
584 index = 0;
585 step = 1;
586 break;
587 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000588 for (i = 0; i < 4; i++) {
589 char temp[3]; /* hold each IP quad in reverse order */
Joe Perches0159f242010-01-13 20:23:30 -0800590 int digits = put_dec_trunc(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000591 if (leading_zeros) {
592 if (digits < 3)
593 *p++ = '0';
594 if (digits < 2)
595 *p++ = '0';
596 }
597 /* reverse the digits in the quad */
598 while (digits--)
599 *p++ = temp[digits];
600 if (i < 3)
601 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -0800602 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000603 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000604 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800605
Joe Perches8a27f7c2009-08-17 12:29:44 +0000606 return p;
607}
608
Joe Perchescf3b4292010-05-24 14:33:16 -0700609static noinline_for_stack
610char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000611{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800612 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000613 unsigned char zerolength[8];
614 int longest = 1;
615 int colonpos = -1;
616 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800617 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000618 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +0000619 bool useIPv4;
620 struct in6_addr in6;
621
622 memcpy(&in6, addr, sizeof(struct in6_addr));
623
624 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000625
626 memset(zerolength, 0, sizeof(zerolength));
627
628 if (useIPv4)
629 range = 6;
630 else
631 range = 8;
632
633 /* find position of longest 0 run */
634 for (i = 0; i < range; i++) {
635 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +0000636 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000637 break;
638 zerolength[i]++;
639 }
640 }
641 for (i = 0; i < range; i++) {
642 if (zerolength[i] > longest) {
643 longest = zerolength[i];
644 colonpos = i;
645 }
646 }
Joe Perches29cf5192011-06-09 11:23:37 -0700647 if (longest == 1) /* don't compress a single 0 */
648 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +0000649
650 /* emit address */
651 for (i = 0; i < range; i++) {
652 if (i == colonpos) {
653 if (needcolon || i == 0)
654 *p++ = ':';
655 *p++ = ':';
656 needcolon = false;
657 i += longest - 1;
658 continue;
659 }
660 if (needcolon) {
661 *p++ = ':';
662 needcolon = false;
663 }
664 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +0000665 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000666 hi = word >> 8;
667 lo = word & 0xff;
668 if (hi) {
669 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700670 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000671 else
672 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700673 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000674 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -0800675 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700676 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000677 else
678 *p++ = hex_asc_lo(lo);
679 needcolon = true;
680 }
681
682 if (useIPv4) {
683 if (needcolon)
684 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -0800685 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +0000686 }
Joe Perches8a27f7c2009-08-17 12:29:44 +0000687 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800688
Joe Perches8a27f7c2009-08-17 12:29:44 +0000689 return p;
690}
691
Joe Perchescf3b4292010-05-24 14:33:16 -0700692static noinline_for_stack
693char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000694{
695 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800696
Harvey Harrison689afa72008-10-28 16:04:44 -0700697 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700698 p = hex_byte_pack(p, *addr++);
699 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000700 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -0700701 *p++ = ':';
702 }
703 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800704
Joe Perches8a27f7c2009-08-17 12:29:44 +0000705 return p;
706}
707
Joe Perchescf3b4292010-05-24 14:33:16 -0700708static noinline_for_stack
709char *ip6_addr_string(char *buf, char *end, const u8 *addr,
710 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +0000711{
712 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
713
714 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +0000715 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000716 else
Joe Percheseb78cd22009-09-18 13:04:06 +0000717 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -0700718
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100719 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -0700720}
721
Joe Perchescf3b4292010-05-24 14:33:16 -0700722static noinline_for_stack
723char *ip4_addr_string(char *buf, char *end, const u8 *addr,
724 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -0700725{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000726 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -0700727
Joe Perches0159f242010-01-13 20:23:30 -0800728 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -0700729
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100730 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -0700731}
732
Joe Perchescf3b4292010-05-24 14:33:16 -0700733static noinline_for_stack
734char *uuid_string(char *buf, char *end, const u8 *addr,
735 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -0800736{
737 char uuid[sizeof("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")];
738 char *p = uuid;
739 int i;
740 static const u8 be[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
741 static const u8 le[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};
742 const u8 *index = be;
743 bool uc = false;
744
745 switch (*(++fmt)) {
746 case 'L':
747 uc = true; /* fall-through */
748 case 'l':
749 index = le;
750 break;
751 case 'B':
752 uc = true;
753 break;
754 }
755
756 for (i = 0; i < 16; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -0700757 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -0800758 switch (i) {
759 case 3:
760 case 5:
761 case 7:
762 case 9:
763 *p++ = '-';
764 break;
765 }
766 }
767
768 *p = 0;
769
770 if (uc) {
771 p = uuid;
772 do {
773 *p = toupper(*p);
774 } while (*(++p));
775 }
776
777 return string(buf, end, uuid, spec);
778}
779
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000780static
781char *netdev_feature_string(char *buf, char *end, const u8 *addr,
782 struct printf_spec spec)
783{
784 spec.flags |= SPECIAL | SMALL | ZEROPAD;
785 if (spec.field_width == -1)
786 spec.field_width = 2 + 2 * sizeof(netdev_features_t);
787 spec.base = 16;
788
789 return number(buf, end, *(const netdev_features_t *)addr, spec);
790}
791
Ingo Molnar411f05f2011-05-12 23:00:28 +0200792int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -0800793
Linus Torvalds4d8a7432008-07-06 16:24:57 -0700794/*
795 * Show a '%p' thing. A kernel extension is that the '%p' is followed
796 * by an extra set of alphanumeric characters that are extended format
797 * specifiers.
798 *
Linus Torvalds332d2e72008-10-20 15:07:34 +1100799 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700800 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200801 * - 'F' For symbolic function descriptor pointers with offset
802 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -0400803 * - 'S' For symbolic direct pointers with offset
804 * - 's' For symbolic direct pointers without offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900805 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600806 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
807 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700808 * - 'M' For a 6-byte MAC address, it prints the address in the
809 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +0000810 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +0000811 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -0800812 * with a dash-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +0000813 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
814 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
815 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
816 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
817 * IPv6 omits the colons (01020304...0f)
818 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Joe Perches0159f242010-01-13 20:23:30 -0800819 * - '[Ii]4[hnbl]' IPv4 addresses in host, network, big or little endian order
Joe Perches8a27f7c2009-08-17 12:29:44 +0000820 * - 'I6c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -0700821 * http://tools.ietf.org/html/rfc5952
Joe Perches9ac6e442009-12-14 18:01:09 -0800822 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
823 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
824 * Options for %pU are:
825 * b big endian lower case hex (default)
826 * B big endian UPPER case hex
827 * l little endian lower case hex
828 * L little endian UPPER case hex
829 * big endian output byte order is:
830 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
831 * little endian output byte order is:
832 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +0000833 * - 'V' For a struct va_format which contains a format string * and va_list *,
834 * call vsnprintf(->format, *->va_list).
835 * Implements a "recursive vsnprintf".
836 * Do not use this feature without some mechanism to verify the
837 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -0800838 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000839 * - 'NF' For a netdev_features_t
Joe Perches9ac6e442009-12-14 18:01:09 -0800840 *
Linus Torvalds332d2e72008-10-20 15:07:34 +1100841 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
842 * function pointers are really function descriptors, which contain a
843 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -0700844 */
Joe Perchescf3b4292010-05-24 14:33:16 -0700845static noinline_for_stack
846char *pointer(const char *fmt, char *buf, char *end, void *ptr,
847 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -0700848{
Kees Cook9f36e2c2011-03-22 16:34:22 -0700849 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -0700850 /*
851 * Print (null) with the same width as a pointer so it makes
852 * tabular output look nice.
853 */
854 if (spec.field_width == -1)
855 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100856 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -0700857 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -0800858
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700859 switch (*fmt) {
860 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200861 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700862 ptr = dereference_function_descriptor(ptr);
863 /* Fallthrough */
864 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -0800865 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900866 case 'B':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200867 return symbol_string(buf, end, ptr, spec, *fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100868 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600869 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600870 return resource_string(buf, end, ptr, spec, fmt);
Joe Perches8a27f7c2009-08-17 12:29:44 +0000871 case 'M': /* Colon separated: 00:01:02:03:04:05 */
872 case 'm': /* Contiguous: 000102030405 */
Joe Perchesbc7259a2010-01-07 11:43:50 +0000873 /* [mM]F (FDDI, bit reversed) */
Joe Perches8a27f7c2009-08-17 12:29:44 +0000874 return mac_address_string(buf, end, ptr, spec, fmt);
875 case 'I': /* Formatted IP supported
876 * 4: 1.2.3.4
877 * 6: 0001:0203:...:0708
878 * 6c: 1::708 or 1::1.2.3.4
879 */
880 case 'i': /* Contiguous:
881 * 4: 001.002.003.004
882 * 6: 000102...0f
883 */
884 switch (fmt[1]) {
885 case '6':
886 return ip6_addr_string(buf, end, ptr, spec, fmt);
887 case '4':
888 return ip4_addr_string(buf, end, ptr, spec, fmt);
889 }
Harvey Harrison4aa99602008-10-29 12:49:58 -0700890 break;
Joe Perches9ac6e442009-12-14 18:01:09 -0800891 case 'U':
892 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +0000893 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +0000894 {
895 va_list va;
896
897 va_copy(va, *((struct va_format *)ptr)->va);
898 buf += vsnprintf(buf, end > buf ? end - buf : 0,
899 ((struct va_format *)ptr)->fmt, va);
900 va_end(va);
901 return buf;
902 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -0800903 case 'K':
904 /*
905 * %pK cannot be used in IRQ context because its test
906 * for CAP_SYSLOG would be meaningless.
907 */
908 if (in_irq() || in_serving_softirq() || in_nmi()) {
909 if (spec.field_width == -1)
910 spec.field_width = 2 * sizeof(void *);
911 return string(buf, end, "pK-error", spec);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -0800912 }
Joe Perches26297602011-03-22 16:34:19 -0700913 if (!((kptr_restrict == 0) ||
914 (kptr_restrict == 1 &&
915 has_capability_noaudit(current, CAP_SYSLOG))))
916 ptr = NULL;
917 break;
Michał Mirosławc8f44af2011-11-15 15:29:55 +0000918 case 'N':
919 switch (fmt[1]) {
920 case 'F':
921 return netdev_feature_string(buf, end, ptr, spec);
922 }
923 break;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700924 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100925 spec.flags |= SMALL;
926 if (spec.field_width == -1) {
Joe Perches5e057982010-10-26 14:22:50 -0700927 spec.field_width = 2 * sizeof(void *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100928 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -0700929 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100930 spec.base = 16;
931
932 return number(buf, end, (unsigned long) ptr, spec);
933}
934
935/*
936 * Helper function to decode printf style format.
937 * Each call decode a token from the format and return the
938 * number of characters read (or likely the delta where it wants
939 * to go on the next call).
940 * The decoded token is returned through the parameters
941 *
942 * 'h', 'l', or 'L' for integer fields
943 * 'z' support added 23/7/1999 S.H.
944 * 'z' changed to 'Z' --davidm 1/25/99
945 * 't' added for ptrdiff_t
946 *
947 * @fmt: the format string
948 * @type of the token returned
949 * @flags: various flags such as +, -, # tokens..
950 * @field_width: overwritten width
951 * @base: base of the number (octal, hex, ...)
952 * @precision: precision of a number
953 * @qualifier: qualifier of a number (long, size_t, ...)
954 */
Joe Perchescf3b4292010-05-24 14:33:16 -0700955static noinline_for_stack
956int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100957{
958 const char *start = fmt;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100959
960 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +0100961 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100962 if (spec->field_width < 0) {
963 spec->field_width = -spec->field_width;
964 spec->flags |= LEFT;
965 }
966 spec->type = FORMAT_TYPE_NONE;
967 goto precision;
968 }
969
970 /* we finished early by reading the precision */
971 if (spec->type == FORMAT_TYPE_PRECISION) {
972 if (spec->precision < 0)
973 spec->precision = 0;
974
975 spec->type = FORMAT_TYPE_NONE;
976 goto qualifier;
977 }
978
979 /* By default */
980 spec->type = FORMAT_TYPE_NONE;
981
982 for (; *fmt ; ++fmt) {
983 if (*fmt == '%')
984 break;
985 }
986
987 /* Return the current non-format string */
988 if (fmt != start || !*fmt)
989 return fmt - start;
990
991 /* Process flags */
992 spec->flags = 0;
993
994 while (1) { /* this also skips first '%' */
995 bool found = true;
996
997 ++fmt;
998
999 switch (*fmt) {
1000 case '-': spec->flags |= LEFT; break;
1001 case '+': spec->flags |= PLUS; break;
1002 case ' ': spec->flags |= SPACE; break;
1003 case '#': spec->flags |= SPECIAL; break;
1004 case '0': spec->flags |= ZEROPAD; break;
1005 default: found = false;
1006 }
1007
1008 if (!found)
1009 break;
1010 }
1011
1012 /* get field width */
1013 spec->field_width = -1;
1014
1015 if (isdigit(*fmt))
1016 spec->field_width = skip_atoi(&fmt);
1017 else if (*fmt == '*') {
1018 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001019 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001020 return ++fmt - start;
1021 }
1022
1023precision:
1024 /* get the precision */
1025 spec->precision = -1;
1026 if (*fmt == '.') {
1027 ++fmt;
1028 if (isdigit(*fmt)) {
1029 spec->precision = skip_atoi(&fmt);
1030 if (spec->precision < 0)
1031 spec->precision = 0;
1032 } else if (*fmt == '*') {
1033 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001034 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001035 return ++fmt - start;
1036 }
1037 }
1038
1039qualifier:
1040 /* get the conversion qualifier */
1041 spec->qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001042 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1043 _tolower(*fmt) == 'z' || *fmt == 't') {
Zhaoleia4e94ef2009-03-27 17:07:05 +08001044 spec->qualifier = *fmt++;
1045 if (unlikely(spec->qualifier == *fmt)) {
1046 if (spec->qualifier == 'l') {
1047 spec->qualifier = 'L';
1048 ++fmt;
1049 } else if (spec->qualifier == 'h') {
1050 spec->qualifier = 'H';
1051 ++fmt;
1052 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001053 }
1054 }
1055
1056 /* default base */
1057 spec->base = 10;
1058 switch (*fmt) {
1059 case 'c':
1060 spec->type = FORMAT_TYPE_CHAR;
1061 return ++fmt - start;
1062
1063 case 's':
1064 spec->type = FORMAT_TYPE_STR;
1065 return ++fmt - start;
1066
1067 case 'p':
1068 spec->type = FORMAT_TYPE_PTR;
1069 return fmt - start;
1070 /* skip alnum */
1071
1072 case 'n':
1073 spec->type = FORMAT_TYPE_NRCHARS;
1074 return ++fmt - start;
1075
1076 case '%':
1077 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1078 return ++fmt - start;
1079
1080 /* integer number formats - set up the flags and "break" */
1081 case 'o':
1082 spec->base = 8;
1083 break;
1084
1085 case 'x':
1086 spec->flags |= SMALL;
1087
1088 case 'X':
1089 spec->base = 16;
1090 break;
1091
1092 case 'd':
1093 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001094 spec->flags |= SIGN;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001095 case 'u':
1096 break;
1097
1098 default:
1099 spec->type = FORMAT_TYPE_INVALID;
1100 return fmt - start;
1101 }
1102
1103 if (spec->qualifier == 'L')
1104 spec->type = FORMAT_TYPE_LONG_LONG;
1105 else if (spec->qualifier == 'l') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001106 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001107 spec->type = FORMAT_TYPE_LONG;
1108 else
1109 spec->type = FORMAT_TYPE_ULONG;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001110 } else if (_tolower(spec->qualifier) == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001111 spec->type = FORMAT_TYPE_SIZE_T;
1112 } else if (spec->qualifier == 't') {
1113 spec->type = FORMAT_TYPE_PTRDIFF;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001114 } else if (spec->qualifier == 'H') {
1115 if (spec->flags & SIGN)
1116 spec->type = FORMAT_TYPE_BYTE;
1117 else
1118 spec->type = FORMAT_TYPE_UBYTE;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001119 } else if (spec->qualifier == 'h') {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001120 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001121 spec->type = FORMAT_TYPE_SHORT;
1122 else
1123 spec->type = FORMAT_TYPE_USHORT;
1124 } else {
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001125 if (spec->flags & SIGN)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001126 spec->type = FORMAT_TYPE_INT;
1127 else
1128 spec->type = FORMAT_TYPE_UINT;
1129 }
1130
1131 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001132}
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134/**
1135 * vsnprintf - Format a string and place it in a buffer
1136 * @buf: The buffer to place the result into
1137 * @size: The size of the buffer, including the trailing null space
1138 * @fmt: The format string to use
1139 * @args: Arguments for the format string
1140 *
Andi Kleen20036fd2008-10-15 22:02:02 -07001141 * This function follows C99 vsnprintf, but has some extensions:
Steven Rostedt91adcd22009-09-16 20:03:06 -04001142 * %pS output the name of a text symbol with offset
1143 * %ps output the name of a text symbol without offset
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001144 * %pF output the name of a function pointer with its offset
1145 * %pf output the name of a function pointer without its offset
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001146 * %pB output the name of a backtrace symbol with its offset
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001147 * %pR output the address range in a struct resource with decoded flags
1148 * %pr output the address range in a struct resource with raw flags
1149 * %pM output a 6-byte MAC address with colons
1150 * %pm output a 6-byte MAC address without colons
1151 * %pI4 print an IPv4 address without leading zeros
1152 * %pi4 print an IPv4 address with leading zeros
1153 * %pI6 print an IPv6 address with colons
1154 * %pi6 print an IPv6 address without colons
Jan Engelhardtf996f202011-07-14 18:48:56 +02001155 * %pI6c print an IPv6 address as specified by RFC 5952
Uwe Kleine-König8a795032009-12-17 15:27:12 -08001156 * %pU[bBlL] print a UUID/GUID in big or little endian using lower or upper
1157 * case.
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001158 * %n is ignored
Andi Kleen20036fd2008-10-15 22:02:02 -07001159 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 * The return value is the number of characters which would
1161 * be generated for the given input, excluding the trailing
1162 * '\0', as per ISO C99. If you want to have the exact
1163 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001164 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 * return is greater than or equal to @size, the resulting
1166 * string is truncated.
1167 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001168 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 */
1170int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1171{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001173 char *str, *end;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001174 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001176 /* Reject out-of-range values early. Large positive sizes are
1177 used for unknown buffer sizes. */
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07001178 if (WARN_ON_ONCE((int) size < 0))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
1181 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001182 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001184 /* Make sure end is always >= buf */
1185 if (end < buf) {
1186 end = ((void *)-1);
1187 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 }
1189
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001190 while (*fmt) {
1191 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001192 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001193
1194 fmt += read;
1195
1196 switch (spec.type) {
1197 case FORMAT_TYPE_NONE: {
1198 int copy = read;
1199 if (str < end) {
1200 if (copy > end - str)
1201 copy = end - str;
1202 memcpy(str, old_fmt, copy);
1203 }
1204 str += read;
1205 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206 }
1207
Vegard Nossumed681a92009-03-14 12:08:50 +01001208 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001209 spec.field_width = va_arg(args, int);
1210 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001212 case FORMAT_TYPE_PRECISION:
1213 spec.precision = va_arg(args, int);
1214 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
André Goddard Rosad4be1512009-12-14 18:00:59 -08001216 case FORMAT_TYPE_CHAR: {
1217 char c;
1218
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001219 if (!(spec.flags & LEFT)) {
1220 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001221 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 *str = ' ';
1223 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001224
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001226 }
1227 c = (unsigned char) va_arg(args, int);
1228 if (str < end)
1229 *str = c;
1230 ++str;
1231 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001232 if (str < end)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001233 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001235 }
1236 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001237 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001239 case FORMAT_TYPE_STR:
1240 str = string(str, end, va_arg(args, char *), spec);
1241 break;
1242
1243 case FORMAT_TYPE_PTR:
1244 str = pointer(fmt+1, str, end, va_arg(args, void *),
1245 spec);
1246 while (isalnum(*fmt))
1247 fmt++;
1248 break;
1249
1250 case FORMAT_TYPE_PERCENT_CHAR:
1251 if (str < end)
1252 *str = '%';
1253 ++str;
1254 break;
1255
1256 case FORMAT_TYPE_INVALID:
1257 if (str < end)
1258 *str = '%';
1259 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001260 break;
1261
1262 case FORMAT_TYPE_NRCHARS: {
Joe Perchesef0658f2010-03-06 17:10:14 -08001263 u8 qualifier = spec.qualifier;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001264
1265 if (qualifier == 'l') {
1266 long *ip = va_arg(args, long *);
1267 *ip = (str - buf);
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001268 } else if (_tolower(qualifier) == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001269 size_t *ip = va_arg(args, size_t *);
1270 *ip = (str - buf);
1271 } else {
1272 int *ip = va_arg(args, int *);
1273 *ip = (str - buf);
1274 }
1275 break;
1276 }
1277
1278 default:
1279 switch (spec.type) {
1280 case FORMAT_TYPE_LONG_LONG:
1281 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001283 case FORMAT_TYPE_ULONG:
1284 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001286 case FORMAT_TYPE_LONG:
1287 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001289 case FORMAT_TYPE_SIZE_T:
1290 num = va_arg(args, size_t);
1291 break;
1292 case FORMAT_TYPE_PTRDIFF:
1293 num = va_arg(args, ptrdiff_t);
1294 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001295 case FORMAT_TYPE_UBYTE:
1296 num = (unsigned char) va_arg(args, int);
1297 break;
1298 case FORMAT_TYPE_BYTE:
1299 num = (signed char) va_arg(args, int);
1300 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001301 case FORMAT_TYPE_USHORT:
1302 num = (unsigned short) va_arg(args, int);
1303 break;
1304 case FORMAT_TYPE_SHORT:
1305 num = (short) va_arg(args, int);
1306 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001307 case FORMAT_TYPE_INT:
1308 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001309 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001311 num = va_arg(args, unsigned int);
1312 }
1313
1314 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001317
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001318 if (size > 0) {
1319 if (str < end)
1320 *str = '\0';
1321 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07001322 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001323 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001324
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001325 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 return str-buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001327
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329EXPORT_SYMBOL(vsnprintf);
1330
1331/**
1332 * vscnprintf - Format a string and place it in a buffer
1333 * @buf: The buffer to place the result into
1334 * @size: The size of the buffer, including the trailing null space
1335 * @fmt: The format string to use
1336 * @args: Arguments for the format string
1337 *
1338 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08001339 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 * returns 0.
1341 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001342 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001343 *
1344 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 */
1346int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
1347{
1348 int i;
1349
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001350 i = vsnprintf(buf, size, fmt, args);
1351
Anton Arapovb921c692011-01-12 16:59:49 -08001352 if (likely(i < size))
1353 return i;
1354 if (size != 0)
1355 return size - 1;
1356 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358EXPORT_SYMBOL(vscnprintf);
1359
1360/**
1361 * snprintf - Format a string and place it in a buffer
1362 * @buf: The buffer to place the result into
1363 * @size: The size of the buffer, including the trailing null space
1364 * @fmt: The format string to use
1365 * @...: Arguments for the format string
1366 *
1367 * The return value is the number of characters which would be
1368 * generated for the given input, excluding the trailing null,
1369 * as per ISO C99. If the return is greater than or equal to
1370 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07001371 *
1372 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001374int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375{
1376 va_list args;
1377 int i;
1378
1379 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001380 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 return i;
1384}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385EXPORT_SYMBOL(snprintf);
1386
1387/**
1388 * scnprintf - Format a string and place it in a buffer
1389 * @buf: The buffer to place the result into
1390 * @size: The size of the buffer, including the trailing null space
1391 * @fmt: The format string to use
1392 * @...: Arguments for the format string
1393 *
1394 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07001395 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 */
1397
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001398int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399{
1400 va_list args;
1401 int i;
1402
1403 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08001404 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001406
Anton Arapovb921c692011-01-12 16:59:49 -08001407 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408}
1409EXPORT_SYMBOL(scnprintf);
1410
1411/**
1412 * vsprintf - Format a string and place it in a buffer
1413 * @buf: The buffer to place the result into
1414 * @fmt: The format string to use
1415 * @args: Arguments for the format string
1416 *
1417 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001418 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 * buffer overflows.
1420 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001421 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07001422 *
1423 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 */
1425int vsprintf(char *buf, const char *fmt, va_list args)
1426{
1427 return vsnprintf(buf, INT_MAX, fmt, args);
1428}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429EXPORT_SYMBOL(vsprintf);
1430
1431/**
1432 * sprintf - Format a string and place it in a buffer
1433 * @buf: The buffer to place the result into
1434 * @fmt: The format string to use
1435 * @...: Arguments for the format string
1436 *
1437 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001438 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07001440 *
1441 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001443int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444{
1445 va_list args;
1446 int i;
1447
1448 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001449 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001451
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 return i;
1453}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454EXPORT_SYMBOL(sprintf);
1455
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001456#ifdef CONFIG_BINARY_PRINTF
1457/*
1458 * bprintf service:
1459 * vbin_printf() - VA arguments to binary data
1460 * bstr_printf() - Binary data to text string
1461 */
1462
1463/**
1464 * vbin_printf - Parse a format string and place args' binary value in a buffer
1465 * @bin_buf: The buffer to place args' binary value
1466 * @size: The size of the buffer(by words(32bits), not characters)
1467 * @fmt: The format string to use
1468 * @args: Arguments for the format string
1469 *
1470 * The format follows C99 vsnprintf, except %n is ignored, and its argument
1471 * is skiped.
1472 *
1473 * The return value is the number of words(32bits) which would be generated for
1474 * the given input.
1475 *
1476 * NOTE:
1477 * If the return value is greater than @size, the resulting bin_buf is NOT
1478 * valid for bstr_printf().
1479 */
1480int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
1481{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001482 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001483 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001484
1485 str = (char *)bin_buf;
1486 end = (char *)(bin_buf + size);
1487
1488#define save_arg(type) \
1489do { \
1490 if (sizeof(type) == 8) { \
1491 unsigned long long value; \
1492 str = PTR_ALIGN(str, sizeof(u32)); \
1493 value = va_arg(args, unsigned long long); \
1494 if (str + sizeof(type) <= end) { \
1495 *(u32 *)str = *(u32 *)&value; \
1496 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
1497 } \
1498 } else { \
1499 unsigned long value; \
1500 str = PTR_ALIGN(str, sizeof(type)); \
1501 value = va_arg(args, int); \
1502 if (str + sizeof(type) <= end) \
1503 *(typeof(type) *)str = (type)value; \
1504 } \
1505 str += sizeof(type); \
1506} while (0)
1507
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001508 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08001509 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001510
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001511 fmt += read;
1512
1513 switch (spec.type) {
1514 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08001515 case FORMAT_TYPE_INVALID:
1516 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001517 break;
1518
Vegard Nossumed681a92009-03-14 12:08:50 +01001519 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001520 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001521 save_arg(int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001522 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001523
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001524 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001525 save_arg(char);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001526 break;
1527
1528 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001529 const char *save_str = va_arg(args, char *);
1530 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08001531
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001532 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
1533 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08001534 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08001535 len = strlen(save_str) + 1;
1536 if (str + len < end)
1537 memcpy(str, save_str, len);
1538 str += len;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001539 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001540 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001541
1542 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001543 save_arg(void *);
1544 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001545 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001546 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001547 break;
1548
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001549 case FORMAT_TYPE_NRCHARS: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001550 /* skip %n 's argument */
Joe Perchesef0658f2010-03-06 17:10:14 -08001551 u8 qualifier = spec.qualifier;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001552 void *skip_arg;
1553 if (qualifier == 'l')
1554 skip_arg = va_arg(args, long *);
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001555 else if (_tolower(qualifier) == 'z')
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001556 skip_arg = va_arg(args, size_t *);
1557 else
1558 skip_arg = va_arg(args, int *);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001559 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001560 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001561
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001562 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001563 switch (spec.type) {
1564
1565 case FORMAT_TYPE_LONG_LONG:
1566 save_arg(long long);
1567 break;
1568 case FORMAT_TYPE_ULONG:
1569 case FORMAT_TYPE_LONG:
1570 save_arg(unsigned long);
1571 break;
1572 case FORMAT_TYPE_SIZE_T:
1573 save_arg(size_t);
1574 break;
1575 case FORMAT_TYPE_PTRDIFF:
1576 save_arg(ptrdiff_t);
1577 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001578 case FORMAT_TYPE_UBYTE:
1579 case FORMAT_TYPE_BYTE:
1580 save_arg(char);
1581 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001582 case FORMAT_TYPE_USHORT:
1583 case FORMAT_TYPE_SHORT:
1584 save_arg(short);
1585 break;
1586 default:
1587 save_arg(int);
1588 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001589 }
1590 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001591
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001592 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001593#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001594}
1595EXPORT_SYMBOL_GPL(vbin_printf);
1596
1597/**
1598 * bstr_printf - Format a string from binary arguments and place it in a buffer
1599 * @buf: The buffer to place the result into
1600 * @size: The size of the buffer, including the trailing null space
1601 * @fmt: The format string to use
1602 * @bin_buf: Binary arguments for the format string
1603 *
1604 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
1605 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
1606 * a binary buffer that generated by vbin_printf.
1607 *
1608 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001609 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001610 *
1611 * The return value is the number of characters which would
1612 * be generated for the given input, excluding the trailing
1613 * '\0', as per ISO C99. If you want to have the exact
1614 * number of characters written into @buf as return value
1615 * (not including the trailing '\0'), use vscnprintf(). If the
1616 * return is greater than or equal to @size, the resulting
1617 * string is truncated.
1618 */
1619int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
1620{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001621 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08001622 char *str, *end;
1623 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001624
Marcin Slusarz2f30b1f92009-09-21 17:04:29 -07001625 if (WARN_ON_ONCE((int) size < 0))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001626 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001627
1628 str = buf;
1629 end = buf + size;
1630
1631#define get_arg(type) \
1632({ \
1633 typeof(type) value; \
1634 if (sizeof(type) == 8) { \
1635 args = PTR_ALIGN(args, sizeof(u32)); \
1636 *(u32 *)&value = *(u32 *)args; \
1637 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
1638 } else { \
1639 args = PTR_ALIGN(args, sizeof(type)); \
1640 value = *(typeof(type) *)args; \
1641 } \
1642 args += sizeof(type); \
1643 value; \
1644})
1645
1646 /* Make sure end is always >= buf */
1647 if (end < buf) {
1648 end = ((void *)-1);
1649 size = end - buf;
1650 }
1651
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001652 while (*fmt) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001653 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001654 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001655
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001656 fmt += read;
1657
1658 switch (spec.type) {
1659 case FORMAT_TYPE_NONE: {
1660 int copy = read;
1661 if (str < end) {
1662 if (copy > end - str)
1663 copy = end - str;
1664 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001665 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001666 str += read;
1667 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001668 }
1669
Vegard Nossumed681a92009-03-14 12:08:50 +01001670 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001671 spec.field_width = get_arg(int);
1672 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001673
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001674 case FORMAT_TYPE_PRECISION:
1675 spec.precision = get_arg(int);
1676 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001677
André Goddard Rosad4be1512009-12-14 18:00:59 -08001678 case FORMAT_TYPE_CHAR: {
1679 char c;
1680
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001681 if (!(spec.flags & LEFT)) {
1682 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001683 if (str < end)
1684 *str = ' ';
1685 ++str;
1686 }
1687 }
1688 c = (unsigned char) get_arg(char);
1689 if (str < end)
1690 *str = c;
1691 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001692 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001693 if (str < end)
1694 *str = ' ';
1695 ++str;
1696 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001697 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001698 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001699
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001700 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001701 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001702 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001703 str = string(str, end, (char *)str_arg, spec);
1704 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001705 }
1706
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001707 case FORMAT_TYPE_PTR:
1708 str = pointer(fmt+1, str, end, get_arg(void *), spec);
1709 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001710 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001711 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001712
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001713 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001714 case FORMAT_TYPE_INVALID:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001715 if (str < end)
1716 *str = '%';
1717 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001718 break;
1719
1720 case FORMAT_TYPE_NRCHARS:
1721 /* skip */
1722 break;
1723
André Goddard Rosad4be1512009-12-14 18:00:59 -08001724 default: {
1725 unsigned long long num;
1726
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001727 switch (spec.type) {
1728
1729 case FORMAT_TYPE_LONG_LONG:
1730 num = get_arg(long long);
1731 break;
1732 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001733 case FORMAT_TYPE_LONG:
1734 num = get_arg(unsigned long);
1735 break;
1736 case FORMAT_TYPE_SIZE_T:
1737 num = get_arg(size_t);
1738 break;
1739 case FORMAT_TYPE_PTRDIFF:
1740 num = get_arg(ptrdiff_t);
1741 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08001742 case FORMAT_TYPE_UBYTE:
1743 num = get_arg(unsigned char);
1744 break;
1745 case FORMAT_TYPE_BYTE:
1746 num = get_arg(signed char);
1747 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001748 case FORMAT_TYPE_USHORT:
1749 num = get_arg(unsigned short);
1750 break;
1751 case FORMAT_TYPE_SHORT:
1752 num = get_arg(short);
1753 break;
1754 case FORMAT_TYPE_UINT:
1755 num = get_arg(unsigned int);
1756 break;
1757 default:
1758 num = get_arg(int);
1759 }
1760
1761 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08001762 } /* default: */
1763 } /* switch(spec.type) */
1764 } /* while(*fmt) */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001765
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001766 if (size > 0) {
1767 if (str < end)
1768 *str = '\0';
1769 else
1770 end[-1] = '\0';
1771 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001772
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001773#undef get_arg
1774
1775 /* the trailing null byte doesn't count towards the total */
1776 return str - buf;
1777}
1778EXPORT_SYMBOL_GPL(bstr_printf);
1779
1780/**
1781 * bprintf - Parse a format string and place args' binary value in a buffer
1782 * @bin_buf: The buffer to place args' binary value
1783 * @size: The size of the buffer(by words(32bits), not characters)
1784 * @fmt: The format string to use
1785 * @...: Arguments for the format string
1786 *
1787 * The function returns the number of words(u32) written
1788 * into @bin_buf.
1789 */
1790int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
1791{
1792 va_list args;
1793 int ret;
1794
1795 va_start(args, fmt);
1796 ret = vbin_printf(bin_buf, size, fmt, args);
1797 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001798
Lai Jiangshan4370aa42009-03-06 17:21:46 +01001799 return ret;
1800}
1801EXPORT_SYMBOL_GPL(bprintf);
1802
1803#endif /* CONFIG_BINARY_PRINTF */
1804
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805/**
1806 * vsscanf - Unformat a buffer into a list of arguments
1807 * @buf: input buffer
1808 * @fmt: format of buffer
1809 * @args: arguments
1810 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001811int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812{
1813 const char *str = buf;
1814 char *next;
1815 char digit;
1816 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08001817 u8 qualifier;
1818 u8 base;
1819 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001820 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001822 while (*fmt && *str) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 /* skip any white space in format */
1824 /* white space in format matchs any amount of
1825 * white space, including none, in the input.
1826 */
1827 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08001828 fmt = skip_spaces(++fmt);
1829 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 }
1831
1832 /* anything that is not a conversion must match exactly */
1833 if (*fmt != '%' && *fmt) {
1834 if (*fmt++ != *str++)
1835 break;
1836 continue;
1837 }
1838
1839 if (!*fmt)
1840 break;
1841 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001842
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 /* skip this conversion.
1844 * advance both strings to next white space
1845 */
1846 if (*fmt == '*') {
Andy Spencer8fccae22009-10-01 15:44:27 -07001847 while (!isspace(*fmt) && *fmt != '%' && *fmt)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 fmt++;
1849 while (!isspace(*str) && *str)
1850 str++;
1851 continue;
1852 }
1853
1854 /* get field width */
1855 field_width = -1;
1856 if (isdigit(*fmt))
1857 field_width = skip_atoi(&fmt);
1858
1859 /* get conversion qualifier */
1860 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001861 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1862 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 qualifier = *fmt++;
1864 if (unlikely(qualifier == *fmt)) {
1865 if (qualifier == 'h') {
1866 qualifier = 'H';
1867 fmt++;
1868 } else if (qualifier == 'l') {
1869 qualifier = 'L';
1870 fmt++;
1871 }
1872 }
1873 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001874
1875 if (!*fmt || !*str)
1876 break;
1877
André Goddard Rosad4be1512009-12-14 18:00:59 -08001878 base = 10;
1879 is_sign = 0;
1880
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001881 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 case 'c':
1883 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001884 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 if (field_width == -1)
1886 field_width = 1;
1887 do {
1888 *s++ = *str++;
1889 } while (--field_width > 0 && *str);
1890 num++;
1891 }
1892 continue;
1893 case 's':
1894 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001895 char *s = (char *)va_arg(args, char *);
1896 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07001897 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08001899 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900
1901 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001902 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 *s = '\0';
1905 num++;
1906 }
1907 continue;
1908 case 'n':
1909 /* return number of characters read so far */
1910 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001911 int *i = (int *)va_arg(args, int*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 *i = str - buf;
1913 }
1914 continue;
1915 case 'o':
1916 base = 8;
1917 break;
1918 case 'x':
1919 case 'X':
1920 base = 16;
1921 break;
1922 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001923 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 case 'd':
1925 is_sign = 1;
1926 case 'u':
1927 break;
1928 case '%':
1929 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001930 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 return num;
1932 continue;
1933 default:
1934 /* invalid format; stop here */
1935 return num;
1936 }
1937
1938 /* have some sort of integer conversion.
1939 * first, skip white space in buffer.
1940 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08001941 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
1943 digit = *str;
1944 if (is_sign && digit == '-')
1945 digit = *(str + 1);
1946
1947 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001948 || (base == 16 && !isxdigit(digit))
1949 || (base == 10 && !isdigit(digit))
1950 || (base == 8 && (!isdigit(digit) || digit > '7'))
1951 || (base == 0 && !isdigit(digit)))
1952 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001954 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 case 'H': /* that's 'hh' in format */
1956 if (is_sign) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001957 signed char *s = (signed char *)va_arg(args, signed char *);
1958 *s = (signed char)simple_strtol(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 } else {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001960 unsigned char *s = (unsigned char *)va_arg(args, unsigned char *);
1961 *s = (unsigned char)simple_strtoul(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962 }
1963 break;
1964 case 'h':
1965 if (is_sign) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001966 short *s = (short *)va_arg(args, short *);
1967 *s = (short)simple_strtol(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 } else {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001969 unsigned short *s = (unsigned short *)va_arg(args, unsigned short *);
1970 *s = (unsigned short)simple_strtoul(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 }
1972 break;
1973 case 'l':
1974 if (is_sign) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001975 long *l = (long *)va_arg(args, long *);
1976 *l = simple_strtol(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 } else {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001978 unsigned long *l = (unsigned long *)va_arg(args, unsigned long *);
1979 *l = simple_strtoul(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 }
1981 break;
1982 case 'L':
1983 if (is_sign) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001984 long long *l = (long long *)va_arg(args, long long *);
1985 *l = simple_strtoll(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 } else {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001987 unsigned long long *l = (unsigned long long *)va_arg(args, unsigned long long *);
1988 *l = simple_strtoull(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 }
1990 break;
1991 case 'Z':
1992 case 'z':
1993 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001994 size_t *s = (size_t *)va_arg(args, size_t *);
1995 *s = (size_t)simple_strtoul(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 }
1997 break;
1998 default:
1999 if (is_sign) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002000 int *i = (int *)va_arg(args, int *);
2001 *i = (int)simple_strtol(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 } else {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002003 unsigned int *i = (unsigned int *)va_arg(args, unsigned int*);
2004 *i = (unsigned int)simple_strtoul(str, &next, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 }
2006 break;
2007 }
2008 num++;
2009
2010 if (!next)
2011 break;
2012 str = next;
2013 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002014
2015 /*
2016 * Now we've come all the way through so either the input string or the
2017 * format ended. In the former case, there can be a %n at the current
2018 * position in the format that needs to be filled.
2019 */
2020 if (*fmt == '%' && *(fmt + 1) == 'n') {
2021 int *p = (int *)va_arg(args, int *);
2022 *p = str - buf;
2023 }
2024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 return num;
2026}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027EXPORT_SYMBOL(vsscanf);
2028
2029/**
2030 * sscanf - Unformat a buffer into a list of arguments
2031 * @buf: input buffer
2032 * @fmt: formatting of buffer
2033 * @...: resulting arguments
2034 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002035int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036{
2037 va_list args;
2038 int i;
2039
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002040 va_start(args, fmt);
2041 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002043
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044 return i;
2045}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046EXPORT_SYMBOL(sscanf);