blob: 0967771d8f7fd725972c74097bd324a8b39b5609 [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>
Stephen Boyd0d1d7a52015-06-19 15:00:46 -070020#include <linux/clk.h>
Geert Uytterhoeven900cca22015-04-15 16:17:20 -070021#include <linux/clk-provider.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050022#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/types.h>
24#include <linux/string.h>
25#include <linux/ctype.h>
26#include <linux/kernel.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070027#include <linux/kallsyms.h>
Jan Beulich53809752012-12-17 16:01:31 -080028#include <linux/math64.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070029#include <linux/uaccess.h>
Linus Torvalds332d2e72008-10-20 15:07:34 +110030#include <linux/ioport.h>
Al Viro4b6ccca2013-09-03 12:00:44 -040031#include <linux/dcache.h>
Ryan Mallon312b4e22013-11-12 15:08:51 -080032#include <linux/cred.h>
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070033#include <linux/uuid.h>
Joe Perches8a27f7c2009-08-17 12:29:44 +000034#include <net/addrconf.h>
Dmitry Monakhov1031bc52015-04-13 16:31:35 +040035#ifdef CONFIG_BLOCK
36#include <linux/blkdev.h>
37#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -070039#include "../mm/internal.h" /* For the trace_print_flags arrays */
40
Tim Schmielau4e57b682005-10-30 15:03:48 -080041#include <asm/page.h> /* for PAGE_SIZE */
James Bottomleydeac93d2008-09-03 20:43:36 -050042#include <asm/sections.h> /* for dereference_function_descriptor() */
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -070043#include <asm/byteorder.h> /* cpu_to_le16 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Andy Shevchenko71dca952014-10-13 15:55:18 -070045#include <linux/string_helpers.h>
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070046#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070047
Linus Torvalds1da177e2005-04-16 15:20:36 -070048/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 * simple_strtoull - convert a string to an unsigned long long
50 * @cp: The start of the string
51 * @endp: A pointer to the end of the parsed string will be placed here
52 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080053 *
54 * This function is obsolete. Please use kstrtoull instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 */
Harvey Harrison22d27052008-10-16 13:40:35 -070056unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070058 unsigned long long result;
59 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070061 cp = _parse_integer_fixup_radix(cp, &base);
62 rv = _parse_integer(cp, base, &result);
63 /* FIXME */
64 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070065
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 if (endp)
67 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080068
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 return result;
70}
Linus Torvalds1da177e2005-04-16 15:20:36 -070071EXPORT_SYMBOL(simple_strtoull);
72
73/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080074 * simple_strtoul - convert a string to an unsigned long
75 * @cp: The start of the string
76 * @endp: A pointer to the end of the parsed string will be placed here
77 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080078 *
79 * This function is obsolete. Please use kstrtoul instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080080 */
81unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
82{
83 return simple_strtoull(cp, endp, base);
84}
85EXPORT_SYMBOL(simple_strtoul);
86
87/**
88 * simple_strtol - convert a string to a signed long
89 * @cp: The start of the string
90 * @endp: A pointer to the end of the parsed string will be placed here
91 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080092 *
93 * This function is obsolete. Please use kstrtol instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080094 */
95long simple_strtol(const char *cp, char **endp, unsigned int base)
96{
97 if (*cp == '-')
98 return -simple_strtoul(cp + 1, endp, base);
99
100 return simple_strtoul(cp, endp, base);
101}
102EXPORT_SYMBOL(simple_strtol);
103
104/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * simple_strtoll - convert a string to a signed long long
106 * @cp: The start of the string
107 * @endp: A pointer to the end of the parsed string will be placed here
108 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -0800109 *
110 * This function is obsolete. Please use kstrtoll instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
Harvey Harrison22d27052008-10-16 13:40:35 -0700112long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800114 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -0700115 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800116
Harvey Harrison22d27052008-10-16 13:40:35 -0700117 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118}
Hans Verkuil98d5ce02010-04-23 13:18:04 -0400119EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Joe Perchescf3b4292010-05-24 14:33:16 -0700121static noinline_for_stack
122int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800124 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800126 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 i = i*10 + *((*s)++) - '0';
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800128 } while (isdigit(**s));
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 return i;
131}
132
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700133/*
134 * Decimal conversion is by far the most typical, and is used for
135 * /proc and /sys data. This directly impacts e.g. top performance
136 * with many processes running. We optimize it for speed by emitting
137 * two characters at a time, using a 200 byte lookup table. This
138 * roughly halves the number of multiplications compared to computing
139 * the digits one at a time. Implementation strongly inspired by the
140 * previous version, which in turn used ideas described at
141 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
142 * from the author, Douglas W. Jones).
143 *
144 * It turns out there is precisely one 26 bit fixed-point
145 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
146 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
147 * range happens to be somewhat larger (x <= 1073741898), but that's
148 * irrelevant for our purpose.
149 *
150 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
151 * need a 32x32->64 bit multiply, so we simply use the same constant.
152 *
153 * For dividing a number in the range [100, 10^4-1] by 100, there are
154 * several options. The simplest is (x * 0x147b) >> 19, which is valid
155 * for all x <= 43698.
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700156 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700157
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700158static const u16 decpair[100] = {
159#define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
160 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
161 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
162 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
163 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
164 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
165 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
166 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
167 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
168 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
169 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
170#undef _
171};
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700172
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700173/*
174 * This will print a single '0' even if r == 0, since we would
Rasmus Villemoes675cf532015-04-16 12:43:42 -0700175 * immediately jump to out_r where two 0s would be written but only
176 * one of them accounted for in buf. This is needed by ip4_string
177 * below. All other callers pass a non-zero value of r.
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700178*/
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700179static noinline_for_stack
180char *put_dec_trunc8(char *buf, unsigned r)
181{
182 unsigned q;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700183
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700184 /* 1 <= r < 10^8 */
185 if (r < 100)
186 goto out_r;
George Spelvincb239d02012-10-04 17:12:30 -0700187
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700188 /* 100 <= r < 10^8 */
189 q = (r * (u64)0x28f5c29) >> 32;
190 *((u16 *)buf) = decpair[r - 100*q];
191 buf += 2;
192
193 /* 1 <= q < 10^6 */
194 if (q < 100)
195 goto out_q;
196
197 /* 100 <= q < 10^6 */
198 r = (q * (u64)0x28f5c29) >> 32;
199 *((u16 *)buf) = decpair[q - 100*r];
200 buf += 2;
201
202 /* 1 <= r < 10^4 */
203 if (r < 100)
204 goto out_r;
205
206 /* 100 <= r < 10^4 */
207 q = (r * 0x147b) >> 19;
208 *((u16 *)buf) = decpair[r - 100*q];
209 buf += 2;
210out_q:
211 /* 1 <= q < 100 */
212 r = q;
213out_r:
214 /* 1 <= r < 100 */
215 *((u16 *)buf) = decpair[r];
Rasmus Villemoes675cf532015-04-16 12:43:42 -0700216 buf += r < 10 ? 1 : 2;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700217 return buf;
218}
219
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700220#if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
221static noinline_for_stack
222char *put_dec_full8(char *buf, unsigned r)
223{
224 unsigned q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700225
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700226 /* 0 <= r < 10^8 */
227 q = (r * (u64)0x28f5c29) >> 32;
228 *((u16 *)buf) = decpair[r - 100*q];
229 buf += 2;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700230
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700231 /* 0 <= q < 10^6 */
232 r = (q * (u64)0x28f5c29) >> 32;
233 *((u16 *)buf) = decpair[q - 100*r];
234 buf += 2;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700235
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700236 /* 0 <= r < 10^4 */
237 q = (r * 0x147b) >> 19;
238 *((u16 *)buf) = decpair[r - 100*q];
239 buf += 2;
240
241 /* 0 <= q < 100 */
242 *((u16 *)buf) = decpair[q];
243 buf += 2;
244 return buf;
245}
246
247static noinline_for_stack
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700248char *put_dec(char *buf, unsigned long long n)
249{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700250 if (n >= 100*1000*1000)
251 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
252 /* 1 <= n <= 1.6e11 */
253 if (n >= 100*1000*1000)
254 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
255 /* 1 <= n < 1e8 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700256 return put_dec_trunc8(buf, n);
257}
258
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700259#elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700260
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700261static void
262put_dec_full4(char *buf, unsigned r)
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700263{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700264 unsigned q;
265
266 /* 0 <= r < 10^4 */
267 q = (r * 0x147b) >> 19;
268 *((u16 *)buf) = decpair[r - 100*q];
269 buf += 2;
270 /* 0 <= q < 100 */
271 *((u16 *)buf) = decpair[q];
George Spelvin23591722012-10-04 17:12:29 -0700272}
273
274/*
275 * Call put_dec_full4 on x % 10000, return x / 10000.
276 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
277 * holds for all x < 1,128,869,999. The largest value this
278 * helper will ever be asked to convert is 1,125,520,955.
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700279 * (second call in the put_dec code, assuming n is all-ones).
George Spelvin23591722012-10-04 17:12:29 -0700280 */
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700281static noinline_for_stack
George Spelvin23591722012-10-04 17:12:29 -0700282unsigned put_dec_helper4(char *buf, unsigned x)
283{
284 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
285
286 put_dec_full4(buf, x - q * 10000);
287 return q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700288}
289
290/* Based on code by Douglas W. Jones found at
291 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
292 * (with permission from the author).
293 * Performs no 64-bit division and hence should be fast on 32-bit machines.
294 */
295static
296char *put_dec(char *buf, unsigned long long n)
297{
298 uint32_t d3, d2, d1, q, h;
299
300 if (n < 100*1000*1000)
301 return put_dec_trunc8(buf, n);
302
303 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
304 h = (n >> 32);
305 d2 = (h ) & 0xffff;
306 d3 = (h >> 16); /* implicit "& 0xffff" */
307
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700308 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
309 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700310 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
George Spelvin23591722012-10-04 17:12:29 -0700311 q = put_dec_helper4(buf, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700312
George Spelvin23591722012-10-04 17:12:29 -0700313 q += 7671 * d3 + 9496 * d2 + 6 * d1;
314 q = put_dec_helper4(buf+4, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700315
George Spelvin23591722012-10-04 17:12:29 -0700316 q += 4749 * d3 + 42 * d2;
317 q = put_dec_helper4(buf+8, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700318
George Spelvin23591722012-10-04 17:12:29 -0700319 q += 281 * d3;
320 buf += 12;
321 if (q)
322 buf = put_dec_trunc8(buf, q);
323 else while (buf[-1] == '0')
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700324 --buf;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800325
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700326 return buf;
327}
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700328
329#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700330
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700331/*
332 * Convert passed number to decimal string.
333 * Returns the length of string. On buffer overflow, returns 0.
334 *
335 * If speed is not important, use snprintf(). It's easy to read the code.
336 */
337int num_to_str(char *buf, int size, unsigned long long num)
338{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700339 /* put_dec requires 2-byte alignment of the buffer. */
340 char tmp[sizeof(num) * 3] __aligned(2);
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700341 int idx, len;
342
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700343 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
344 if (num <= 9) {
345 tmp[0] = '0' + num;
346 len = 1;
347 } else {
348 len = put_dec(tmp, num) - tmp;
349 }
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700350
351 if (len > size)
352 return 0;
353 for (idx = 0; idx < len; ++idx)
354 buf[idx] = tmp[len - idx - 1];
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700355 return len;
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700356}
357
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700358#define SIGN 1 /* unsigned/signed, must be 1 */
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700359#define LEFT 2 /* left justified */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360#define PLUS 4 /* show plus */
361#define SPACE 8 /* space if plus */
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700362#define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
Bjorn Helgaasb89dc5d2010-03-05 10:47:31 -0700363#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
364#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100366enum format_type {
367 FORMAT_TYPE_NONE, /* Just a string part */
Vegard Nossumed681a92009-03-14 12:08:50 +0100368 FORMAT_TYPE_WIDTH,
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100369 FORMAT_TYPE_PRECISION,
370 FORMAT_TYPE_CHAR,
371 FORMAT_TYPE_STR,
372 FORMAT_TYPE_PTR,
373 FORMAT_TYPE_PERCENT_CHAR,
374 FORMAT_TYPE_INVALID,
375 FORMAT_TYPE_LONG_LONG,
376 FORMAT_TYPE_ULONG,
377 FORMAT_TYPE_LONG,
Zhaoleia4e94ef2009-03-27 17:07:05 +0800378 FORMAT_TYPE_UBYTE,
379 FORMAT_TYPE_BYTE,
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100380 FORMAT_TYPE_USHORT,
381 FORMAT_TYPE_SHORT,
382 FORMAT_TYPE_UINT,
383 FORMAT_TYPE_INT,
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100384 FORMAT_TYPE_SIZE_T,
385 FORMAT_TYPE_PTRDIFF
386};
387
388struct printf_spec {
Rasmus Villemoesd0484192016-01-15 16:58:37 -0800389 unsigned int type:8; /* format_type enum */
390 signed int field_width:24; /* width of output field */
391 unsigned int flags:8; /* flags to number() */
392 unsigned int base:8; /* number base, 8, 10 or 16 only */
393 signed int precision:16; /* # of digits/chars */
394} __packed;
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -0800395#define FIELD_WIDTH_MAX ((1 << 23) - 1)
396#define PRECISION_MAX ((1 << 15) - 1)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100397
Joe Perchescf3b4292010-05-24 14:33:16 -0700398static noinline_for_stack
399char *number(char *buf, char *end, unsigned long long num,
400 struct printf_spec spec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700402 /* put_dec requires 2-byte alignment of the buffer. */
403 char tmp[3 * sizeof(num)] __aligned(2);
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100404 char sign;
405 char locase;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100406 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 int i;
Pierre Carrier7c203422012-05-29 15:07:35 -0700408 bool is_zero = num == 0LL;
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800409 int field_width = spec.field_width;
410 int precision = spec.precision;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Rasmus Villemoesd0484192016-01-15 16:58:37 -0800412 BUILD_BUG_ON(sizeof(struct printf_spec) != 8);
413
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100414 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
415 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100416 locase = (spec.flags & SMALL);
417 if (spec.flags & LEFT)
418 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 sign = 0;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100420 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800421 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800423 num = -(signed long long)num;
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800424 field_width--;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100425 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 sign = '+';
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800427 field_width--;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100428 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 sign = ' ';
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800430 field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 }
432 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700433 if (need_pfx) {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100434 if (spec.base == 16)
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800435 field_width -= 2;
Pierre Carrier7c203422012-05-29 15:07:35 -0700436 else if (!is_zero)
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800437 field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700439
440 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 i = 0;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700442 if (num < spec.base)
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700443 tmp[i++] = hex_asc_upper[num] | locase;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100444 else if (spec.base != 10) { /* 8 or 16 */
445 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700446 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800447
448 if (spec.base == 16)
449 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700450 do {
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700451 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700452 num >>= shift;
453 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700454 } else { /* base 10 */
455 i = put_dec(tmp, num) - tmp;
456 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700457
458 /* printing 100 using %2d gives "100", not "00" */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800459 if (i > precision)
460 precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700461 /* leading space padding */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800462 field_width -= precision;
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700463 if (!(spec.flags & (ZEROPAD | LEFT))) {
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800464 while (--field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700465 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 *buf = ' ';
467 ++buf;
468 }
469 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700470 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700472 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 *buf = sign;
474 ++buf;
475 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700476 /* "0x" / "0" prefix */
477 if (need_pfx) {
Pierre Carrier7c203422012-05-29 15:07:35 -0700478 if (spec.base == 16 || !is_zero) {
479 if (buf < end)
480 *buf = '0';
481 ++buf;
482 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100483 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700484 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100485 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 ++buf;
487 }
488 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700489 /* zero or space padding */
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100490 if (!(spec.flags & LEFT)) {
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700491 char c = ' ' + (spec.flags & ZEROPAD);
492 BUILD_BUG_ON(' ' + ZEROPAD != '0');
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800493 while (--field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700494 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 *buf = c;
496 ++buf;
497 }
498 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700499 /* hmm even more zero padding? */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800500 while (i <= --precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700501 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 *buf = '0';
503 ++buf;
504 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700505 /* actual digits of result */
506 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700507 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 *buf = tmp[i];
509 ++buf;
510 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700511 /* trailing space padding */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800512 while (--field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700513 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 *buf = ' ';
515 ++buf;
516 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 return buf;
519}
520
Andy Shevchenko3cab1e72016-01-15 16:59:18 -0800521static noinline_for_stack
522char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
523{
524 struct printf_spec spec;
525
526 spec.type = FORMAT_TYPE_PTR;
527 spec.field_width = 2 + 2 * size; /* 0x + hex */
528 spec.flags = SPECIAL | SMALL | ZEROPAD;
529 spec.base = 16;
530 spec.precision = -1;
531
532 return number(buf, end, num, spec);
533}
534
Rasmus Villemoescfccde02016-01-15 16:58:28 -0800535static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
Al Viro4b6ccca2013-09-03 12:00:44 -0400536{
537 size_t size;
538 if (buf >= end) /* nowhere to put anything */
539 return;
540 size = end - buf;
541 if (size <= spaces) {
542 memset(buf, ' ', size);
543 return;
544 }
545 if (len) {
546 if (len > size - spaces)
547 len = size - spaces;
548 memmove(buf + spaces, buf, len);
549 }
550 memset(buf, ' ', spaces);
551}
552
Rasmus Villemoescfccde02016-01-15 16:58:28 -0800553/*
554 * Handle field width padding for a string.
555 * @buf: current buffer position
556 * @n: length of string
557 * @end: end of output buffer
558 * @spec: for field width and flags
559 * Returns: new buffer position after padding.
560 */
561static noinline_for_stack
562char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
563{
564 unsigned spaces;
565
566 if (likely(n >= spec.field_width))
567 return buf;
568 /* we want to pad the sucker */
569 spaces = spec.field_width - n;
570 if (!(spec.flags & LEFT)) {
571 move_right(buf - n, end, n, spaces);
572 return buf + spaces;
573 }
574 while (spaces--) {
575 if (buf < end)
576 *buf = ' ';
577 ++buf;
578 }
579 return buf;
580}
581
Al Viro4b6ccca2013-09-03 12:00:44 -0400582static noinline_for_stack
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800583char *string(char *buf, char *end, const char *s, struct printf_spec spec)
584{
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800585 int len = 0;
586 size_t lim = spec.precision;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800587
588 if ((unsigned long)s < PAGE_SIZE)
589 s = "(null)";
590
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800591 while (lim--) {
592 char c = *s++;
593 if (!c)
594 break;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800595 if (buf < end)
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800596 *buf = c;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800597 ++buf;
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800598 ++len;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800599 }
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800600 return widen_string(buf, len, end, spec);
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800601}
602
603static noinline_for_stack
Al Viro4b6ccca2013-09-03 12:00:44 -0400604char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
605 const char *fmt)
606{
607 const char *array[4], *s;
608 const struct dentry *p;
609 int depth;
610 int i, n;
611
612 switch (fmt[1]) {
613 case '2': case '3': case '4':
614 depth = fmt[1] - '0';
615 break;
616 default:
617 depth = 1;
618 }
619
620 rcu_read_lock();
621 for (i = 0; i < depth; i++, d = p) {
622 p = ACCESS_ONCE(d->d_parent);
623 array[i] = ACCESS_ONCE(d->d_name.name);
624 if (p == d) {
625 if (i)
626 array[i] = "";
627 i++;
628 break;
629 }
630 }
631 s = array[--i];
632 for (n = 0; n != spec.precision; n++, buf++) {
633 char c = *s++;
634 if (!c) {
635 if (!i)
636 break;
637 c = '/';
638 s = array[--i];
639 }
640 if (buf < end)
641 *buf = c;
642 }
643 rcu_read_unlock();
Rasmus Villemoescfccde02016-01-15 16:58:28 -0800644 return widen_string(buf, n, end, spec);
Al Viro4b6ccca2013-09-03 12:00:44 -0400645}
646
Dmitry Monakhov1031bc52015-04-13 16:31:35 +0400647#ifdef CONFIG_BLOCK
648static noinline_for_stack
649char *bdev_name(char *buf, char *end, struct block_device *bdev,
650 struct printf_spec spec, const char *fmt)
651{
652 struct gendisk *hd = bdev->bd_disk;
653
654 buf = string(buf, end, hd->disk_name, spec);
655 if (bdev->bd_part->partno) {
656 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
657 if (buf < end)
658 *buf = 'p';
659 buf++;
660 }
661 buf = number(buf, end, bdev->bd_part->partno, spec);
662 }
663 return buf;
664}
665#endif
666
Joe Perchescf3b4292010-05-24 14:33:16 -0700667static noinline_for_stack
668char *symbol_string(char *buf, char *end, void *ptr,
Joe Perchesb0d33c22012-12-12 10:18:50 -0800669 struct printf_spec spec, const char *fmt)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700670{
Joe Perchesb0d33c22012-12-12 10:18:50 -0800671 unsigned long value;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700672#ifdef CONFIG_KALLSYMS
673 char sym[KSYM_SYMBOL_LEN];
Joe Perchesb0d33c22012-12-12 10:18:50 -0800674#endif
675
676 if (fmt[1] == 'R')
677 ptr = __builtin_extract_return_addr(ptr);
678 value = (unsigned long)ptr;
679
680#ifdef CONFIG_KALLSYMS
681 if (*fmt == 'B')
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900682 sprint_backtrace(sym, value);
Joe Perchesb0d33c22012-12-12 10:18:50 -0800683 else if (*fmt != 'f' && *fmt != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200684 sprint_symbol(sym, value);
685 else
Stephen Boyd4796dd22012-05-29 15:07:33 -0700686 sprint_symbol_no_offset(sym, value);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800687
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100688 return string(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700689#else
Andy Shevchenko3cab1e72016-01-15 16:59:18 -0800690 return special_hex_number(buf, end, value, sizeof(void *));
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700691#endif
692}
693
Joe Perchescf3b4292010-05-24 14:33:16 -0700694static noinline_for_stack
695char *resource_string(char *buf, char *end, struct resource *res,
696 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +1100697{
698#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600699#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +1100700#endif
701
702#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -0600703#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +1100704#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700705 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100706 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700707 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100708 .precision = -1,
709 .flags = SPECIAL | SMALL | ZEROPAD,
710 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700711 static const struct printf_spec mem_spec = {
712 .base = 16,
713 .field_width = MEM_RSRC_PRINTK_SIZE,
714 .precision = -1,
715 .flags = SPECIAL | SMALL | ZEROPAD,
716 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700717 static const struct printf_spec bus_spec = {
718 .base = 16,
719 .field_width = 2,
720 .precision = -1,
721 .flags = SMALL | ZEROPAD,
722 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700723 static const struct printf_spec dec_spec = {
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600724 .base = 10,
725 .precision = -1,
726 .flags = 0,
727 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700728 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600729 .field_width = -1,
730 .precision = 10,
731 .flags = LEFT,
732 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700733 static const struct printf_spec flag_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600734 .base = 16,
735 .precision = -1,
736 .flags = SPECIAL | SMALL,
737 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600738
739 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
740 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
741#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
742#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700743#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600744#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
745 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
746 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
747
Linus Torvalds332d2e72008-10-20 15:07:34 +1100748 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600749 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700750 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +1100751
752 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700753 if (res->flags & IORESOURCE_IO) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600754 p = string(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700755 specp = &io_spec;
756 } else if (res->flags & IORESOURCE_MEM) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600757 p = string(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700758 specp = &mem_spec;
759 } else if (res->flags & IORESOURCE_IRQ) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600760 p = string(p, pend, "irq ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700761 specp = &dec_spec;
762 } else if (res->flags & IORESOURCE_DMA) {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600763 p = string(p, pend, "dma ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700764 specp = &dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -0700765 } else if (res->flags & IORESOURCE_BUS) {
766 p = string(p, pend, "bus ", str_spec);
767 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700768 } else {
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600769 p = string(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -0700770 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600771 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600772 }
Bjorn Helgaasd19cb802014-02-26 11:25:56 -0700773 if (decode && res->flags & IORESOURCE_UNSET) {
774 p = string(p, pend, "size ", str_spec);
775 p = number(p, pend, resource_size(res), *specp);
776 } else {
777 p = number(p, pend, res->start, *specp);
778 if (res->start != res->end) {
779 *p++ = '-';
780 p = number(p, pend, res->end, *specp);
781 }
Bjorn Helgaasc91d3372009-10-06 15:33:34 -0600782 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600783 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600784 if (res->flags & IORESOURCE_MEM_64)
785 p = string(p, pend, " 64bit", str_spec);
786 if (res->flags & IORESOURCE_PREFETCH)
787 p = string(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -0700788 if (res->flags & IORESOURCE_WINDOW)
789 p = string(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600790 if (res->flags & IORESOURCE_DISABLED)
791 p = string(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600792 } else {
793 p = string(p, pend, " flags ", str_spec);
794 p = number(p, pend, res->flags, flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -0600795 }
Linus Torvalds332d2e72008-10-20 15:07:34 +1100796 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -0600797 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +1100798
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100799 return string(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +1100800}
801
Joe Perchescf3b4292010-05-24 14:33:16 -0700802static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -0700803char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
804 const char *fmt)
805{
Steven Rostedt360603a2013-05-28 15:47:39 -0400806 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -0700807 negative value, fallback to the default */
808 char separator;
809
810 if (spec.field_width == 0)
811 /* nothing to print */
812 return buf;
813
814 if (ZERO_OR_NULL_PTR(addr))
815 /* NULL pointer */
816 return string(buf, end, NULL, spec);
817
818 switch (fmt[1]) {
819 case 'C':
820 separator = ':';
821 break;
822 case 'D':
823 separator = '-';
824 break;
825 case 'N':
826 separator = 0;
827 break;
828 default:
829 separator = ' ';
830 break;
831 }
832
833 if (spec.field_width > 0)
834 len = min_t(int, spec.field_width, 64);
835
Rasmus Villemoes9c98f232015-04-15 16:17:23 -0700836 for (i = 0; i < len; ++i) {
837 if (buf < end)
838 *buf = hex_asc_hi(addr[i]);
839 ++buf;
840 if (buf < end)
841 *buf = hex_asc_lo(addr[i]);
842 ++buf;
Andy Shevchenko31550a12012-07-30 14:40:27 -0700843
Rasmus Villemoes9c98f232015-04-15 16:17:23 -0700844 if (separator && i != len - 1) {
845 if (buf < end)
846 *buf = separator;
847 ++buf;
848 }
Andy Shevchenko31550a12012-07-30 14:40:27 -0700849 }
850
851 return buf;
852}
853
854static noinline_for_stack
Tejun Heodbc760b2015-02-13 14:36:53 -0800855char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
856 struct printf_spec spec, const char *fmt)
857{
858 const int CHUNKSZ = 32;
859 int nr_bits = max_t(int, spec.field_width, 0);
860 int i, chunksz;
861 bool first = true;
862
863 /* reused to print numbers */
864 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
865
866 chunksz = nr_bits & (CHUNKSZ - 1);
867 if (chunksz == 0)
868 chunksz = CHUNKSZ;
869
870 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
871 for (; i >= 0; i -= CHUNKSZ) {
872 u32 chunkmask, val;
873 int word, bit;
874
875 chunkmask = ((1ULL << chunksz) - 1);
876 word = i / BITS_PER_LONG;
877 bit = i % BITS_PER_LONG;
878 val = (bitmap[word] >> bit) & chunkmask;
879
880 if (!first) {
881 if (buf < end)
882 *buf = ',';
883 buf++;
884 }
885 first = false;
886
887 spec.field_width = DIV_ROUND_UP(chunksz, 4);
888 buf = number(buf, end, val, spec);
889
890 chunksz = CHUNKSZ;
891 }
892 return buf;
893}
894
895static noinline_for_stack
896char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
897 struct printf_spec spec, const char *fmt)
898{
899 int nr_bits = max_t(int, spec.field_width, 0);
900 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
901 int cur, rbot, rtop;
902 bool first = true;
903
904 /* reused to print numbers */
905 spec = (struct printf_spec){ .base = 10 };
906
907 rbot = cur = find_first_bit(bitmap, nr_bits);
908 while (cur < nr_bits) {
909 rtop = cur;
910 cur = find_next_bit(bitmap, nr_bits, cur + 1);
911 if (cur < nr_bits && cur <= rtop + 1)
912 continue;
913
914 if (!first) {
915 if (buf < end)
916 *buf = ',';
917 buf++;
918 }
919 first = false;
920
921 buf = number(buf, end, rbot, spec);
922 if (rbot < rtop) {
923 if (buf < end)
924 *buf = '-';
925 buf++;
926
927 buf = number(buf, end, rtop, spec);
928 }
929
930 rbot = cur;
931 }
932 return buf;
933}
934
935static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -0700936char *mac_address_string(char *buf, char *end, u8 *addr,
937 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700938{
Joe Perches8a27f7c2009-08-17 12:29:44 +0000939 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700940 char *p = mac_addr;
941 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000942 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700943 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000944
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700945 switch (fmt[1]) {
946 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +0000947 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700948 break;
949
950 case 'R':
951 reversed = true;
952 /* fall through */
953
954 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +0000955 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700956 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +0000957 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700958
959 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -0700960 if (reversed)
961 p = hex_byte_pack(p, addr[5 - i]);
962 else
963 p = hex_byte_pack(p, addr[i]);
964
Joe Perches8a27f7c2009-08-17 12:29:44 +0000965 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +0000966 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700967 }
968 *p = '\0';
969
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +0100970 return string(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -0700971}
972
Joe Perchescf3b4292010-05-24 14:33:16 -0700973static noinline_for_stack
974char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -0700975{
Harvey Harrison689afa72008-10-28 16:04:44 -0700976 int i;
Joe Perches0159f242010-01-13 20:23:30 -0800977 bool leading_zeros = (fmt[0] == 'i');
978 int index;
979 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -0700980
Joe Perches0159f242010-01-13 20:23:30 -0800981 switch (fmt[2]) {
982 case 'h':
983#ifdef __BIG_ENDIAN
984 index = 0;
985 step = 1;
986#else
987 index = 3;
988 step = -1;
989#endif
990 break;
991 case 'l':
992 index = 3;
993 step = -1;
994 break;
995 case 'n':
996 case 'b':
997 default:
998 index = 0;
999 step = 1;
1000 break;
1001 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001002 for (i = 0; i < 4; i++) {
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -07001003 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -07001004 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001005 if (leading_zeros) {
1006 if (digits < 3)
1007 *p++ = '0';
1008 if (digits < 2)
1009 *p++ = '0';
1010 }
1011 /* reverse the digits in the quad */
1012 while (digits--)
1013 *p++ = temp[digits];
1014 if (i < 3)
1015 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -08001016 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001017 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001018 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001019
Joe Perches8a27f7c2009-08-17 12:29:44 +00001020 return p;
1021}
1022
Joe Perchescf3b4292010-05-24 14:33:16 -07001023static noinline_for_stack
1024char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001025{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001026 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001027 unsigned char zerolength[8];
1028 int longest = 1;
1029 int colonpos = -1;
1030 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001031 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001032 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +00001033 bool useIPv4;
1034 struct in6_addr in6;
1035
1036 memcpy(&in6, addr, sizeof(struct in6_addr));
1037
1038 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001039
1040 memset(zerolength, 0, sizeof(zerolength));
1041
1042 if (useIPv4)
1043 range = 6;
1044 else
1045 range = 8;
1046
1047 /* find position of longest 0 run */
1048 for (i = 0; i < range; i++) {
1049 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +00001050 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001051 break;
1052 zerolength[i]++;
1053 }
1054 }
1055 for (i = 0; i < range; i++) {
1056 if (zerolength[i] > longest) {
1057 longest = zerolength[i];
1058 colonpos = i;
1059 }
1060 }
Joe Perches29cf5192011-06-09 11:23:37 -07001061 if (longest == 1) /* don't compress a single 0 */
1062 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001063
1064 /* emit address */
1065 for (i = 0; i < range; i++) {
1066 if (i == colonpos) {
1067 if (needcolon || i == 0)
1068 *p++ = ':';
1069 *p++ = ':';
1070 needcolon = false;
1071 i += longest - 1;
1072 continue;
1073 }
1074 if (needcolon) {
1075 *p++ = ':';
1076 needcolon = false;
1077 }
1078 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +00001079 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001080 hi = word >> 8;
1081 lo = word & 0xff;
1082 if (hi) {
1083 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001084 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001085 else
1086 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001087 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001088 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -08001089 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001090 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001091 else
1092 *p++ = hex_asc_lo(lo);
1093 needcolon = true;
1094 }
1095
1096 if (useIPv4) {
1097 if (needcolon)
1098 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -08001099 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +00001100 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001101 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001102
Joe Perches8a27f7c2009-08-17 12:29:44 +00001103 return p;
1104}
1105
Joe Perchescf3b4292010-05-24 14:33:16 -07001106static noinline_for_stack
1107char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001108{
1109 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001110
Harvey Harrison689afa72008-10-28 16:04:44 -07001111 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001112 p = hex_byte_pack(p, *addr++);
1113 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001114 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -07001115 *p++ = ':';
1116 }
1117 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001118
Joe Perches8a27f7c2009-08-17 12:29:44 +00001119 return p;
1120}
1121
Joe Perchescf3b4292010-05-24 14:33:16 -07001122static noinline_for_stack
1123char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1124 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001125{
1126 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1127
1128 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +00001129 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001130 else
Joe Percheseb78cd22009-09-18 13:04:06 +00001131 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -07001132
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001133 return string(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -07001134}
1135
Joe Perchescf3b4292010-05-24 14:33:16 -07001136static noinline_for_stack
1137char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1138 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -07001139{
Joe Perches8a27f7c2009-08-17 12:29:44 +00001140 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -07001141
Joe Perches0159f242010-01-13 20:23:30 -08001142 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001143
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001144 return string(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001145}
1146
Joe Perchescf3b4292010-05-24 14:33:16 -07001147static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001148char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1149 struct printf_spec spec, const char *fmt)
1150{
1151 bool have_p = false, have_s = false, have_f = false, have_c = false;
1152 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1153 sizeof(":12345") + sizeof("/123456789") +
1154 sizeof("%1234567890")];
1155 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1156 const u8 *addr = (const u8 *) &sa->sin6_addr;
1157 char fmt6[2] = { fmt[0], '6' };
1158 u8 off = 0;
1159
1160 fmt++;
1161 while (isalpha(*++fmt)) {
1162 switch (*fmt) {
1163 case 'p':
1164 have_p = true;
1165 break;
1166 case 'f':
1167 have_f = true;
1168 break;
1169 case 's':
1170 have_s = true;
1171 break;
1172 case 'c':
1173 have_c = true;
1174 break;
1175 }
1176 }
1177
1178 if (have_p || have_s || have_f) {
1179 *p = '[';
1180 off = 1;
1181 }
1182
1183 if (fmt6[0] == 'I' && have_c)
1184 p = ip6_compressed_string(ip6_addr + off, addr);
1185 else
1186 p = ip6_string(ip6_addr + off, addr, fmt6);
1187
1188 if (have_p || have_s || have_f)
1189 *p++ = ']';
1190
1191 if (have_p) {
1192 *p++ = ':';
1193 p = number(p, pend, ntohs(sa->sin6_port), spec);
1194 }
1195 if (have_f) {
1196 *p++ = '/';
1197 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1198 IPV6_FLOWINFO_MASK), spec);
1199 }
1200 if (have_s) {
1201 *p++ = '%';
1202 p = number(p, pend, sa->sin6_scope_id, spec);
1203 }
1204 *p = '\0';
1205
1206 return string(buf, end, ip6_addr, spec);
1207}
1208
1209static noinline_for_stack
1210char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1211 struct printf_spec spec, const char *fmt)
1212{
1213 bool have_p = false;
1214 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1215 char *pend = ip4_addr + sizeof(ip4_addr);
1216 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1217 char fmt4[3] = { fmt[0], '4', 0 };
1218
1219 fmt++;
1220 while (isalpha(*++fmt)) {
1221 switch (*fmt) {
1222 case 'p':
1223 have_p = true;
1224 break;
1225 case 'h':
1226 case 'l':
1227 case 'n':
1228 case 'b':
1229 fmt4[2] = *fmt;
1230 break;
1231 }
1232 }
1233
1234 p = ip4_string(ip4_addr, addr, fmt4);
1235 if (have_p) {
1236 *p++ = ':';
1237 p = number(p, pend, ntohs(sa->sin_port), spec);
1238 }
1239 *p = '\0';
1240
1241 return string(buf, end, ip4_addr, spec);
1242}
1243
1244static noinline_for_stack
Andy Shevchenko71dca952014-10-13 15:55:18 -07001245char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1246 const char *fmt)
1247{
1248 bool found = true;
1249 int count = 1;
1250 unsigned int flags = 0;
1251 int len;
1252
1253 if (spec.field_width == 0)
1254 return buf; /* nothing to print */
1255
1256 if (ZERO_OR_NULL_PTR(addr))
1257 return string(buf, end, NULL, spec); /* NULL pointer */
1258
1259
1260 do {
1261 switch (fmt[count++]) {
1262 case 'a':
1263 flags |= ESCAPE_ANY;
1264 break;
1265 case 'c':
1266 flags |= ESCAPE_SPECIAL;
1267 break;
1268 case 'h':
1269 flags |= ESCAPE_HEX;
1270 break;
1271 case 'n':
1272 flags |= ESCAPE_NULL;
1273 break;
1274 case 'o':
1275 flags |= ESCAPE_OCTAL;
1276 break;
1277 case 'p':
1278 flags |= ESCAPE_NP;
1279 break;
1280 case 's':
1281 flags |= ESCAPE_SPACE;
1282 break;
1283 default:
1284 found = false;
1285 break;
1286 }
1287 } while (found);
1288
1289 if (!flags)
1290 flags = ESCAPE_ANY_NP;
1291
1292 len = spec.field_width < 0 ? 1 : spec.field_width;
1293
Rasmus Villemoes41416f22015-04-15 16:17:28 -07001294 /*
1295 * string_escape_mem() writes as many characters as it can to
1296 * the given buffer, and returns the total size of the output
1297 * had the buffer been big enough.
1298 */
1299 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
Andy Shevchenko71dca952014-10-13 15:55:18 -07001300
1301 return buf;
1302}
1303
1304static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001305char *uuid_string(char *buf, char *end, const u8 *addr,
1306 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001307{
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -07001308 char uuid[UUID_STRING_LEN + 1];
Joe Perches9ac6e442009-12-14 18:01:09 -08001309 char *p = uuid;
1310 int i;
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -07001311 const u8 *index = uuid_be_index;
Joe Perches9ac6e442009-12-14 18:01:09 -08001312 bool uc = false;
1313
1314 switch (*(++fmt)) {
1315 case 'L':
1316 uc = true; /* fall-through */
1317 case 'l':
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -07001318 index = uuid_le_index;
Joe Perches9ac6e442009-12-14 18:01:09 -08001319 break;
1320 case 'B':
1321 uc = true;
1322 break;
1323 }
1324
1325 for (i = 0; i < 16; i++) {
Andy Shevchenkoaa4ea1c2016-05-20 17:00:54 -07001326 if (uc)
1327 p = hex_byte_pack_upper(p, addr[index[i]]);
1328 else
1329 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001330 switch (i) {
1331 case 3:
1332 case 5:
1333 case 7:
1334 case 9:
1335 *p++ = '-';
1336 break;
1337 }
1338 }
1339
1340 *p = 0;
1341
Joe Perches9ac6e442009-12-14 18:01:09 -08001342 return string(buf, end, uuid, spec);
1343}
1344
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001345static noinline_for_stack
1346char *netdev_bits(char *buf, char *end, const void *addr, const char *fmt)
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001347{
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001348 unsigned long long num;
1349 int size;
1350
1351 switch (fmt[1]) {
1352 case 'F':
1353 num = *(const netdev_features_t *)addr;
1354 size = sizeof(netdev_features_t);
1355 break;
1356 default:
1357 num = (unsigned long)addr;
1358 size = sizeof(unsigned long);
1359 break;
1360 }
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001361
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001362 return special_hex_number(buf, end, num, size);
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001363}
1364
Joe Perchesaaf07622014-01-23 15:54:17 -08001365static noinline_for_stack
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001366char *address_val(char *buf, char *end, const void *addr, const char *fmt)
Joe Perchesaaf07622014-01-23 15:54:17 -08001367{
1368 unsigned long long num;
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001369 int size;
Joe Perchesaaf07622014-01-23 15:54:17 -08001370
1371 switch (fmt[1]) {
1372 case 'd':
1373 num = *(const dma_addr_t *)addr;
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001374 size = sizeof(dma_addr_t);
Joe Perchesaaf07622014-01-23 15:54:17 -08001375 break;
1376 case 'p':
1377 default:
1378 num = *(const phys_addr_t *)addr;
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001379 size = sizeof(phys_addr_t);
Joe Perchesaaf07622014-01-23 15:54:17 -08001380 break;
1381 }
1382
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001383 return special_hex_number(buf, end, num, size);
Joe Perchesaaf07622014-01-23 15:54:17 -08001384}
1385
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001386static noinline_for_stack
1387char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1388 const char *fmt)
1389{
1390 if (!IS_ENABLED(CONFIG_HAVE_CLK) || !clk)
1391 return string(buf, end, NULL, spec);
1392
1393 switch (fmt[1]) {
1394 case 'r':
1395 return number(buf, end, clk_get_rate(clk), spec);
1396
1397 case 'n':
1398 default:
1399#ifdef CONFIG_COMMON_CLK
1400 return string(buf, end, __clk_get_name(clk), spec);
1401#else
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001402 return special_hex_number(buf, end, (unsigned long)clk, sizeof(unsigned long));
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001403#endif
1404 }
1405}
1406
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001407static
1408char *format_flags(char *buf, char *end, unsigned long flags,
1409 const struct trace_print_flags *names)
1410{
1411 unsigned long mask;
1412 const struct printf_spec strspec = {
1413 .field_width = -1,
1414 .precision = -1,
1415 };
1416 const struct printf_spec numspec = {
1417 .flags = SPECIAL|SMALL,
1418 .field_width = -1,
1419 .precision = -1,
1420 .base = 16,
1421 };
1422
1423 for ( ; flags && names->name; names++) {
1424 mask = names->mask;
1425 if ((flags & mask) != mask)
1426 continue;
1427
1428 buf = string(buf, end, names->name, strspec);
1429
1430 flags &= ~mask;
1431 if (flags) {
1432 if (buf < end)
1433 *buf = '|';
1434 buf++;
1435 }
1436 }
1437
1438 if (flags)
1439 buf = number(buf, end, flags, numspec);
1440
1441 return buf;
1442}
1443
1444static noinline_for_stack
1445char *flags_string(char *buf, char *end, void *flags_ptr, const char *fmt)
1446{
1447 unsigned long flags;
1448 const struct trace_print_flags *names;
1449
1450 switch (fmt[1]) {
1451 case 'p':
1452 flags = *(unsigned long *)flags_ptr;
1453 /* Remove zone id */
1454 flags &= (1UL << NR_PAGEFLAGS) - 1;
1455 names = pageflag_names;
1456 break;
1457 case 'v':
1458 flags = *(unsigned long *)flags_ptr;
1459 names = vmaflag_names;
1460 break;
1461 case 'g':
1462 flags = *(gfp_t *)flags_ptr;
1463 names = gfpflag_names;
1464 break;
1465 default:
1466 WARN_ONCE(1, "Unsupported flags modifier: %c\n", fmt[1]);
1467 return buf;
1468 }
1469
1470 return format_flags(buf, end, flags, names);
1471}
1472
Ingo Molnar411f05f2011-05-12 23:00:28 +02001473int kptr_restrict __read_mostly;
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001474
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001475/*
1476 * Show a '%p' thing. A kernel extension is that the '%p' is followed
1477 * by an extra set of alphanumeric characters that are extended format
1478 * specifiers.
1479 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001480 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001481 *
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001482 * - 'F' For symbolic function descriptor pointers with offset
1483 * - 'f' For simple symbolic function names without offset
Steven Rostedt0efb4d22009-09-17 09:27:29 -04001484 * - 'S' For symbolic direct pointers with offset
1485 * - 's' For symbolic direct pointers without offset
Joe Perchesb0d33c22012-12-12 10:18:50 -08001486 * - '[FfSs]R' as above with __builtin_extract_return_addr() translation
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001487 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001488 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
1489 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Tejun Heodbc760b2015-02-13 14:36:53 -08001490 * - 'b[l]' For a bitmap, the number of bits is determined by the field
1491 * width which must be explicitly specified either as part of the
1492 * format string '%32b[l]' or through '%*b[l]', [l] selects
1493 * range-list format instead of hex format
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001494 * - 'M' For a 6-byte MAC address, it prints the address in the
1495 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00001496 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00001497 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08001498 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07001499 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001500 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
1501 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
1502 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02001503 * [S][pfs]
1504 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1505 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00001506 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
1507 * IPv6 omits the colons (01020304...0f)
1508 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02001509 * [S][pfs]
1510 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
1511 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
1512 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
1513 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07001514 * http://tools.ietf.org/html/rfc5952
Andy Shevchenko71dca952014-10-13 15:55:18 -07001515 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
1516 * of the following flags (see string_escape_mem() for the
1517 * details):
1518 * a - ESCAPE_ANY
1519 * c - ESCAPE_SPECIAL
1520 * h - ESCAPE_HEX
1521 * n - ESCAPE_NULL
1522 * o - ESCAPE_OCTAL
1523 * p - ESCAPE_NP
1524 * s - ESCAPE_SPACE
1525 * By default ESCAPE_ANY_NP is used.
Joe Perches9ac6e442009-12-14 18:01:09 -08001526 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
1527 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
1528 * Options for %pU are:
1529 * b big endian lower case hex (default)
1530 * B big endian UPPER case hex
1531 * l little endian lower case hex
1532 * L little endian UPPER case hex
1533 * big endian output byte order is:
1534 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
1535 * little endian output byte order is:
1536 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00001537 * - 'V' For a struct va_format which contains a format string * and va_list *,
1538 * call vsnprintf(->format, *->va_list).
1539 * Implements a "recursive vsnprintf".
1540 * Do not use this feature without some mechanism to verify the
1541 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001542 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001543 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07001544 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
1545 * a certain separator (' ' by default):
1546 * C colon
1547 * D dash
1548 * N no separator
1549 * The maximum supported length is 64 bytes of the input. Consider
1550 * to use print_hex_dump() for the larger input.
Joe Perchesaaf07622014-01-23 15:54:17 -08001551 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
1552 * (default assumed to be phys_addr_t, passed by reference)
Olof Johanssonc0d92a52013-11-12 15:09:50 -08001553 * - 'd[234]' For a dentry name (optionally 2-4 last components)
1554 * - 'D[234]' Same as 'd' but for a struct file
Dmitry Monakhov1031bc52015-04-13 16:31:35 +04001555 * - 'g' For block_device name (gendisk + partition number)
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001556 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
1557 * (legacy clock framework) of the clock
1558 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
1559 * (legacy clock framework) of the clock
1560 * - 'Cr' For a clock, it prints the current rate of the clock
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001561 * - 'G' For flags to be printed as a collection of symbolic strings that would
1562 * construct the specific value. Supported flags given by option:
1563 * p page flags (see struct page) given as pointer to unsigned long
1564 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
1565 * v vma flags (VM_*) given as pointer to unsigned long
Martin Kletzander5e4ee7b2015-11-06 16:30:17 -08001566 *
1567 * ** Please update also Documentation/printk-formats.txt when making changes **
Joe Perches9ac6e442009-12-14 18:01:09 -08001568 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11001569 * Note: The difference between 'S' and 'F' is that on ia64 and ppc64
1570 * function pointers are really function descriptors, which contain a
1571 * pointer to the real address.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07001572 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001573static noinline_for_stack
1574char *pointer(const char *fmt, char *buf, char *end, void *ptr,
1575 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001576{
Rasmus Villemoes80c9eb42015-11-06 16:30:26 -08001577 const int default_width = 2 * sizeof(void *);
Grant Likely725fe002012-05-31 16:26:08 -07001578
Kees Cook9f36e2c2011-03-22 16:34:22 -07001579 if (!ptr && *fmt != 'K') {
Joe Perches5e057982010-10-26 14:22:50 -07001580 /*
1581 * Print (null) with the same width as a pointer so it makes
1582 * tabular output look nice.
1583 */
1584 if (spec.field_width == -1)
Grant Likely725fe002012-05-31 16:26:08 -07001585 spec.field_width = default_width;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001586 return string(buf, end, "(null)", spec);
Joe Perches5e057982010-10-26 14:22:50 -07001587 }
Linus Torvaldsd97106a2009-01-03 11:46:17 -08001588
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001589 switch (*fmt) {
1590 case 'F':
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +02001591 case 'f':
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001592 ptr = dereference_function_descriptor(ptr);
1593 /* Fallthrough */
1594 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08001595 case 's':
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09001596 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08001597 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001598 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001599 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001600 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07001601 case 'h':
1602 return hex_string(buf, end, ptr, spec, fmt);
Tejun Heodbc760b2015-02-13 14:36:53 -08001603 case 'b':
1604 switch (fmt[1]) {
1605 case 'l':
1606 return bitmap_list_string(buf, end, ptr, spec, fmt);
1607 default:
1608 return bitmap_string(buf, end, ptr, spec, fmt);
1609 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001610 case 'M': /* Colon separated: 00:01:02:03:04:05 */
1611 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001612 /* [mM]F (FDDI) */
1613 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00001614 return mac_address_string(buf, end, ptr, spec, fmt);
1615 case 'I': /* Formatted IP supported
1616 * 4: 1.2.3.4
1617 * 6: 0001:0203:...:0708
1618 * 6c: 1::708 or 1::1.2.3.4
1619 */
1620 case 'i': /* Contiguous:
1621 * 4: 001.002.003.004
1622 * 6: 000102...0f
1623 */
1624 switch (fmt[1]) {
1625 case '6':
1626 return ip6_addr_string(buf, end, ptr, spec, fmt);
1627 case '4':
1628 return ip4_addr_string(buf, end, ptr, spec, fmt);
Daniel Borkmann10679642013-06-28 19:49:39 +02001629 case 'S': {
1630 const union {
1631 struct sockaddr raw;
1632 struct sockaddr_in v4;
1633 struct sockaddr_in6 v6;
1634 } *sa = ptr;
1635
1636 switch (sa->raw.sa_family) {
1637 case AF_INET:
1638 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1639 case AF_INET6:
1640 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1641 default:
1642 return string(buf, end, "(invalid address)", spec);
1643 }}
Joe Perches8a27f7c2009-08-17 12:29:44 +00001644 }
Harvey Harrison4aa99602008-10-29 12:49:58 -07001645 break;
Andy Shevchenko71dca952014-10-13 15:55:18 -07001646 case 'E':
1647 return escaped_string(buf, end, ptr, spec, fmt);
Joe Perches9ac6e442009-12-14 18:01:09 -08001648 case 'U':
1649 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00001650 case 'V':
Jan Beulich5756b762012-03-05 16:49:24 +00001651 {
1652 va_list va;
1653
1654 va_copy(va, *((struct va_format *)ptr)->va);
1655 buf += vsnprintf(buf, end > buf ? end - buf : 0,
1656 ((struct va_format *)ptr)->fmt, va);
1657 va_end(va);
1658 return buf;
1659 }
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08001660 case 'K':
Ryan Mallon312b4e22013-11-12 15:08:51 -08001661 switch (kptr_restrict) {
1662 case 0:
1663 /* Always print %pK values */
1664 break;
1665 case 1: {
Jason A. Donenfeld7eb39122016-02-11 16:13:00 -08001666 const struct cred *cred;
1667
1668 /*
1669 * kptr_restrict==1 cannot be used in IRQ context
1670 * because its test for CAP_SYSLOG would be meaningless.
1671 */
1672 if (in_irq() || in_serving_softirq() || in_nmi()) {
1673 if (spec.field_width == -1)
1674 spec.field_width = default_width;
1675 return string(buf, end, "pK-error", spec);
1676 }
1677
Ryan Mallon312b4e22013-11-12 15:08:51 -08001678 /*
1679 * Only print the real pointer value if the current
1680 * process has CAP_SYSLOG and is running with the
1681 * same credentials it started with. This is because
1682 * access to files is checked at open() time, but %pK
1683 * checks permission at read() time. We don't want to
1684 * leak pointer values if a binary opens a file using
1685 * %pK and then elevates privileges before reading it.
1686 */
Jason A. Donenfeld7eb39122016-02-11 16:13:00 -08001687 cred = current_cred();
Ryan Mallon312b4e22013-11-12 15:08:51 -08001688 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
1689 !uid_eq(cred->euid, cred->uid) ||
1690 !gid_eq(cred->egid, cred->gid))
1691 ptr = NULL;
1692 break;
1693 }
1694 case 2:
1695 default:
1696 /* Always print 0's for %pK */
Joe Perches26297602011-03-22 16:34:19 -07001697 ptr = NULL;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001698 break;
1699 }
Joe Perches26297602011-03-22 16:34:19 -07001700 break;
Ryan Mallon312b4e22013-11-12 15:08:51 -08001701
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001702 case 'N':
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001703 return netdev_bits(buf, end, ptr, fmt);
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08001704 case 'a':
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001705 return address_val(buf, end, ptr, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04001706 case 'd':
1707 return dentry_name(buf, end, ptr, spec, fmt);
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001708 case 'C':
1709 return clock(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04001710 case 'D':
1711 return dentry_name(buf, end,
1712 ((const struct file *)ptr)->f_path.dentry,
1713 spec, fmt);
Dmitry Monakhov1031bc52015-04-13 16:31:35 +04001714#ifdef CONFIG_BLOCK
1715 case 'g':
1716 return bdev_name(buf, end, ptr, spec, fmt);
1717#endif
1718
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001719 case 'G':
1720 return flags_string(buf, end, ptr, fmt);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07001721 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001722 spec.flags |= SMALL;
1723 if (spec.field_width == -1) {
Grant Likely725fe002012-05-31 16:26:08 -07001724 spec.field_width = default_width;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001725 spec.flags |= ZEROPAD;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001726 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001727 spec.base = 16;
1728
1729 return number(buf, end, (unsigned long) ptr, spec);
1730}
1731
1732/*
1733 * Helper function to decode printf style format.
1734 * Each call decode a token from the format and return the
1735 * number of characters read (or likely the delta where it wants
1736 * to go on the next call).
1737 * The decoded token is returned through the parameters
1738 *
1739 * 'h', 'l', or 'L' for integer fields
1740 * 'z' support added 23/7/1999 S.H.
1741 * 'z' changed to 'Z' --davidm 1/25/99
1742 * 't' added for ptrdiff_t
1743 *
1744 * @fmt: the format string
1745 * @type of the token returned
1746 * @flags: various flags such as +, -, # tokens..
1747 * @field_width: overwritten width
1748 * @base: base of the number (octal, hex, ...)
1749 * @precision: precision of a number
1750 * @qualifier: qualifier of a number (long, size_t, ...)
1751 */
Joe Perchescf3b4292010-05-24 14:33:16 -07001752static noinline_for_stack
1753int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001754{
1755 const char *start = fmt;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001756 char qualifier;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001757
1758 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01001759 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001760 if (spec->field_width < 0) {
1761 spec->field_width = -spec->field_width;
1762 spec->flags |= LEFT;
1763 }
1764 spec->type = FORMAT_TYPE_NONE;
1765 goto precision;
1766 }
1767
1768 /* we finished early by reading the precision */
1769 if (spec->type == FORMAT_TYPE_PRECISION) {
1770 if (spec->precision < 0)
1771 spec->precision = 0;
1772
1773 spec->type = FORMAT_TYPE_NONE;
1774 goto qualifier;
1775 }
1776
1777 /* By default */
1778 spec->type = FORMAT_TYPE_NONE;
1779
1780 for (; *fmt ; ++fmt) {
1781 if (*fmt == '%')
1782 break;
1783 }
1784
1785 /* Return the current non-format string */
1786 if (fmt != start || !*fmt)
1787 return fmt - start;
1788
1789 /* Process flags */
1790 spec->flags = 0;
1791
1792 while (1) { /* this also skips first '%' */
1793 bool found = true;
1794
1795 ++fmt;
1796
1797 switch (*fmt) {
1798 case '-': spec->flags |= LEFT; break;
1799 case '+': spec->flags |= PLUS; break;
1800 case ' ': spec->flags |= SPACE; break;
1801 case '#': spec->flags |= SPECIAL; break;
1802 case '0': spec->flags |= ZEROPAD; break;
1803 default: found = false;
1804 }
1805
1806 if (!found)
1807 break;
1808 }
1809
1810 /* get field width */
1811 spec->field_width = -1;
1812
1813 if (isdigit(*fmt))
1814 spec->field_width = skip_atoi(&fmt);
1815 else if (*fmt == '*') {
1816 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01001817 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001818 return ++fmt - start;
1819 }
1820
1821precision:
1822 /* get the precision */
1823 spec->precision = -1;
1824 if (*fmt == '.') {
1825 ++fmt;
1826 if (isdigit(*fmt)) {
1827 spec->precision = skip_atoi(&fmt);
1828 if (spec->precision < 0)
1829 spec->precision = 0;
1830 } else if (*fmt == '*') {
1831 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01001832 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001833 return ++fmt - start;
1834 }
1835 }
1836
1837qualifier:
1838 /* get the conversion qualifier */
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001839 qualifier = 0;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07001840 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
1841 _tolower(*fmt) == 'z' || *fmt == 't') {
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001842 qualifier = *fmt++;
1843 if (unlikely(qualifier == *fmt)) {
1844 if (qualifier == 'l') {
1845 qualifier = 'L';
Zhaoleia4e94ef2009-03-27 17:07:05 +08001846 ++fmt;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001847 } else if (qualifier == 'h') {
1848 qualifier = 'H';
Zhaoleia4e94ef2009-03-27 17:07:05 +08001849 ++fmt;
1850 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001851 }
1852 }
1853
1854 /* default base */
1855 spec->base = 10;
1856 switch (*fmt) {
1857 case 'c':
1858 spec->type = FORMAT_TYPE_CHAR;
1859 return ++fmt - start;
1860
1861 case 's':
1862 spec->type = FORMAT_TYPE_STR;
1863 return ++fmt - start;
1864
1865 case 'p':
1866 spec->type = FORMAT_TYPE_PTR;
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08001867 return ++fmt - start;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001868
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001869 case '%':
1870 spec->type = FORMAT_TYPE_PERCENT_CHAR;
1871 return ++fmt - start;
1872
1873 /* integer number formats - set up the flags and "break" */
1874 case 'o':
1875 spec->base = 8;
1876 break;
1877
1878 case 'x':
1879 spec->flags |= SMALL;
1880
1881 case 'X':
1882 spec->base = 16;
1883 break;
1884
1885 case 'd':
1886 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01001887 spec->flags |= SIGN;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001888 case 'u':
1889 break;
1890
Ryan Mallon708d96fd2014-04-03 14:48:37 -07001891 case 'n':
1892 /*
Rasmus Villemoesb006f192015-11-06 16:30:20 -08001893 * Since %n poses a greater security risk than
1894 * utility, treat it as any other invalid or
1895 * unsupported format specifier.
Ryan Mallon708d96fd2014-04-03 14:48:37 -07001896 */
Ryan Mallon708d96fd2014-04-03 14:48:37 -07001897 /* Fall-through */
1898
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001899 default:
Rasmus Villemoesb006f192015-11-06 16:30:20 -08001900 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001901 spec->type = FORMAT_TYPE_INVALID;
1902 return fmt - start;
1903 }
1904
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001905 if (qualifier == 'L')
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001906 spec->type = FORMAT_TYPE_LONG_LONG;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001907 else if (qualifier == 'l') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001908 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
1909 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001910 } else if (_tolower(qualifier) == 'z') {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001911 spec->type = FORMAT_TYPE_SIZE_T;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001912 } else if (qualifier == 't') {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001913 spec->type = FORMAT_TYPE_PTRDIFF;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001914 } else if (qualifier == 'H') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001915 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
1916 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
Rasmus Villemoesd0484192016-01-15 16:58:37 -08001917 } else if (qualifier == 'h') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001918 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
1919 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001920 } else {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07001921 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
1922 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001923 }
1924
1925 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07001926}
1927
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08001928static void
1929set_field_width(struct printf_spec *spec, int width)
1930{
1931 spec->field_width = width;
1932 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
1933 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
1934 }
1935}
1936
1937static void
1938set_precision(struct printf_spec *spec, int prec)
1939{
1940 spec->precision = prec;
1941 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
1942 spec->precision = clamp(prec, 0, PRECISION_MAX);
1943 }
1944}
1945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946/**
1947 * vsnprintf - Format a string and place it in a buffer
1948 * @buf: The buffer to place the result into
1949 * @size: The size of the buffer, including the trailing null space
1950 * @fmt: The format string to use
1951 * @args: Arguments for the format string
1952 *
Rasmus Villemoesd7ec9a02015-11-06 16:30:35 -08001953 * This function generally follows C99 vsnprintf, but has some
1954 * extensions and a few limitations:
1955 *
1956 * %n is unsupported
Martin Kletzander5e4ee7b2015-11-06 16:30:17 -08001957 * %p* is handled by pointer()
Andi Kleen20036fd2008-10-15 22:02:02 -07001958 *
Martin Kletzander5e4ee7b2015-11-06 16:30:17 -08001959 * See pointer() or Documentation/printk-formats.txt for more
1960 * extensive description.
1961 *
1962 * ** Please update the documentation in both places when making changes **
Andrew Morton80f548e2012-07-30 14:40:25 -07001963 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 * The return value is the number of characters which would
1965 * be generated for the given input, excluding the trailing
1966 * '\0', as per ISO C99. If you want to have the exact
1967 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001968 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 * return is greater than or equal to @size, the resulting
1970 * string is truncated.
1971 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07001972 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 */
1974int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
1975{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001977 char *str, *end;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001978 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001980 /* Reject out-of-range values early. Large positive sizes are
1981 used for unknown buffer sizes. */
Rasmus Villemoes2aa2f9e2015-02-12 15:01:39 -08001982 if (WARN_ON_ONCE(size > INT_MAX))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
1985 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001986 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07001988 /* Make sure end is always >= buf */
1989 if (end < buf) {
1990 end = ((void *)-1);
1991 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 }
1993
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001994 while (*fmt) {
1995 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08001996 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01001997
1998 fmt += read;
1999
2000 switch (spec.type) {
2001 case FORMAT_TYPE_NONE: {
2002 int copy = read;
2003 if (str < end) {
2004 if (copy > end - str)
2005 copy = end - str;
2006 memcpy(str, old_fmt, copy);
2007 }
2008 str += read;
2009 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 }
2011
Vegard Nossumed681a92009-03-14 12:08:50 +01002012 case FORMAT_TYPE_WIDTH:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002013 set_field_width(&spec, va_arg(args, int));
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002014 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002016 case FORMAT_TYPE_PRECISION:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002017 set_precision(&spec, va_arg(args, int));
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002018 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019
André Goddard Rosad4be1512009-12-14 18:00:59 -08002020 case FORMAT_TYPE_CHAR: {
2021 char c;
2022
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002023 if (!(spec.flags & LEFT)) {
2024 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002025 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 *str = ' ';
2027 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002030 }
2031 c = (unsigned char) va_arg(args, int);
2032 if (str < end)
2033 *str = c;
2034 ++str;
2035 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002036 if (str < end)
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002037 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002039 }
2040 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002041 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002043 case FORMAT_TYPE_STR:
2044 str = string(str, end, va_arg(args, char *), spec);
2045 break;
2046
2047 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002048 str = pointer(fmt, str, end, va_arg(args, void *),
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002049 spec);
2050 while (isalnum(*fmt))
2051 fmt++;
2052 break;
2053
2054 case FORMAT_TYPE_PERCENT_CHAR:
2055 if (str < end)
2056 *str = '%';
2057 ++str;
2058 break;
2059
2060 case FORMAT_TYPE_INVALID:
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002061 /*
2062 * Presumably the arguments passed gcc's type
2063 * checking, but there is no safe or sane way
2064 * for us to continue parsing the format and
2065 * fetching from the va_list; the remaining
2066 * specifiers and arguments would be out of
2067 * sync.
2068 */
2069 goto out;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002070
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002071 default:
2072 switch (spec.type) {
2073 case FORMAT_TYPE_LONG_LONG:
2074 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002076 case FORMAT_TYPE_ULONG:
2077 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002079 case FORMAT_TYPE_LONG:
2080 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002082 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08002083 if (spec.flags & SIGN)
2084 num = va_arg(args, ssize_t);
2085 else
2086 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002087 break;
2088 case FORMAT_TYPE_PTRDIFF:
2089 num = va_arg(args, ptrdiff_t);
2090 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002091 case FORMAT_TYPE_UBYTE:
2092 num = (unsigned char) va_arg(args, int);
2093 break;
2094 case FORMAT_TYPE_BYTE:
2095 num = (signed char) va_arg(args, int);
2096 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002097 case FORMAT_TYPE_USHORT:
2098 num = (unsigned short) va_arg(args, int);
2099 break;
2100 case FORMAT_TYPE_SHORT:
2101 num = (short) va_arg(args, int);
2102 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01002103 case FORMAT_TYPE_INT:
2104 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002105 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 default:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002107 num = va_arg(args, unsigned int);
2108 }
2109
2110 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002113
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002114out:
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002115 if (size > 0) {
2116 if (str < end)
2117 *str = '\0';
2118 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07002119 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002120 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002121
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002122 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 return str-buf;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002124
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126EXPORT_SYMBOL(vsnprintf);
2127
2128/**
2129 * vscnprintf - Format a string and place it in a buffer
2130 * @buf: The buffer to place the result into
2131 * @size: The size of the buffer, including the trailing null space
2132 * @fmt: The format string to use
2133 * @args: Arguments for the format string
2134 *
2135 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08002136 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 * returns 0.
2138 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002139 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002140 *
2141 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 */
2143int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2144{
2145 int i;
2146
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002147 i = vsnprintf(buf, size, fmt, args);
2148
Anton Arapovb921c692011-01-12 16:59:49 -08002149 if (likely(i < size))
2150 return i;
2151 if (size != 0)
2152 return size - 1;
2153 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155EXPORT_SYMBOL(vscnprintf);
2156
2157/**
2158 * snprintf - Format a string and place it in a buffer
2159 * @buf: The buffer to place the result into
2160 * @size: The size of the buffer, including the trailing null space
2161 * @fmt: The format string to use
2162 * @...: Arguments for the format string
2163 *
2164 * The return value is the number of characters which would be
2165 * generated for the given input, excluding the trailing null,
2166 * as per ISO C99. If the return is greater than or equal to
2167 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07002168 *
2169 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002171int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172{
2173 va_list args;
2174 int i;
2175
2176 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002177 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002179
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 return i;
2181}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182EXPORT_SYMBOL(snprintf);
2183
2184/**
2185 * scnprintf - Format a string and place it in a buffer
2186 * @buf: The buffer to place the result into
2187 * @size: The size of the buffer, including the trailing null space
2188 * @fmt: The format string to use
2189 * @...: Arguments for the format string
2190 *
2191 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07002192 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 */
2194
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002195int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196{
2197 va_list args;
2198 int i;
2199
2200 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08002201 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002203
Anton Arapovb921c692011-01-12 16:59:49 -08002204 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205}
2206EXPORT_SYMBOL(scnprintf);
2207
2208/**
2209 * vsprintf - Format a string and place it in a buffer
2210 * @buf: The buffer to place the result into
2211 * @fmt: The format string to use
2212 * @args: Arguments for the format string
2213 *
2214 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002215 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 * buffer overflows.
2217 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002218 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002219 *
2220 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 */
2222int vsprintf(char *buf, const char *fmt, va_list args)
2223{
2224 return vsnprintf(buf, INT_MAX, fmt, args);
2225}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226EXPORT_SYMBOL(vsprintf);
2227
2228/**
2229 * sprintf - Format a string and place it in a buffer
2230 * @buf: The buffer to place the result into
2231 * @fmt: The format string to use
2232 * @...: Arguments for the format string
2233 *
2234 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002235 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07002237 *
2238 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002240int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241{
2242 va_list args;
2243 int i;
2244
2245 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002246 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002248
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 return i;
2250}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251EXPORT_SYMBOL(sprintf);
2252
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002253#ifdef CONFIG_BINARY_PRINTF
2254/*
2255 * bprintf service:
2256 * vbin_printf() - VA arguments to binary data
2257 * bstr_printf() - Binary data to text string
2258 */
2259
2260/**
2261 * vbin_printf - Parse a format string and place args' binary value in a buffer
2262 * @bin_buf: The buffer to place args' binary value
2263 * @size: The size of the buffer(by words(32bits), not characters)
2264 * @fmt: The format string to use
2265 * @args: Arguments for the format string
2266 *
2267 * The format follows C99 vsnprintf, except %n is ignored, and its argument
Masanari Iidada3dae52014-09-09 01:27:23 +09002268 * is skipped.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002269 *
2270 * The return value is the number of words(32bits) which would be generated for
2271 * the given input.
2272 *
2273 * NOTE:
2274 * If the return value is greater than @size, the resulting bin_buf is NOT
2275 * valid for bstr_printf().
2276 */
2277int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2278{
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002279 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002280 char *str, *end;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002281
2282 str = (char *)bin_buf;
2283 end = (char *)(bin_buf + size);
2284
2285#define save_arg(type) \
2286do { \
2287 if (sizeof(type) == 8) { \
2288 unsigned long long value; \
2289 str = PTR_ALIGN(str, sizeof(u32)); \
2290 value = va_arg(args, unsigned long long); \
2291 if (str + sizeof(type) <= end) { \
2292 *(u32 *)str = *(u32 *)&value; \
2293 *(u32 *)(str + 4) = *((u32 *)&value + 1); \
2294 } \
2295 } else { \
2296 unsigned long value; \
2297 str = PTR_ALIGN(str, sizeof(type)); \
2298 value = va_arg(args, int); \
2299 if (str + sizeof(type) <= end) \
2300 *(typeof(type) *)str = (type)value; \
2301 } \
2302 str += sizeof(type); \
2303} while (0)
2304
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002305 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08002306 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002307
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002308 fmt += read;
2309
2310 switch (spec.type) {
2311 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08002312 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002313 break;
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002314 case FORMAT_TYPE_INVALID:
2315 goto out;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002316
Vegard Nossumed681a92009-03-14 12:08:50 +01002317 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002318 case FORMAT_TYPE_PRECISION:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002319 save_arg(int);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002320 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002321
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002322 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002323 save_arg(char);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002324 break;
2325
2326 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002327 const char *save_str = va_arg(args, char *);
2328 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08002329
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002330 if ((unsigned long)save_str > (unsigned long)-PAGE_SIZE
2331 || (unsigned long)save_str < PAGE_SIZE)
André Goddard Rosa0f4f81d2009-12-14 18:00:55 -08002332 save_str = "(null)";
André Goddard Rosa6c356632009-12-14 18:00:56 -08002333 len = strlen(save_str) + 1;
2334 if (str + len < end)
2335 memcpy(str, save_str, len);
2336 str += len;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002337 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002338 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002339
2340 case FORMAT_TYPE_PTR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002341 save_arg(void *);
2342 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002343 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002344 fmt++;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002345 break;
2346
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002347 default:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002348 switch (spec.type) {
2349
2350 case FORMAT_TYPE_LONG_LONG:
2351 save_arg(long long);
2352 break;
2353 case FORMAT_TYPE_ULONG:
2354 case FORMAT_TYPE_LONG:
2355 save_arg(unsigned long);
2356 break;
2357 case FORMAT_TYPE_SIZE_T:
2358 save_arg(size_t);
2359 break;
2360 case FORMAT_TYPE_PTRDIFF:
2361 save_arg(ptrdiff_t);
2362 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002363 case FORMAT_TYPE_UBYTE:
2364 case FORMAT_TYPE_BYTE:
2365 save_arg(char);
2366 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002367 case FORMAT_TYPE_USHORT:
2368 case FORMAT_TYPE_SHORT:
2369 save_arg(short);
2370 break;
2371 default:
2372 save_arg(int);
2373 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002374 }
2375 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002376
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002377out:
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002378 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002379#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002380}
2381EXPORT_SYMBOL_GPL(vbin_printf);
2382
2383/**
2384 * bstr_printf - Format a string from binary arguments and place it in a buffer
2385 * @buf: The buffer to place the result into
2386 * @size: The size of the buffer, including the trailing null space
2387 * @fmt: The format string to use
2388 * @bin_buf: Binary arguments for the format string
2389 *
2390 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2391 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2392 * a binary buffer that generated by vbin_printf.
2393 *
2394 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002395 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002396 *
2397 * The return value is the number of characters which would
2398 * be generated for the given input, excluding the trailing
2399 * '\0', as per ISO C99. If you want to have the exact
2400 * number of characters written into @buf as return value
2401 * (not including the trailing '\0'), use vscnprintf(). If the
2402 * return is greater than or equal to @size, the resulting
2403 * string is truncated.
2404 */
2405int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2406{
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002407 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002408 char *str, *end;
2409 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002410
Rasmus Villemoes762abb52015-11-06 16:30:23 -08002411 if (WARN_ON_ONCE(size > INT_MAX))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002412 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002413
2414 str = buf;
2415 end = buf + size;
2416
2417#define get_arg(type) \
2418({ \
2419 typeof(type) value; \
2420 if (sizeof(type) == 8) { \
2421 args = PTR_ALIGN(args, sizeof(u32)); \
2422 *(u32 *)&value = *(u32 *)args; \
2423 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
2424 } else { \
2425 args = PTR_ALIGN(args, sizeof(type)); \
2426 value = *(typeof(type) *)args; \
2427 } \
2428 args += sizeof(type); \
2429 value; \
2430})
2431
2432 /* Make sure end is always >= buf */
2433 if (end < buf) {
2434 end = ((void *)-1);
2435 size = end - buf;
2436 }
2437
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002438 while (*fmt) {
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002439 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002440 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002441
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002442 fmt += read;
2443
2444 switch (spec.type) {
2445 case FORMAT_TYPE_NONE: {
2446 int copy = read;
2447 if (str < end) {
2448 if (copy > end - str)
2449 copy = end - str;
2450 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002451 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002452 str += read;
2453 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002454 }
2455
Vegard Nossumed681a92009-03-14 12:08:50 +01002456 case FORMAT_TYPE_WIDTH:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002457 set_field_width(&spec, get_arg(int));
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002458 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002459
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002460 case FORMAT_TYPE_PRECISION:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002461 set_precision(&spec, get_arg(int));
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002462 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002463
André Goddard Rosad4be1512009-12-14 18:00:59 -08002464 case FORMAT_TYPE_CHAR: {
2465 char c;
2466
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002467 if (!(spec.flags & LEFT)) {
2468 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002469 if (str < end)
2470 *str = ' ';
2471 ++str;
2472 }
2473 }
2474 c = (unsigned char) get_arg(char);
2475 if (str < end)
2476 *str = c;
2477 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002478 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002479 if (str < end)
2480 *str = ' ';
2481 ++str;
2482 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002483 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002484 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002485
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002486 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002487 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002488 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002489 str = string(str, end, (char *)str_arg, spec);
2490 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002491 }
2492
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002493 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002494 str = pointer(fmt, str, end, get_arg(void *), spec);
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002495 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002496 fmt++;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002497 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002498
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002499 case FORMAT_TYPE_PERCENT_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002500 if (str < end)
2501 *str = '%';
2502 ++str;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002503 break;
2504
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002505 case FORMAT_TYPE_INVALID:
2506 goto out;
2507
André Goddard Rosad4be1512009-12-14 18:00:59 -08002508 default: {
2509 unsigned long long num;
2510
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002511 switch (spec.type) {
2512
2513 case FORMAT_TYPE_LONG_LONG:
2514 num = get_arg(long long);
2515 break;
2516 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002517 case FORMAT_TYPE_LONG:
2518 num = get_arg(unsigned long);
2519 break;
2520 case FORMAT_TYPE_SIZE_T:
2521 num = get_arg(size_t);
2522 break;
2523 case FORMAT_TYPE_PTRDIFF:
2524 num = get_arg(ptrdiff_t);
2525 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002526 case FORMAT_TYPE_UBYTE:
2527 num = get_arg(unsigned char);
2528 break;
2529 case FORMAT_TYPE_BYTE:
2530 num = get_arg(signed char);
2531 break;
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002532 case FORMAT_TYPE_USHORT:
2533 num = get_arg(unsigned short);
2534 break;
2535 case FORMAT_TYPE_SHORT:
2536 num = get_arg(short);
2537 break;
2538 case FORMAT_TYPE_UINT:
2539 num = get_arg(unsigned int);
2540 break;
2541 default:
2542 num = get_arg(int);
2543 }
2544
2545 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08002546 } /* default: */
2547 } /* switch(spec.type) */
2548 } /* while(*fmt) */
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002549
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002550out:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002551 if (size > 0) {
2552 if (str < end)
2553 *str = '\0';
2554 else
2555 end[-1] = '\0';
2556 }
Frederic Weisbeckerfef20d9c2009-03-06 17:21:50 +01002557
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002558#undef get_arg
2559
2560 /* the trailing null byte doesn't count towards the total */
2561 return str - buf;
2562}
2563EXPORT_SYMBOL_GPL(bstr_printf);
2564
2565/**
2566 * bprintf - Parse a format string and place args' binary value in a buffer
2567 * @bin_buf: The buffer to place args' binary value
2568 * @size: The size of the buffer(by words(32bits), not characters)
2569 * @fmt: The format string to use
2570 * @...: Arguments for the format string
2571 *
2572 * The function returns the number of words(u32) written
2573 * into @bin_buf.
2574 */
2575int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
2576{
2577 va_list args;
2578 int ret;
2579
2580 va_start(args, fmt);
2581 ret = vbin_printf(bin_buf, size, fmt, args);
2582 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002583
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002584 return ret;
2585}
2586EXPORT_SYMBOL_GPL(bprintf);
2587
2588#endif /* CONFIG_BINARY_PRINTF */
2589
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590/**
2591 * vsscanf - Unformat a buffer into a list of arguments
2592 * @buf: input buffer
2593 * @fmt: format of buffer
2594 * @args: arguments
2595 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002596int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597{
2598 const char *str = buf;
2599 char *next;
2600 char digit;
2601 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08002602 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08002603 unsigned int base;
2604 union {
2605 long long s;
2606 unsigned long long u;
2607 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08002608 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002609 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610
Jan Beulichda990752012-10-04 17:13:24 -07002611 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 /* skip any white space in format */
2613 /* white space in format matchs any amount of
2614 * white space, including none, in the input.
2615 */
2616 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08002617 fmt = skip_spaces(++fmt);
2618 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002619 }
2620
2621 /* anything that is not a conversion must match exactly */
2622 if (*fmt != '%' && *fmt) {
2623 if (*fmt++ != *str++)
2624 break;
2625 continue;
2626 }
2627
2628 if (!*fmt)
2629 break;
2630 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002631
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 /* skip this conversion.
2633 * advance both strings to next white space
2634 */
2635 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07002636 if (!*str)
2637 break;
Jessica Yuf9310b22016-03-17 14:23:07 -07002638 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
2639 /* '%*[' not yet supported, invalid format */
2640 if (*fmt == '[')
2641 return num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642 fmt++;
Jessica Yuf9310b22016-03-17 14:23:07 -07002643 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644 while (!isspace(*str) && *str)
2645 str++;
2646 continue;
2647 }
2648
2649 /* get field width */
2650 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08002651 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08002653 if (field_width <= 0)
2654 break;
2655 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656
2657 /* get conversion qualifier */
2658 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002659 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
2660 _tolower(*fmt) == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 qualifier = *fmt++;
2662 if (unlikely(qualifier == *fmt)) {
2663 if (qualifier == 'h') {
2664 qualifier = 'H';
2665 fmt++;
2666 } else if (qualifier == 'l') {
2667 qualifier = 'L';
2668 fmt++;
2669 }
2670 }
2671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672
Jan Beulichda990752012-10-04 17:13:24 -07002673 if (!*fmt)
2674 break;
2675
2676 if (*fmt == 'n') {
2677 /* return number of characters read so far */
2678 *va_arg(args, int *) = str - buf;
2679 ++fmt;
2680 continue;
2681 }
2682
2683 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684 break;
2685
André Goddard Rosad4be1512009-12-14 18:00:59 -08002686 base = 10;
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002687 is_sign = false;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002688
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002689 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690 case 'c':
2691 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002692 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 if (field_width == -1)
2694 field_width = 1;
2695 do {
2696 *s++ = *str++;
2697 } while (--field_width > 0 && *str);
2698 num++;
2699 }
2700 continue;
2701 case 's':
2702 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002703 char *s = (char *)va_arg(args, char *);
2704 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07002705 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002707 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708
2709 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002710 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712 *s = '\0';
2713 num++;
2714 }
2715 continue;
Jessica Yuf9310b22016-03-17 14:23:07 -07002716 /*
2717 * Warning: This implementation of the '[' conversion specifier
2718 * deviates from its glibc counterpart in the following ways:
2719 * (1) It does NOT support ranges i.e. '-' is NOT a special
2720 * character
2721 * (2) It cannot match the closing bracket ']' itself
2722 * (3) A field width is required
2723 * (4) '%*[' (discard matching input) is currently not supported
2724 *
2725 * Example usage:
2726 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
2727 * buf1, buf2, buf3);
2728 * if (ret < 3)
2729 * // etc..
2730 */
2731 case '[':
2732 {
2733 char *s = (char *)va_arg(args, char *);
2734 DECLARE_BITMAP(set, 256) = {0};
2735 unsigned int len = 0;
2736 bool negate = (*fmt == '^');
2737
2738 /* field width is required */
2739 if (field_width == -1)
2740 return num;
2741
2742 if (negate)
2743 ++fmt;
2744
2745 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
2746 set_bit((u8)*fmt, set);
2747
2748 /* no ']' or no character set found */
2749 if (!*fmt || !len)
2750 return num;
2751 ++fmt;
2752
2753 if (negate) {
2754 bitmap_complement(set, set, 256);
2755 /* exclude null '\0' byte */
2756 clear_bit(0, set);
2757 }
2758
2759 /* match must be non-empty */
2760 if (!test_bit((u8)*str, set))
2761 return num;
2762
2763 while (test_bit((u8)*str, set) && field_width--)
2764 *s++ = *str++;
2765 *s = '\0';
2766 ++num;
2767 }
2768 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 case 'o':
2770 base = 8;
2771 break;
2772 case 'x':
2773 case 'X':
2774 base = 16;
2775 break;
2776 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002777 base = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 case 'd':
Fabian Frederick3f623eb2014-06-04 16:11:52 -07002779 is_sign = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780 case 'u':
2781 break;
2782 case '%':
2783 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002784 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785 return num;
2786 continue;
2787 default:
2788 /* invalid format; stop here */
2789 return num;
2790 }
2791
2792 /* have some sort of integer conversion.
2793 * first, skip white space in buffer.
2794 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08002795 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796
2797 digit = *str;
2798 if (is_sign && digit == '-')
2799 digit = *(str + 1);
2800
2801 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002802 || (base == 16 && !isxdigit(digit))
2803 || (base == 10 && !isdigit(digit))
2804 || (base == 8 && (!isdigit(digit) || digit > '7'))
2805 || (base == 0 && !isdigit(digit)))
2806 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807
Jan Beulich53809752012-12-17 16:01:31 -08002808 if (is_sign)
2809 val.s = qualifier != 'L' ?
2810 simple_strtol(str, &next, base) :
2811 simple_strtoll(str, &next, base);
2812 else
2813 val.u = qualifier != 'L' ?
2814 simple_strtoul(str, &next, base) :
2815 simple_strtoull(str, &next, base);
2816
2817 if (field_width > 0 && next - str > field_width) {
2818 if (base == 0)
2819 _parse_integer_fixup_radix(str, &base);
2820 while (next - str > field_width) {
2821 if (is_sign)
2822 val.s = div_s64(val.s, base);
2823 else
2824 val.u = div_u64(val.u, base);
2825 --next;
2826 }
2827 }
2828
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002829 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08002831 if (is_sign)
2832 *va_arg(args, signed char *) = val.s;
2833 else
2834 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002835 break;
2836 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08002837 if (is_sign)
2838 *va_arg(args, short *) = val.s;
2839 else
2840 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002841 break;
2842 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08002843 if (is_sign)
2844 *va_arg(args, long *) = val.s;
2845 else
2846 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002847 break;
2848 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08002849 if (is_sign)
2850 *va_arg(args, long long *) = val.s;
2851 else
2852 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 break;
2854 case 'Z':
2855 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08002856 *va_arg(args, size_t *) = val.u;
2857 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002858 default:
Jan Beulich53809752012-12-17 16:01:31 -08002859 if (is_sign)
2860 *va_arg(args, int *) = val.s;
2861 else
2862 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 break;
2864 }
2865 num++;
2866
2867 if (!next)
2868 break;
2869 str = next;
2870 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07002871
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872 return num;
2873}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874EXPORT_SYMBOL(vsscanf);
2875
2876/**
2877 * sscanf - Unformat a buffer into a list of arguments
2878 * @buf: input buffer
2879 * @fmt: formatting of buffer
2880 * @...: resulting arguments
2881 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002882int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883{
2884 va_list args;
2885 int i;
2886
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002887 va_start(args, fmt);
2888 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002890
Linus Torvalds1da177e2005-04-16 15:20:36 -07002891 return i;
2892}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893EXPORT_SYMBOL(sscanf);