blob: adbcca9c9cbad6b0f270a23e26c5068da8b9d970 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/lib/vsprintf.c
4 *
5 * Copyright (C) 1991, 1992 Linus Torvalds
6 */
7
8/* vsprintf.c -- Lars Wirzenius & Linus Torvalds. */
9/*
10 * Wirzenius wrote this portably, Torvalds fucked it up :-)
11 */
12
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080013/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 * Fri Jul 13 2001 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
15 * - changed to provide snprintf and vsnprintf functions
16 * So Feb 1 16:51:32 CET 2004 Juergen Quade <quade@hsnr.de>
17 * - scnprintf and vscnprintf
18 */
19
20#include <stdarg.h>
Rasmus Villemoesef27ac12019-03-07 16:27:03 -080021#include <linux/build_bug.h>
Stephen Boyd0d1d7a52015-06-19 15:00:46 -070022#include <linux/clk.h>
Geert Uytterhoeven900cca22015-04-15 16:17:20 -070023#include <linux/clk-provider.h>
Rasmus Villemoes57f56772019-10-15 21:07:05 +020024#include <linux/errname.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050025#include <linux/module.h> /* for KSYM_SYMBOL_LEN */
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/types.h>
27#include <linux/string.h>
28#include <linux/ctype.h>
29#include <linux/kernel.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070030#include <linux/kallsyms.h>
Jan Beulich53809752012-12-17 16:01:31 -080031#include <linux/math64.h>
Linus Torvalds0fe1ef22008-07-06 16:43:12 -070032#include <linux/uaccess.h>
Linus Torvalds332d2e72008-10-20 15:07:34 +110033#include <linux/ioport.h>
Al Viro4b6ccca2013-09-03 12:00:44 -040034#include <linux/dcache.h>
Ryan Mallon312b4e22013-11-12 15:08:51 -080035#include <linux/cred.h>
Andy Shevchenko4d42c442018-12-04 23:23:11 +020036#include <linux/rtc.h>
Andy Shevchenko7daac5b2020-04-15 20:00:44 +030037#include <linux/time.h>
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -070038#include <linux/uuid.h>
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +020039#include <linux/of.h>
Joe Perches8a27f7c2009-08-17 12:29:44 +000040#include <net/addrconf.h>
Tobin C. Hardingad67b742017-11-01 15:32:23 +110041#include <linux/siphash.h>
42#include <linux/compiler.h>
Sakari Ailusa92eb762019-10-03 15:32:16 +030043#include <linux/property.h>
Dmitry Monakhov1031bc52015-04-13 16:31:35 +040044#ifdef CONFIG_BLOCK
45#include <linux/blkdev.h>
46#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -070048#include "../mm/internal.h" /* For the trace_print_flags arrays */
49
Tim Schmielau4e57b682005-10-30 15:03:48 -080050#include <asm/page.h> /* for PAGE_SIZE */
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -070051#include <asm/byteorder.h> /* cpu_to_le16 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Andy Shevchenko71dca952014-10-13 15:55:18 -070053#include <linux/string_helpers.h>
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070054#include "kstrtox.h"
Harvey Harrisonaa46a632008-10-16 13:40:34 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * simple_strtoull - convert a string to an unsigned long long
58 * @cp: The start of the string
59 * @endp: A pointer to the end of the parsed string will be placed here
60 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080061 *
62 * This function is obsolete. Please use kstrtoull instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 */
Harvey Harrison22d27052008-10-16 13:40:35 -070064unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070066 unsigned long long result;
67 unsigned int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Alexey Dobriyan1dff46d2011-10-31 17:12:28 -070069 cp = _parse_integer_fixup_radix(cp, &base);
70 rv = _parse_integer(cp, base, &result);
71 /* FIXME */
72 cp += (rv & ~KSTRTOX_OVERFLOW);
Harvey Harrisonaa46a632008-10-16 13:40:34 -070073
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 if (endp)
75 *endp = (char *)cp;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -080076
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 return result;
78}
Linus Torvalds1da177e2005-04-16 15:20:36 -070079EXPORT_SYMBOL(simple_strtoull);
80
81/**
André Goddard Rosa922ac252009-12-14 18:01:01 -080082 * simple_strtoul - convert a string to an unsigned long
83 * @cp: The start of the string
84 * @endp: A pointer to the end of the parsed string will be placed here
85 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -080086 *
87 * This function is obsolete. Please use kstrtoul instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -080088 */
89unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base)
90{
91 return simple_strtoull(cp, endp, base);
92}
93EXPORT_SYMBOL(simple_strtoul);
94
95/**
96 * simple_strtol - convert a string to a signed long
97 * @cp: The start of the string
98 * @endp: A pointer to the end of the parsed string will be placed here
99 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -0800100 *
101 * This function is obsolete. Please use kstrtol instead.
André Goddard Rosa922ac252009-12-14 18:01:01 -0800102 */
103long simple_strtol(const char *cp, char **endp, unsigned int base)
104{
105 if (*cp == '-')
106 return -simple_strtoul(cp + 1, endp, base);
107
108 return simple_strtoul(cp, endp, base);
109}
110EXPORT_SYMBOL(simple_strtol);
111
112/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * simple_strtoll - convert a string to a signed long long
114 * @cp: The start of the string
115 * @endp: A pointer to the end of the parsed string will be placed here
116 * @base: The number base to use
Eldad Zack462e4712012-12-17 16:03:05 -0800117 *
118 * This function is obsolete. Please use kstrtoll instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
Harvey Harrison22d27052008-10-16 13:40:35 -0700120long long simple_strtoll(const char *cp, char **endp, unsigned int base)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800122 if (*cp == '-')
Harvey Harrison22d27052008-10-16 13:40:35 -0700123 return -simple_strtoull(cp + 1, endp, base);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800124
Harvey Harrison22d27052008-10-16 13:40:35 -0700125 return simple_strtoull(cp, endp, base);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126}
Hans Verkuil98d5ce02010-04-23 13:18:04 -0400127EXPORT_SYMBOL(simple_strtoll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
Joe Perchescf3b4292010-05-24 14:33:16 -0700129static noinline_for_stack
130int skip_atoi(const char **s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800132 int i = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800134 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 i = i*10 + *((*s)++) - '0';
Rasmus Villemoes43e5b662015-02-12 15:01:42 -0800136 } while (isdigit(**s));
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 return i;
139}
140
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700141/*
142 * Decimal conversion is by far the most typical, and is used for
143 * /proc and /sys data. This directly impacts e.g. top performance
144 * with many processes running. We optimize it for speed by emitting
145 * two characters at a time, using a 200 byte lookup table. This
146 * roughly halves the number of multiplications compared to computing
147 * the digits one at a time. Implementation strongly inspired by the
148 * previous version, which in turn used ideas described at
149 * <http://www.cs.uiowa.edu/~jones/bcd/divide.html> (with permission
150 * from the author, Douglas W. Jones).
151 *
152 * It turns out there is precisely one 26 bit fixed-point
153 * approximation a of 64/100 for which x/100 == (x * (u64)a) >> 32
154 * holds for all x in [0, 10^8-1], namely a = 0x28f5c29. The actual
155 * range happens to be somewhat larger (x <= 1073741898), but that's
156 * irrelevant for our purpose.
157 *
158 * For dividing a number in the range [10^4, 10^6-1] by 100, we still
159 * need a 32x32->64 bit multiply, so we simply use the same constant.
160 *
161 * For dividing a number in the range [100, 10^4-1] by 100, there are
162 * several options. The simplest is (x * 0x147b) >> 19, which is valid
163 * for all x <= 43698.
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700164 */
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700165
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700166static const u16 decpair[100] = {
167#define _(x) (__force u16) cpu_to_le16(((x % 10) | ((x / 10) << 8)) + 0x3030)
168 _( 0), _( 1), _( 2), _( 3), _( 4), _( 5), _( 6), _( 7), _( 8), _( 9),
169 _(10), _(11), _(12), _(13), _(14), _(15), _(16), _(17), _(18), _(19),
170 _(20), _(21), _(22), _(23), _(24), _(25), _(26), _(27), _(28), _(29),
171 _(30), _(31), _(32), _(33), _(34), _(35), _(36), _(37), _(38), _(39),
172 _(40), _(41), _(42), _(43), _(44), _(45), _(46), _(47), _(48), _(49),
173 _(50), _(51), _(52), _(53), _(54), _(55), _(56), _(57), _(58), _(59),
174 _(60), _(61), _(62), _(63), _(64), _(65), _(66), _(67), _(68), _(69),
175 _(70), _(71), _(72), _(73), _(74), _(75), _(76), _(77), _(78), _(79),
176 _(80), _(81), _(82), _(83), _(84), _(85), _(86), _(87), _(88), _(89),
177 _(90), _(91), _(92), _(93), _(94), _(95), _(96), _(97), _(98), _(99),
178#undef _
179};
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700180
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700181/*
182 * This will print a single '0' even if r == 0, since we would
Rasmus Villemoes675cf532015-04-16 12:43:42 -0700183 * immediately jump to out_r where two 0s would be written but only
184 * one of them accounted for in buf. This is needed by ip4_string
185 * below. All other callers pass a non-zero value of r.
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700186*/
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700187static noinline_for_stack
188char *put_dec_trunc8(char *buf, unsigned r)
189{
190 unsigned q;
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700191
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700192 /* 1 <= r < 10^8 */
193 if (r < 100)
194 goto out_r;
George Spelvincb239d02012-10-04 17:12:30 -0700195
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700196 /* 100 <= r < 10^8 */
197 q = (r * (u64)0x28f5c29) >> 32;
198 *((u16 *)buf) = decpair[r - 100*q];
199 buf += 2;
200
201 /* 1 <= q < 10^6 */
202 if (q < 100)
203 goto out_q;
204
205 /* 100 <= q < 10^6 */
206 r = (q * (u64)0x28f5c29) >> 32;
207 *((u16 *)buf) = decpair[q - 100*r];
208 buf += 2;
209
210 /* 1 <= r < 10^4 */
211 if (r < 100)
212 goto out_r;
213
214 /* 100 <= r < 10^4 */
215 q = (r * 0x147b) >> 19;
216 *((u16 *)buf) = decpair[r - 100*q];
217 buf += 2;
218out_q:
219 /* 1 <= q < 100 */
220 r = q;
221out_r:
222 /* 1 <= r < 100 */
223 *((u16 *)buf) = decpair[r];
Rasmus Villemoes675cf532015-04-16 12:43:42 -0700224 buf += r < 10 ? 1 : 2;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700225 return buf;
226}
227
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700228#if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64
229static noinline_for_stack
230char *put_dec_full8(char *buf, unsigned r)
231{
232 unsigned q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700233
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700234 /* 0 <= r < 10^8 */
235 q = (r * (u64)0x28f5c29) >> 32;
236 *((u16 *)buf) = decpair[r - 100*q];
237 buf += 2;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700238
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700239 /* 0 <= q < 10^6 */
240 r = (q * (u64)0x28f5c29) >> 32;
241 *((u16 *)buf) = decpair[q - 100*r];
242 buf += 2;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700243
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700244 /* 0 <= r < 10^4 */
245 q = (r * 0x147b) >> 19;
246 *((u16 *)buf) = decpair[r - 100*q];
247 buf += 2;
248
249 /* 0 <= q < 100 */
250 *((u16 *)buf) = decpair[q];
251 buf += 2;
252 return buf;
253}
254
255static noinline_for_stack
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700256char *put_dec(char *buf, unsigned long long n)
257{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700258 if (n >= 100*1000*1000)
259 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
260 /* 1 <= n <= 1.6e11 */
261 if (n >= 100*1000*1000)
262 buf = put_dec_full8(buf, do_div(n, 100*1000*1000));
263 /* 1 <= n < 1e8 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700264 return put_dec_trunc8(buf, n);
265}
266
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700267#elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700268
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700269static void
270put_dec_full4(char *buf, unsigned r)
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700271{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700272 unsigned q;
273
274 /* 0 <= r < 10^4 */
275 q = (r * 0x147b) >> 19;
276 *((u16 *)buf) = decpair[r - 100*q];
277 buf += 2;
278 /* 0 <= q < 100 */
279 *((u16 *)buf) = decpair[q];
George Spelvin23591722012-10-04 17:12:29 -0700280}
281
282/*
283 * Call put_dec_full4 on x % 10000, return x / 10000.
284 * The approximation x/10000 == (x * 0x346DC5D7) >> 43
285 * holds for all x < 1,128,869,999. The largest value this
286 * helper will ever be asked to convert is 1,125,520,955.
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700287 * (second call in the put_dec code, assuming n is all-ones).
George Spelvin23591722012-10-04 17:12:29 -0700288 */
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700289static noinline_for_stack
George Spelvin23591722012-10-04 17:12:29 -0700290unsigned put_dec_helper4(char *buf, unsigned x)
291{
292 uint32_t q = (x * (uint64_t)0x346DC5D7) >> 43;
293
294 put_dec_full4(buf, x - q * 10000);
295 return q;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700296}
297
298/* Based on code by Douglas W. Jones found at
299 * <http://www.cs.uiowa.edu/~jones/bcd/decimal.html#sixtyfour>
300 * (with permission from the author).
301 * Performs no 64-bit division and hence should be fast on 32-bit machines.
302 */
303static
304char *put_dec(char *buf, unsigned long long n)
305{
306 uint32_t d3, d2, d1, q, h;
307
308 if (n < 100*1000*1000)
309 return put_dec_trunc8(buf, n);
310
311 d1 = ((uint32_t)n >> 16); /* implicit "& 0xffff" */
312 h = (n >> 32);
313 d2 = (h ) & 0xffff;
314 d3 = (h >> 16); /* implicit "& 0xffff" */
315
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700316 /* n = 2^48 d3 + 2^32 d2 + 2^16 d1 + d0
317 = 281_4749_7671_0656 d3 + 42_9496_7296 d2 + 6_5536 d1 + d0 */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700318 q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff);
George Spelvin23591722012-10-04 17:12:29 -0700319 q = put_dec_helper4(buf, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700320
George Spelvin23591722012-10-04 17:12:29 -0700321 q += 7671 * d3 + 9496 * d2 + 6 * d1;
322 q = put_dec_helper4(buf+4, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700323
George Spelvin23591722012-10-04 17:12:29 -0700324 q += 4749 * d3 + 42 * d2;
325 q = put_dec_helper4(buf+8, q);
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700326
George Spelvin23591722012-10-04 17:12:29 -0700327 q += 281 * d3;
328 buf += 12;
329 if (q)
330 buf = put_dec_trunc8(buf, q);
331 else while (buf[-1] == '0')
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700332 --buf;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800333
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700334 return buf;
335}
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700336
337#endif
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700338
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700339/*
340 * Convert passed number to decimal string.
341 * Returns the length of string. On buffer overflow, returns 0.
342 *
343 * If speed is not important, use snprintf(). It's easy to read the code.
344 */
Andrei Vagind1be35c2018-04-10 16:31:16 -0700345int num_to_str(char *buf, int size, unsigned long long num, unsigned int width)
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700346{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700347 /* put_dec requires 2-byte alignment of the buffer. */
348 char tmp[sizeof(num) * 3] __aligned(2);
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700349 int idx, len;
350
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700351 /* put_dec() may work incorrectly for num = 0 (generate "", not "0") */
352 if (num <= 9) {
353 tmp[0] = '0' + num;
354 len = 1;
355 } else {
356 len = put_dec(tmp, num) - tmp;
357 }
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700358
Andrei Vagind1be35c2018-04-10 16:31:16 -0700359 if (len > size || width > size)
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700360 return 0;
Andrei Vagind1be35c2018-04-10 16:31:16 -0700361
362 if (width > len) {
363 width = width - len;
364 for (idx = 0; idx < width; idx++)
365 buf[idx] = ' ';
366 } else {
367 width = 0;
368 }
369
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700370 for (idx = 0; idx < len; ++idx)
Andrei Vagind1be35c2018-04-10 16:31:16 -0700371 buf[idx + width] = tmp[len - idx - 1];
372
373 return len + width;
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700374}
375
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700376#define SIGN 1 /* unsigned/signed, must be 1 */
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700377#define LEFT 2 /* left justified */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378#define PLUS 4 /* show plus */
379#define SPACE 8 /* space if plus */
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700380#define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */
Bjorn Helgaasb89dc5d2010-03-05 10:47:31 -0700381#define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */
382#define SPECIAL 64 /* prefix hex with "0x", octal with "0" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100384enum format_type {
385 FORMAT_TYPE_NONE, /* Just a string part */
Vegard Nossumed681a92009-03-14 12:08:50 +0100386 FORMAT_TYPE_WIDTH,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100387 FORMAT_TYPE_PRECISION,
388 FORMAT_TYPE_CHAR,
389 FORMAT_TYPE_STR,
390 FORMAT_TYPE_PTR,
391 FORMAT_TYPE_PERCENT_CHAR,
392 FORMAT_TYPE_INVALID,
393 FORMAT_TYPE_LONG_LONG,
394 FORMAT_TYPE_ULONG,
395 FORMAT_TYPE_LONG,
Zhaoleia4e94ef2009-03-27 17:07:05 +0800396 FORMAT_TYPE_UBYTE,
397 FORMAT_TYPE_BYTE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100398 FORMAT_TYPE_USHORT,
399 FORMAT_TYPE_SHORT,
400 FORMAT_TYPE_UINT,
401 FORMAT_TYPE_INT,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100402 FORMAT_TYPE_SIZE_T,
403 FORMAT_TYPE_PTRDIFF
404};
405
406struct printf_spec {
Rasmus Villemoesd0484192016-01-15 16:58:37 -0800407 unsigned int type:8; /* format_type enum */
408 signed int field_width:24; /* width of output field */
409 unsigned int flags:8; /* flags to number() */
410 unsigned int base:8; /* number base, 8, 10 or 16 only */
411 signed int precision:16; /* # of digits/chars */
412} __packed;
Rasmus Villemoesef27ac12019-03-07 16:27:03 -0800413static_assert(sizeof(struct printf_spec) == 8);
414
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -0800415#define FIELD_WIDTH_MAX ((1 << 23) - 1)
416#define PRECISION_MAX ((1 << 15) - 1)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100417
Joe Perchescf3b4292010-05-24 14:33:16 -0700418static noinline_for_stack
419char *number(char *buf, char *end, unsigned long long num,
420 struct printf_spec spec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -0700422 /* put_dec requires 2-byte alignment of the buffer. */
423 char tmp[3 * sizeof(num)] __aligned(2);
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100424 char sign;
425 char locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100426 int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 int i;
Pierre Carrier7c203422012-05-29 15:07:35 -0700428 bool is_zero = num == 0LL;
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800429 int field_width = spec.field_width;
430 int precision = spec.precision;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100432 /* locase = 0 or 0x20. ORing digits or letters with 'locase'
433 * produces same digits or (maybe lowercased) letters */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100434 locase = (spec.flags & SMALL);
435 if (spec.flags & LEFT)
436 spec.flags &= ~ZEROPAD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 sign = 0;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100438 if (spec.flags & SIGN) {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800439 if ((signed long long)num < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 sign = '-';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800441 num = -(signed long long)num;
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800442 field_width--;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100443 } else if (spec.flags & PLUS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 sign = '+';
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800445 field_width--;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100446 } else if (spec.flags & SPACE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 sign = ' ';
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800448 field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 }
450 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700451 if (need_pfx) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100452 if (spec.base == 16)
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800453 field_width -= 2;
Pierre Carrier7c203422012-05-29 15:07:35 -0700454 else if (!is_zero)
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800455 field_width--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700457
458 /* generate full string in tmp[], in reverse order */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 i = 0;
Denys Vlasenko133fd9f2012-05-31 16:26:08 -0700460 if (num < spec.base)
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700461 tmp[i++] = hex_asc_upper[num] | locase;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100462 else if (spec.base != 10) { /* 8 or 16 */
463 int mask = spec.base - 1;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700464 int shift = 3;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800465
466 if (spec.base == 16)
467 shift = 4;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700468 do {
Rasmus Villemoes3ea8d442015-04-15 16:17:08 -0700469 tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase);
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700470 num >>= shift;
471 } while (num);
Denis Vlasenko4277eed2007-07-15 23:41:56 -0700472 } else { /* base 10 */
473 i = put_dec(tmp, num) - tmp;
474 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700475
476 /* printing 100 using %2d gives "100", not "00" */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800477 if (i > precision)
478 precision = i;
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700479 /* leading space padding */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800480 field_width -= precision;
Rasmus Villemoes51be17d2015-04-15 16:17:02 -0700481 if (!(spec.flags & (ZEROPAD | LEFT))) {
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800482 while (--field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700483 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 *buf = ' ';
485 ++buf;
486 }
487 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700488 /* sign */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 if (sign) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700490 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 *buf = sign;
492 ++buf;
493 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700494 /* "0x" / "0" prefix */
495 if (need_pfx) {
Pierre Carrier7c203422012-05-29 15:07:35 -0700496 if (spec.base == 16 || !is_zero) {
497 if (buf < end)
498 *buf = '0';
499 ++buf;
500 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100501 if (spec.base == 16) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700502 if (buf < end)
Denys Vlasenko9b706ae2008-02-09 23:24:09 +0100503 *buf = ('X' | locase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 ++buf;
505 }
506 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700507 /* zero or space padding */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +0100508 if (!(spec.flags & LEFT)) {
Rasmus Villemoesd1c1b122015-04-15 16:17:11 -0700509 char c = ' ' + (spec.flags & ZEROPAD);
510 BUILD_BUG_ON(' ' + ZEROPAD != '0');
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800511 while (--field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700512 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 *buf = c;
514 ++buf;
515 }
516 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700517 /* hmm even more zero padding? */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800518 while (i <= --precision) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700519 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 *buf = '0';
521 ++buf;
522 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700523 /* actual digits of result */
524 while (--i >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700525 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 *buf = tmp[i];
527 ++buf;
528 }
Denis Vlasenkob39a7342007-07-15 23:41:54 -0700529 /* trailing space padding */
Rasmus Villemoes1c7a8e62016-01-15 16:58:41 -0800530 while (--field_width >= 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -0700531 if (buf < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 *buf = ' ';
533 ++buf;
534 }
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 return buf;
537}
538
Andy Shevchenko3cab1e72016-01-15 16:59:18 -0800539static noinline_for_stack
540char *special_hex_number(char *buf, char *end, unsigned long long num, int size)
541{
542 struct printf_spec spec;
543
544 spec.type = FORMAT_TYPE_PTR;
545 spec.field_width = 2 + 2 * size; /* 0x + hex */
546 spec.flags = SPECIAL | SMALL | ZEROPAD;
547 spec.base = 16;
548 spec.precision = -1;
549
550 return number(buf, end, num, spec);
551}
552
Rasmus Villemoescfccde02016-01-15 16:58:28 -0800553static void move_right(char *buf, char *end, unsigned len, unsigned spaces)
Al Viro4b6ccca2013-09-03 12:00:44 -0400554{
555 size_t size;
556 if (buf >= end) /* nowhere to put anything */
557 return;
558 size = end - buf;
559 if (size <= spaces) {
560 memset(buf, ' ', size);
561 return;
562 }
563 if (len) {
564 if (len > size - spaces)
565 len = size - spaces;
566 memmove(buf + spaces, buf, len);
567 }
568 memset(buf, ' ', spaces);
569}
570
Rasmus Villemoescfccde02016-01-15 16:58:28 -0800571/*
572 * Handle field width padding for a string.
573 * @buf: current buffer position
574 * @n: length of string
575 * @end: end of output buffer
576 * @spec: for field width and flags
577 * Returns: new buffer position after padding.
578 */
579static noinline_for_stack
580char *widen_string(char *buf, int n, char *end, struct printf_spec spec)
581{
582 unsigned spaces;
583
584 if (likely(n >= spec.field_width))
585 return buf;
586 /* we want to pad the sucker */
587 spaces = spec.field_width - n;
588 if (!(spec.flags & LEFT)) {
589 move_right(buf - n, end, n, spaces);
590 return buf + spaces;
591 }
592 while (spaces--) {
593 if (buf < end)
594 *buf = ' ';
595 ++buf;
596 }
597 return buf;
598}
599
Petr Mladekd529ac42019-04-17 13:53:43 +0200600/* Handle string from a well known address. */
601static char *string_nocheck(char *buf, char *end, const char *s,
602 struct printf_spec spec)
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800603{
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800604 int len = 0;
Youngmin Namb314dd42019-06-10 16:47:07 +0900605 int lim = spec.precision;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800606
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800607 while (lim--) {
608 char c = *s++;
609 if (!c)
610 break;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800611 if (buf < end)
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800612 *buf = c;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800613 ++buf;
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800614 ++len;
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800615 }
Rasmus Villemoes34fc8b92016-01-15 16:58:34 -0800616 return widen_string(buf, len, end, spec);
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800617}
618
Rasmus Villemoes57f56772019-10-15 21:07:05 +0200619static char *err_ptr(char *buf, char *end, void *ptr,
620 struct printf_spec spec)
621{
622 int err = PTR_ERR(ptr);
623 const char *sym = errname(err);
624
625 if (sym)
626 return string_nocheck(buf, end, sym, spec);
627
628 /*
629 * Somebody passed ERR_PTR(-1234) or some other non-existing
630 * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to
631 * printing it as its decimal representation.
632 */
633 spec.flags |= SIGN;
634 spec.base = 10;
635 return number(buf, end, err, spec);
636}
637
Petr Mladekc8c3b582019-04-17 13:53:50 +0200638/* Be careful: error messages must fit into the given buffer. */
639static char *error_string(char *buf, char *end, const char *s,
640 struct printf_spec spec)
641{
642 /*
643 * Hard limit to avoid a completely insane messages. It actually
644 * works pretty well because most error messages are in
645 * the many pointer format modifiers.
646 */
647 if (spec.precision == -1)
648 spec.precision = 2 * sizeof(void *);
649
650 return string_nocheck(buf, end, s, spec);
651}
652
Petr Mladek3e5903e2019-04-17 13:53:48 +0200653/*
Petr Mladek2ac5a3b2019-05-10 10:42:13 +0200654 * Do not call any complex external code here. Nested printk()/vsprintf()
655 * might cause infinite loops. Failures might break printk() and would
656 * be hard to debug.
Petr Mladek3e5903e2019-04-17 13:53:48 +0200657 */
658static const char *check_pointer_msg(const void *ptr)
659{
Petr Mladek3e5903e2019-04-17 13:53:48 +0200660 if (!ptr)
661 return "(null)";
662
Petr Mladek2ac5a3b2019-05-10 10:42:13 +0200663 if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr))
Petr Mladek3e5903e2019-04-17 13:53:48 +0200664 return "(efault)";
665
666 return NULL;
667}
668
669static int check_pointer(char **buf, char *end, const void *ptr,
670 struct printf_spec spec)
671{
672 const char *err_msg;
673
674 err_msg = check_pointer_msg(ptr);
675 if (err_msg) {
Petr Mladekc8c3b582019-04-17 13:53:50 +0200676 *buf = error_string(*buf, end, err_msg, spec);
Petr Mladek3e5903e2019-04-17 13:53:48 +0200677 return -EFAULT;
678 }
679
680 return 0;
681}
682
Rasmus Villemoes95508cf2016-01-15 16:58:31 -0800683static noinline_for_stack
Petr Mladekd529ac42019-04-17 13:53:43 +0200684char *string(char *buf, char *end, const char *s,
685 struct printf_spec spec)
686{
Petr Mladek3e5903e2019-04-17 13:53:48 +0200687 if (check_pointer(&buf, end, s, spec))
688 return buf;
Petr Mladekd529ac42019-04-17 13:53:43 +0200689
690 return string_nocheck(buf, end, s, spec);
691}
692
YueHaibingce9d3ec2019-04-27 00:46:30 +0800693static char *pointer_string(char *buf, char *end,
694 const void *ptr,
695 struct printf_spec spec)
Geert Uytterhoeven9073dac2018-10-11 10:42:47 +0200696{
697 spec.base = 16;
698 spec.flags |= SMALL;
699 if (spec.field_width == -1) {
700 spec.field_width = 2 * sizeof(ptr);
701 spec.flags |= ZEROPAD;
702 }
703
704 return number(buf, end, (unsigned long int)ptr, spec);
705}
706
707/* Make pointers available for printing early in the boot sequence. */
708static int debug_boot_weak_hash __ro_after_init;
709
710static int __init debug_boot_weak_hash_enable(char *str)
711{
712 debug_boot_weak_hash = 1;
713 pr_info("debug_boot_weak_hash enabled\n");
714 return 0;
715}
716early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable);
717
718static DEFINE_STATIC_KEY_TRUE(not_filled_random_ptr_key);
719static siphash_key_t ptr_key __read_mostly;
720
721static void enable_ptr_key_workfn(struct work_struct *work)
722{
723 get_random_bytes(&ptr_key, sizeof(ptr_key));
724 /* Needs to run from preemptible context */
725 static_branch_disable(&not_filled_random_ptr_key);
726}
727
728static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn);
729
730static void fill_random_ptr_key(struct random_ready_callback *unused)
731{
732 /* This may be in an interrupt handler. */
733 queue_work(system_unbound_wq, &enable_ptr_key_work);
734}
735
736static struct random_ready_callback random_ready = {
737 .func = fill_random_ptr_key
738};
739
740static int __init initialize_ptr_random(void)
741{
742 int key_size = sizeof(ptr_key);
743 int ret;
744
745 /* Use hw RNG if available. */
746 if (get_random_bytes_arch(&ptr_key, key_size) == key_size) {
747 static_branch_disable(&not_filled_random_ptr_key);
748 return 0;
749 }
750
751 ret = add_random_ready_callback(&random_ready);
752 if (!ret) {
753 return 0;
754 } else if (ret == -EALREADY) {
755 /* This is in preemptible context */
756 enable_ptr_key_workfn(&enable_ptr_key_work);
757 return 0;
758 }
759
760 return ret;
761}
762early_initcall(initialize_ptr_random);
763
764/* Maps a pointer to a 32 bit unique identifier. */
Joel Fernandes (Google)e4dcad22019-11-30 17:50:33 -0800765static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
Geert Uytterhoeven9073dac2018-10-11 10:42:47 +0200766{
Geert Uytterhoeven9073dac2018-10-11 10:42:47 +0200767 unsigned long hashval;
768
Joel Fernandes (Google)e4dcad22019-11-30 17:50:33 -0800769 if (static_branch_unlikely(&not_filled_random_ptr_key))
770 return -EAGAIN;
Geert Uytterhoeven9073dac2018-10-11 10:42:47 +0200771
772#ifdef CONFIG_64BIT
773 hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key);
774 /*
775 * Mask off the first 32 bits, this makes explicit that we have
776 * modified the address (and 32 bits is plenty for a unique ID).
777 */
778 hashval = hashval & 0xffffffff;
779#else
780 hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key);
781#endif
Joel Fernandes (Google)e4dcad22019-11-30 17:50:33 -0800782 *hashval_out = hashval;
783 return 0;
784}
785
786int ptr_to_hashval(const void *ptr, unsigned long *hashval_out)
787{
788 return __ptr_to_hashval(ptr, hashval_out);
789}
790
791static char *ptr_to_id(char *buf, char *end, const void *ptr,
792 struct printf_spec spec)
793{
794 const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)";
795 unsigned long hashval;
796 int ret;
797
798 /* When debugging early boot use non-cryptographically secure hash. */
799 if (unlikely(debug_boot_weak_hash)) {
800 hashval = hash_long((unsigned long)ptr, 32);
801 return pointer_string(buf, end, (const void *)hashval, spec);
802 }
803
804 ret = __ptr_to_hashval(ptr, &hashval);
805 if (ret) {
806 spec.field_width = 2 * sizeof(ptr);
807 /* string length must be less than default_width */
808 return error_string(buf, end, str, spec);
809 }
810
Geert Uytterhoeven9073dac2018-10-11 10:42:47 +0200811 return pointer_string(buf, end, (const void *)hashval, spec);
812}
813
Petr Mladek6eea2422019-04-17 13:53:41 +0200814int kptr_restrict __read_mostly;
815
816static noinline_for_stack
817char *restricted_pointer(char *buf, char *end, const void *ptr,
818 struct printf_spec spec)
819{
820 switch (kptr_restrict) {
821 case 0:
Petr Mladek1ac2f972019-04-17 13:53:42 +0200822 /* Handle as %p, hash and do _not_ leak addresses. */
823 return ptr_to_id(buf, end, ptr, spec);
Petr Mladek6eea2422019-04-17 13:53:41 +0200824 case 1: {
825 const struct cred *cred;
826
827 /*
828 * kptr_restrict==1 cannot be used in IRQ context
829 * because its test for CAP_SYSLOG would be meaningless.
830 */
831 if (in_irq() || in_serving_softirq() || in_nmi()) {
832 if (spec.field_width == -1)
833 spec.field_width = 2 * sizeof(ptr);
Petr Mladekc8c3b582019-04-17 13:53:50 +0200834 return error_string(buf, end, "pK-error", spec);
Petr Mladek6eea2422019-04-17 13:53:41 +0200835 }
836
837 /*
838 * Only print the real pointer value if the current
839 * process has CAP_SYSLOG and is running with the
840 * same credentials it started with. This is because
841 * access to files is checked at open() time, but %pK
842 * checks permission at read() time. We don't want to
843 * leak pointer values if a binary opens a file using
844 * %pK and then elevates privileges before reading it.
845 */
846 cred = current_cred();
847 if (!has_capability_noaudit(current, CAP_SYSLOG) ||
848 !uid_eq(cred->euid, cred->uid) ||
849 !gid_eq(cred->egid, cred->gid))
850 ptr = NULL;
851 break;
852 }
853 case 2:
854 default:
855 /* Always print 0's for %pK */
856 ptr = NULL;
857 break;
858 }
859
860 return pointer_string(buf, end, ptr, spec);
861}
862
Geert Uytterhoeven9073dac2018-10-11 10:42:47 +0200863static noinline_for_stack
Al Viro4b6ccca2013-09-03 12:00:44 -0400864char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec,
865 const char *fmt)
866{
867 const char *array[4], *s;
868 const struct dentry *p;
869 int depth;
870 int i, n;
871
872 switch (fmt[1]) {
873 case '2': case '3': case '4':
874 depth = fmt[1] - '0';
875 break;
876 default:
877 depth = 1;
878 }
879
880 rcu_read_lock();
881 for (i = 0; i < depth; i++, d = p) {
Petr Mladek3e5903e2019-04-17 13:53:48 +0200882 if (check_pointer(&buf, end, d, spec)) {
883 rcu_read_unlock();
884 return buf;
885 }
886
Mark Rutland6aa7de02017-10-23 14:07:29 -0700887 p = READ_ONCE(d->d_parent);
888 array[i] = READ_ONCE(d->d_name.name);
Al Viro4b6ccca2013-09-03 12:00:44 -0400889 if (p == d) {
890 if (i)
891 array[i] = "";
892 i++;
893 break;
894 }
895 }
896 s = array[--i];
897 for (n = 0; n != spec.precision; n++, buf++) {
898 char c = *s++;
899 if (!c) {
900 if (!i)
901 break;
902 c = '/';
903 s = array[--i];
904 }
905 if (buf < end)
906 *buf = c;
907 }
908 rcu_read_unlock();
Rasmus Villemoescfccde02016-01-15 16:58:28 -0800909 return widen_string(buf, n, end, spec);
Al Viro4b6ccca2013-09-03 12:00:44 -0400910}
911
Jia He36594b32019-08-09 09:24:56 +0800912static noinline_for_stack
913char *file_dentry_name(char *buf, char *end, const struct file *f,
914 struct printf_spec spec, const char *fmt)
915{
916 if (check_pointer(&buf, end, f, spec))
917 return buf;
918
919 return dentry_name(buf, end, f->f_path.dentry, spec, fmt);
920}
Dmitry Monakhov1031bc52015-04-13 16:31:35 +0400921#ifdef CONFIG_BLOCK
922static noinline_for_stack
923char *bdev_name(char *buf, char *end, struct block_device *bdev,
924 struct printf_spec spec, const char *fmt)
925{
Petr Mladek3e5903e2019-04-17 13:53:48 +0200926 struct gendisk *hd;
927
928 if (check_pointer(&buf, end, bdev, spec))
929 return buf;
930
931 hd = bdev->bd_disk;
Dmitry Monakhov1031bc52015-04-13 16:31:35 +0400932 buf = string(buf, end, hd->disk_name, spec);
933 if (bdev->bd_part->partno) {
934 if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) {
935 if (buf < end)
936 *buf = 'p';
937 buf++;
938 }
939 buf = number(buf, end, bdev->bd_part->partno, spec);
940 }
941 return buf;
942}
943#endif
944
Joe Perchescf3b4292010-05-24 14:33:16 -0700945static noinline_for_stack
946char *symbol_string(char *buf, char *end, void *ptr,
Joe Perchesb0d33c22012-12-12 10:18:50 -0800947 struct printf_spec spec, const char *fmt)
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700948{
Joe Perchesb0d33c22012-12-12 10:18:50 -0800949 unsigned long value;
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700950#ifdef CONFIG_KALLSYMS
951 char sym[KSYM_SYMBOL_LEN];
Joe Perchesb0d33c22012-12-12 10:18:50 -0800952#endif
953
954 if (fmt[1] == 'R')
955 ptr = __builtin_extract_return_addr(ptr);
956 value = (unsigned long)ptr;
957
958#ifdef CONFIG_KALLSYMS
959 if (*fmt == 'B')
Namhyung Kim0f77a8d2011-03-24 11:42:29 +0900960 sprint_backtrace(sym, value);
Sakari Ailus9af77062019-10-03 15:32:14 +0300961 else if (*fmt != 's')
Frederic Weisbecker0c8b9462009-04-15 17:48:18 +0200962 sprint_symbol(sym, value);
963 else
Stephen Boyd4796dd22012-05-29 15:07:33 -0700964 sprint_symbol_no_offset(sym, value);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -0800965
Petr Mladekd529ac42019-04-17 13:53:43 +0200966 return string_nocheck(buf, end, sym, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700967#else
Andy Shevchenko3cab1e72016-01-15 16:59:18 -0800968 return special_hex_number(buf, end, value, sizeof(void *));
Linus Torvalds0fe1ef22008-07-06 16:43:12 -0700969#endif
970}
971
Andy Shevchenkoabd4fe622018-02-16 23:07:05 +0200972static const struct printf_spec default_str_spec = {
973 .field_width = -1,
974 .precision = -1,
975};
976
Andy Shevchenko54433972018-02-16 23:07:06 +0200977static const struct printf_spec default_flag_spec = {
978 .base = 16,
979 .precision = -1,
980 .flags = SPECIAL | SMALL,
981};
982
Andy Shevchenkoce0b4912018-02-16 23:07:04 +0200983static const struct printf_spec default_dec_spec = {
984 .base = 10,
985 .precision = -1,
986};
987
Andy Shevchenko4d42c442018-12-04 23:23:11 +0200988static const struct printf_spec default_dec02_spec = {
989 .base = 10,
990 .field_width = 2,
991 .precision = -1,
992 .flags = ZEROPAD,
993};
994
995static const struct printf_spec default_dec04_spec = {
996 .base = 10,
997 .field_width = 4,
998 .precision = -1,
999 .flags = ZEROPAD,
1000};
1001
Joe Perchescf3b4292010-05-24 14:33:16 -07001002static noinline_for_stack
1003char *resource_string(char *buf, char *end, struct resource *res,
1004 struct printf_spec spec, const char *fmt)
Linus Torvalds332d2e72008-10-20 15:07:34 +11001005{
1006#ifndef IO_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -06001007#define IO_RSRC_PRINTK_SIZE 6
Linus Torvalds332d2e72008-10-20 15:07:34 +11001008#endif
1009
1010#ifndef MEM_RSRC_PRINTK_SIZE
Bjorn Helgaas28405372009-10-06 15:33:29 -06001011#define MEM_RSRC_PRINTK_SIZE 10
Linus Torvalds332d2e72008-10-20 15:07:34 +11001012#endif
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001013 static const struct printf_spec io_spec = {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001014 .base = 16,
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001015 .field_width = IO_RSRC_PRINTK_SIZE,
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01001016 .precision = -1,
1017 .flags = SPECIAL | SMALL | ZEROPAD,
1018 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001019 static const struct printf_spec mem_spec = {
1020 .base = 16,
1021 .field_width = MEM_RSRC_PRINTK_SIZE,
1022 .precision = -1,
1023 .flags = SPECIAL | SMALL | ZEROPAD,
1024 };
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -07001025 static const struct printf_spec bus_spec = {
1026 .base = 16,
1027 .field_width = 2,
1028 .precision = -1,
1029 .flags = SMALL | ZEROPAD,
1030 };
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001031 static const struct printf_spec str_spec = {
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001032 .field_width = -1,
1033 .precision = 10,
1034 .flags = LEFT,
1035 };
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001036
1037 /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8)
1038 * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */
1039#define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4)
1040#define FLAG_BUF_SIZE (2 * sizeof(res->flags))
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -07001041#define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]")
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001042#define RAW_BUF_SIZE sizeof("[mem - flags 0x]")
1043 char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE,
1044 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)];
1045
Linus Torvalds332d2e72008-10-20 15:07:34 +11001046 char *p = sym, *pend = sym + sizeof(sym);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001047 int decode = (fmt[0] == 'R') ? 1 : 0;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001048 const struct printf_spec *specp;
Linus Torvalds332d2e72008-10-20 15:07:34 +11001049
Petr Mladek3e5903e2019-04-17 13:53:48 +02001050 if (check_pointer(&buf, end, res, spec))
1051 return buf;
1052
Linus Torvalds332d2e72008-10-20 15:07:34 +11001053 *p++ = '[';
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001054 if (res->flags & IORESOURCE_IO) {
Petr Mladekd529ac42019-04-17 13:53:43 +02001055 p = string_nocheck(p, pend, "io ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001056 specp = &io_spec;
1057 } else if (res->flags & IORESOURCE_MEM) {
Petr Mladekd529ac42019-04-17 13:53:43 +02001058 p = string_nocheck(p, pend, "mem ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001059 specp = &mem_spec;
1060 } else if (res->flags & IORESOURCE_IRQ) {
Petr Mladekd529ac42019-04-17 13:53:43 +02001061 p = string_nocheck(p, pend, "irq ", str_spec);
Andy Shevchenkoce0b4912018-02-16 23:07:04 +02001062 specp = &default_dec_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001063 } else if (res->flags & IORESOURCE_DMA) {
Petr Mladekd529ac42019-04-17 13:53:43 +02001064 p = string_nocheck(p, pend, "dma ", str_spec);
Andy Shevchenkoce0b4912018-02-16 23:07:04 +02001065 specp = &default_dec_spec;
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -07001066 } else if (res->flags & IORESOURCE_BUS) {
Petr Mladekd529ac42019-04-17 13:53:43 +02001067 p = string_nocheck(p, pend, "bus ", str_spec);
Bjorn Helgaas0f4050c2010-03-05 10:47:42 -07001068 specp = &bus_spec;
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001069 } else {
Petr Mladekd529ac42019-04-17 13:53:43 +02001070 p = string_nocheck(p, pend, "??? ", str_spec);
Bjorn Helgaas4da0b662010-03-05 10:47:37 -07001071 specp = &mem_spec;
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001072 decode = 0;
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001073 }
Bjorn Helgaasd19cb802014-02-26 11:25:56 -07001074 if (decode && res->flags & IORESOURCE_UNSET) {
Petr Mladekd529ac42019-04-17 13:53:43 +02001075 p = string_nocheck(p, pend, "size ", str_spec);
Bjorn Helgaasd19cb802014-02-26 11:25:56 -07001076 p = number(p, pend, resource_size(res), *specp);
1077 } else {
1078 p = number(p, pend, res->start, *specp);
1079 if (res->start != res->end) {
1080 *p++ = '-';
1081 p = number(p, pend, res->end, *specp);
1082 }
Bjorn Helgaasc91d3372009-10-06 15:33:34 -06001083 }
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001084 if (decode) {
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001085 if (res->flags & IORESOURCE_MEM_64)
Petr Mladekd529ac42019-04-17 13:53:43 +02001086 p = string_nocheck(p, pend, " 64bit", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001087 if (res->flags & IORESOURCE_PREFETCH)
Petr Mladekd529ac42019-04-17 13:53:43 +02001088 p = string_nocheck(p, pend, " pref", str_spec);
Bjorn Helgaas9d7cca02010-03-05 10:47:47 -07001089 if (res->flags & IORESOURCE_WINDOW)
Petr Mladekd529ac42019-04-17 13:53:43 +02001090 p = string_nocheck(p, pend, " window", str_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001091 if (res->flags & IORESOURCE_DISABLED)
Petr Mladekd529ac42019-04-17 13:53:43 +02001092 p = string_nocheck(p, pend, " disabled", str_spec);
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001093 } else {
Petr Mladekd529ac42019-04-17 13:53:43 +02001094 p = string_nocheck(p, pend, " flags ", str_spec);
Andy Shevchenko54433972018-02-16 23:07:06 +02001095 p = number(p, pend, res->flags, default_flag_spec);
Bjorn Helgaasfd955412009-10-06 15:33:39 -06001096 }
Linus Torvalds332d2e72008-10-20 15:07:34 +11001097 *p++ = ']';
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06001098 *p = '\0';
Linus Torvalds332d2e72008-10-20 15:07:34 +11001099
Petr Mladekd529ac42019-04-17 13:53:43 +02001100 return string_nocheck(buf, end, sym, spec);
Linus Torvalds332d2e72008-10-20 15:07:34 +11001101}
1102
Joe Perchescf3b4292010-05-24 14:33:16 -07001103static noinline_for_stack
Andy Shevchenko31550a12012-07-30 14:40:27 -07001104char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1105 const char *fmt)
1106{
Steven Rostedt360603a2013-05-28 15:47:39 -04001107 int i, len = 1; /* if we pass '%ph[CDN]', field width remains
Andy Shevchenko31550a12012-07-30 14:40:27 -07001108 negative value, fallback to the default */
1109 char separator;
1110
1111 if (spec.field_width == 0)
1112 /* nothing to print */
1113 return buf;
1114
Petr Mladek3e5903e2019-04-17 13:53:48 +02001115 if (check_pointer(&buf, end, addr, spec))
1116 return buf;
Andy Shevchenko31550a12012-07-30 14:40:27 -07001117
1118 switch (fmt[1]) {
1119 case 'C':
1120 separator = ':';
1121 break;
1122 case 'D':
1123 separator = '-';
1124 break;
1125 case 'N':
1126 separator = 0;
1127 break;
1128 default:
1129 separator = ' ';
1130 break;
1131 }
1132
1133 if (spec.field_width > 0)
1134 len = min_t(int, spec.field_width, 64);
1135
Rasmus Villemoes9c98f232015-04-15 16:17:23 -07001136 for (i = 0; i < len; ++i) {
1137 if (buf < end)
1138 *buf = hex_asc_hi(addr[i]);
1139 ++buf;
1140 if (buf < end)
1141 *buf = hex_asc_lo(addr[i]);
1142 ++buf;
Andy Shevchenko31550a12012-07-30 14:40:27 -07001143
Rasmus Villemoes9c98f232015-04-15 16:17:23 -07001144 if (separator && i != len - 1) {
1145 if (buf < end)
1146 *buf = separator;
1147 ++buf;
1148 }
Andy Shevchenko31550a12012-07-30 14:40:27 -07001149 }
1150
1151 return buf;
1152}
1153
1154static noinline_for_stack
Tejun Heodbc760b2015-02-13 14:36:53 -08001155char *bitmap_string(char *buf, char *end, unsigned long *bitmap,
1156 struct printf_spec spec, const char *fmt)
1157{
1158 const int CHUNKSZ = 32;
1159 int nr_bits = max_t(int, spec.field_width, 0);
1160 int i, chunksz;
1161 bool first = true;
1162
Petr Mladek3e5903e2019-04-17 13:53:48 +02001163 if (check_pointer(&buf, end, bitmap, spec))
1164 return buf;
1165
Tejun Heodbc760b2015-02-13 14:36:53 -08001166 /* reused to print numbers */
1167 spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 };
1168
1169 chunksz = nr_bits & (CHUNKSZ - 1);
1170 if (chunksz == 0)
1171 chunksz = CHUNKSZ;
1172
1173 i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ;
1174 for (; i >= 0; i -= CHUNKSZ) {
1175 u32 chunkmask, val;
1176 int word, bit;
1177
1178 chunkmask = ((1ULL << chunksz) - 1);
1179 word = i / BITS_PER_LONG;
1180 bit = i % BITS_PER_LONG;
1181 val = (bitmap[word] >> bit) & chunkmask;
1182
1183 if (!first) {
1184 if (buf < end)
1185 *buf = ',';
1186 buf++;
1187 }
1188 first = false;
1189
1190 spec.field_width = DIV_ROUND_UP(chunksz, 4);
1191 buf = number(buf, end, val, spec);
1192
1193 chunksz = CHUNKSZ;
1194 }
1195 return buf;
1196}
1197
1198static noinline_for_stack
1199char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap,
1200 struct printf_spec spec, const char *fmt)
1201{
1202 int nr_bits = max_t(int, spec.field_width, 0);
1203 /* current bit is 'cur', most recently seen range is [rbot, rtop] */
1204 int cur, rbot, rtop;
1205 bool first = true;
1206
Petr Mladek3e5903e2019-04-17 13:53:48 +02001207 if (check_pointer(&buf, end, bitmap, spec))
1208 return buf;
1209
Tejun Heodbc760b2015-02-13 14:36:53 -08001210 rbot = cur = find_first_bit(bitmap, nr_bits);
1211 while (cur < nr_bits) {
1212 rtop = cur;
1213 cur = find_next_bit(bitmap, nr_bits, cur + 1);
1214 if (cur < nr_bits && cur <= rtop + 1)
1215 continue;
1216
1217 if (!first) {
1218 if (buf < end)
1219 *buf = ',';
1220 buf++;
1221 }
1222 first = false;
1223
Andy Shevchenkoce0b4912018-02-16 23:07:04 +02001224 buf = number(buf, end, rbot, default_dec_spec);
Tejun Heodbc760b2015-02-13 14:36:53 -08001225 if (rbot < rtop) {
1226 if (buf < end)
1227 *buf = '-';
1228 buf++;
1229
Andy Shevchenkoce0b4912018-02-16 23:07:04 +02001230 buf = number(buf, end, rtop, default_dec_spec);
Tejun Heodbc760b2015-02-13 14:36:53 -08001231 }
1232
1233 rbot = cur;
1234 }
1235 return buf;
1236}
1237
1238static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001239char *mac_address_string(char *buf, char *end, u8 *addr,
1240 struct printf_spec spec, const char *fmt)
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001241{
Joe Perches8a27f7c2009-08-17 12:29:44 +00001242 char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")];
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001243 char *p = mac_addr;
1244 int i;
Joe Perchesbc7259a2010-01-07 11:43:50 +00001245 char separator;
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001246 bool reversed = false;
Joe Perchesbc7259a2010-01-07 11:43:50 +00001247
Petr Mladek3e5903e2019-04-17 13:53:48 +02001248 if (check_pointer(&buf, end, addr, spec))
1249 return buf;
1250
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001251 switch (fmt[1]) {
1252 case 'F':
Joe Perchesbc7259a2010-01-07 11:43:50 +00001253 separator = '-';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001254 break;
1255
1256 case 'R':
1257 reversed = true;
1258 /* fall through */
1259
1260 default:
Joe Perchesbc7259a2010-01-07 11:43:50 +00001261 separator = ':';
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001262 break;
Joe Perchesbc7259a2010-01-07 11:43:50 +00001263 }
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001264
1265 for (i = 0; i < 6; i++) {
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07001266 if (reversed)
1267 p = hex_byte_pack(p, addr[5 - i]);
1268 else
1269 p = hex_byte_pack(p, addr[i]);
1270
Joe Perches8a27f7c2009-08-17 12:29:44 +00001271 if (fmt[0] == 'M' && i != 5)
Joe Perchesbc7259a2010-01-07 11:43:50 +00001272 *p++ = separator;
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001273 }
1274 *p = '\0';
1275
Petr Mladekd529ac42019-04-17 13:53:43 +02001276 return string_nocheck(buf, end, mac_addr, spec);
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07001277}
1278
Joe Perchescf3b4292010-05-24 14:33:16 -07001279static noinline_for_stack
1280char *ip4_string(char *p, const u8 *addr, const char *fmt)
Harvey Harrison689afa72008-10-28 16:04:44 -07001281{
Harvey Harrison689afa72008-10-28 16:04:44 -07001282 int i;
Joe Perches0159f242010-01-13 20:23:30 -08001283 bool leading_zeros = (fmt[0] == 'i');
1284 int index;
1285 int step;
Harvey Harrison689afa72008-10-28 16:04:44 -07001286
Joe Perches0159f242010-01-13 20:23:30 -08001287 switch (fmt[2]) {
1288 case 'h':
1289#ifdef __BIG_ENDIAN
1290 index = 0;
1291 step = 1;
1292#else
1293 index = 3;
1294 step = -1;
1295#endif
1296 break;
1297 case 'l':
1298 index = 3;
1299 step = -1;
1300 break;
1301 case 'n':
1302 case 'b':
1303 default:
1304 index = 0;
1305 step = 1;
1306 break;
1307 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001308 for (i = 0; i < 4; i++) {
Rasmus Villemoes7c43d9a2015-04-16 12:43:22 -07001309 char temp[4] __aligned(2); /* hold each IP quad in reverse order */
Denys Vlasenko133fd9f2012-05-31 16:26:08 -07001310 int digits = put_dec_trunc8(temp, addr[index]) - temp;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001311 if (leading_zeros) {
1312 if (digits < 3)
1313 *p++ = '0';
1314 if (digits < 2)
1315 *p++ = '0';
1316 }
1317 /* reverse the digits in the quad */
1318 while (digits--)
1319 *p++ = temp[digits];
1320 if (i < 3)
1321 *p++ = '.';
Joe Perches0159f242010-01-13 20:23:30 -08001322 index += step;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001323 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001324 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001325
Joe Perches8a27f7c2009-08-17 12:29:44 +00001326 return p;
1327}
1328
Joe Perchescf3b4292010-05-24 14:33:16 -07001329static noinline_for_stack
1330char *ip6_compressed_string(char *p, const char *addr)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001331{
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001332 int i, j, range;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001333 unsigned char zerolength[8];
1334 int longest = 1;
1335 int colonpos = -1;
1336 u16 word;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001337 u8 hi, lo;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001338 bool needcolon = false;
Joe Percheseb78cd22009-09-18 13:04:06 +00001339 bool useIPv4;
1340 struct in6_addr in6;
1341
1342 memcpy(&in6, addr, sizeof(struct in6_addr));
1343
1344 useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001345
1346 memset(zerolength, 0, sizeof(zerolength));
1347
1348 if (useIPv4)
1349 range = 6;
1350 else
1351 range = 8;
1352
1353 /* find position of longest 0 run */
1354 for (i = 0; i < range; i++) {
1355 for (j = i; j < range; j++) {
Joe Percheseb78cd22009-09-18 13:04:06 +00001356 if (in6.s6_addr16[j] != 0)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001357 break;
1358 zerolength[i]++;
1359 }
1360 }
1361 for (i = 0; i < range; i++) {
1362 if (zerolength[i] > longest) {
1363 longest = zerolength[i];
1364 colonpos = i;
1365 }
1366 }
Joe Perches29cf5192011-06-09 11:23:37 -07001367 if (longest == 1) /* don't compress a single 0 */
1368 colonpos = -1;
Joe Perches8a27f7c2009-08-17 12:29:44 +00001369
1370 /* emit address */
1371 for (i = 0; i < range; i++) {
1372 if (i == colonpos) {
1373 if (needcolon || i == 0)
1374 *p++ = ':';
1375 *p++ = ':';
1376 needcolon = false;
1377 i += longest - 1;
1378 continue;
1379 }
1380 if (needcolon) {
1381 *p++ = ':';
1382 needcolon = false;
1383 }
1384 /* hex u16 without leading 0s */
Joe Percheseb78cd22009-09-18 13:04:06 +00001385 word = ntohs(in6.s6_addr16[i]);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001386 hi = word >> 8;
1387 lo = word & 0xff;
1388 if (hi) {
1389 if (hi > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001390 p = hex_byte_pack(p, hi);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001391 else
1392 *p++ = hex_asc_lo(hi);
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001393 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001394 }
André Goddard Rosab5ff9922009-12-14 18:00:59 -08001395 else if (lo > 0x0f)
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001396 p = hex_byte_pack(p, lo);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001397 else
1398 *p++ = hex_asc_lo(lo);
1399 needcolon = true;
1400 }
1401
1402 if (useIPv4) {
1403 if (needcolon)
1404 *p++ = ':';
Joe Perches0159f242010-01-13 20:23:30 -08001405 p = ip4_string(p, &in6.s6_addr[12], "I4");
Joe Perches8a27f7c2009-08-17 12:29:44 +00001406 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00001407 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001408
Joe Perches8a27f7c2009-08-17 12:29:44 +00001409 return p;
1410}
1411
Joe Perchescf3b4292010-05-24 14:33:16 -07001412static noinline_for_stack
1413char *ip6_string(char *p, const char *addr, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001414{
1415 int i;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001416
Harvey Harrison689afa72008-10-28 16:04:44 -07001417 for (i = 0; i < 8; i++) {
Andy Shevchenko55036ba2011-10-31 17:12:41 -07001418 p = hex_byte_pack(p, *addr++);
1419 p = hex_byte_pack(p, *addr++);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001420 if (fmt[0] == 'I' && i != 7)
Harvey Harrison689afa72008-10-28 16:04:44 -07001421 *p++ = ':';
1422 }
1423 *p = '\0';
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08001424
Joe Perches8a27f7c2009-08-17 12:29:44 +00001425 return p;
1426}
1427
Joe Perchescf3b4292010-05-24 14:33:16 -07001428static noinline_for_stack
1429char *ip6_addr_string(char *buf, char *end, const u8 *addr,
1430 struct printf_spec spec, const char *fmt)
Joe Perches8a27f7c2009-08-17 12:29:44 +00001431{
1432 char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")];
1433
1434 if (fmt[0] == 'I' && fmt[2] == 'c')
Joe Percheseb78cd22009-09-18 13:04:06 +00001435 ip6_compressed_string(ip6_addr, addr);
Joe Perches8a27f7c2009-08-17 12:29:44 +00001436 else
Joe Percheseb78cd22009-09-18 13:04:06 +00001437 ip6_string(ip6_addr, addr, fmt);
Harvey Harrison689afa72008-10-28 16:04:44 -07001438
Petr Mladekd529ac42019-04-17 13:53:43 +02001439 return string_nocheck(buf, end, ip6_addr, spec);
Harvey Harrison689afa72008-10-28 16:04:44 -07001440}
1441
Joe Perchescf3b4292010-05-24 14:33:16 -07001442static noinline_for_stack
1443char *ip4_addr_string(char *buf, char *end, const u8 *addr,
1444 struct printf_spec spec, const char *fmt)
Harvey Harrison4aa99602008-10-29 12:49:58 -07001445{
Joe Perches8a27f7c2009-08-17 12:29:44 +00001446 char ip4_addr[sizeof("255.255.255.255")];
Harvey Harrison4aa99602008-10-29 12:49:58 -07001447
Joe Perches0159f242010-01-13 20:23:30 -08001448 ip4_string(ip4_addr, addr, fmt);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001449
Petr Mladekd529ac42019-04-17 13:53:43 +02001450 return string_nocheck(buf, end, ip4_addr, spec);
Harvey Harrison4aa99602008-10-29 12:49:58 -07001451}
1452
Joe Perchescf3b4292010-05-24 14:33:16 -07001453static noinline_for_stack
Daniel Borkmann10679642013-06-28 19:49:39 +02001454char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa,
1455 struct printf_spec spec, const char *fmt)
1456{
1457 bool have_p = false, have_s = false, have_f = false, have_c = false;
1458 char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") +
1459 sizeof(":12345") + sizeof("/123456789") +
1460 sizeof("%1234567890")];
1461 char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr);
1462 const u8 *addr = (const u8 *) &sa->sin6_addr;
1463 char fmt6[2] = { fmt[0], '6' };
1464 u8 off = 0;
1465
1466 fmt++;
1467 while (isalpha(*++fmt)) {
1468 switch (*fmt) {
1469 case 'p':
1470 have_p = true;
1471 break;
1472 case 'f':
1473 have_f = true;
1474 break;
1475 case 's':
1476 have_s = true;
1477 break;
1478 case 'c':
1479 have_c = true;
1480 break;
1481 }
1482 }
1483
1484 if (have_p || have_s || have_f) {
1485 *p = '[';
1486 off = 1;
1487 }
1488
1489 if (fmt6[0] == 'I' && have_c)
1490 p = ip6_compressed_string(ip6_addr + off, addr);
1491 else
1492 p = ip6_string(ip6_addr + off, addr, fmt6);
1493
1494 if (have_p || have_s || have_f)
1495 *p++ = ']';
1496
1497 if (have_p) {
1498 *p++ = ':';
1499 p = number(p, pend, ntohs(sa->sin6_port), spec);
1500 }
1501 if (have_f) {
1502 *p++ = '/';
1503 p = number(p, pend, ntohl(sa->sin6_flowinfo &
1504 IPV6_FLOWINFO_MASK), spec);
1505 }
1506 if (have_s) {
1507 *p++ = '%';
1508 p = number(p, pend, sa->sin6_scope_id, spec);
1509 }
1510 *p = '\0';
1511
Petr Mladekd529ac42019-04-17 13:53:43 +02001512 return string_nocheck(buf, end, ip6_addr, spec);
Daniel Borkmann10679642013-06-28 19:49:39 +02001513}
1514
1515static noinline_for_stack
1516char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa,
1517 struct printf_spec spec, const char *fmt)
1518{
1519 bool have_p = false;
1520 char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")];
1521 char *pend = ip4_addr + sizeof(ip4_addr);
1522 const u8 *addr = (const u8 *) &sa->sin_addr.s_addr;
1523 char fmt4[3] = { fmt[0], '4', 0 };
1524
1525 fmt++;
1526 while (isalpha(*++fmt)) {
1527 switch (*fmt) {
1528 case 'p':
1529 have_p = true;
1530 break;
1531 case 'h':
1532 case 'l':
1533 case 'n':
1534 case 'b':
1535 fmt4[2] = *fmt;
1536 break;
1537 }
1538 }
1539
1540 p = ip4_string(ip4_addr, addr, fmt4);
1541 if (have_p) {
1542 *p++ = ':';
1543 p = number(p, pend, ntohs(sa->sin_port), spec);
1544 }
1545 *p = '\0';
1546
Petr Mladekd529ac42019-04-17 13:53:43 +02001547 return string_nocheck(buf, end, ip4_addr, spec);
Daniel Borkmann10679642013-06-28 19:49:39 +02001548}
1549
1550static noinline_for_stack
Petr Mladekf00cc102019-04-17 13:53:44 +02001551char *ip_addr_string(char *buf, char *end, const void *ptr,
1552 struct printf_spec spec, const char *fmt)
1553{
Petr Mladek0b74d4d2019-04-17 13:53:47 +02001554 char *err_fmt_msg;
1555
Petr Mladek3e5903e2019-04-17 13:53:48 +02001556 if (check_pointer(&buf, end, ptr, spec))
1557 return buf;
1558
Petr Mladekf00cc102019-04-17 13:53:44 +02001559 switch (fmt[1]) {
1560 case '6':
1561 return ip6_addr_string(buf, end, ptr, spec, fmt);
1562 case '4':
1563 return ip4_addr_string(buf, end, ptr, spec, fmt);
1564 case 'S': {
1565 const union {
1566 struct sockaddr raw;
1567 struct sockaddr_in v4;
1568 struct sockaddr_in6 v6;
1569 } *sa = ptr;
1570
1571 switch (sa->raw.sa_family) {
1572 case AF_INET:
1573 return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt);
1574 case AF_INET6:
1575 return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt);
1576 default:
Petr Mladekc8c3b582019-04-17 13:53:50 +02001577 return error_string(buf, end, "(einval)", spec);
Petr Mladekf00cc102019-04-17 13:53:44 +02001578 }}
1579 }
1580
Petr Mladek0b74d4d2019-04-17 13:53:47 +02001581 err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)";
Petr Mladekc8c3b582019-04-17 13:53:50 +02001582 return error_string(buf, end, err_fmt_msg, spec);
Petr Mladekf00cc102019-04-17 13:53:44 +02001583}
1584
1585static noinline_for_stack
Andy Shevchenko71dca952014-10-13 15:55:18 -07001586char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec,
1587 const char *fmt)
1588{
1589 bool found = true;
1590 int count = 1;
1591 unsigned int flags = 0;
1592 int len;
1593
1594 if (spec.field_width == 0)
1595 return buf; /* nothing to print */
1596
Petr Mladek3e5903e2019-04-17 13:53:48 +02001597 if (check_pointer(&buf, end, addr, spec))
1598 return buf;
Andy Shevchenko71dca952014-10-13 15:55:18 -07001599
1600 do {
1601 switch (fmt[count++]) {
1602 case 'a':
1603 flags |= ESCAPE_ANY;
1604 break;
1605 case 'c':
1606 flags |= ESCAPE_SPECIAL;
1607 break;
1608 case 'h':
1609 flags |= ESCAPE_HEX;
1610 break;
1611 case 'n':
1612 flags |= ESCAPE_NULL;
1613 break;
1614 case 'o':
1615 flags |= ESCAPE_OCTAL;
1616 break;
1617 case 'p':
1618 flags |= ESCAPE_NP;
1619 break;
1620 case 's':
1621 flags |= ESCAPE_SPACE;
1622 break;
1623 default:
1624 found = false;
1625 break;
1626 }
1627 } while (found);
1628
1629 if (!flags)
1630 flags = ESCAPE_ANY_NP;
1631
1632 len = spec.field_width < 0 ? 1 : spec.field_width;
1633
Rasmus Villemoes41416f22015-04-15 16:17:28 -07001634 /*
1635 * string_escape_mem() writes as many characters as it can to
1636 * the given buffer, and returns the total size of the output
1637 * had the buffer been big enough.
1638 */
1639 buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL);
Andy Shevchenko71dca952014-10-13 15:55:18 -07001640
1641 return buf;
1642}
1643
Petr Mladek3e5903e2019-04-17 13:53:48 +02001644static char *va_format(char *buf, char *end, struct va_format *va_fmt,
1645 struct printf_spec spec, const char *fmt)
Petr Mladek45c3e932019-04-17 13:53:45 +02001646{
1647 va_list va;
1648
Petr Mladek3e5903e2019-04-17 13:53:48 +02001649 if (check_pointer(&buf, end, va_fmt, spec))
1650 return buf;
1651
Petr Mladek45c3e932019-04-17 13:53:45 +02001652 va_copy(va, *va_fmt->va);
1653 buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va);
1654 va_end(va);
1655
1656 return buf;
1657}
1658
Andy Shevchenko71dca952014-10-13 15:55:18 -07001659static noinline_for_stack
Joe Perchescf3b4292010-05-24 14:33:16 -07001660char *uuid_string(char *buf, char *end, const u8 *addr,
1661 struct printf_spec spec, const char *fmt)
Joe Perches9ac6e442009-12-14 18:01:09 -08001662{
Andy Shevchenko2b1b0d62016-05-20 17:01:04 -07001663 char uuid[UUID_STRING_LEN + 1];
Joe Perches9ac6e442009-12-14 18:01:09 -08001664 char *p = uuid;
1665 int i;
Christoph Hellwigf9727a12017-05-17 10:02:48 +02001666 const u8 *index = uuid_index;
Joe Perches9ac6e442009-12-14 18:01:09 -08001667 bool uc = false;
1668
Petr Mladek3e5903e2019-04-17 13:53:48 +02001669 if (check_pointer(&buf, end, addr, spec))
1670 return buf;
1671
Joe Perches9ac6e442009-12-14 18:01:09 -08001672 switch (*(++fmt)) {
1673 case 'L':
1674 uc = true; /* fall-through */
1675 case 'l':
Christoph Hellwigf9727a12017-05-17 10:02:48 +02001676 index = guid_index;
Joe Perches9ac6e442009-12-14 18:01:09 -08001677 break;
1678 case 'B':
1679 uc = true;
1680 break;
1681 }
1682
1683 for (i = 0; i < 16; i++) {
Andy Shevchenkoaa4ea1c2016-05-20 17:00:54 -07001684 if (uc)
1685 p = hex_byte_pack_upper(p, addr[index[i]]);
1686 else
1687 p = hex_byte_pack(p, addr[index[i]]);
Joe Perches9ac6e442009-12-14 18:01:09 -08001688 switch (i) {
1689 case 3:
1690 case 5:
1691 case 7:
1692 case 9:
1693 *p++ = '-';
1694 break;
1695 }
1696 }
1697
1698 *p = 0;
1699
Petr Mladekd529ac42019-04-17 13:53:43 +02001700 return string_nocheck(buf, end, uuid, spec);
Joe Perches9ac6e442009-12-14 18:01:09 -08001701}
1702
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001703static noinline_for_stack
Geert Uytterhoeven431bca22018-10-11 10:42:49 +02001704char *netdev_bits(char *buf, char *end, const void *addr,
1705 struct printf_spec spec, const char *fmt)
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001706{
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001707 unsigned long long num;
1708 int size;
1709
Petr Mladek3e5903e2019-04-17 13:53:48 +02001710 if (check_pointer(&buf, end, addr, spec))
1711 return buf;
1712
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001713 switch (fmt[1]) {
1714 case 'F':
1715 num = *(const netdev_features_t *)addr;
1716 size = sizeof(netdev_features_t);
1717 break;
1718 default:
Petr Mladekc8c3b582019-04-17 13:53:50 +02001719 return error_string(buf, end, "(%pN?)", spec);
Andy Shevchenko5b17aec2016-01-15 16:59:20 -08001720 }
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001721
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001722 return special_hex_number(buf, end, num, size);
Michał Mirosławc8f44af2011-11-15 15:29:55 +00001723}
1724
Joe Perchesaaf07622014-01-23 15:54:17 -08001725static noinline_for_stack
Petr Mladek3e5903e2019-04-17 13:53:48 +02001726char *address_val(char *buf, char *end, const void *addr,
1727 struct printf_spec spec, const char *fmt)
Joe Perchesaaf07622014-01-23 15:54:17 -08001728{
1729 unsigned long long num;
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001730 int size;
Joe Perchesaaf07622014-01-23 15:54:17 -08001731
Petr Mladek3e5903e2019-04-17 13:53:48 +02001732 if (check_pointer(&buf, end, addr, spec))
1733 return buf;
1734
Joe Perchesaaf07622014-01-23 15:54:17 -08001735 switch (fmt[1]) {
1736 case 'd':
1737 num = *(const dma_addr_t *)addr;
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001738 size = sizeof(dma_addr_t);
Joe Perchesaaf07622014-01-23 15:54:17 -08001739 break;
1740 case 'p':
1741 default:
1742 num = *(const phys_addr_t *)addr;
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001743 size = sizeof(phys_addr_t);
Joe Perchesaaf07622014-01-23 15:54:17 -08001744 break;
1745 }
1746
Andy Shevchenko3cab1e72016-01-15 16:59:18 -08001747 return special_hex_number(buf, end, num, size);
Joe Perchesaaf07622014-01-23 15:54:17 -08001748}
1749
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001750static noinline_for_stack
Andy Shevchenko4d42c442018-12-04 23:23:11 +02001751char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1752{
1753 int year = tm->tm_year + (r ? 0 : 1900);
1754 int mon = tm->tm_mon + (r ? 0 : 1);
1755
1756 buf = number(buf, end, year, default_dec04_spec);
1757 if (buf < end)
1758 *buf = '-';
1759 buf++;
1760
1761 buf = number(buf, end, mon, default_dec02_spec);
1762 if (buf < end)
1763 *buf = '-';
1764 buf++;
1765
1766 return number(buf, end, tm->tm_mday, default_dec02_spec);
1767}
1768
1769static noinline_for_stack
1770char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r)
1771{
1772 buf = number(buf, end, tm->tm_hour, default_dec02_spec);
1773 if (buf < end)
1774 *buf = ':';
1775 buf++;
1776
1777 buf = number(buf, end, tm->tm_min, default_dec02_spec);
1778 if (buf < end)
1779 *buf = ':';
1780 buf++;
1781
1782 return number(buf, end, tm->tm_sec, default_dec02_spec);
1783}
1784
1785static noinline_for_stack
Petr Mladek3e5903e2019-04-17 13:53:48 +02001786char *rtc_str(char *buf, char *end, const struct rtc_time *tm,
1787 struct printf_spec spec, const char *fmt)
Andy Shevchenko4d42c442018-12-04 23:23:11 +02001788{
1789 bool have_t = true, have_d = true;
1790 bool raw = false;
1791 int count = 2;
1792
Petr Mladek3e5903e2019-04-17 13:53:48 +02001793 if (check_pointer(&buf, end, tm, spec))
1794 return buf;
1795
Andy Shevchenko4d42c442018-12-04 23:23:11 +02001796 switch (fmt[count]) {
1797 case 'd':
1798 have_t = false;
1799 count++;
1800 break;
1801 case 't':
1802 have_d = false;
1803 count++;
1804 break;
1805 }
1806
1807 raw = fmt[count] == 'r';
1808
1809 if (have_d)
1810 buf = date_str(buf, end, tm, raw);
1811 if (have_d && have_t) {
1812 /* Respect ISO 8601 */
1813 if (buf < end)
1814 *buf = 'T';
1815 buf++;
1816 }
1817 if (have_t)
1818 buf = time_str(buf, end, tm, raw);
1819
1820 return buf;
1821}
1822
1823static noinline_for_stack
Andy Shevchenko7daac5b2020-04-15 20:00:44 +03001824char *time64_str(char *buf, char *end, const time64_t time,
1825 struct printf_spec spec, const char *fmt)
1826{
1827 struct rtc_time rtc_time;
1828 struct tm tm;
1829
1830 time64_to_tm(time, 0, &tm);
1831
1832 rtc_time.tm_sec = tm.tm_sec;
1833 rtc_time.tm_min = tm.tm_min;
1834 rtc_time.tm_hour = tm.tm_hour;
1835 rtc_time.tm_mday = tm.tm_mday;
1836 rtc_time.tm_mon = tm.tm_mon;
1837 rtc_time.tm_year = tm.tm_year;
1838 rtc_time.tm_wday = tm.tm_wday;
1839 rtc_time.tm_yday = tm.tm_yday;
1840
1841 rtc_time.tm_isdst = 0;
1842
1843 return rtc_str(buf, end, &rtc_time, spec, fmt);
1844}
1845
1846static noinline_for_stack
Andy Shevchenko4d42c442018-12-04 23:23:11 +02001847char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec,
1848 const char *fmt)
1849{
1850 switch (fmt[1]) {
1851 case 'R':
Petr Mladek3e5903e2019-04-17 13:53:48 +02001852 return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt);
Andy Shevchenko7daac5b2020-04-15 20:00:44 +03001853 case 'T':
1854 return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt);
Andy Shevchenko4d42c442018-12-04 23:23:11 +02001855 default:
Andy Shevchenko7daac5b2020-04-15 20:00:44 +03001856 return error_string(buf, end, "(%pt?)", spec);
Andy Shevchenko4d42c442018-12-04 23:23:11 +02001857 }
1858}
1859
1860static noinline_for_stack
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001861char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec,
1862 const char *fmt)
1863{
Petr Mladek0b74d4d2019-04-17 13:53:47 +02001864 if (!IS_ENABLED(CONFIG_HAVE_CLK))
Petr Mladekc8c3b582019-04-17 13:53:50 +02001865 return error_string(buf, end, "(%pC?)", spec);
Petr Mladek0b74d4d2019-04-17 13:53:47 +02001866
Petr Mladek3e5903e2019-04-17 13:53:48 +02001867 if (check_pointer(&buf, end, clk, spec))
1868 return buf;
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001869
1870 switch (fmt[1]) {
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001871 case 'n':
1872 default:
1873#ifdef CONFIG_COMMON_CLK
1874 return string(buf, end, __clk_get_name(clk), spec);
1875#else
Geert Uytterhoeven4ca96aa2019-07-01 16:00:09 +02001876 return ptr_to_id(buf, end, clk, spec);
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07001877#endif
1878 }
1879}
1880
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001881static
1882char *format_flags(char *buf, char *end, unsigned long flags,
1883 const struct trace_print_flags *names)
1884{
1885 unsigned long mask;
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001886
1887 for ( ; flags && names->name; names++) {
1888 mask = names->mask;
1889 if ((flags & mask) != mask)
1890 continue;
1891
Andy Shevchenkoabd4fe622018-02-16 23:07:05 +02001892 buf = string(buf, end, names->name, default_str_spec);
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001893
1894 flags &= ~mask;
1895 if (flags) {
1896 if (buf < end)
1897 *buf = '|';
1898 buf++;
1899 }
1900 }
1901
1902 if (flags)
Andy Shevchenko54433972018-02-16 23:07:06 +02001903 buf = number(buf, end, flags, default_flag_spec);
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001904
1905 return buf;
1906}
1907
1908static noinline_for_stack
Petr Mladek0b74d4d2019-04-17 13:53:47 +02001909char *flags_string(char *buf, char *end, void *flags_ptr,
1910 struct printf_spec spec, const char *fmt)
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001911{
1912 unsigned long flags;
1913 const struct trace_print_flags *names;
1914
Petr Mladek3e5903e2019-04-17 13:53:48 +02001915 if (check_pointer(&buf, end, flags_ptr, spec))
1916 return buf;
1917
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001918 switch (fmt[1]) {
1919 case 'p':
1920 flags = *(unsigned long *)flags_ptr;
1921 /* Remove zone id */
1922 flags &= (1UL << NR_PAGEFLAGS) - 1;
1923 names = pageflag_names;
1924 break;
1925 case 'v':
1926 flags = *(unsigned long *)flags_ptr;
1927 names = vmaflag_names;
1928 break;
1929 case 'g':
1930 flags = *(gfp_t *)flags_ptr;
1931 names = gfpflag_names;
1932 break;
1933 default:
Petr Mladekc8c3b582019-04-17 13:53:50 +02001934 return error_string(buf, end, "(%pG?)", spec);
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07001935 }
1936
1937 return format_flags(buf, end, flags, names);
1938}
1939
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001940static noinline_for_stack
Sakari Ailusa92eb762019-10-03 15:32:16 +03001941char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf,
1942 char *end)
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001943{
1944 int depth;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001945
Sakari Ailusa92eb762019-10-03 15:32:16 +03001946 /* Loop starting from the root node to the current node. */
1947 for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) {
1948 struct fwnode_handle *__fwnode =
1949 fwnode_get_nth_parent(fwnode, depth);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001950
Sakari Ailusa92eb762019-10-03 15:32:16 +03001951 buf = string(buf, end, fwnode_get_name_prefix(__fwnode),
Andy Shevchenkoabd4fe622018-02-16 23:07:05 +02001952 default_str_spec);
Sakari Ailusa92eb762019-10-03 15:32:16 +03001953 buf = string(buf, end, fwnode_get_name(__fwnode),
1954 default_str_spec);
1955
1956 fwnode_handle_put(__fwnode);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001957 }
Sakari Ailusa92eb762019-10-03 15:32:16 +03001958
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001959 return buf;
1960}
1961
1962static noinline_for_stack
1963char *device_node_string(char *buf, char *end, struct device_node *dn,
1964 struct printf_spec spec, const char *fmt)
1965{
1966 char tbuf[sizeof("xxxx") + 1];
1967 const char *p;
1968 int ret;
1969 char *buf_start = buf;
1970 struct property *prop;
1971 bool has_mult, pass;
1972 static const struct printf_spec num_spec = {
1973 .flags = SMALL,
1974 .field_width = -1,
1975 .precision = -1,
1976 .base = 10,
1977 };
1978
1979 struct printf_spec str_spec = spec;
1980 str_spec.field_width = -1;
1981
Sakari Ailus83abc5a2019-10-03 15:32:17 +03001982 if (fmt[0] != 'F')
1983 return error_string(buf, end, "(%pO?)", spec);
1984
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001985 if (!IS_ENABLED(CONFIG_OF))
Petr Mladekc8c3b582019-04-17 13:53:50 +02001986 return error_string(buf, end, "(%pOF?)", spec);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001987
Petr Mladek3e5903e2019-04-17 13:53:48 +02001988 if (check_pointer(&buf, end, dn, spec))
1989 return buf;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001990
1991 /* simple case without anything any more format specifiers */
1992 fmt++;
1993 if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0)
1994 fmt = "f";
1995
1996 for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
Rob Herring6d0a70a2018-08-27 08:13:56 -05001997 int precision;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02001998 if (pass) {
1999 if (buf < end)
2000 *buf = ':';
2001 buf++;
2002 }
2003
2004 switch (*fmt) {
2005 case 'f': /* full_name */
Sakari Ailusa92eb762019-10-03 15:32:16 +03002006 buf = fwnode_full_name_string(of_fwnode_handle(dn), buf,
2007 end);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002008 break;
2009 case 'n': /* name */
Sakari Ailusa92eb762019-10-03 15:32:16 +03002010 p = fwnode_get_name(of_fwnode_handle(dn));
Rob Herring6d0a70a2018-08-27 08:13:56 -05002011 precision = str_spec.precision;
2012 str_spec.precision = strchrnul(p, '@') - p;
2013 buf = string(buf, end, p, str_spec);
2014 str_spec.precision = precision;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002015 break;
2016 case 'p': /* phandle */
2017 buf = number(buf, end, (unsigned int)dn->phandle, num_spec);
2018 break;
2019 case 'P': /* path-spec */
Sakari Ailusa92eb762019-10-03 15:32:16 +03002020 p = fwnode_get_name(of_fwnode_handle(dn));
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002021 if (!p[1])
2022 p = "/";
2023 buf = string(buf, end, p, str_spec);
2024 break;
2025 case 'F': /* flags */
2026 tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-';
2027 tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-';
2028 tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-';
2029 tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-';
2030 tbuf[4] = 0;
Petr Mladekd529ac42019-04-17 13:53:43 +02002031 buf = string_nocheck(buf, end, tbuf, str_spec);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002032 break;
2033 case 'c': /* major compatible string */
2034 ret = of_property_read_string(dn, "compatible", &p);
2035 if (!ret)
2036 buf = string(buf, end, p, str_spec);
2037 break;
2038 case 'C': /* full compatible string */
2039 has_mult = false;
2040 of_property_for_each_string(dn, "compatible", prop, p) {
2041 if (has_mult)
Petr Mladekd529ac42019-04-17 13:53:43 +02002042 buf = string_nocheck(buf, end, ",", str_spec);
2043 buf = string_nocheck(buf, end, "\"", str_spec);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002044 buf = string(buf, end, p, str_spec);
Petr Mladekd529ac42019-04-17 13:53:43 +02002045 buf = string_nocheck(buf, end, "\"", str_spec);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002046
2047 has_mult = true;
2048 }
2049 break;
2050 default:
2051 break;
2052 }
2053 }
2054
2055 return widen_string(buf, buf - buf_start, end, spec);
2056}
2057
Sakari Ailus3bd32d62019-10-03 15:32:18 +03002058static noinline_for_stack
2059char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode,
2060 struct printf_spec spec, const char *fmt)
Petr Mladek798cc272019-04-17 13:53:46 +02002061{
Sakari Ailus3bd32d62019-10-03 15:32:18 +03002062 struct printf_spec str_spec = spec;
2063 char *buf_start = buf;
2064
2065 str_spec.field_width = -1;
2066
2067 if (*fmt != 'w')
2068 return error_string(buf, end, "(%pf?)", spec);
2069
2070 if (check_pointer(&buf, end, fwnode, spec))
2071 return buf;
2072
2073 fmt++;
2074
2075 switch (*fmt) {
2076 case 'P': /* name */
2077 buf = string(buf, end, fwnode_get_name(fwnode), str_spec);
2078 break;
2079 case 'f': /* full_name */
2080 default:
2081 buf = fwnode_full_name_string(fwnode, buf, end);
2082 break;
Petr Mladek798cc272019-04-17 13:53:46 +02002083 }
2084
Sakari Ailus3bd32d62019-10-03 15:32:18 +03002085 return widen_string(buf, buf - buf_start, end, spec);
Petr Mladek798cc272019-04-17 13:53:46 +02002086}
2087
Linus Torvalds4d8a7432008-07-06 16:24:57 -07002088/*
2089 * Show a '%p' thing. A kernel extension is that the '%p' is followed
2090 * by an extra set of alphanumeric characters that are extended format
2091 * specifiers.
2092 *
Joe Perches0b523762017-05-08 15:55:36 -07002093 * Please update scripts/checkpatch.pl when adding/removing conversion
2094 * characters. (Search for "check for vsprintf extension").
2095 *
Linus Torvalds332d2e72008-10-20 15:07:34 +11002096 * Right now we handle:
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07002097 *
Sergey Senozhatskycdb7e522018-04-14 12:00:05 +09002098 * - 'S' For symbolic direct pointers (or function descriptors) with offset
2099 * - 's' For symbolic direct pointers (or function descriptors) without offset
Sakari Ailus9af77062019-10-03 15:32:14 +03002100 * - '[Ss]R' as above with __builtin_extract_return_addr() translation
Sakari Ailus1586c5a2019-10-03 15:32:15 +03002101 * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
2102 * %ps and %pS. Be careful when re-using these specifiers.
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09002103 * - 'B' For backtraced symbolic direct pointers with offset
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06002104 * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref]
2105 * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Tejun Heodbc760b2015-02-13 14:36:53 -08002106 * - 'b[l]' For a bitmap, the number of bits is determined by the field
2107 * width which must be explicitly specified either as part of the
2108 * format string '%32b[l]' or through '%*b[l]', [l] selects
2109 * range-list format instead of hex format
Harvey Harrisondd45c9c2008-10-27 15:47:12 -07002110 * - 'M' For a 6-byte MAC address, it prints the address in the
2111 * usual colon-separated hex notation
Joe Perches8a27f7c2009-08-17 12:29:44 +00002112 * - 'm' For a 6-byte MAC address, it prints the hex address without colons
Joe Perchesbc7259a2010-01-07 11:43:50 +00002113 * - 'MF' For a 6-byte MAC FDDI address, it prints the address
Joe Perchesc8e00062010-01-11 00:44:14 -08002114 * with a dash-separated hex notation
Andy Shevchenko7c591542012-10-04 17:12:33 -07002115 * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth)
Joe Perches8a27f7c2009-08-17 12:29:44 +00002116 * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way
2117 * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4)
2118 * IPv6 uses colon separated network-order 16 bit hex with leading 0's
Daniel Borkmann10679642013-06-28 19:49:39 +02002119 * [S][pfs]
2120 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2121 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
Joe Perches8a27f7c2009-08-17 12:29:44 +00002122 * - 'i' [46] for 'raw' IPv4/IPv6 addresses
2123 * IPv6 omits the colons (01020304...0f)
2124 * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006)
Daniel Borkmann10679642013-06-28 19:49:39 +02002125 * [S][pfs]
2126 * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to
2127 * [4] or [6] and is able to print port [p], flowinfo [f], scope [s]
2128 * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order
2129 * - 'I[6S]c' for IPv6 addresses printed as specified by
Joe Perches29cf5192011-06-09 11:23:37 -07002130 * http://tools.ietf.org/html/rfc5952
Andy Shevchenko71dca952014-10-13 15:55:18 -07002131 * - 'E[achnops]' For an escaped buffer, where rules are defined by combination
2132 * of the following flags (see string_escape_mem() for the
2133 * details):
2134 * a - ESCAPE_ANY
2135 * c - ESCAPE_SPECIAL
2136 * h - ESCAPE_HEX
2137 * n - ESCAPE_NULL
2138 * o - ESCAPE_OCTAL
2139 * p - ESCAPE_NP
2140 * s - ESCAPE_SPACE
2141 * By default ESCAPE_ANY_NP is used.
Joe Perches9ac6e442009-12-14 18:01:09 -08002142 * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form
2143 * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
2144 * Options for %pU are:
2145 * b big endian lower case hex (default)
2146 * B big endian UPPER case hex
2147 * l little endian lower case hex
2148 * L little endian UPPER case hex
2149 * big endian output byte order is:
2150 * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15]
2151 * little endian output byte order is:
2152 * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15]
Joe Perches7db6f5f2010-06-27 01:02:33 +00002153 * - 'V' For a struct va_format which contains a format string * and va_list *,
2154 * call vsnprintf(->format, *->va_list).
2155 * Implements a "recursive vsnprintf".
2156 * Do not use this feature without some mechanism to verify the
2157 * correctness of the format string and va_list arguments.
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08002158 * - 'K' For a kernel pointer that should be hidden from unprivileged users
Michał Mirosławc8f44af2011-11-15 15:29:55 +00002159 * - 'NF' For a netdev_features_t
Andy Shevchenko31550a12012-07-30 14:40:27 -07002160 * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with
2161 * a certain separator (' ' by default):
2162 * C colon
2163 * D dash
2164 * N no separator
2165 * The maximum supported length is 64 bytes of the input. Consider
2166 * to use print_hex_dump() for the larger input.
Joe Perchesaaf07622014-01-23 15:54:17 -08002167 * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives
2168 * (default assumed to be phys_addr_t, passed by reference)
Olof Johanssonc0d92a52013-11-12 15:09:50 -08002169 * - 'd[234]' For a dentry name (optionally 2-4 last components)
2170 * - 'D[234]' Same as 'd' but for a struct file
Dmitry Monakhov1031bc52015-04-13 16:31:35 +04002171 * - 'g' For block_device name (gendisk + partition number)
Andy Shevchenko7daac5b2020-04-15 20:00:44 +03002172 * - 't[RT][dt][r]' For time and date as represented by:
Andy Shevchenko4d42c442018-12-04 23:23:11 +02002173 * R struct rtc_time
Andy Shevchenko7daac5b2020-04-15 20:00:44 +03002174 * T time64_t
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07002175 * - 'C' For a clock, it prints the name (Common Clock Framework) or address
2176 * (legacy clock framework) of the clock
2177 * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address
2178 * (legacy clock framework) of the clock
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07002179 * - 'G' For flags to be printed as a collection of symbolic strings that would
2180 * construct the specific value. Supported flags given by option:
2181 * p page flags (see struct page) given as pointer to unsigned long
2182 * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t
2183 * v vma flags (VM_*) given as pointer to unsigned long
Geert Uytterhoeven94ac8f22018-10-08 13:08:48 +02002184 * - 'OF[fnpPcCF]' For a device tree object
2185 * Without any optional arguments prints the full_name
2186 * f device node full_name
2187 * n device node name
2188 * p device node phandle
2189 * P device node path spec (name + @unit)
2190 * F device node flags
2191 * c major compatible string
2192 * C full compatible string
Sakari Ailus3bd32d62019-10-03 15:32:18 +03002193 * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer
2194 * Without an option prints the full name of the node
2195 * f full name
2196 * P node name, including a possible unit address
Tobin C. Harding7b1924a2017-11-23 10:59:45 +11002197 * - 'x' For printing the address. Equivalent to "%lx".
2198 *
Tobin C. Hardingb3ed2322017-12-20 08:17:15 +11002199 * ** When making changes please also update:
2200 * Documentation/core-api/printk-formats.rst
Joe Perches9ac6e442009-12-14 18:01:09 -08002201 *
Tobin C. Hardingad67b742017-11-01 15:32:23 +11002202 * Note: The default behaviour (unadorned %p) is to hash the address,
2203 * rendering it useful as a unique identifier.
Linus Torvalds4d8a7432008-07-06 16:24:57 -07002204 */
Joe Perchescf3b4292010-05-24 14:33:16 -07002205static noinline_for_stack
2206char *pointer(const char *fmt, char *buf, char *end, void *ptr,
2207 struct printf_spec spec)
Linus Torvalds78a8bf62008-07-06 16:16:15 -07002208{
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07002209 switch (*fmt) {
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07002210 case 'S':
Joe Perches9ac6e442009-12-14 18:01:09 -08002211 case 's':
Sergey Senozhatsky04b8eb72017-12-06 13:36:49 +09002212 ptr = dereference_symbol_descriptor(ptr);
2213 /* Fallthrough */
Namhyung Kim0f77a8d2011-03-24 11:42:29 +09002214 case 'B':
Joe Perchesb0d33c22012-12-12 10:18:50 -08002215 return symbol_string(buf, end, ptr, spec, fmt);
Linus Torvalds332d2e72008-10-20 15:07:34 +11002216 case 'R':
Bjorn Helgaasc7dabef2009-10-27 13:26:47 -06002217 case 'r':
Bjorn Helgaasfd955412009-10-06 15:33:39 -06002218 return resource_string(buf, end, ptr, spec, fmt);
Andy Shevchenko31550a12012-07-30 14:40:27 -07002219 case 'h':
2220 return hex_string(buf, end, ptr, spec, fmt);
Tejun Heodbc760b2015-02-13 14:36:53 -08002221 case 'b':
2222 switch (fmt[1]) {
2223 case 'l':
2224 return bitmap_list_string(buf, end, ptr, spec, fmt);
2225 default:
2226 return bitmap_string(buf, end, ptr, spec, fmt);
2227 }
Joe Perches8a27f7c2009-08-17 12:29:44 +00002228 case 'M': /* Colon separated: 00:01:02:03:04:05 */
2229 case 'm': /* Contiguous: 000102030405 */
Andrei Emeltchenko76597ff92012-07-30 14:40:23 -07002230 /* [mM]F (FDDI) */
2231 /* [mM]R (Reverse order; Bluetooth) */
Joe Perches8a27f7c2009-08-17 12:29:44 +00002232 return mac_address_string(buf, end, ptr, spec, fmt);
2233 case 'I': /* Formatted IP supported
2234 * 4: 1.2.3.4
2235 * 6: 0001:0203:...:0708
2236 * 6c: 1::708 or 1::1.2.3.4
2237 */
2238 case 'i': /* Contiguous:
2239 * 4: 001.002.003.004
2240 * 6: 000102...0f
2241 */
Petr Mladekf00cc102019-04-17 13:53:44 +02002242 return ip_addr_string(buf, end, ptr, spec, fmt);
Andy Shevchenko71dca952014-10-13 15:55:18 -07002243 case 'E':
2244 return escaped_string(buf, end, ptr, spec, fmt);
Joe Perches9ac6e442009-12-14 18:01:09 -08002245 case 'U':
2246 return uuid_string(buf, end, ptr, spec, fmt);
Joe Perches7db6f5f2010-06-27 01:02:33 +00002247 case 'V':
Petr Mladek3e5903e2019-04-17 13:53:48 +02002248 return va_format(buf, end, ptr, spec, fmt);
Dan Rosenberg455cd5a2011-01-12 16:59:41 -08002249 case 'K':
Tobin C. Harding57e73442017-11-23 10:56:39 +11002250 return restricted_pointer(buf, end, ptr, spec);
Michał Mirosławc8f44af2011-11-15 15:29:55 +00002251 case 'N':
Geert Uytterhoeven431bca22018-10-11 10:42:49 +02002252 return netdev_bits(buf, end, ptr, spec, fmt);
Stepan Moskovchenko7d799212013-02-21 16:43:09 -08002253 case 'a':
Petr Mladek3e5903e2019-04-17 13:53:48 +02002254 return address_val(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04002255 case 'd':
2256 return dentry_name(buf, end, ptr, spec, fmt);
Andy Shevchenko4d42c442018-12-04 23:23:11 +02002257 case 't':
2258 return time_and_date(buf, end, ptr, spec, fmt);
Geert Uytterhoeven900cca22015-04-15 16:17:20 -07002259 case 'C':
2260 return clock(buf, end, ptr, spec, fmt);
Al Viro4b6ccca2013-09-03 12:00:44 -04002261 case 'D':
Jia He36594b32019-08-09 09:24:56 +08002262 return file_dentry_name(buf, end, ptr, spec, fmt);
Dmitry Monakhov1031bc52015-04-13 16:31:35 +04002263#ifdef CONFIG_BLOCK
2264 case 'g':
2265 return bdev_name(buf, end, ptr, spec, fmt);
2266#endif
2267
Vlastimil Babkaedf14cd2016-03-15 14:55:56 -07002268 case 'G':
Petr Mladek0b74d4d2019-04-17 13:53:47 +02002269 return flags_string(buf, end, ptr, spec, fmt);
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02002270 case 'O':
Sakari Ailus83abc5a2019-10-03 15:32:17 +03002271 return device_node_string(buf, end, ptr, spec, fmt + 1);
Sakari Ailus3bd32d62019-10-03 15:32:18 +03002272 case 'f':
2273 return fwnode_string(buf, end, ptr, spec, fmt + 1);
Tobin C. Harding7b1924a2017-11-23 10:59:45 +11002274 case 'x':
2275 return pointer_string(buf, end, ptr, spec);
Rasmus Villemoes57f56772019-10-15 21:07:05 +02002276 case 'e':
2277 /* %pe with a non-ERR_PTR gets treated as plain %p */
2278 if (!IS_ERR(ptr))
2279 break;
2280 return err_ptr(buf, end, ptr, spec);
Linus Torvalds0fe1ef22008-07-06 16:43:12 -07002281 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002282
Tobin C. Hardingad67b742017-11-01 15:32:23 +11002283 /* default is to _not_ leak addresses, hash before printing */
2284 return ptr_to_id(buf, end, ptr, spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002285}
2286
2287/*
2288 * Helper function to decode printf style format.
2289 * Each call decode a token from the format and return the
2290 * number of characters read (or likely the delta where it wants
2291 * to go on the next call).
2292 * The decoded token is returned through the parameters
2293 *
2294 * 'h', 'l', or 'L' for integer fields
2295 * 'z' support added 23/7/1999 S.H.
2296 * 'z' changed to 'Z' --davidm 1/25/99
Alexey Dobriyan5b5e0922017-02-27 14:30:02 -08002297 * 'Z' changed to 'z' --adobriyan 2017-01-25
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002298 * 't' added for ptrdiff_t
2299 *
2300 * @fmt: the format string
2301 * @type of the token returned
2302 * @flags: various flags such as +, -, # tokens..
2303 * @field_width: overwritten width
2304 * @base: base of the number (octal, hex, ...)
2305 * @precision: precision of a number
2306 * @qualifier: qualifier of a number (long, size_t, ...)
2307 */
Joe Perchescf3b4292010-05-24 14:33:16 -07002308static noinline_for_stack
2309int format_decode(const char *fmt, struct printf_spec *spec)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002310{
2311 const char *start = fmt;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002312 char qualifier;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002313
2314 /* we finished early by reading the field width */
Vegard Nossumed681a92009-03-14 12:08:50 +01002315 if (spec->type == FORMAT_TYPE_WIDTH) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002316 if (spec->field_width < 0) {
2317 spec->field_width = -spec->field_width;
2318 spec->flags |= LEFT;
2319 }
2320 spec->type = FORMAT_TYPE_NONE;
2321 goto precision;
2322 }
2323
2324 /* we finished early by reading the precision */
2325 if (spec->type == FORMAT_TYPE_PRECISION) {
2326 if (spec->precision < 0)
2327 spec->precision = 0;
2328
2329 spec->type = FORMAT_TYPE_NONE;
2330 goto qualifier;
2331 }
2332
2333 /* By default */
2334 spec->type = FORMAT_TYPE_NONE;
2335
2336 for (; *fmt ; ++fmt) {
2337 if (*fmt == '%')
2338 break;
2339 }
2340
2341 /* Return the current non-format string */
2342 if (fmt != start || !*fmt)
2343 return fmt - start;
2344
2345 /* Process flags */
2346 spec->flags = 0;
2347
2348 while (1) { /* this also skips first '%' */
2349 bool found = true;
2350
2351 ++fmt;
2352
2353 switch (*fmt) {
2354 case '-': spec->flags |= LEFT; break;
2355 case '+': spec->flags |= PLUS; break;
2356 case ' ': spec->flags |= SPACE; break;
2357 case '#': spec->flags |= SPECIAL; break;
2358 case '0': spec->flags |= ZEROPAD; break;
2359 default: found = false;
2360 }
2361
2362 if (!found)
2363 break;
2364 }
2365
2366 /* get field width */
2367 spec->field_width = -1;
2368
2369 if (isdigit(*fmt))
2370 spec->field_width = skip_atoi(&fmt);
2371 else if (*fmt == '*') {
2372 /* it's the next argument */
Vegard Nossumed681a92009-03-14 12:08:50 +01002373 spec->type = FORMAT_TYPE_WIDTH;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002374 return ++fmt - start;
2375 }
2376
2377precision:
2378 /* get the precision */
2379 spec->precision = -1;
2380 if (*fmt == '.') {
2381 ++fmt;
2382 if (isdigit(*fmt)) {
2383 spec->precision = skip_atoi(&fmt);
2384 if (spec->precision < 0)
2385 spec->precision = 0;
2386 } else if (*fmt == '*') {
2387 /* it's the next argument */
Vegard Nossumadf26f82009-03-14 12:08:50 +01002388 spec->type = FORMAT_TYPE_PRECISION;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002389 return ++fmt - start;
2390 }
2391 }
2392
2393qualifier:
2394 /* get the conversion qualifier */
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002395 qualifier = 0;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07002396 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
Alexey Dobriyan5b5e0922017-02-27 14:30:02 -08002397 *fmt == 'z' || *fmt == 't') {
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002398 qualifier = *fmt++;
2399 if (unlikely(qualifier == *fmt)) {
2400 if (qualifier == 'l') {
2401 qualifier = 'L';
Zhaoleia4e94ef2009-03-27 17:07:05 +08002402 ++fmt;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002403 } else if (qualifier == 'h') {
2404 qualifier = 'H';
Zhaoleia4e94ef2009-03-27 17:07:05 +08002405 ++fmt;
2406 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002407 }
2408 }
2409
2410 /* default base */
2411 spec->base = 10;
2412 switch (*fmt) {
2413 case 'c':
2414 spec->type = FORMAT_TYPE_CHAR;
2415 return ++fmt - start;
2416
2417 case 's':
2418 spec->type = FORMAT_TYPE_STR;
2419 return ++fmt - start;
2420
2421 case 'p':
2422 spec->type = FORMAT_TYPE_PTR;
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002423 return ++fmt - start;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002424
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002425 case '%':
2426 spec->type = FORMAT_TYPE_PERCENT_CHAR;
2427 return ++fmt - start;
2428
2429 /* integer number formats - set up the flags and "break" */
2430 case 'o':
2431 spec->base = 8;
2432 break;
2433
2434 case 'x':
2435 spec->flags |= SMALL;
Andy Shevchenko7e6bd6f2018-02-16 23:07:11 +02002436 /* fall through */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002437
2438 case 'X':
2439 spec->base = 16;
2440 break;
2441
2442 case 'd':
2443 case 'i':
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01002444 spec->flags |= SIGN;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002445 case 'u':
2446 break;
2447
Ryan Mallon708d96fd2014-04-03 14:48:37 -07002448 case 'n':
2449 /*
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002450 * Since %n poses a greater security risk than
2451 * utility, treat it as any other invalid or
2452 * unsupported format specifier.
Ryan Mallon708d96fd2014-04-03 14:48:37 -07002453 */
Ryan Mallon708d96fd2014-04-03 14:48:37 -07002454 /* Fall-through */
2455
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002456 default:
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002457 WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002458 spec->type = FORMAT_TYPE_INVALID;
2459 return fmt - start;
2460 }
2461
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002462 if (qualifier == 'L')
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002463 spec->type = FORMAT_TYPE_LONG_LONG;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002464 else if (qualifier == 'l') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07002465 BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG);
2466 spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN);
Alexey Dobriyan5b5e0922017-02-27 14:30:02 -08002467 } else if (qualifier == 'z') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002468 spec->type = FORMAT_TYPE_SIZE_T;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002469 } else if (qualifier == 't') {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002470 spec->type = FORMAT_TYPE_PTRDIFF;
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002471 } else if (qualifier == 'H') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07002472 BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE);
2473 spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN);
Rasmus Villemoesd0484192016-01-15 16:58:37 -08002474 } else if (qualifier == 'h') {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07002475 BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT);
2476 spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002477 } else {
Rasmus Villemoes51be17d2015-04-15 16:17:02 -07002478 BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT);
2479 spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002480 }
2481
2482 return ++fmt - start;
Linus Torvalds78a8bf62008-07-06 16:16:15 -07002483}
2484
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002485static void
2486set_field_width(struct printf_spec *spec, int width)
2487{
2488 spec->field_width = width;
2489 if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) {
2490 spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX);
2491 }
2492}
2493
2494static void
2495set_precision(struct printf_spec *spec, int prec)
2496{
2497 spec->precision = prec;
2498 if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) {
2499 spec->precision = clamp(prec, 0, PRECISION_MAX);
2500 }
2501}
2502
Linus Torvalds1da177e2005-04-16 15:20:36 -07002503/**
2504 * vsnprintf - Format a string and place it in a buffer
2505 * @buf: The buffer to place the result into
2506 * @size: The size of the buffer, including the trailing null space
2507 * @fmt: The format string to use
2508 * @args: Arguments for the format string
2509 *
Rasmus Villemoesd7ec9a02015-11-06 16:30:35 -08002510 * This function generally follows C99 vsnprintf, but has some
2511 * extensions and a few limitations:
2512 *
mchehab@s-opensource.com6cc89132017-03-30 17:11:33 -03002513 * - ``%n`` is unsupported
2514 * - ``%p*`` is handled by pointer()
Andi Kleen20036fd2008-10-15 22:02:02 -07002515 *
Jonathan Corbet27e7c0e2017-12-21 12:39:45 -07002516 * See pointer() or Documentation/core-api/printk-formats.rst for more
Martin Kletzander5e4ee7b2015-11-06 16:30:17 -08002517 * extensive description.
2518 *
mchehab@s-opensource.com6cc89132017-03-30 17:11:33 -03002519 * **Please update the documentation in both places when making changes**
Andrew Morton80f548e2012-07-30 14:40:25 -07002520 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 * The return value is the number of characters which would
2522 * be generated for the given input, excluding the trailing
2523 * '\0', as per ISO C99. If you want to have the exact
2524 * number of characters written into @buf as return value
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002525 * (not including the trailing '\0'), use vscnprintf(). If the
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526 * return is greater than or equal to @size, the resulting
2527 * string is truncated.
2528 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002529 * If you're not already dealing with a va_list consider using snprintf().
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 */
2531int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
2532{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 unsigned long long num;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002534 char *str, *end;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002535 struct printf_spec spec = {0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002537 /* Reject out-of-range values early. Large positive sizes are
2538 used for unknown buffer sizes. */
Rasmus Villemoes2aa2f9e2015-02-12 15:01:39 -08002539 if (WARN_ON_ONCE(size > INT_MAX))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541
2542 str = buf;
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002543 end = buf + size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002545 /* Make sure end is always >= buf */
2546 if (end < buf) {
2547 end = ((void *)-1);
2548 size = end - buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 }
2550
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002551 while (*fmt) {
2552 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002553 int read = format_decode(fmt, &spec);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002554
2555 fmt += read;
2556
2557 switch (spec.type) {
2558 case FORMAT_TYPE_NONE: {
2559 int copy = read;
2560 if (str < end) {
2561 if (copy > end - str)
2562 copy = end - str;
2563 memcpy(str, old_fmt, copy);
2564 }
2565 str += read;
2566 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002567 }
2568
Vegard Nossumed681a92009-03-14 12:08:50 +01002569 case FORMAT_TYPE_WIDTH:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002570 set_field_width(&spec, va_arg(args, int));
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002571 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002572
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002573 case FORMAT_TYPE_PRECISION:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08002574 set_precision(&spec, va_arg(args, int));
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002575 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576
André Goddard Rosad4be1512009-12-14 18:00:59 -08002577 case FORMAT_TYPE_CHAR: {
2578 char c;
2579
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002580 if (!(spec.flags & LEFT)) {
2581 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002582 if (str < end)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583 *str = ' ';
2584 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002585
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002587 }
2588 c = (unsigned char) va_arg(args, int);
2589 if (str < end)
2590 *str = c;
2591 ++str;
2592 while (--spec.field_width > 0) {
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002593 if (str < end)
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002594 *str = ' ';
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002596 }
2597 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08002598 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002599
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002600 case FORMAT_TYPE_STR:
2601 str = string(str, end, va_arg(args, char *), spec);
2602 break;
2603
2604 case FORMAT_TYPE_PTR:
Rasmus Villemoesffbfed02015-02-12 15:01:37 -08002605 str = pointer(fmt, str, end, va_arg(args, void *),
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002606 spec);
2607 while (isalnum(*fmt))
2608 fmt++;
2609 break;
2610
2611 case FORMAT_TYPE_PERCENT_CHAR:
2612 if (str < end)
2613 *str = '%';
2614 ++str;
2615 break;
2616
2617 case FORMAT_TYPE_INVALID:
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002618 /*
2619 * Presumably the arguments passed gcc's type
2620 * checking, but there is no safe or sane way
2621 * for us to continue parsing the format and
2622 * fetching from the va_list; the remaining
2623 * specifiers and arguments would be out of
2624 * sync.
2625 */
2626 goto out;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002627
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002628 default:
2629 switch (spec.type) {
2630 case FORMAT_TYPE_LONG_LONG:
2631 num = va_arg(args, long long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002633 case FORMAT_TYPE_ULONG:
2634 num = va_arg(args, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002636 case FORMAT_TYPE_LONG:
2637 num = va_arg(args, long);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002639 case FORMAT_TYPE_SIZE_T:
Jason Gunthorpeef124962012-12-17 15:59:58 -08002640 if (spec.flags & SIGN)
2641 num = va_arg(args, ssize_t);
2642 else
2643 num = va_arg(args, size_t);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002644 break;
2645 case FORMAT_TYPE_PTRDIFF:
2646 num = va_arg(args, ptrdiff_t);
2647 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002648 case FORMAT_TYPE_UBYTE:
2649 num = (unsigned char) va_arg(args, int);
2650 break;
2651 case FORMAT_TYPE_BYTE:
2652 num = (signed char) va_arg(args, int);
2653 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002654 case FORMAT_TYPE_USHORT:
2655 num = (unsigned short) va_arg(args, int);
2656 break;
2657 case FORMAT_TYPE_SHORT:
2658 num = (short) va_arg(args, int);
2659 break;
Frederic Weisbecker39e874f2009-03-09 21:15:04 +01002660 case FORMAT_TYPE_INT:
2661 num = (int) va_arg(args, int);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002662 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002664 num = va_arg(args, unsigned int);
2665 }
2666
2667 str = number(str, end, num, spec);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002668 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002670
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002671out:
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002672 if (size > 0) {
2673 if (str < end)
2674 *str = '\0';
2675 else
Linus Torvalds0a6047e2006-06-28 17:09:34 -07002676 end[-1] = '\0';
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002677 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002678
Jeremy Fitzhardingef7969372006-06-25 05:49:17 -07002679 /* the trailing null byte doesn't count towards the total */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002680 return str-buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002681
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683EXPORT_SYMBOL(vsnprintf);
2684
2685/**
2686 * vscnprintf - Format a string and place it in a buffer
2687 * @buf: The buffer to place the result into
2688 * @size: The size of the buffer, including the trailing null space
2689 * @fmt: The format string to use
2690 * @args: Arguments for the format string
2691 *
2692 * The return value is the number of characters which have been written into
Anton Arapovb921c692011-01-12 16:59:49 -08002693 * the @buf not including the trailing '\0'. If @size is == 0 the function
Linus Torvalds1da177e2005-04-16 15:20:36 -07002694 * returns 0.
2695 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002696 * If you're not already dealing with a va_list consider using scnprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002697 *
2698 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 */
2700int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
2701{
2702 int i;
2703
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002704 i = vsnprintf(buf, size, fmt, args);
2705
Anton Arapovb921c692011-01-12 16:59:49 -08002706 if (likely(i < size))
2707 return i;
2708 if (size != 0)
2709 return size - 1;
2710 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712EXPORT_SYMBOL(vscnprintf);
2713
2714/**
2715 * snprintf - Format a string and place it in a buffer
2716 * @buf: The buffer to place the result into
2717 * @size: The size of the buffer, including the trailing null space
2718 * @fmt: The format string to use
2719 * @...: Arguments for the format string
2720 *
2721 * The return value is the number of characters which would be
2722 * generated for the given input, excluding the trailing null,
2723 * as per ISO C99. If the return is greater than or equal to
2724 * @size, the resulting string is truncated.
Andi Kleen20036fd2008-10-15 22:02:02 -07002725 *
2726 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002728int snprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729{
2730 va_list args;
2731 int i;
2732
2733 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002734 i = vsnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002736
Linus Torvalds1da177e2005-04-16 15:20:36 -07002737 return i;
2738}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739EXPORT_SYMBOL(snprintf);
2740
2741/**
2742 * scnprintf - Format a string and place it in a buffer
2743 * @buf: The buffer to place the result into
2744 * @size: The size of the buffer, including the trailing null space
2745 * @fmt: The format string to use
2746 * @...: Arguments for the format string
2747 *
2748 * The return value is the number of characters written into @buf not including
Changli Gaob903c0b2010-10-26 14:22:50 -07002749 * the trailing '\0'. If @size is == 0 the function returns 0.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 */
2751
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002752int scnprintf(char *buf, size_t size, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753{
2754 va_list args;
2755 int i;
2756
2757 va_start(args, fmt);
Anton Arapovb921c692011-01-12 16:59:49 -08002758 i = vscnprintf(buf, size, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002760
Anton Arapovb921c692011-01-12 16:59:49 -08002761 return i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762}
2763EXPORT_SYMBOL(scnprintf);
2764
2765/**
2766 * vsprintf - Format a string and place it in a buffer
2767 * @buf: The buffer to place the result into
2768 * @fmt: The format string to use
2769 * @args: Arguments for the format string
2770 *
2771 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002772 * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 * buffer overflows.
2774 *
Uwe Kleine-Königba1835e2011-04-06 07:49:04 -07002775 * If you're not already dealing with a va_list consider using sprintf().
Andi Kleen20036fd2008-10-15 22:02:02 -07002776 *
2777 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778 */
2779int vsprintf(char *buf, const char *fmt, va_list args)
2780{
2781 return vsnprintf(buf, INT_MAX, fmt, args);
2782}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002783EXPORT_SYMBOL(vsprintf);
2784
2785/**
2786 * sprintf - Format a string and place it in a buffer
2787 * @buf: The buffer to place the result into
2788 * @fmt: The format string to use
2789 * @...: Arguments for the format string
2790 *
2791 * The function returns the number of characters written
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08002792 * into @buf. Use snprintf() or scnprintf() in order to avoid
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 * buffer overflows.
Andi Kleen20036fd2008-10-15 22:02:02 -07002794 *
2795 * See the vsnprintf() documentation for format string extensions over C99.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002797int sprintf(char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798{
2799 va_list args;
2800 int i;
2801
2802 va_start(args, fmt);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002803 i = vsnprintf(buf, INT_MAX, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002805
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 return i;
2807}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808EXPORT_SYMBOL(sprintf);
2809
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002810#ifdef CONFIG_BINARY_PRINTF
2811/*
2812 * bprintf service:
2813 * vbin_printf() - VA arguments to binary data
2814 * bstr_printf() - Binary data to text string
2815 */
2816
2817/**
2818 * vbin_printf - Parse a format string and place args' binary value in a buffer
2819 * @bin_buf: The buffer to place args' binary value
2820 * @size: The size of the buffer(by words(32bits), not characters)
2821 * @fmt: The format string to use
2822 * @args: Arguments for the format string
2823 *
2824 * The format follows C99 vsnprintf, except %n is ignored, and its argument
Masanari Iidada3dae52014-09-09 01:27:23 +09002825 * is skipped.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002826 *
2827 * The return value is the number of words(32bits) which would be generated for
2828 * the given input.
2829 *
2830 * NOTE:
2831 * If the return value is greater than @size, the resulting bin_buf is NOT
2832 * valid for bstr_printf().
2833 */
2834int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args)
2835{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002836 struct printf_spec spec = {0};
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002837 char *str, *end;
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002838 int width;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002839
2840 str = (char *)bin_buf;
2841 end = (char *)(bin_buf + size);
2842
2843#define save_arg(type) \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002844({ \
2845 unsigned long long value; \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002846 if (sizeof(type) == 8) { \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002847 unsigned long long val8; \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002848 str = PTR_ALIGN(str, sizeof(u32)); \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002849 val8 = va_arg(args, unsigned long long); \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002850 if (str + sizeof(type) <= end) { \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002851 *(u32 *)str = *(u32 *)&val8; \
2852 *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002853 } \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002854 value = val8; \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002855 } else { \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002856 unsigned int val4; \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002857 str = PTR_ALIGN(str, sizeof(type)); \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002858 val4 = va_arg(args, int); \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002859 if (str + sizeof(type) <= end) \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002860 *(typeof(type) *)str = (type)(long)val4; \
2861 value = (unsigned long long)val4; \
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002862 } \
2863 str += sizeof(type); \
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002864 value; \
2865})
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002866
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002867 while (*fmt) {
André Goddard Rosad4be1512009-12-14 18:00:59 -08002868 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002869
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002870 fmt += read;
2871
2872 switch (spec.type) {
2873 case FORMAT_TYPE_NONE:
André Goddard Rosad4be1512009-12-14 18:00:59 -08002874 case FORMAT_TYPE_PERCENT_CHAR:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002875 break;
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002876 case FORMAT_TYPE_INVALID:
2877 goto out;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002878
Vegard Nossumed681a92009-03-14 12:08:50 +01002879 case FORMAT_TYPE_WIDTH:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002880 case FORMAT_TYPE_PRECISION:
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002881 width = (int)save_arg(int);
2882 /* Pointers may require the width */
2883 if (*fmt == 'p')
2884 set_field_width(&spec, width);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002885 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002886
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002887 case FORMAT_TYPE_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002888 save_arg(char);
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002889 break;
2890
2891 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002892 const char *save_str = va_arg(args, char *);
Petr Mladek3e5903e2019-04-17 13:53:48 +02002893 const char *err_msg;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002894 size_t len;
André Goddard Rosa6c356632009-12-14 18:00:56 -08002895
Petr Mladek3e5903e2019-04-17 13:53:48 +02002896 err_msg = check_pointer_msg(save_str);
2897 if (err_msg)
2898 save_str = err_msg;
2899
André Goddard Rosa6c356632009-12-14 18:00:56 -08002900 len = strlen(save_str) + 1;
2901 if (str + len < end)
2902 memcpy(str, save_str, len);
2903 str += len;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002904 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002905 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002906
2907 case FORMAT_TYPE_PTR:
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002908 /* Dereferenced pointers must be done now */
2909 switch (*fmt) {
2910 /* Dereference of functions is still OK */
2911 case 'S':
2912 case 's':
Steven Rostedt (VMware)1e6338c2018-04-03 14:38:53 -04002913 case 'x':
2914 case 'K':
Rasmus Villemoes57f56772019-10-15 21:07:05 +02002915 case 'e':
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05002916 save_arg(void *);
2917 break;
2918 default:
2919 if (!isalnum(*fmt)) {
2920 save_arg(void *);
2921 break;
2922 }
2923 str = pointer(fmt, str, end, va_arg(args, void *),
2924 spec);
2925 if (str + 1 < end)
2926 *str++ = '\0';
2927 else
2928 end[-1] = '\0'; /* Must be nul terminated */
2929 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002930 /* skip all alphanumeric pointer suffixes */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002931 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002932 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002933 break;
2934
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002935 default:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002936 switch (spec.type) {
2937
2938 case FORMAT_TYPE_LONG_LONG:
2939 save_arg(long long);
2940 break;
2941 case FORMAT_TYPE_ULONG:
2942 case FORMAT_TYPE_LONG:
2943 save_arg(unsigned long);
2944 break;
2945 case FORMAT_TYPE_SIZE_T:
2946 save_arg(size_t);
2947 break;
2948 case FORMAT_TYPE_PTRDIFF:
2949 save_arg(ptrdiff_t);
2950 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08002951 case FORMAT_TYPE_UBYTE:
2952 case FORMAT_TYPE_BYTE:
2953 save_arg(char);
2954 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002955 case FORMAT_TYPE_USHORT:
2956 case FORMAT_TYPE_SHORT:
2957 save_arg(short);
2958 break;
2959 default:
2960 save_arg(int);
2961 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002962 }
2963 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002964
Rasmus Villemoesb006f192015-11-06 16:30:20 -08002965out:
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08002966 return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002967#undef save_arg
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002968}
2969EXPORT_SYMBOL_GPL(vbin_printf);
2970
2971/**
2972 * bstr_printf - Format a string from binary arguments and place it in a buffer
2973 * @buf: The buffer to place the result into
2974 * @size: The size of the buffer, including the trailing null space
2975 * @fmt: The format string to use
2976 * @bin_buf: Binary arguments for the format string
2977 *
2978 * This function like C99 vsnprintf, but the difference is that vsnprintf gets
2979 * arguments from stack, and bstr_printf gets arguments from @bin_buf which is
2980 * a binary buffer that generated by vbin_printf.
2981 *
2982 * The format follows C99 vsnprintf, but has some extensions:
Steven Rostedt0efb4d22009-09-17 09:27:29 -04002983 * see vsnprintf comment for details.
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002984 *
2985 * The return value is the number of characters which would
2986 * be generated for the given input, excluding the trailing
2987 * '\0', as per ISO C99. If you want to have the exact
2988 * number of characters written into @buf as return value
2989 * (not including the trailing '\0'), use vscnprintf(). If the
2990 * return is greater than or equal to @size, the resulting
2991 * string is truncated.
2992 */
2993int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf)
2994{
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01002995 struct printf_spec spec = {0};
André Goddard Rosad4be1512009-12-14 18:00:59 -08002996 char *str, *end;
2997 const char *args = (const char *)bin_buf;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01002998
Rasmus Villemoes762abb52015-11-06 16:30:23 -08002999 if (WARN_ON_ONCE(size > INT_MAX))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003000 return 0;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003001
3002 str = buf;
3003 end = buf + size;
3004
3005#define get_arg(type) \
3006({ \
3007 typeof(type) value; \
3008 if (sizeof(type) == 8) { \
3009 args = PTR_ALIGN(args, sizeof(u32)); \
3010 *(u32 *)&value = *(u32 *)args; \
3011 *((u32 *)&value + 1) = *(u32 *)(args + 4); \
3012 } else { \
3013 args = PTR_ALIGN(args, sizeof(type)); \
3014 value = *(typeof(type) *)args; \
3015 } \
3016 args += sizeof(type); \
3017 value; \
3018})
3019
3020 /* Make sure end is always >= buf */
3021 if (end < buf) {
3022 end = ((void *)-1);
3023 size = end - buf;
3024 }
3025
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003026 while (*fmt) {
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003027 const char *old_fmt = fmt;
André Goddard Rosad4be1512009-12-14 18:00:59 -08003028 int read = format_decode(fmt, &spec);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003029
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003030 fmt += read;
3031
3032 switch (spec.type) {
3033 case FORMAT_TYPE_NONE: {
3034 int copy = read;
3035 if (str < end) {
3036 if (copy > end - str)
3037 copy = end - str;
3038 memcpy(str, old_fmt, copy);
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003039 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003040 str += read;
3041 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003042 }
3043
Vegard Nossumed681a92009-03-14 12:08:50 +01003044 case FORMAT_TYPE_WIDTH:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08003045 set_field_width(&spec, get_arg(int));
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003046 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003047
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003048 case FORMAT_TYPE_PRECISION:
Rasmus Villemoes4d72ba02016-01-15 16:58:44 -08003049 set_precision(&spec, get_arg(int));
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003050 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003051
André Goddard Rosad4be1512009-12-14 18:00:59 -08003052 case FORMAT_TYPE_CHAR: {
3053 char c;
3054
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003055 if (!(spec.flags & LEFT)) {
3056 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003057 if (str < end)
3058 *str = ' ';
3059 ++str;
3060 }
3061 }
3062 c = (unsigned char) get_arg(char);
3063 if (str < end)
3064 *str = c;
3065 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003066 while (--spec.field_width > 0) {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003067 if (str < end)
3068 *str = ' ';
3069 ++str;
3070 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003071 break;
André Goddard Rosad4be1512009-12-14 18:00:59 -08003072 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003073
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003074 case FORMAT_TYPE_STR: {
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003075 const char *str_arg = args;
André Goddard Rosad4be1512009-12-14 18:00:59 -08003076 args += strlen(str_arg) + 1;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003077 str = string(str, end, (char *)str_arg, spec);
3078 break;
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003079 }
3080
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05003081 case FORMAT_TYPE_PTR: {
3082 bool process = false;
3083 int copy, len;
3084 /* Non function dereferences were already done */
3085 switch (*fmt) {
3086 case 'S':
3087 case 's':
3088 case 'F':
3089 case 'f':
Steven Rostedt (VMware)1e6338c2018-04-03 14:38:53 -04003090 case 'x':
3091 case 'K':
Rasmus Villemoes57f56772019-10-15 21:07:05 +02003092 case 'e':
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05003093 process = true;
3094 break;
3095 default:
3096 if (!isalnum(*fmt)) {
3097 process = true;
3098 break;
3099 }
3100 /* Pointer dereference was already processed */
3101 if (str < end) {
3102 len = copy = strlen(args);
3103 if (copy > end - str)
3104 copy = end - str;
3105 memcpy(str, args, copy);
3106 str += len;
Steven Rostedt (VMware)62165602018-10-05 10:08:03 -04003107 args += len + 1;
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05003108 }
3109 }
3110 if (process)
3111 str = pointer(fmt, str, end, get_arg(void *), spec);
3112
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003113 while (isalnum(*fmt))
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003114 fmt++;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003115 break;
Steven Rostedt (VMware)841a9152017-12-28 20:40:25 -05003116 }
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003117
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003118 case FORMAT_TYPE_PERCENT_CHAR:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003119 if (str < end)
3120 *str = '%';
3121 ++str;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003122 break;
3123
Rasmus Villemoesb006f192015-11-06 16:30:20 -08003124 case FORMAT_TYPE_INVALID:
3125 goto out;
3126
André Goddard Rosad4be1512009-12-14 18:00:59 -08003127 default: {
3128 unsigned long long num;
3129
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003130 switch (spec.type) {
3131
3132 case FORMAT_TYPE_LONG_LONG:
3133 num = get_arg(long long);
3134 break;
3135 case FORMAT_TYPE_ULONG:
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003136 case FORMAT_TYPE_LONG:
3137 num = get_arg(unsigned long);
3138 break;
3139 case FORMAT_TYPE_SIZE_T:
3140 num = get_arg(size_t);
3141 break;
3142 case FORMAT_TYPE_PTRDIFF:
3143 num = get_arg(ptrdiff_t);
3144 break;
Zhaoleia4e94ef2009-03-27 17:07:05 +08003145 case FORMAT_TYPE_UBYTE:
3146 num = get_arg(unsigned char);
3147 break;
3148 case FORMAT_TYPE_BYTE:
3149 num = get_arg(signed char);
3150 break;
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003151 case FORMAT_TYPE_USHORT:
3152 num = get_arg(unsigned short);
3153 break;
3154 case FORMAT_TYPE_SHORT:
3155 num = get_arg(short);
3156 break;
3157 case FORMAT_TYPE_UINT:
3158 num = get_arg(unsigned int);
3159 break;
3160 default:
3161 num = get_arg(int);
3162 }
3163
3164 str = number(str, end, num, spec);
André Goddard Rosad4be1512009-12-14 18:00:59 -08003165 } /* default: */
3166 } /* switch(spec.type) */
3167 } /* while(*fmt) */
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003168
Rasmus Villemoesb006f192015-11-06 16:30:20 -08003169out:
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003170 if (size > 0) {
3171 if (str < end)
3172 *str = '\0';
3173 else
3174 end[-1] = '\0';
3175 }
Frederic Weisbeckerfef20d92009-03-06 17:21:50 +01003176
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003177#undef get_arg
3178
3179 /* the trailing null byte doesn't count towards the total */
3180 return str - buf;
3181}
3182EXPORT_SYMBOL_GPL(bstr_printf);
3183
3184/**
3185 * bprintf - Parse a format string and place args' binary value in a buffer
3186 * @bin_buf: The buffer to place args' binary value
3187 * @size: The size of the buffer(by words(32bits), not characters)
3188 * @fmt: The format string to use
3189 * @...: Arguments for the format string
3190 *
3191 * The function returns the number of words(u32) written
3192 * into @bin_buf.
3193 */
3194int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...)
3195{
3196 va_list args;
3197 int ret;
3198
3199 va_start(args, fmt);
3200 ret = vbin_printf(bin_buf, size, fmt, args);
3201 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003202
Lai Jiangshan4370aa42009-03-06 17:21:46 +01003203 return ret;
3204}
3205EXPORT_SYMBOL_GPL(bprintf);
3206
3207#endif /* CONFIG_BINARY_PRINTF */
3208
Linus Torvalds1da177e2005-04-16 15:20:36 -07003209/**
3210 * vsscanf - Unformat a buffer into a list of arguments
3211 * @buf: input buffer
3212 * @fmt: format of buffer
3213 * @args: arguments
3214 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003215int vsscanf(const char *buf, const char *fmt, va_list args)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003216{
3217 const char *str = buf;
3218 char *next;
3219 char digit;
3220 int num = 0;
Joe Perchesef0658f2010-03-06 17:10:14 -08003221 u8 qualifier;
Jan Beulich53809752012-12-17 16:01:31 -08003222 unsigned int base;
3223 union {
3224 long long s;
3225 unsigned long long u;
3226 } val;
Joe Perchesef0658f2010-03-06 17:10:14 -08003227 s16 field_width;
André Goddard Rosad4be1512009-12-14 18:00:59 -08003228 bool is_sign;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003229
Jan Beulichda990752012-10-04 17:13:24 -07003230 while (*fmt) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231 /* skip any white space in format */
3232 /* white space in format matchs any amount of
3233 * white space, including none, in the input.
3234 */
3235 if (isspace(*fmt)) {
André Goddard Rosae7d28602009-12-14 18:01:06 -08003236 fmt = skip_spaces(++fmt);
3237 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238 }
3239
3240 /* anything that is not a conversion must match exactly */
3241 if (*fmt != '%' && *fmt) {
3242 if (*fmt++ != *str++)
3243 break;
3244 continue;
3245 }
3246
3247 if (!*fmt)
3248 break;
3249 ++fmt;
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003250
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251 /* skip this conversion.
3252 * advance both strings to next white space
3253 */
3254 if (*fmt == '*') {
Jan Beulichda990752012-10-04 17:13:24 -07003255 if (!*str)
3256 break;
Jessica Yuf9310b22016-03-17 14:23:07 -07003257 while (!isspace(*fmt) && *fmt != '%' && *fmt) {
3258 /* '%*[' not yet supported, invalid format */
3259 if (*fmt == '[')
3260 return num;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261 fmt++;
Jessica Yuf9310b22016-03-17 14:23:07 -07003262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263 while (!isspace(*str) && *str)
3264 str++;
3265 continue;
3266 }
3267
3268 /* get field width */
3269 field_width = -1;
Jan Beulich53809752012-12-17 16:01:31 -08003270 if (isdigit(*fmt)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271 field_width = skip_atoi(&fmt);
Jan Beulich53809752012-12-17 16:01:31 -08003272 if (field_width <= 0)
3273 break;
3274 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003275
3276 /* get conversion qualifier */
3277 qualifier = -1;
Andy Shevchenko75fb8f22011-07-25 17:13:20 -07003278 if (*fmt == 'h' || _tolower(*fmt) == 'l' ||
Alexey Dobriyan5b5e0922017-02-27 14:30:02 -08003279 *fmt == 'z') {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280 qualifier = *fmt++;
3281 if (unlikely(qualifier == *fmt)) {
3282 if (qualifier == 'h') {
3283 qualifier = 'H';
3284 fmt++;
3285 } else if (qualifier == 'l') {
3286 qualifier = 'L';
3287 fmt++;
3288 }
3289 }
3290 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003291
Jan Beulichda990752012-10-04 17:13:24 -07003292 if (!*fmt)
3293 break;
3294
3295 if (*fmt == 'n') {
3296 /* return number of characters read so far */
3297 *va_arg(args, int *) = str - buf;
3298 ++fmt;
3299 continue;
3300 }
3301
3302 if (!*str)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303 break;
3304
André Goddard Rosad4be1512009-12-14 18:00:59 -08003305 base = 10;
Fabian Frederick3f623eb2014-06-04 16:11:52 -07003306 is_sign = false;
André Goddard Rosad4be1512009-12-14 18:00:59 -08003307
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003308 switch (*fmt++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003309 case 'c':
3310 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003311 char *s = (char *)va_arg(args, char*);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003312 if (field_width == -1)
3313 field_width = 1;
3314 do {
3315 *s++ = *str++;
3316 } while (--field_width > 0 && *str);
3317 num++;
3318 }
3319 continue;
3320 case 's':
3321 {
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003322 char *s = (char *)va_arg(args, char *);
3323 if (field_width == -1)
Alexey Dobriyan4be929b2010-05-24 14:33:03 -07003324 field_width = SHRT_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325 /* first, skip leading white space in buffer */
André Goddard Rosae7d28602009-12-14 18:01:06 -08003326 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327
3328 /* now copy until next white space */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003329 while (*str && !isspace(*str) && field_width--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003330 *s++ = *str++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003331 *s = '\0';
3332 num++;
3333 }
3334 continue;
Jessica Yuf9310b22016-03-17 14:23:07 -07003335 /*
3336 * Warning: This implementation of the '[' conversion specifier
3337 * deviates from its glibc counterpart in the following ways:
3338 * (1) It does NOT support ranges i.e. '-' is NOT a special
3339 * character
3340 * (2) It cannot match the closing bracket ']' itself
3341 * (3) A field width is required
3342 * (4) '%*[' (discard matching input) is currently not supported
3343 *
3344 * Example usage:
3345 * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]",
3346 * buf1, buf2, buf3);
3347 * if (ret < 3)
3348 * // etc..
3349 */
3350 case '[':
3351 {
3352 char *s = (char *)va_arg(args, char *);
3353 DECLARE_BITMAP(set, 256) = {0};
3354 unsigned int len = 0;
3355 bool negate = (*fmt == '^');
3356
3357 /* field width is required */
3358 if (field_width == -1)
3359 return num;
3360
3361 if (negate)
3362 ++fmt;
3363
3364 for ( ; *fmt && *fmt != ']'; ++fmt, ++len)
3365 set_bit((u8)*fmt, set);
3366
3367 /* no ']' or no character set found */
3368 if (!*fmt || !len)
3369 return num;
3370 ++fmt;
3371
3372 if (negate) {
3373 bitmap_complement(set, set, 256);
3374 /* exclude null '\0' byte */
3375 clear_bit(0, set);
3376 }
3377
3378 /* match must be non-empty */
3379 if (!test_bit((u8)*str, set))
3380 return num;
3381
3382 while (test_bit((u8)*str, set) && field_width--)
3383 *s++ = *str++;
3384 *s = '\0';
3385 ++num;
3386 }
3387 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003388 case 'o':
3389 base = 8;
3390 break;
3391 case 'x':
3392 case 'X':
3393 base = 16;
3394 break;
3395 case 'i':
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003396 base = 0;
Andy Shevchenko7e6bd6f2018-02-16 23:07:11 +02003397 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398 case 'd':
Fabian Frederick3f623eb2014-06-04 16:11:52 -07003399 is_sign = true;
Andy Shevchenko7e6bd6f2018-02-16 23:07:11 +02003400 /* fall through */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401 case 'u':
3402 break;
3403 case '%':
3404 /* looking for '%' in str */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003405 if (*str++ != '%')
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 return num;
3407 continue;
3408 default:
3409 /* invalid format; stop here */
3410 return num;
3411 }
3412
3413 /* have some sort of integer conversion.
3414 * first, skip white space in buffer.
3415 */
André Goddard Rosae7d28602009-12-14 18:01:06 -08003416 str = skip_spaces(str);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417
3418 digit = *str;
3419 if (is_sign && digit == '-')
3420 digit = *(str + 1);
3421
3422 if (!digit
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003423 || (base == 16 && !isxdigit(digit))
3424 || (base == 10 && !isdigit(digit))
3425 || (base == 8 && (!isdigit(digit) || digit > '7'))
3426 || (base == 0 && !isdigit(digit)))
3427 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428
Jan Beulich53809752012-12-17 16:01:31 -08003429 if (is_sign)
3430 val.s = qualifier != 'L' ?
3431 simple_strtol(str, &next, base) :
3432 simple_strtoll(str, &next, base);
3433 else
3434 val.u = qualifier != 'L' ?
3435 simple_strtoul(str, &next, base) :
3436 simple_strtoull(str, &next, base);
3437
3438 if (field_width > 0 && next - str > field_width) {
3439 if (base == 0)
3440 _parse_integer_fixup_radix(str, &base);
3441 while (next - str > field_width) {
3442 if (is_sign)
3443 val.s = div_s64(val.s, base);
3444 else
3445 val.u = div_u64(val.u, base);
3446 --next;
3447 }
3448 }
3449
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003450 switch (qualifier) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451 case 'H': /* that's 'hh' in format */
Jan Beulich53809752012-12-17 16:01:31 -08003452 if (is_sign)
3453 *va_arg(args, signed char *) = val.s;
3454 else
3455 *va_arg(args, unsigned char *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456 break;
3457 case 'h':
Jan Beulich53809752012-12-17 16:01:31 -08003458 if (is_sign)
3459 *va_arg(args, short *) = val.s;
3460 else
3461 *va_arg(args, unsigned short *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003462 break;
3463 case 'l':
Jan Beulich53809752012-12-17 16:01:31 -08003464 if (is_sign)
3465 *va_arg(args, long *) = val.s;
3466 else
3467 *va_arg(args, unsigned long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003468 break;
3469 case 'L':
Jan Beulich53809752012-12-17 16:01:31 -08003470 if (is_sign)
3471 *va_arg(args, long long *) = val.s;
3472 else
3473 *va_arg(args, unsigned long long *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003474 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003475 case 'z':
Jan Beulich53809752012-12-17 16:01:31 -08003476 *va_arg(args, size_t *) = val.u;
3477 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003478 default:
Jan Beulich53809752012-12-17 16:01:31 -08003479 if (is_sign)
3480 *va_arg(args, int *) = val.s;
3481 else
3482 *va_arg(args, unsigned int *) = val.u;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003483 break;
3484 }
3485 num++;
3486
3487 if (!next)
3488 break;
3489 str = next;
3490 }
Johannes Bergc6b40d12007-05-08 00:27:20 -07003491
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492 return num;
3493}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494EXPORT_SYMBOL(vsscanf);
3495
3496/**
3497 * sscanf - Unformat a buffer into a list of arguments
3498 * @buf: input buffer
3499 * @fmt: formatting of buffer
3500 * @...: resulting arguments
3501 */
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003502int sscanf(const char *buf, const char *fmt, ...)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003503{
3504 va_list args;
3505 int i;
3506
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003507 va_start(args, fmt);
3508 i = vsscanf(buf, fmt, args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003509 va_end(args);
André Goddard Rosa7b9186f2009-12-14 18:00:57 -08003510
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511 return i;
3512}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513EXPORT_SYMBOL(sscanf);