]>
Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* |
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 | ||
7b9186f5 | 13 | /* |
1da177e4 LT |
14 | * Fri Jul 13 2001 Crutcher Dunnavant <[email protected]> |
15 | * - changed to provide snprintf and vsnprintf functions | |
16 | * So Feb 1 16:51:32 CET 2004 Juergen Quade <[email protected]> | |
17 | * - scnprintf and vscnprintf | |
18 | */ | |
19 | ||
20 | #include <stdarg.h> | |
ef27ac18 | 21 | #include <linux/build_bug.h> |
0d1d7a55 | 22 | #include <linux/clk.h> |
900cca29 | 23 | #include <linux/clk-provider.h> |
57f5677e | 24 | #include <linux/errname.h> |
8bc3bcc9 | 25 | #include <linux/module.h> /* for KSYM_SYMBOL_LEN */ |
1da177e4 LT |
26 | #include <linux/types.h> |
27 | #include <linux/string.h> | |
28 | #include <linux/ctype.h> | |
29 | #include <linux/kernel.h> | |
0fe1ef24 | 30 | #include <linux/kallsyms.h> |
53809751 | 31 | #include <linux/math64.h> |
0fe1ef24 | 32 | #include <linux/uaccess.h> |
332d2e78 | 33 | #include <linux/ioport.h> |
4b6ccca7 | 34 | #include <linux/dcache.h> |
312b4e22 | 35 | #include <linux/cred.h> |
4d42c447 | 36 | #include <linux/rtc.h> |
7daac5b2 | 37 | #include <linux/time.h> |
2b1b0d66 | 38 | #include <linux/uuid.h> |
ce4fecf1 | 39 | #include <linux/of.h> |
8a27f7c9 | 40 | #include <net/addrconf.h> |
ad67b74d TH |
41 | #include <linux/siphash.h> |
42 | #include <linux/compiler.h> | |
a92eb762 | 43 | #include <linux/property.h> |
1031bc58 DM |
44 | #ifdef CONFIG_BLOCK |
45 | #include <linux/blkdev.h> | |
46 | #endif | |
1da177e4 | 47 | |
edf14cdb VB |
48 | #include "../mm/internal.h" /* For the trace_print_flags arrays */ |
49 | ||
4e57b681 | 50 | #include <asm/page.h> /* for PAGE_SIZE */ |
7c43d9a3 | 51 | #include <asm/byteorder.h> /* cpu_to_le16 */ |
1da177e4 | 52 | |
71dca95d | 53 | #include <linux/string_helpers.h> |
1dff46d6 | 54 | #include "kstrtox.h" |
aa46a63e | 55 | |
1da177e4 | 56 | /** |
922ac25c | 57 | * simple_strtoull - convert a string to an unsigned long long |
1da177e4 LT |
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 | |
462e4711 | 61 | * |
e8cc2b97 | 62 | * This function has caveats. Please use kstrtoull instead. |
1da177e4 | 63 | */ |
922ac25c | 64 | unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base) |
1da177e4 | 65 | { |
1dff46d6 AD |
66 | unsigned long long result; |
67 | unsigned int rv; | |
aa46a63e | 68 | |
1dff46d6 AD |
69 | cp = _parse_integer_fixup_radix(cp, &base); |
70 | rv = _parse_integer(cp, base, &result); | |
71 | /* FIXME */ | |
72 | cp += (rv & ~KSTRTOX_OVERFLOW); | |
aa46a63e | 73 | |
1da177e4 LT |
74 | if (endp) |
75 | *endp = (char *)cp; | |
7b9186f5 | 76 | |
1da177e4 LT |
77 | return result; |
78 | } | |
922ac25c | 79 | EXPORT_SYMBOL(simple_strtoull); |
1da177e4 LT |
80 | |
81 | /** | |
922ac25c | 82 | * simple_strtoul - convert a string to an unsigned long |
1da177e4 LT |
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 | |
462e4711 | 86 | * |
e8cc2b97 | 87 | * This function has caveats. Please use kstrtoul instead. |
1da177e4 | 88 | */ |
922ac25c | 89 | unsigned long simple_strtoul(const char *cp, char **endp, unsigned int base) |
1da177e4 | 90 | { |
922ac25c | 91 | return simple_strtoull(cp, endp, base); |
1da177e4 | 92 | } |
922ac25c | 93 | EXPORT_SYMBOL(simple_strtoul); |
1da177e4 LT |
94 | |
95 | /** | |
922ac25c | 96 | * simple_strtol - convert a string to a signed long |
1da177e4 LT |
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 | |
462e4711 | 100 | * |
e8cc2b97 | 101 | * This function has caveats. Please use kstrtol instead. |
1da177e4 | 102 | */ |
922ac25c | 103 | long simple_strtol(const char *cp, char **endp, unsigned int base) |
1da177e4 | 104 | { |
922ac25c AGR |
105 | if (*cp == '-') |
106 | return -simple_strtoul(cp + 1, endp, base); | |
7b9186f5 | 107 | |
922ac25c | 108 | return simple_strtoul(cp, endp, base); |
1da177e4 | 109 | } |
922ac25c | 110 | EXPORT_SYMBOL(simple_strtol); |
1da177e4 LT |
111 | |
112 | /** | |
113 | * 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 | |
462e4711 | 117 | * |
e8cc2b97 | 118 | * This function has caveats. Please use kstrtoll instead. |
1da177e4 | 119 | */ |
22d27051 | 120 | long long simple_strtoll(const char *cp, char **endp, unsigned int base) |
1da177e4 | 121 | { |
7b9186f5 | 122 | if (*cp == '-') |
22d27051 | 123 | return -simple_strtoull(cp + 1, endp, base); |
7b9186f5 | 124 | |
22d27051 | 125 | return simple_strtoull(cp, endp, base); |
1da177e4 | 126 | } |
98d5ce0d | 127 | EXPORT_SYMBOL(simple_strtoll); |
1da177e4 | 128 | |
cf3b429b JP |
129 | static noinline_for_stack |
130 | int skip_atoi(const char **s) | |
1da177e4 | 131 | { |
7b9186f5 | 132 | int i = 0; |
1da177e4 | 133 | |
43e5b666 | 134 | do { |
1da177e4 | 135 | i = i*10 + *((*s)++) - '0'; |
43e5b666 | 136 | } while (isdigit(**s)); |
7b9186f5 | 137 | |
1da177e4 LT |
138 | return i; |
139 | } | |
140 | ||
7c43d9a3 RV |
141 | /* |
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. | |
133fd9f5 | 164 | */ |
4277eedd | 165 | |
7c43d9a3 RV |
166 | static 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 | }; | |
180 | ||
181 | /* | |
182 | * This will print a single '0' even if r == 0, since we would | |
675cf53c RV |
183 | * 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. | |
7c43d9a3 | 186 | */ |
cf3b429b | 187 | static noinline_for_stack |
7c43d9a3 | 188 | char *put_dec_trunc8(char *buf, unsigned r) |
4277eedd | 189 | { |
7c43d9a3 RV |
190 | unsigned q; |
191 | ||
192 | /* 1 <= r < 10^8 */ | |
193 | if (r < 100) | |
194 | goto out_r; | |
195 | ||
196 | /* 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; | |
218 | out_q: | |
219 | /* 1 <= q < 100 */ | |
220 | r = q; | |
221 | out_r: | |
222 | /* 1 <= r < 100 */ | |
223 | *((u16 *)buf) = decpair[r]; | |
675cf53c | 224 | buf += r < 10 ? 1 : 2; |
4277eedd DV |
225 | return buf; |
226 | } | |
133fd9f5 | 227 | |
7c43d9a3 | 228 | #if BITS_PER_LONG == 64 && BITS_PER_LONG_LONG == 64 |
cf3b429b | 229 | static noinline_for_stack |
7c43d9a3 | 230 | char *put_dec_full8(char *buf, unsigned r) |
4277eedd | 231 | { |
133fd9f5 DV |
232 | unsigned q; |
233 | ||
7c43d9a3 RV |
234 | /* 0 <= r < 10^8 */ |
235 | q = (r * (u64)0x28f5c29) >> 32; | |
236 | *((u16 *)buf) = decpair[r - 100*q]; | |
237 | buf += 2; | |
4277eedd | 238 | |
7c43d9a3 RV |
239 | /* 0 <= q < 10^6 */ |
240 | r = (q * (u64)0x28f5c29) >> 32; | |
241 | *((u16 *)buf) = decpair[q - 100*r]; | |
242 | buf += 2; | |
7b9186f5 | 243 | |
7c43d9a3 RV |
244 | /* 0 <= r < 10^4 */ |
245 | q = (r * 0x147b) >> 19; | |
246 | *((u16 *)buf) = decpair[r - 100*q]; | |
247 | buf += 2; | |
133fd9f5 | 248 | |
7c43d9a3 RV |
249 | /* 0 <= q < 100 */ |
250 | *((u16 *)buf) = decpair[q]; | |
251 | buf += 2; | |
252 | return buf; | |
253 | } | |
133fd9f5 | 254 | |
7c43d9a3 | 255 | static noinline_for_stack |
133fd9f5 DV |
256 | char *put_dec(char *buf, unsigned long long n) |
257 | { | |
7c43d9a3 RV |
258 | 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 */ | |
133fd9f5 | 264 | return put_dec_trunc8(buf, n); |
4277eedd | 265 | } |
133fd9f5 | 266 | |
7c43d9a3 | 267 | #elif BITS_PER_LONG == 32 && BITS_PER_LONG_LONG == 64 |
133fd9f5 | 268 | |
7c43d9a3 RV |
269 | static void |
270 | put_dec_full4(char *buf, unsigned r) | |
4277eedd | 271 | { |
7c43d9a3 RV |
272 | 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]; | |
2359172a GS |
280 | } |
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. | |
7c43d9a3 | 287 | * (second call in the put_dec code, assuming n is all-ones). |
2359172a | 288 | */ |
7c43d9a3 | 289 | static noinline_for_stack |
2359172a GS |
290 | unsigned 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; | |
4277eedd DV |
296 | } |
297 | ||
133fd9f5 DV |
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 | */ | |
303 | static | |
304 | char *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 | ||
7c43d9a3 RV |
316 | /* 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 */ | |
133fd9f5 | 318 | q = 656 * d3 + 7296 * d2 + 5536 * d1 + ((uint32_t)n & 0xffff); |
2359172a GS |
319 | q = put_dec_helper4(buf, q); |
320 | ||
321 | q += 7671 * d3 + 9496 * d2 + 6 * d1; | |
322 | q = put_dec_helper4(buf+4, q); | |
323 | ||
324 | q += 4749 * d3 + 42 * d2; | |
325 | q = put_dec_helper4(buf+8, q); | |
133fd9f5 | 326 | |
2359172a GS |
327 | q += 281 * d3; |
328 | buf += 12; | |
329 | if (q) | |
330 | buf = put_dec_trunc8(buf, q); | |
331 | else while (buf[-1] == '0') | |
133fd9f5 DV |
332 | --buf; |
333 | ||
334 | return buf; | |
335 | } | |
336 | ||
337 | #endif | |
338 | ||
1ac101a5 KH |
339 | /* |
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 | */ | |
d1be35cb | 345 | int num_to_str(char *buf, int size, unsigned long long num, unsigned int width) |
1ac101a5 | 346 | { |
7c43d9a3 RV |
347 | /* put_dec requires 2-byte alignment of the buffer. */ |
348 | char tmp[sizeof(num) * 3] __aligned(2); | |
1ac101a5 KH |
349 | int idx, len; |
350 | ||
133fd9f5 DV |
351 | /* 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 | } | |
1ac101a5 | 358 | |
d1be35cb | 359 | if (len > size || width > size) |
1ac101a5 | 360 | return 0; |
d1be35cb AV |
361 | |
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 | ||
1ac101a5 | 370 | for (idx = 0; idx < len; ++idx) |
d1be35cb AV |
371 | buf[idx + width] = tmp[len - idx - 1]; |
372 | ||
373 | return len + width; | |
1ac101a5 KH |
374 | } |
375 | ||
51be17df | 376 | #define SIGN 1 /* unsigned/signed, must be 1 */ |
d1c1b121 | 377 | #define LEFT 2 /* left justified */ |
1da177e4 LT |
378 | #define PLUS 4 /* show plus */ |
379 | #define SPACE 8 /* space if plus */ | |
d1c1b121 | 380 | #define ZEROPAD 16 /* pad with zero, must be 16 == '0' - ' ' */ |
b89dc5d6 BH |
381 | #define SMALL 32 /* use lowercase in hex (must be 32 == 0x20) */ |
382 | #define SPECIAL 64 /* prefix hex with "0x", octal with "0" */ | |
1da177e4 | 383 | |
b886690d AS |
384 | static_assert(ZEROPAD == ('0' - ' ')); |
385 | static_assert(SMALL == ' '); | |
386 | ||
fef20d9c FW |
387 | enum format_type { |
388 | FORMAT_TYPE_NONE, /* Just a string part */ | |
ed681a91 | 389 | FORMAT_TYPE_WIDTH, |
fef20d9c FW |
390 | FORMAT_TYPE_PRECISION, |
391 | FORMAT_TYPE_CHAR, | |
392 | FORMAT_TYPE_STR, | |
393 | FORMAT_TYPE_PTR, | |
394 | FORMAT_TYPE_PERCENT_CHAR, | |
395 | FORMAT_TYPE_INVALID, | |
396 | FORMAT_TYPE_LONG_LONG, | |
397 | FORMAT_TYPE_ULONG, | |
398 | FORMAT_TYPE_LONG, | |
a4e94ef0 Z |
399 | FORMAT_TYPE_UBYTE, |
400 | FORMAT_TYPE_BYTE, | |
fef20d9c FW |
401 | FORMAT_TYPE_USHORT, |
402 | FORMAT_TYPE_SHORT, | |
403 | FORMAT_TYPE_UINT, | |
404 | FORMAT_TYPE_INT, | |
fef20d9c FW |
405 | FORMAT_TYPE_SIZE_T, |
406 | FORMAT_TYPE_PTRDIFF | |
407 | }; | |
408 | ||
409 | struct printf_spec { | |
d0484193 RV |
410 | unsigned int type:8; /* format_type enum */ |
411 | signed int field_width:24; /* width of output field */ | |
412 | unsigned int flags:8; /* flags to number() */ | |
413 | unsigned int base:8; /* number base, 8, 10 or 16 only */ | |
414 | signed int precision:16; /* # of digits/chars */ | |
415 | } __packed; | |
ef27ac18 RV |
416 | static_assert(sizeof(struct printf_spec) == 8); |
417 | ||
4d72ba01 RV |
418 | #define FIELD_WIDTH_MAX ((1 << 23) - 1) |
419 | #define PRECISION_MAX ((1 << 15) - 1) | |
fef20d9c | 420 | |
cf3b429b JP |
421 | static noinline_for_stack |
422 | char *number(char *buf, char *end, unsigned long long num, | |
423 | struct printf_spec spec) | |
1da177e4 | 424 | { |
7c43d9a3 RV |
425 | /* put_dec requires 2-byte alignment of the buffer. */ |
426 | char tmp[3 * sizeof(num)] __aligned(2); | |
9b706aee DV |
427 | char sign; |
428 | char locase; | |
fef20d9c | 429 | int need_pfx = ((spec.flags & SPECIAL) && spec.base != 10); |
1da177e4 | 430 | int i; |
7c203422 | 431 | bool is_zero = num == 0LL; |
1c7a8e62 RV |
432 | int field_width = spec.field_width; |
433 | int precision = spec.precision; | |
1da177e4 | 434 | |
9b706aee DV |
435 | /* locase = 0 or 0x20. ORing digits or letters with 'locase' |
436 | * produces same digits or (maybe lowercased) letters */ | |
fef20d9c FW |
437 | locase = (spec.flags & SMALL); |
438 | if (spec.flags & LEFT) | |
439 | spec.flags &= ~ZEROPAD; | |
1da177e4 | 440 | sign = 0; |
fef20d9c | 441 | if (spec.flags & SIGN) { |
7b9186f5 | 442 | if ((signed long long)num < 0) { |
1da177e4 | 443 | sign = '-'; |
7b9186f5 | 444 | num = -(signed long long)num; |
1c7a8e62 | 445 | field_width--; |
fef20d9c | 446 | } else if (spec.flags & PLUS) { |
1da177e4 | 447 | sign = '+'; |
1c7a8e62 | 448 | field_width--; |
fef20d9c | 449 | } else if (spec.flags & SPACE) { |
1da177e4 | 450 | sign = ' '; |
1c7a8e62 | 451 | field_width--; |
1da177e4 LT |
452 | } |
453 | } | |
b39a7340 | 454 | if (need_pfx) { |
fef20d9c | 455 | if (spec.base == 16) |
1c7a8e62 | 456 | field_width -= 2; |
7c203422 | 457 | else if (!is_zero) |
1c7a8e62 | 458 | field_width--; |
1da177e4 | 459 | } |
b39a7340 DV |
460 | |
461 | /* generate full string in tmp[], in reverse order */ | |
1da177e4 | 462 | i = 0; |
133fd9f5 | 463 | if (num < spec.base) |
3ea8d440 | 464 | tmp[i++] = hex_asc_upper[num] | locase; |
fef20d9c FW |
465 | else if (spec.base != 10) { /* 8 or 16 */ |
466 | int mask = spec.base - 1; | |
b39a7340 | 467 | int shift = 3; |
7b9186f5 AGR |
468 | |
469 | if (spec.base == 16) | |
470 | shift = 4; | |
b39a7340 | 471 | do { |
3ea8d440 | 472 | tmp[i++] = (hex_asc_upper[((unsigned char)num) & mask] | locase); |
b39a7340 DV |
473 | num >>= shift; |
474 | } while (num); | |
4277eedd DV |
475 | } else { /* base 10 */ |
476 | i = put_dec(tmp, num) - tmp; | |
477 | } | |
b39a7340 DV |
478 | |
479 | /* printing 100 using %2d gives "100", not "00" */ | |
1c7a8e62 RV |
480 | if (i > precision) |
481 | precision = i; | |
b39a7340 | 482 | /* leading space padding */ |
1c7a8e62 | 483 | field_width -= precision; |
51be17df | 484 | if (!(spec.flags & (ZEROPAD | LEFT))) { |
1c7a8e62 | 485 | while (--field_width >= 0) { |
f796937a | 486 | if (buf < end) |
1da177e4 LT |
487 | *buf = ' '; |
488 | ++buf; | |
489 | } | |
490 | } | |
b39a7340 | 491 | /* sign */ |
1da177e4 | 492 | if (sign) { |
f796937a | 493 | if (buf < end) |
1da177e4 LT |
494 | *buf = sign; |
495 | ++buf; | |
496 | } | |
b39a7340 DV |
497 | /* "0x" / "0" prefix */ |
498 | if (need_pfx) { | |
7c203422 PC |
499 | if (spec.base == 16 || !is_zero) { |
500 | if (buf < end) | |
501 | *buf = '0'; | |
502 | ++buf; | |
503 | } | |
fef20d9c | 504 | if (spec.base == 16) { |
f796937a | 505 | if (buf < end) |
9b706aee | 506 | *buf = ('X' | locase); |
1da177e4 LT |
507 | ++buf; |
508 | } | |
509 | } | |
b39a7340 | 510 | /* zero or space padding */ |
fef20d9c | 511 | if (!(spec.flags & LEFT)) { |
d1c1b121 | 512 | char c = ' ' + (spec.flags & ZEROPAD); |
b886690d | 513 | |
1c7a8e62 | 514 | while (--field_width >= 0) { |
f796937a | 515 | if (buf < end) |
1da177e4 LT |
516 | *buf = c; |
517 | ++buf; | |
518 | } | |
519 | } | |
b39a7340 | 520 | /* hmm even more zero padding? */ |
1c7a8e62 | 521 | while (i <= --precision) { |
f796937a | 522 | if (buf < end) |
1da177e4 LT |
523 | *buf = '0'; |
524 | ++buf; | |
525 | } | |
b39a7340 DV |
526 | /* actual digits of result */ |
527 | while (--i >= 0) { | |
f796937a | 528 | if (buf < end) |
1da177e4 LT |
529 | *buf = tmp[i]; |
530 | ++buf; | |
531 | } | |
b39a7340 | 532 | /* trailing space padding */ |
1c7a8e62 | 533 | while (--field_width >= 0) { |
f796937a | 534 | if (buf < end) |
1da177e4 LT |
535 | *buf = ' '; |
536 | ++buf; | |
537 | } | |
7b9186f5 | 538 | |
1da177e4 LT |
539 | return buf; |
540 | } | |
541 | ||
3cab1e71 AS |
542 | static noinline_for_stack |
543 | char *special_hex_number(char *buf, char *end, unsigned long long num, int size) | |
544 | { | |
545 | struct printf_spec spec; | |
546 | ||
547 | spec.type = FORMAT_TYPE_PTR; | |
548 | spec.field_width = 2 + 2 * size; /* 0x + hex */ | |
549 | spec.flags = SPECIAL | SMALL | ZEROPAD; | |
550 | spec.base = 16; | |
551 | spec.precision = -1; | |
552 | ||
553 | return number(buf, end, num, spec); | |
554 | } | |
555 | ||
cfccde04 | 556 | static void move_right(char *buf, char *end, unsigned len, unsigned spaces) |
4b6ccca7 AV |
557 | { |
558 | size_t size; | |
559 | if (buf >= end) /* nowhere to put anything */ | |
560 | return; | |
561 | size = end - buf; | |
562 | if (size <= spaces) { | |
563 | memset(buf, ' ', size); | |
564 | return; | |
565 | } | |
566 | if (len) { | |
567 | if (len > size - spaces) | |
568 | len = size - spaces; | |
569 | memmove(buf + spaces, buf, len); | |
570 | } | |
571 | memset(buf, ' ', spaces); | |
572 | } | |
573 | ||
cfccde04 RV |
574 | /* |
575 | * Handle field width padding for a string. | |
576 | * @buf: current buffer position | |
577 | * @n: length of string | |
578 | * @end: end of output buffer | |
579 | * @spec: for field width and flags | |
580 | * Returns: new buffer position after padding. | |
581 | */ | |
582 | static noinline_for_stack | |
583 | char *widen_string(char *buf, int n, char *end, struct printf_spec spec) | |
584 | { | |
585 | unsigned spaces; | |
586 | ||
587 | if (likely(n >= spec.field_width)) | |
588 | return buf; | |
589 | /* we want to pad the sucker */ | |
590 | spaces = spec.field_width - n; | |
591 | if (!(spec.flags & LEFT)) { | |
592 | move_right(buf - n, end, n, spaces); | |
593 | return buf + spaces; | |
594 | } | |
595 | while (spaces--) { | |
596 | if (buf < end) | |
597 | *buf = ' '; | |
598 | ++buf; | |
599 | } | |
600 | return buf; | |
601 | } | |
602 | ||
d529ac41 PM |
603 | /* Handle string from a well known address. */ |
604 | static char *string_nocheck(char *buf, char *end, const char *s, | |
605 | struct printf_spec spec) | |
95508cfa | 606 | { |
34fc8b90 | 607 | int len = 0; |
b314dd49 | 608 | int lim = spec.precision; |
95508cfa | 609 | |
34fc8b90 RV |
610 | while (lim--) { |
611 | char c = *s++; | |
612 | if (!c) | |
613 | break; | |
95508cfa | 614 | if (buf < end) |
34fc8b90 | 615 | *buf = c; |
95508cfa | 616 | ++buf; |
34fc8b90 | 617 | ++len; |
95508cfa | 618 | } |
34fc8b90 | 619 | return widen_string(buf, len, end, spec); |
95508cfa RV |
620 | } |
621 | ||
57f5677e RV |
622 | static char *err_ptr(char *buf, char *end, void *ptr, |
623 | struct printf_spec spec) | |
624 | { | |
625 | int err = PTR_ERR(ptr); | |
626 | const char *sym = errname(err); | |
627 | ||
628 | if (sym) | |
629 | return string_nocheck(buf, end, sym, spec); | |
630 | ||
631 | /* | |
632 | * Somebody passed ERR_PTR(-1234) or some other non-existing | |
633 | * Efoo - or perhaps CONFIG_SYMBOLIC_ERRNAME=n. Fall back to | |
634 | * printing it as its decimal representation. | |
635 | */ | |
636 | spec.flags |= SIGN; | |
637 | spec.base = 10; | |
638 | return number(buf, end, err, spec); | |
639 | } | |
640 | ||
c8c3b584 PM |
641 | /* Be careful: error messages must fit into the given buffer. */ |
642 | static char *error_string(char *buf, char *end, const char *s, | |
643 | struct printf_spec spec) | |
644 | { | |
645 | /* | |
646 | * Hard limit to avoid a completely insane messages. It actually | |
647 | * works pretty well because most error messages are in | |
648 | * the many pointer format modifiers. | |
649 | */ | |
650 | if (spec.precision == -1) | |
651 | spec.precision = 2 * sizeof(void *); | |
652 | ||
653 | return string_nocheck(buf, end, s, spec); | |
654 | } | |
655 | ||
3e5903eb | 656 | /* |
2ac5a3bf PM |
657 | * Do not call any complex external code here. Nested printk()/vsprintf() |
658 | * might cause infinite loops. Failures might break printk() and would | |
659 | * be hard to debug. | |
3e5903eb PM |
660 | */ |
661 | static const char *check_pointer_msg(const void *ptr) | |
662 | { | |
3e5903eb PM |
663 | if (!ptr) |
664 | return "(null)"; | |
665 | ||
2ac5a3bf | 666 | if ((unsigned long)ptr < PAGE_SIZE || IS_ERR_VALUE(ptr)) |
3e5903eb PM |
667 | return "(efault)"; |
668 | ||
669 | return NULL; | |
670 | } | |
671 | ||
672 | static int check_pointer(char **buf, char *end, const void *ptr, | |
673 | struct printf_spec spec) | |
674 | { | |
675 | const char *err_msg; | |
676 | ||
677 | err_msg = check_pointer_msg(ptr); | |
678 | if (err_msg) { | |
c8c3b584 | 679 | *buf = error_string(*buf, end, err_msg, spec); |
3e5903eb PM |
680 | return -EFAULT; |
681 | } | |
682 | ||
683 | return 0; | |
684 | } | |
685 | ||
9073dac1 | 686 | static noinline_for_stack |
d529ac41 PM |
687 | char *string(char *buf, char *end, const char *s, |
688 | struct printf_spec spec) | |
689 | { | |
3e5903eb PM |
690 | if (check_pointer(&buf, end, s, spec)) |
691 | return buf; | |
d529ac41 PM |
692 | |
693 | return string_nocheck(buf, end, s, spec); | |
694 | } | |
695 | ||
ce9d3ece Y |
696 | static char *pointer_string(char *buf, char *end, |
697 | const void *ptr, | |
698 | struct printf_spec spec) | |
9073dac1 GU |
699 | { |
700 | spec.base = 16; | |
701 | spec.flags |= SMALL; | |
702 | if (spec.field_width == -1) { | |
703 | spec.field_width = 2 * sizeof(ptr); | |
704 | spec.flags |= ZEROPAD; | |
705 | } | |
706 | ||
707 | return number(buf, end, (unsigned long int)ptr, spec); | |
708 | } | |
709 | ||
710 | /* Make pointers available for printing early in the boot sequence. */ | |
711 | static int debug_boot_weak_hash __ro_after_init; | |
712 | ||
713 | static int __init debug_boot_weak_hash_enable(char *str) | |
714 | { | |
715 | debug_boot_weak_hash = 1; | |
716 | pr_info("debug_boot_weak_hash enabled\n"); | |
717 | return 0; | |
718 | } | |
719 | early_param("debug_boot_weak_hash", debug_boot_weak_hash_enable); | |
720 | ||
721 | static DEFINE_STATIC_KEY_TRUE(not_filled_random_ptr_key); | |
722 | static siphash_key_t ptr_key __read_mostly; | |
723 | ||
724 | static void enable_ptr_key_workfn(struct work_struct *work) | |
725 | { | |
726 | get_random_bytes(&ptr_key, sizeof(ptr_key)); | |
727 | /* Needs to run from preemptible context */ | |
728 | static_branch_disable(¬_filled_random_ptr_key); | |
729 | } | |
730 | ||
731 | static DECLARE_WORK(enable_ptr_key_work, enable_ptr_key_workfn); | |
732 | ||
733 | static void fill_random_ptr_key(struct random_ready_callback *unused) | |
734 | { | |
735 | /* This may be in an interrupt handler. */ | |
736 | queue_work(system_unbound_wq, &enable_ptr_key_work); | |
737 | } | |
738 | ||
739 | static struct random_ready_callback random_ready = { | |
740 | .func = fill_random_ptr_key | |
741 | }; | |
742 | ||
743 | static int __init initialize_ptr_random(void) | |
744 | { | |
745 | int key_size = sizeof(ptr_key); | |
746 | int ret; | |
747 | ||
748 | /* Use hw RNG if available. */ | |
749 | if (get_random_bytes_arch(&ptr_key, key_size) == key_size) { | |
750 | static_branch_disable(¬_filled_random_ptr_key); | |
751 | return 0; | |
752 | } | |
753 | ||
754 | ret = add_random_ready_callback(&random_ready); | |
755 | if (!ret) { | |
756 | return 0; | |
757 | } else if (ret == -EALREADY) { | |
758 | /* This is in preemptible context */ | |
759 | enable_ptr_key_workfn(&enable_ptr_key_work); | |
760 | return 0; | |
761 | } | |
762 | ||
763 | return ret; | |
764 | } | |
765 | early_initcall(initialize_ptr_random); | |
766 | ||
767 | /* Maps a pointer to a 32 bit unique identifier. */ | |
e4dcad20 JFG |
768 | static inline int __ptr_to_hashval(const void *ptr, unsigned long *hashval_out) |
769 | { | |
770 | unsigned long hashval; | |
771 | ||
772 | if (static_branch_unlikely(¬_filled_random_ptr_key)) | |
773 | return -EAGAIN; | |
774 | ||
775 | #ifdef CONFIG_64BIT | |
776 | hashval = (unsigned long)siphash_1u64((u64)ptr, &ptr_key); | |
777 | /* | |
778 | * Mask off the first 32 bits, this makes explicit that we have | |
779 | * modified the address (and 32 bits is plenty for a unique ID). | |
780 | */ | |
781 | hashval = hashval & 0xffffffff; | |
782 | #else | |
783 | hashval = (unsigned long)siphash_1u32((u32)ptr, &ptr_key); | |
784 | #endif | |
785 | *hashval_out = hashval; | |
786 | return 0; | |
787 | } | |
788 | ||
789 | int ptr_to_hashval(const void *ptr, unsigned long *hashval_out) | |
790 | { | |
791 | return __ptr_to_hashval(ptr, hashval_out); | |
792 | } | |
793 | ||
9073dac1 GU |
794 | static char *ptr_to_id(char *buf, char *end, const void *ptr, |
795 | struct printf_spec spec) | |
796 | { | |
797 | const char *str = sizeof(ptr) == 8 ? "(____ptrval____)" : "(ptrval)"; | |
798 | unsigned long hashval; | |
e4dcad20 | 799 | int ret; |
9073dac1 | 800 | |
7bd57fbc ID |
801 | /* |
802 | * Print the real pointer value for NULL and error pointers, | |
803 | * as they are not actual addresses. | |
804 | */ | |
805 | if (IS_ERR_OR_NULL(ptr)) | |
806 | return pointer_string(buf, end, ptr, spec); | |
807 | ||
9073dac1 GU |
808 | /* When debugging early boot use non-cryptographically secure hash. */ |
809 | if (unlikely(debug_boot_weak_hash)) { | |
810 | hashval = hash_long((unsigned long)ptr, 32); | |
811 | return pointer_string(buf, end, (const void *)hashval, spec); | |
812 | } | |
813 | ||
e4dcad20 JFG |
814 | ret = __ptr_to_hashval(ptr, &hashval); |
815 | if (ret) { | |
9073dac1 GU |
816 | spec.field_width = 2 * sizeof(ptr); |
817 | /* string length must be less than default_width */ | |
c8c3b584 | 818 | return error_string(buf, end, str, spec); |
9073dac1 GU |
819 | } |
820 | ||
9073dac1 GU |
821 | return pointer_string(buf, end, (const void *)hashval, spec); |
822 | } | |
823 | ||
6eea242f PM |
824 | int kptr_restrict __read_mostly; |
825 | ||
826 | static noinline_for_stack | |
827 | char *restricted_pointer(char *buf, char *end, const void *ptr, | |
828 | struct printf_spec spec) | |
829 | { | |
830 | switch (kptr_restrict) { | |
831 | case 0: | |
1ac2f978 PM |
832 | /* Handle as %p, hash and do _not_ leak addresses. */ |
833 | return ptr_to_id(buf, end, ptr, spec); | |
6eea242f PM |
834 | case 1: { |
835 | const struct cred *cred; | |
836 | ||
837 | /* | |
838 | * kptr_restrict==1 cannot be used in IRQ context | |
839 | * because its test for CAP_SYSLOG would be meaningless. | |
840 | */ | |
841 | if (in_irq() || in_serving_softirq() || in_nmi()) { | |
842 | if (spec.field_width == -1) | |
843 | spec.field_width = 2 * sizeof(ptr); | |
c8c3b584 | 844 | return error_string(buf, end, "pK-error", spec); |
6eea242f PM |
845 | } |
846 | ||
847 | /* | |
848 | * Only print the real pointer value if the current | |
849 | * process has CAP_SYSLOG and is running with the | |
850 | * same credentials it started with. This is because | |
851 | * access to files is checked at open() time, but %pK | |
852 | * checks permission at read() time. We don't want to | |
853 | * leak pointer values if a binary opens a file using | |
854 | * %pK and then elevates privileges before reading it. | |
855 | */ | |
856 | cred = current_cred(); | |
857 | if (!has_capability_noaudit(current, CAP_SYSLOG) || | |
858 | !uid_eq(cred->euid, cred->uid) || | |
859 | !gid_eq(cred->egid, cred->gid)) | |
860 | ptr = NULL; | |
861 | break; | |
862 | } | |
863 | case 2: | |
864 | default: | |
865 | /* Always print 0's for %pK */ | |
866 | ptr = NULL; | |
867 | break; | |
868 | } | |
869 | ||
870 | return pointer_string(buf, end, ptr, spec); | |
871 | } | |
872 | ||
4b6ccca7 AV |
873 | static noinline_for_stack |
874 | char *dentry_name(char *buf, char *end, const struct dentry *d, struct printf_spec spec, | |
875 | const char *fmt) | |
876 | { | |
877 | const char *array[4], *s; | |
878 | const struct dentry *p; | |
879 | int depth; | |
880 | int i, n; | |
881 | ||
882 | switch (fmt[1]) { | |
883 | case '2': case '3': case '4': | |
884 | depth = fmt[1] - '0'; | |
885 | break; | |
886 | default: | |
887 | depth = 1; | |
888 | } | |
889 | ||
890 | rcu_read_lock(); | |
891 | for (i = 0; i < depth; i++, d = p) { | |
3e5903eb PM |
892 | if (check_pointer(&buf, end, d, spec)) { |
893 | rcu_read_unlock(); | |
894 | return buf; | |
895 | } | |
896 | ||
6aa7de05 MR |
897 | p = READ_ONCE(d->d_parent); |
898 | array[i] = READ_ONCE(d->d_name.name); | |
4b6ccca7 AV |
899 | if (p == d) { |
900 | if (i) | |
901 | array[i] = ""; | |
902 | i++; | |
903 | break; | |
904 | } | |
905 | } | |
906 | s = array[--i]; | |
907 | for (n = 0; n != spec.precision; n++, buf++) { | |
908 | char c = *s++; | |
909 | if (!c) { | |
910 | if (!i) | |
911 | break; | |
912 | c = '/'; | |
913 | s = array[--i]; | |
914 | } | |
915 | if (buf < end) | |
916 | *buf = c; | |
917 | } | |
918 | rcu_read_unlock(); | |
cfccde04 | 919 | return widen_string(buf, n, end, spec); |
4b6ccca7 AV |
920 | } |
921 | ||
36594b31 JH |
922 | static noinline_for_stack |
923 | char *file_dentry_name(char *buf, char *end, const struct file *f, | |
924 | struct printf_spec spec, const char *fmt) | |
925 | { | |
926 | if (check_pointer(&buf, end, f, spec)) | |
927 | return buf; | |
928 | ||
929 | return dentry_name(buf, end, f->f_path.dentry, spec, fmt); | |
930 | } | |
1031bc58 DM |
931 | #ifdef CONFIG_BLOCK |
932 | static noinline_for_stack | |
933 | char *bdev_name(char *buf, char *end, struct block_device *bdev, | |
934 | struct printf_spec spec, const char *fmt) | |
935 | { | |
3e5903eb PM |
936 | struct gendisk *hd; |
937 | ||
938 | if (check_pointer(&buf, end, bdev, spec)) | |
939 | return buf; | |
940 | ||
941 | hd = bdev->bd_disk; | |
1031bc58 | 942 | buf = string(buf, end, hd->disk_name, spec); |
700cd59d | 943 | if (bdev->bd_partno) { |
1031bc58 DM |
944 | if (isdigit(hd->disk_name[strlen(hd->disk_name)-1])) { |
945 | if (buf < end) | |
946 | *buf = 'p'; | |
947 | buf++; | |
948 | } | |
700cd59d | 949 | buf = number(buf, end, bdev->bd_partno, spec); |
1031bc58 DM |
950 | } |
951 | return buf; | |
952 | } | |
953 | #endif | |
954 | ||
cf3b429b JP |
955 | static noinline_for_stack |
956 | char *symbol_string(char *buf, char *end, void *ptr, | |
b0d33c2b | 957 | struct printf_spec spec, const char *fmt) |
0fe1ef24 | 958 | { |
b0d33c2b | 959 | unsigned long value; |
0fe1ef24 LT |
960 | #ifdef CONFIG_KALLSYMS |
961 | char sym[KSYM_SYMBOL_LEN]; | |
b0d33c2b JP |
962 | #endif |
963 | ||
964 | if (fmt[1] == 'R') | |
965 | ptr = __builtin_extract_return_addr(ptr); | |
966 | value = (unsigned long)ptr; | |
967 | ||
968 | #ifdef CONFIG_KALLSYMS | |
969 | if (*fmt == 'B') | |
0f77a8d3 | 970 | sprint_backtrace(sym, value); |
9af77064 | 971 | else if (*fmt != 's') |
0c8b946e FW |
972 | sprint_symbol(sym, value); |
973 | else | |
4796dd20 | 974 | sprint_symbol_no_offset(sym, value); |
7b9186f5 | 975 | |
d529ac41 | 976 | return string_nocheck(buf, end, sym, spec); |
0fe1ef24 | 977 | #else |
3cab1e71 | 978 | return special_hex_number(buf, end, value, sizeof(void *)); |
0fe1ef24 LT |
979 | #endif |
980 | } | |
981 | ||
abd4fe62 AS |
982 | static const struct printf_spec default_str_spec = { |
983 | .field_width = -1, | |
984 | .precision = -1, | |
985 | }; | |
986 | ||
54433973 AS |
987 | static const struct printf_spec default_flag_spec = { |
988 | .base = 16, | |
989 | .precision = -1, | |
990 | .flags = SPECIAL | SMALL, | |
991 | }; | |
992 | ||
ce0b4910 AS |
993 | static const struct printf_spec default_dec_spec = { |
994 | .base = 10, | |
995 | .precision = -1, | |
996 | }; | |
997 | ||
4d42c447 AS |
998 | static const struct printf_spec default_dec02_spec = { |
999 | .base = 10, | |
1000 | .field_width = 2, | |
1001 | .precision = -1, | |
1002 | .flags = ZEROPAD, | |
1003 | }; | |
1004 | ||
1005 | static const struct printf_spec default_dec04_spec = { | |
1006 | .base = 10, | |
1007 | .field_width = 4, | |
1008 | .precision = -1, | |
1009 | .flags = ZEROPAD, | |
1010 | }; | |
1011 | ||
cf3b429b JP |
1012 | static noinline_for_stack |
1013 | char *resource_string(char *buf, char *end, struct resource *res, | |
1014 | struct printf_spec spec, const char *fmt) | |
332d2e78 LT |
1015 | { |
1016 | #ifndef IO_RSRC_PRINTK_SIZE | |
28405372 | 1017 | #define IO_RSRC_PRINTK_SIZE 6 |
332d2e78 LT |
1018 | #endif |
1019 | ||
1020 | #ifndef MEM_RSRC_PRINTK_SIZE | |
28405372 | 1021 | #define MEM_RSRC_PRINTK_SIZE 10 |
332d2e78 | 1022 | #endif |
4da0b66c | 1023 | static const struct printf_spec io_spec = { |
fef20d9c | 1024 | .base = 16, |
4da0b66c | 1025 | .field_width = IO_RSRC_PRINTK_SIZE, |
fef20d9c FW |
1026 | .precision = -1, |
1027 | .flags = SPECIAL | SMALL | ZEROPAD, | |
1028 | }; | |
4da0b66c BH |
1029 | static const struct printf_spec mem_spec = { |
1030 | .base = 16, | |
1031 | .field_width = MEM_RSRC_PRINTK_SIZE, | |
1032 | .precision = -1, | |
1033 | .flags = SPECIAL | SMALL | ZEROPAD, | |
1034 | }; | |
0f4050c7 BH |
1035 | static const struct printf_spec bus_spec = { |
1036 | .base = 16, | |
1037 | .field_width = 2, | |
1038 | .precision = -1, | |
1039 | .flags = SMALL | ZEROPAD, | |
1040 | }; | |
4da0b66c | 1041 | static const struct printf_spec str_spec = { |
fd95541e BH |
1042 | .field_width = -1, |
1043 | .precision = 10, | |
1044 | .flags = LEFT, | |
1045 | }; | |
c7dabef8 BH |
1046 | |
1047 | /* 32-bit res (sizeof==4): 10 chars in dec, 10 in hex ("0x" + 8) | |
1048 | * 64-bit res (sizeof==8): 20 chars in dec, 18 in hex ("0x" + 16) */ | |
1049 | #define RSRC_BUF_SIZE ((2 * sizeof(resource_size_t)) + 4) | |
1050 | #define FLAG_BUF_SIZE (2 * sizeof(res->flags)) | |
9d7cca04 | 1051 | #define DECODED_BUF_SIZE sizeof("[mem - 64bit pref window disabled]") |
c7dabef8 BH |
1052 | #define RAW_BUF_SIZE sizeof("[mem - flags 0x]") |
1053 | char sym[max(2*RSRC_BUF_SIZE + DECODED_BUF_SIZE, | |
1054 | 2*RSRC_BUF_SIZE + FLAG_BUF_SIZE + RAW_BUF_SIZE)]; | |
1055 | ||
332d2e78 | 1056 | char *p = sym, *pend = sym + sizeof(sym); |
c7dabef8 | 1057 | int decode = (fmt[0] == 'R') ? 1 : 0; |
4da0b66c | 1058 | const struct printf_spec *specp; |
332d2e78 | 1059 | |
3e5903eb PM |
1060 | if (check_pointer(&buf, end, res, spec)) |
1061 | return buf; | |
1062 | ||
332d2e78 | 1063 | *p++ = '['; |
4da0b66c | 1064 | if (res->flags & IORESOURCE_IO) { |
d529ac41 | 1065 | p = string_nocheck(p, pend, "io ", str_spec); |
4da0b66c BH |
1066 | specp = &io_spec; |
1067 | } else if (res->flags & IORESOURCE_MEM) { | |
d529ac41 | 1068 | p = string_nocheck(p, pend, "mem ", str_spec); |
4da0b66c BH |
1069 | specp = &mem_spec; |
1070 | } else if (res->flags & IORESOURCE_IRQ) { | |
d529ac41 | 1071 | p = string_nocheck(p, pend, "irq ", str_spec); |
ce0b4910 | 1072 | specp = &default_dec_spec; |
4da0b66c | 1073 | } else if (res->flags & IORESOURCE_DMA) { |
d529ac41 | 1074 | p = string_nocheck(p, pend, "dma ", str_spec); |
ce0b4910 | 1075 | specp = &default_dec_spec; |
0f4050c7 | 1076 | } else if (res->flags & IORESOURCE_BUS) { |
d529ac41 | 1077 | p = string_nocheck(p, pend, "bus ", str_spec); |
0f4050c7 | 1078 | specp = &bus_spec; |
4da0b66c | 1079 | } else { |
d529ac41 | 1080 | p = string_nocheck(p, pend, "??? ", str_spec); |
4da0b66c | 1081 | specp = &mem_spec; |
c7dabef8 | 1082 | decode = 0; |
fd95541e | 1083 | } |
d19cb803 | 1084 | if (decode && res->flags & IORESOURCE_UNSET) { |
d529ac41 | 1085 | p = string_nocheck(p, pend, "size ", str_spec); |
d19cb803 BH |
1086 | p = number(p, pend, resource_size(res), *specp); |
1087 | } else { | |
1088 | p = number(p, pend, res->start, *specp); | |
1089 | if (res->start != res->end) { | |
1090 | *p++ = '-'; | |
1091 | p = number(p, pend, res->end, *specp); | |
1092 | } | |
c91d3376 | 1093 | } |
c7dabef8 | 1094 | if (decode) { |
fd95541e | 1095 | if (res->flags & IORESOURCE_MEM_64) |
d529ac41 | 1096 | p = string_nocheck(p, pend, " 64bit", str_spec); |
fd95541e | 1097 | if (res->flags & IORESOURCE_PREFETCH) |
d529ac41 | 1098 | p = string_nocheck(p, pend, " pref", str_spec); |
9d7cca04 | 1099 | if (res->flags & IORESOURCE_WINDOW) |
d529ac41 | 1100 | p = string_nocheck(p, pend, " window", str_spec); |
fd95541e | 1101 | if (res->flags & IORESOURCE_DISABLED) |
d529ac41 | 1102 | p = string_nocheck(p, pend, " disabled", str_spec); |
c7dabef8 | 1103 | } else { |
d529ac41 | 1104 | p = string_nocheck(p, pend, " flags ", str_spec); |
54433973 | 1105 | p = number(p, pend, res->flags, default_flag_spec); |
fd95541e | 1106 | } |
332d2e78 | 1107 | *p++ = ']'; |
c7dabef8 | 1108 | *p = '\0'; |
332d2e78 | 1109 | |
d529ac41 | 1110 | return string_nocheck(buf, end, sym, spec); |
332d2e78 LT |
1111 | } |
1112 | ||
31550a16 AS |
1113 | static noinline_for_stack |
1114 | char *hex_string(char *buf, char *end, u8 *addr, struct printf_spec spec, | |
1115 | const char *fmt) | |
1116 | { | |
360603a1 | 1117 | int i, len = 1; /* if we pass '%ph[CDN]', field width remains |
31550a16 AS |
1118 | negative value, fallback to the default */ |
1119 | char separator; | |
1120 | ||
1121 | if (spec.field_width == 0) | |
1122 | /* nothing to print */ | |
1123 | return buf; | |
1124 | ||
3e5903eb PM |
1125 | if (check_pointer(&buf, end, addr, spec)) |
1126 | return buf; | |
31550a16 AS |
1127 | |
1128 | switch (fmt[1]) { | |
1129 | case 'C': | |
1130 | separator = ':'; | |
1131 | break; | |
1132 | case 'D': | |
1133 | separator = '-'; | |
1134 | break; | |
1135 | case 'N': | |
1136 | separator = 0; | |
1137 | break; | |
1138 | default: | |
1139 | separator = ' '; | |
1140 | break; | |
1141 | } | |
1142 | ||
1143 | if (spec.field_width > 0) | |
1144 | len = min_t(int, spec.field_width, 64); | |
1145 | ||
9c98f235 RV |
1146 | for (i = 0; i < len; ++i) { |
1147 | if (buf < end) | |
1148 | *buf = hex_asc_hi(addr[i]); | |
1149 | ++buf; | |
1150 | if (buf < end) | |
1151 | *buf = hex_asc_lo(addr[i]); | |
1152 | ++buf; | |
31550a16 | 1153 | |
9c98f235 RV |
1154 | if (separator && i != len - 1) { |
1155 | if (buf < end) | |
1156 | *buf = separator; | |
1157 | ++buf; | |
1158 | } | |
31550a16 AS |
1159 | } |
1160 | ||
1161 | return buf; | |
1162 | } | |
1163 | ||
dbc760bc TH |
1164 | static noinline_for_stack |
1165 | char *bitmap_string(char *buf, char *end, unsigned long *bitmap, | |
1166 | struct printf_spec spec, const char *fmt) | |
1167 | { | |
1168 | const int CHUNKSZ = 32; | |
1169 | int nr_bits = max_t(int, spec.field_width, 0); | |
1170 | int i, chunksz; | |
1171 | bool first = true; | |
1172 | ||
3e5903eb PM |
1173 | if (check_pointer(&buf, end, bitmap, spec)) |
1174 | return buf; | |
1175 | ||
dbc760bc TH |
1176 | /* reused to print numbers */ |
1177 | spec = (struct printf_spec){ .flags = SMALL | ZEROPAD, .base = 16 }; | |
1178 | ||
1179 | chunksz = nr_bits & (CHUNKSZ - 1); | |
1180 | if (chunksz == 0) | |
1181 | chunksz = CHUNKSZ; | |
1182 | ||
1183 | i = ALIGN(nr_bits, CHUNKSZ) - CHUNKSZ; | |
1184 | for (; i >= 0; i -= CHUNKSZ) { | |
1185 | u32 chunkmask, val; | |
1186 | int word, bit; | |
1187 | ||
1188 | chunkmask = ((1ULL << chunksz) - 1); | |
1189 | word = i / BITS_PER_LONG; | |
1190 | bit = i % BITS_PER_LONG; | |
1191 | val = (bitmap[word] >> bit) & chunkmask; | |
1192 | ||
1193 | if (!first) { | |
1194 | if (buf < end) | |
1195 | *buf = ','; | |
1196 | buf++; | |
1197 | } | |
1198 | first = false; | |
1199 | ||
1200 | spec.field_width = DIV_ROUND_UP(chunksz, 4); | |
1201 | buf = number(buf, end, val, spec); | |
1202 | ||
1203 | chunksz = CHUNKSZ; | |
1204 | } | |
1205 | return buf; | |
1206 | } | |
1207 | ||
1208 | static noinline_for_stack | |
1209 | char *bitmap_list_string(char *buf, char *end, unsigned long *bitmap, | |
1210 | struct printf_spec spec, const char *fmt) | |
1211 | { | |
1212 | int nr_bits = max_t(int, spec.field_width, 0); | |
1213 | /* current bit is 'cur', most recently seen range is [rbot, rtop] */ | |
1214 | int cur, rbot, rtop; | |
1215 | bool first = true; | |
1216 | ||
3e5903eb PM |
1217 | if (check_pointer(&buf, end, bitmap, spec)) |
1218 | return buf; | |
1219 | ||
dbc760bc TH |
1220 | rbot = cur = find_first_bit(bitmap, nr_bits); |
1221 | while (cur < nr_bits) { | |
1222 | rtop = cur; | |
1223 | cur = find_next_bit(bitmap, nr_bits, cur + 1); | |
1224 | if (cur < nr_bits && cur <= rtop + 1) | |
1225 | continue; | |
1226 | ||
1227 | if (!first) { | |
1228 | if (buf < end) | |
1229 | *buf = ','; | |
1230 | buf++; | |
1231 | } | |
1232 | first = false; | |
1233 | ||
ce0b4910 | 1234 | buf = number(buf, end, rbot, default_dec_spec); |
dbc760bc TH |
1235 | if (rbot < rtop) { |
1236 | if (buf < end) | |
1237 | *buf = '-'; | |
1238 | buf++; | |
1239 | ||
ce0b4910 | 1240 | buf = number(buf, end, rtop, default_dec_spec); |
dbc760bc TH |
1241 | } |
1242 | ||
1243 | rbot = cur; | |
1244 | } | |
1245 | return buf; | |
1246 | } | |
1247 | ||
cf3b429b JP |
1248 | static noinline_for_stack |
1249 | char *mac_address_string(char *buf, char *end, u8 *addr, | |
1250 | struct printf_spec spec, const char *fmt) | |
dd45c9cf | 1251 | { |
8a27f7c9 | 1252 | char mac_addr[sizeof("xx:xx:xx:xx:xx:xx")]; |
dd45c9cf HH |
1253 | char *p = mac_addr; |
1254 | int i; | |
bc7259a2 | 1255 | char separator; |
76597ff9 | 1256 | bool reversed = false; |
bc7259a2 | 1257 | |
3e5903eb PM |
1258 | if (check_pointer(&buf, end, addr, spec)) |
1259 | return buf; | |
1260 | ||
76597ff9 AE |
1261 | switch (fmt[1]) { |
1262 | case 'F': | |
bc7259a2 | 1263 | separator = '-'; |
76597ff9 AE |
1264 | break; |
1265 | ||
1266 | case 'R': | |
1267 | reversed = true; | |
4c1ca831 | 1268 | fallthrough; |
76597ff9 AE |
1269 | |
1270 | default: | |
bc7259a2 | 1271 | separator = ':'; |
76597ff9 | 1272 | break; |
bc7259a2 | 1273 | } |
dd45c9cf HH |
1274 | |
1275 | for (i = 0; i < 6; i++) { | |
76597ff9 AE |
1276 | if (reversed) |
1277 | p = hex_byte_pack(p, addr[5 - i]); | |
1278 | else | |
1279 | p = hex_byte_pack(p, addr[i]); | |
1280 | ||
8a27f7c9 | 1281 | if (fmt[0] == 'M' && i != 5) |
bc7259a2 | 1282 | *p++ = separator; |
dd45c9cf HH |
1283 | } |
1284 | *p = '\0'; | |
1285 | ||
d529ac41 | 1286 | return string_nocheck(buf, end, mac_addr, spec); |
dd45c9cf HH |
1287 | } |
1288 | ||
cf3b429b JP |
1289 | static noinline_for_stack |
1290 | char *ip4_string(char *p, const u8 *addr, const char *fmt) | |
8a27f7c9 JP |
1291 | { |
1292 | int i; | |
0159f24e JP |
1293 | bool leading_zeros = (fmt[0] == 'i'); |
1294 | int index; | |
1295 | int step; | |
1296 | ||
1297 | switch (fmt[2]) { | |
1298 | case 'h': | |
1299 | #ifdef __BIG_ENDIAN | |
1300 | index = 0; | |
1301 | step = 1; | |
1302 | #else | |
1303 | index = 3; | |
1304 | step = -1; | |
1305 | #endif | |
1306 | break; | |
1307 | case 'l': | |
1308 | index = 3; | |
1309 | step = -1; | |
1310 | break; | |
1311 | case 'n': | |
1312 | case 'b': | |
1313 | default: | |
1314 | index = 0; | |
1315 | step = 1; | |
1316 | break; | |
1317 | } | |
8a27f7c9 | 1318 | for (i = 0; i < 4; i++) { |
7c43d9a3 | 1319 | char temp[4] __aligned(2); /* hold each IP quad in reverse order */ |
133fd9f5 | 1320 | int digits = put_dec_trunc8(temp, addr[index]) - temp; |
8a27f7c9 JP |
1321 | if (leading_zeros) { |
1322 | if (digits < 3) | |
1323 | *p++ = '0'; | |
1324 | if (digits < 2) | |
1325 | *p++ = '0'; | |
1326 | } | |
1327 | /* reverse the digits in the quad */ | |
1328 | while (digits--) | |
1329 | *p++ = temp[digits]; | |
1330 | if (i < 3) | |
1331 | *p++ = '.'; | |
0159f24e | 1332 | index += step; |
8a27f7c9 | 1333 | } |
8a27f7c9 | 1334 | *p = '\0'; |
7b9186f5 | 1335 | |
8a27f7c9 JP |
1336 | return p; |
1337 | } | |
1338 | ||
cf3b429b JP |
1339 | static noinline_for_stack |
1340 | char *ip6_compressed_string(char *p, const char *addr) | |
689afa7d | 1341 | { |
7b9186f5 | 1342 | int i, j, range; |
8a27f7c9 JP |
1343 | unsigned char zerolength[8]; |
1344 | int longest = 1; | |
1345 | int colonpos = -1; | |
1346 | u16 word; | |
7b9186f5 | 1347 | u8 hi, lo; |
8a27f7c9 | 1348 | bool needcolon = false; |
eb78cd26 JP |
1349 | bool useIPv4; |
1350 | struct in6_addr in6; | |
1351 | ||
1352 | memcpy(&in6, addr, sizeof(struct in6_addr)); | |
1353 | ||
1354 | useIPv4 = ipv6_addr_v4mapped(&in6) || ipv6_addr_is_isatap(&in6); | |
8a27f7c9 JP |
1355 | |
1356 | memset(zerolength, 0, sizeof(zerolength)); | |
1357 | ||
1358 | if (useIPv4) | |
1359 | range = 6; | |
1360 | else | |
1361 | range = 8; | |
1362 | ||
1363 | /* find position of longest 0 run */ | |
1364 | for (i = 0; i < range; i++) { | |
1365 | for (j = i; j < range; j++) { | |
eb78cd26 | 1366 | if (in6.s6_addr16[j] != 0) |
8a27f7c9 JP |
1367 | break; |
1368 | zerolength[i]++; | |
1369 | } | |
1370 | } | |
1371 | for (i = 0; i < range; i++) { | |
1372 | if (zerolength[i] > longest) { | |
1373 | longest = zerolength[i]; | |
1374 | colonpos = i; | |
1375 | } | |
1376 | } | |
29cf519e JP |
1377 | if (longest == 1) /* don't compress a single 0 */ |
1378 | colonpos = -1; | |
689afa7d | 1379 | |
8a27f7c9 JP |
1380 | /* emit address */ |
1381 | for (i = 0; i < range; i++) { | |
1382 | if (i == colonpos) { | |
1383 | if (needcolon || i == 0) | |
1384 | *p++ = ':'; | |
1385 | *p++ = ':'; | |
1386 | needcolon = false; | |
1387 | i += longest - 1; | |
1388 | continue; | |
1389 | } | |
1390 | if (needcolon) { | |
1391 | *p++ = ':'; | |
1392 | needcolon = false; | |
1393 | } | |
1394 | /* hex u16 without leading 0s */ | |
eb78cd26 | 1395 | word = ntohs(in6.s6_addr16[i]); |
8a27f7c9 JP |
1396 | hi = word >> 8; |
1397 | lo = word & 0xff; | |
1398 | if (hi) { | |
1399 | if (hi > 0x0f) | |
55036ba7 | 1400 | p = hex_byte_pack(p, hi); |
8a27f7c9 JP |
1401 | else |
1402 | *p++ = hex_asc_lo(hi); | |
55036ba7 | 1403 | p = hex_byte_pack(p, lo); |
8a27f7c9 | 1404 | } |
b5ff992b | 1405 | else if (lo > 0x0f) |
55036ba7 | 1406 | p = hex_byte_pack(p, lo); |
8a27f7c9 JP |
1407 | else |
1408 | *p++ = hex_asc_lo(lo); | |
1409 | needcolon = true; | |
1410 | } | |
1411 | ||
1412 | if (useIPv4) { | |
1413 | if (needcolon) | |
1414 | *p++ = ':'; | |
0159f24e | 1415 | p = ip4_string(p, &in6.s6_addr[12], "I4"); |
8a27f7c9 | 1416 | } |
8a27f7c9 | 1417 | *p = '\0'; |
7b9186f5 | 1418 | |
8a27f7c9 JP |
1419 | return p; |
1420 | } | |
1421 | ||
cf3b429b JP |
1422 | static noinline_for_stack |
1423 | char *ip6_string(char *p, const char *addr, const char *fmt) | |
8a27f7c9 JP |
1424 | { |
1425 | int i; | |
7b9186f5 | 1426 | |
689afa7d | 1427 | for (i = 0; i < 8; i++) { |
55036ba7 AS |
1428 | p = hex_byte_pack(p, *addr++); |
1429 | p = hex_byte_pack(p, *addr++); | |
8a27f7c9 | 1430 | if (fmt[0] == 'I' && i != 7) |
689afa7d HH |
1431 | *p++ = ':'; |
1432 | } | |
1433 | *p = '\0'; | |
7b9186f5 | 1434 | |
8a27f7c9 JP |
1435 | return p; |
1436 | } | |
1437 | ||
cf3b429b JP |
1438 | static noinline_for_stack |
1439 | char *ip6_addr_string(char *buf, char *end, const u8 *addr, | |
1440 | struct printf_spec spec, const char *fmt) | |
8a27f7c9 JP |
1441 | { |
1442 | char ip6_addr[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255")]; | |
1443 | ||
1444 | if (fmt[0] == 'I' && fmt[2] == 'c') | |
eb78cd26 | 1445 | ip6_compressed_string(ip6_addr, addr); |
8a27f7c9 | 1446 | else |
eb78cd26 | 1447 | ip6_string(ip6_addr, addr, fmt); |
689afa7d | 1448 | |
d529ac41 | 1449 | return string_nocheck(buf, end, ip6_addr, spec); |
689afa7d HH |
1450 | } |
1451 | ||
cf3b429b JP |
1452 | static noinline_for_stack |
1453 | char *ip4_addr_string(char *buf, char *end, const u8 *addr, | |
1454 | struct printf_spec spec, const char *fmt) | |
4aa99606 | 1455 | { |
8a27f7c9 | 1456 | char ip4_addr[sizeof("255.255.255.255")]; |
4aa99606 | 1457 | |
0159f24e | 1458 | ip4_string(ip4_addr, addr, fmt); |
4aa99606 | 1459 | |
d529ac41 | 1460 | return string_nocheck(buf, end, ip4_addr, spec); |
4aa99606 HH |
1461 | } |
1462 | ||
10679643 DB |
1463 | static noinline_for_stack |
1464 | char *ip6_addr_string_sa(char *buf, char *end, const struct sockaddr_in6 *sa, | |
1465 | struct printf_spec spec, const char *fmt) | |
1466 | { | |
1467 | bool have_p = false, have_s = false, have_f = false, have_c = false; | |
1468 | char ip6_addr[sizeof("[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:255.255.255.255]") + | |
1469 | sizeof(":12345") + sizeof("/123456789") + | |
1470 | sizeof("%1234567890")]; | |
1471 | char *p = ip6_addr, *pend = ip6_addr + sizeof(ip6_addr); | |
1472 | const u8 *addr = (const u8 *) &sa->sin6_addr; | |
1473 | char fmt6[2] = { fmt[0], '6' }; | |
1474 | u8 off = 0; | |
1475 | ||
1476 | fmt++; | |
1477 | while (isalpha(*++fmt)) { | |
1478 | switch (*fmt) { | |
1479 | case 'p': | |
1480 | have_p = true; | |
1481 | break; | |
1482 | case 'f': | |
1483 | have_f = true; | |
1484 | break; | |
1485 | case 's': | |
1486 | have_s = true; | |
1487 | break; | |
1488 | case 'c': | |
1489 | have_c = true; | |
1490 | break; | |
1491 | } | |
1492 | } | |
1493 | ||
1494 | if (have_p || have_s || have_f) { | |
1495 | *p = '['; | |
1496 | off = 1; | |
1497 | } | |
1498 | ||
1499 | if (fmt6[0] == 'I' && have_c) | |
1500 | p = ip6_compressed_string(ip6_addr + off, addr); | |
1501 | else | |
1502 | p = ip6_string(ip6_addr + off, addr, fmt6); | |
1503 | ||
1504 | if (have_p || have_s || have_f) | |
1505 | *p++ = ']'; | |
1506 | ||
1507 | if (have_p) { | |
1508 | *p++ = ':'; | |
1509 | p = number(p, pend, ntohs(sa->sin6_port), spec); | |
1510 | } | |
1511 | if (have_f) { | |
1512 | *p++ = '/'; | |
1513 | p = number(p, pend, ntohl(sa->sin6_flowinfo & | |
1514 | IPV6_FLOWINFO_MASK), spec); | |
1515 | } | |
1516 | if (have_s) { | |
1517 | *p++ = '%'; | |
1518 | p = number(p, pend, sa->sin6_scope_id, spec); | |
1519 | } | |
1520 | *p = '\0'; | |
1521 | ||
d529ac41 | 1522 | return string_nocheck(buf, end, ip6_addr, spec); |
10679643 DB |
1523 | } |
1524 | ||
1525 | static noinline_for_stack | |
1526 | char *ip4_addr_string_sa(char *buf, char *end, const struct sockaddr_in *sa, | |
1527 | struct printf_spec spec, const char *fmt) | |
1528 | { | |
1529 | bool have_p = false; | |
1530 | char *p, ip4_addr[sizeof("255.255.255.255") + sizeof(":12345")]; | |
1531 | char *pend = ip4_addr + sizeof(ip4_addr); | |
1532 | const u8 *addr = (const u8 *) &sa->sin_addr.s_addr; | |
1533 | char fmt4[3] = { fmt[0], '4', 0 }; | |
1534 | ||
1535 | fmt++; | |
1536 | while (isalpha(*++fmt)) { | |
1537 | switch (*fmt) { | |
1538 | case 'p': | |
1539 | have_p = true; | |
1540 | break; | |
1541 | case 'h': | |
1542 | case 'l': | |
1543 | case 'n': | |
1544 | case 'b': | |
1545 | fmt4[2] = *fmt; | |
1546 | break; | |
1547 | } | |
1548 | } | |
1549 | ||
1550 | p = ip4_string(ip4_addr, addr, fmt4); | |
1551 | if (have_p) { | |
1552 | *p++ = ':'; | |
1553 | p = number(p, pend, ntohs(sa->sin_port), spec); | |
1554 | } | |
1555 | *p = '\0'; | |
1556 | ||
d529ac41 | 1557 | return string_nocheck(buf, end, ip4_addr, spec); |
10679643 DB |
1558 | } |
1559 | ||
f00cc102 PM |
1560 | static noinline_for_stack |
1561 | char *ip_addr_string(char *buf, char *end, const void *ptr, | |
1562 | struct printf_spec spec, const char *fmt) | |
1563 | { | |
0b74d4d7 PM |
1564 | char *err_fmt_msg; |
1565 | ||
3e5903eb PM |
1566 | if (check_pointer(&buf, end, ptr, spec)) |
1567 | return buf; | |
1568 | ||
f00cc102 PM |
1569 | switch (fmt[1]) { |
1570 | case '6': | |
1571 | return ip6_addr_string(buf, end, ptr, spec, fmt); | |
1572 | case '4': | |
1573 | return ip4_addr_string(buf, end, ptr, spec, fmt); | |
1574 | case 'S': { | |
1575 | const union { | |
1576 | struct sockaddr raw; | |
1577 | struct sockaddr_in v4; | |
1578 | struct sockaddr_in6 v6; | |
1579 | } *sa = ptr; | |
1580 | ||
1581 | switch (sa->raw.sa_family) { | |
1582 | case AF_INET: | |
1583 | return ip4_addr_string_sa(buf, end, &sa->v4, spec, fmt); | |
1584 | case AF_INET6: | |
1585 | return ip6_addr_string_sa(buf, end, &sa->v6, spec, fmt); | |
1586 | default: | |
c8c3b584 | 1587 | return error_string(buf, end, "(einval)", spec); |
f00cc102 PM |
1588 | }} |
1589 | } | |
1590 | ||
0b74d4d7 | 1591 | err_fmt_msg = fmt[0] == 'i' ? "(%pi?)" : "(%pI?)"; |
c8c3b584 | 1592 | return error_string(buf, end, err_fmt_msg, spec); |
f00cc102 PM |
1593 | } |
1594 | ||
71dca95d AS |
1595 | static noinline_for_stack |
1596 | char *escaped_string(char *buf, char *end, u8 *addr, struct printf_spec spec, | |
1597 | const char *fmt) | |
1598 | { | |
1599 | bool found = true; | |
1600 | int count = 1; | |
1601 | unsigned int flags = 0; | |
1602 | int len; | |
1603 | ||
1604 | if (spec.field_width == 0) | |
1605 | return buf; /* nothing to print */ | |
1606 | ||
3e5903eb PM |
1607 | if (check_pointer(&buf, end, addr, spec)) |
1608 | return buf; | |
71dca95d AS |
1609 | |
1610 | do { | |
1611 | switch (fmt[count++]) { | |
1612 | case 'a': | |
1613 | flags |= ESCAPE_ANY; | |
1614 | break; | |
1615 | case 'c': | |
1616 | flags |= ESCAPE_SPECIAL; | |
1617 | break; | |
1618 | case 'h': | |
1619 | flags |= ESCAPE_HEX; | |
1620 | break; | |
1621 | case 'n': | |
1622 | flags |= ESCAPE_NULL; | |
1623 | break; | |
1624 | case 'o': | |
1625 | flags |= ESCAPE_OCTAL; | |
1626 | break; | |
1627 | case 'p': | |
1628 | flags |= ESCAPE_NP; | |
1629 | break; | |
1630 | case 's': | |
1631 | flags |= ESCAPE_SPACE; | |
1632 | break; | |
1633 | default: | |
1634 | found = false; | |
1635 | break; | |
1636 | } | |
1637 | } while (found); | |
1638 | ||
1639 | if (!flags) | |
1640 | flags = ESCAPE_ANY_NP; | |
1641 | ||
1642 | len = spec.field_width < 0 ? 1 : spec.field_width; | |
1643 | ||
41416f23 RV |
1644 | /* |
1645 | * string_escape_mem() writes as many characters as it can to | |
1646 | * the given buffer, and returns the total size of the output | |
1647 | * had the buffer been big enough. | |
1648 | */ | |
1649 | buf += string_escape_mem(addr, len, buf, buf < end ? end - buf : 0, flags, NULL); | |
71dca95d AS |
1650 | |
1651 | return buf; | |
1652 | } | |
1653 | ||
3e5903eb PM |
1654 | static char *va_format(char *buf, char *end, struct va_format *va_fmt, |
1655 | struct printf_spec spec, const char *fmt) | |
45c3e93d PM |
1656 | { |
1657 | va_list va; | |
1658 | ||
3e5903eb PM |
1659 | if (check_pointer(&buf, end, va_fmt, spec)) |
1660 | return buf; | |
1661 | ||
45c3e93d PM |
1662 | va_copy(va, *va_fmt->va); |
1663 | buf += vsnprintf(buf, end > buf ? end - buf : 0, va_fmt->fmt, va); | |
1664 | va_end(va); | |
1665 | ||
1666 | return buf; | |
1667 | } | |
1668 | ||
cf3b429b JP |
1669 | static noinline_for_stack |
1670 | char *uuid_string(char *buf, char *end, const u8 *addr, | |
1671 | struct printf_spec spec, const char *fmt) | |
9ac6e44e | 1672 | { |
2b1b0d66 | 1673 | char uuid[UUID_STRING_LEN + 1]; |
9ac6e44e JP |
1674 | char *p = uuid; |
1675 | int i; | |
f9727a17 | 1676 | const u8 *index = uuid_index; |
9ac6e44e JP |
1677 | bool uc = false; |
1678 | ||
3e5903eb PM |
1679 | if (check_pointer(&buf, end, addr, spec)) |
1680 | return buf; | |
1681 | ||
9ac6e44e JP |
1682 | switch (*(++fmt)) { |
1683 | case 'L': | |
df561f66 | 1684 | uc = true; |
4c1ca831 | 1685 | fallthrough; |
9ac6e44e | 1686 | case 'l': |
f9727a17 | 1687 | index = guid_index; |
9ac6e44e JP |
1688 | break; |
1689 | case 'B': | |
1690 | uc = true; | |
1691 | break; | |
1692 | } | |
1693 | ||
1694 | for (i = 0; i < 16; i++) { | |
aa4ea1c3 AS |
1695 | if (uc) |
1696 | p = hex_byte_pack_upper(p, addr[index[i]]); | |
1697 | else | |
1698 | p = hex_byte_pack(p, addr[index[i]]); | |
9ac6e44e JP |
1699 | switch (i) { |
1700 | case 3: | |
1701 | case 5: | |
1702 | case 7: | |
1703 | case 9: | |
1704 | *p++ = '-'; | |
1705 | break; | |
1706 | } | |
1707 | } | |
1708 | ||
1709 | *p = 0; | |
1710 | ||
d529ac41 | 1711 | return string_nocheck(buf, end, uuid, spec); |
9ac6e44e JP |
1712 | } |
1713 | ||
5b17aecf | 1714 | static noinline_for_stack |
431bca24 GU |
1715 | char *netdev_bits(char *buf, char *end, const void *addr, |
1716 | struct printf_spec spec, const char *fmt) | |
c8f44aff | 1717 | { |
5b17aecf AS |
1718 | unsigned long long num; |
1719 | int size; | |
1720 | ||
3e5903eb PM |
1721 | if (check_pointer(&buf, end, addr, spec)) |
1722 | return buf; | |
1723 | ||
5b17aecf AS |
1724 | switch (fmt[1]) { |
1725 | case 'F': | |
1726 | num = *(const netdev_features_t *)addr; | |
1727 | size = sizeof(netdev_features_t); | |
1728 | break; | |
1729 | default: | |
c8c3b584 | 1730 | return error_string(buf, end, "(%pN?)", spec); |
5b17aecf | 1731 | } |
c8f44aff | 1732 | |
3cab1e71 | 1733 | return special_hex_number(buf, end, num, size); |
c8f44aff MM |
1734 | } |
1735 | ||
aaf07621 | 1736 | static noinline_for_stack |
3e5903eb PM |
1737 | char *address_val(char *buf, char *end, const void *addr, |
1738 | struct printf_spec spec, const char *fmt) | |
aaf07621 JP |
1739 | { |
1740 | unsigned long long num; | |
3cab1e71 | 1741 | int size; |
aaf07621 | 1742 | |
3e5903eb PM |
1743 | if (check_pointer(&buf, end, addr, spec)) |
1744 | return buf; | |
1745 | ||
aaf07621 JP |
1746 | switch (fmt[1]) { |
1747 | case 'd': | |
1748 | num = *(const dma_addr_t *)addr; | |
3cab1e71 | 1749 | size = sizeof(dma_addr_t); |
aaf07621 JP |
1750 | break; |
1751 | case 'p': | |
1752 | default: | |
1753 | num = *(const phys_addr_t *)addr; | |
3cab1e71 | 1754 | size = sizeof(phys_addr_t); |
aaf07621 JP |
1755 | break; |
1756 | } | |
1757 | ||
3cab1e71 | 1758 | return special_hex_number(buf, end, num, size); |
aaf07621 JP |
1759 | } |
1760 | ||
4d42c447 AS |
1761 | static noinline_for_stack |
1762 | char *date_str(char *buf, char *end, const struct rtc_time *tm, bool r) | |
1763 | { | |
1764 | int year = tm->tm_year + (r ? 0 : 1900); | |
1765 | int mon = tm->tm_mon + (r ? 0 : 1); | |
1766 | ||
1767 | buf = number(buf, end, year, default_dec04_spec); | |
1768 | if (buf < end) | |
1769 | *buf = '-'; | |
1770 | buf++; | |
1771 | ||
1772 | buf = number(buf, end, mon, default_dec02_spec); | |
1773 | if (buf < end) | |
1774 | *buf = '-'; | |
1775 | buf++; | |
1776 | ||
1777 | return number(buf, end, tm->tm_mday, default_dec02_spec); | |
1778 | } | |
1779 | ||
1780 | static noinline_for_stack | |
1781 | char *time_str(char *buf, char *end, const struct rtc_time *tm, bool r) | |
1782 | { | |
1783 | buf = number(buf, end, tm->tm_hour, default_dec02_spec); | |
1784 | if (buf < end) | |
1785 | *buf = ':'; | |
1786 | buf++; | |
1787 | ||
1788 | buf = number(buf, end, tm->tm_min, default_dec02_spec); | |
1789 | if (buf < end) | |
1790 | *buf = ':'; | |
1791 | buf++; | |
1792 | ||
1793 | return number(buf, end, tm->tm_sec, default_dec02_spec); | |
1794 | } | |
1795 | ||
1796 | static noinline_for_stack | |
3e5903eb PM |
1797 | char *rtc_str(char *buf, char *end, const struct rtc_time *tm, |
1798 | struct printf_spec spec, const char *fmt) | |
4d42c447 AS |
1799 | { |
1800 | bool have_t = true, have_d = true; | |
1801 | bool raw = false; | |
1802 | int count = 2; | |
1803 | ||
3e5903eb PM |
1804 | if (check_pointer(&buf, end, tm, spec)) |
1805 | return buf; | |
1806 | ||
4d42c447 AS |
1807 | switch (fmt[count]) { |
1808 | case 'd': | |
1809 | have_t = false; | |
1810 | count++; | |
1811 | break; | |
1812 | case 't': | |
1813 | have_d = false; | |
1814 | count++; | |
1815 | break; | |
1816 | } | |
1817 | ||
1818 | raw = fmt[count] == 'r'; | |
1819 | ||
1820 | if (have_d) | |
1821 | buf = date_str(buf, end, tm, raw); | |
1822 | if (have_d && have_t) { | |
1823 | /* Respect ISO 8601 */ | |
1824 | if (buf < end) | |
1825 | *buf = 'T'; | |
1826 | buf++; | |
1827 | } | |
1828 | if (have_t) | |
1829 | buf = time_str(buf, end, tm, raw); | |
1830 | ||
1831 | return buf; | |
1832 | } | |
1833 | ||
7daac5b2 AS |
1834 | static noinline_for_stack |
1835 | char *time64_str(char *buf, char *end, const time64_t time, | |
1836 | struct printf_spec spec, const char *fmt) | |
1837 | { | |
1838 | struct rtc_time rtc_time; | |
1839 | struct tm tm; | |
1840 | ||
1841 | time64_to_tm(time, 0, &tm); | |
1842 | ||
1843 | rtc_time.tm_sec = tm.tm_sec; | |
1844 | rtc_time.tm_min = tm.tm_min; | |
1845 | rtc_time.tm_hour = tm.tm_hour; | |
1846 | rtc_time.tm_mday = tm.tm_mday; | |
1847 | rtc_time.tm_mon = tm.tm_mon; | |
1848 | rtc_time.tm_year = tm.tm_year; | |
1849 | rtc_time.tm_wday = tm.tm_wday; | |
1850 | rtc_time.tm_yday = tm.tm_yday; | |
1851 | ||
1852 | rtc_time.tm_isdst = 0; | |
1853 | ||
1854 | return rtc_str(buf, end, &rtc_time, spec, fmt); | |
1855 | } | |
1856 | ||
4d42c447 AS |
1857 | static noinline_for_stack |
1858 | char *time_and_date(char *buf, char *end, void *ptr, struct printf_spec spec, | |
1859 | const char *fmt) | |
1860 | { | |
1861 | switch (fmt[1]) { | |
1862 | case 'R': | |
3e5903eb | 1863 | return rtc_str(buf, end, (const struct rtc_time *)ptr, spec, fmt); |
7daac5b2 AS |
1864 | case 'T': |
1865 | return time64_str(buf, end, *(const time64_t *)ptr, spec, fmt); | |
4d42c447 | 1866 | default: |
7daac5b2 | 1867 | return error_string(buf, end, "(%pt?)", spec); |
4d42c447 AS |
1868 | } |
1869 | } | |
1870 | ||
900cca29 GU |
1871 | static noinline_for_stack |
1872 | char *clock(char *buf, char *end, struct clk *clk, struct printf_spec spec, | |
1873 | const char *fmt) | |
1874 | { | |
0b74d4d7 | 1875 | if (!IS_ENABLED(CONFIG_HAVE_CLK)) |
c8c3b584 | 1876 | return error_string(buf, end, "(%pC?)", spec); |
0b74d4d7 | 1877 | |
3e5903eb PM |
1878 | if (check_pointer(&buf, end, clk, spec)) |
1879 | return buf; | |
900cca29 GU |
1880 | |
1881 | switch (fmt[1]) { | |
900cca29 GU |
1882 | case 'n': |
1883 | default: | |
1884 | #ifdef CONFIG_COMMON_CLK | |
1885 | return string(buf, end, __clk_get_name(clk), spec); | |
1886 | #else | |
4ca96aa9 | 1887 | return ptr_to_id(buf, end, clk, spec); |
900cca29 GU |
1888 | #endif |
1889 | } | |
1890 | } | |
1891 | ||
edf14cdb VB |
1892 | static |
1893 | char *format_flags(char *buf, char *end, unsigned long flags, | |
1894 | const struct trace_print_flags *names) | |
1895 | { | |
1896 | unsigned long mask; | |
edf14cdb VB |
1897 | |
1898 | for ( ; flags && names->name; names++) { | |
1899 | mask = names->mask; | |
1900 | if ((flags & mask) != mask) | |
1901 | continue; | |
1902 | ||
abd4fe62 | 1903 | buf = string(buf, end, names->name, default_str_spec); |
edf14cdb VB |
1904 | |
1905 | flags &= ~mask; | |
1906 | if (flags) { | |
1907 | if (buf < end) | |
1908 | *buf = '|'; | |
1909 | buf++; | |
1910 | } | |
1911 | } | |
1912 | ||
1913 | if (flags) | |
54433973 | 1914 | buf = number(buf, end, flags, default_flag_spec); |
edf14cdb VB |
1915 | |
1916 | return buf; | |
1917 | } | |
1918 | ||
c244297a YS |
1919 | struct page_flags_fields { |
1920 | int width; | |
1921 | int shift; | |
1922 | int mask; | |
1923 | const struct printf_spec *spec; | |
1924 | const char *name; | |
1925 | }; | |
1926 | ||
1927 | static const struct page_flags_fields pff[] = { | |
1928 | {SECTIONS_WIDTH, SECTIONS_PGSHIFT, SECTIONS_MASK, | |
1929 | &default_dec_spec, "section"}, | |
1930 | {NODES_WIDTH, NODES_PGSHIFT, NODES_MASK, | |
1931 | &default_dec_spec, "node"}, | |
1932 | {ZONES_WIDTH, ZONES_PGSHIFT, ZONES_MASK, | |
1933 | &default_dec_spec, "zone"}, | |
1934 | {LAST_CPUPID_WIDTH, LAST_CPUPID_PGSHIFT, LAST_CPUPID_MASK, | |
1935 | &default_flag_spec, "lastcpupid"}, | |
1936 | {KASAN_TAG_WIDTH, KASAN_TAG_PGSHIFT, KASAN_TAG_MASK, | |
1937 | &default_flag_spec, "kasantag"}, | |
1938 | }; | |
1939 | ||
1940 | static | |
1941 | char *format_page_flags(char *buf, char *end, unsigned long flags) | |
1942 | { | |
1943 | unsigned long main_flags = flags & (BIT(NR_PAGEFLAGS) - 1); | |
1944 | bool append = false; | |
1945 | int i; | |
1946 | ||
1947 | /* Page flags from the main area. */ | |
1948 | if (main_flags) { | |
1949 | buf = format_flags(buf, end, main_flags, pageflag_names); | |
1950 | append = true; | |
1951 | } | |
1952 | ||
1953 | /* Page flags from the fields area */ | |
1954 | for (i = 0; i < ARRAY_SIZE(pff); i++) { | |
1955 | /* Skip undefined fields. */ | |
1956 | if (!pff[i].width) | |
1957 | continue; | |
1958 | ||
1959 | /* Format: Flag Name + '=' (equals sign) + Number + '|' (separator) */ | |
1960 | if (append) { | |
1961 | if (buf < end) | |
1962 | *buf = '|'; | |
1963 | buf++; | |
1964 | } | |
1965 | ||
1966 | buf = string(buf, end, pff[i].name, default_str_spec); | |
1967 | if (buf < end) | |
1968 | *buf = '='; | |
1969 | buf++; | |
1970 | buf = number(buf, end, (flags >> pff[i].shift) & pff[i].mask, | |
1971 | *pff[i].spec); | |
1972 | ||
1973 | append = true; | |
1974 | } | |
1975 | ||
1976 | return buf; | |
1977 | } | |
1978 | ||
edf14cdb | 1979 | static noinline_for_stack |
0b74d4d7 PM |
1980 | char *flags_string(char *buf, char *end, void *flags_ptr, |
1981 | struct printf_spec spec, const char *fmt) | |
edf14cdb VB |
1982 | { |
1983 | unsigned long flags; | |
1984 | const struct trace_print_flags *names; | |
1985 | ||
3e5903eb PM |
1986 | if (check_pointer(&buf, end, flags_ptr, spec)) |
1987 | return buf; | |
1988 | ||
edf14cdb VB |
1989 | switch (fmt[1]) { |
1990 | case 'p': | |
c244297a | 1991 | return format_page_flags(buf, end, *(unsigned long *)flags_ptr); |
edf14cdb VB |
1992 | case 'v': |
1993 | flags = *(unsigned long *)flags_ptr; | |
1994 | names = vmaflag_names; | |
1995 | break; | |
1996 | case 'g': | |
30d497a0 | 1997 | flags = (__force unsigned long)(*(gfp_t *)flags_ptr); |
edf14cdb VB |
1998 | names = gfpflag_names; |
1999 | break; | |
2000 | default: | |
c8c3b584 | 2001 | return error_string(buf, end, "(%pG?)", spec); |
edf14cdb VB |
2002 | } |
2003 | ||
2004 | return format_flags(buf, end, flags, names); | |
2005 | } | |
2006 | ||
ce4fecf1 | 2007 | static noinline_for_stack |
a92eb762 SA |
2008 | char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf, |
2009 | char *end) | |
ce4fecf1 PA |
2010 | { |
2011 | int depth; | |
ce4fecf1 | 2012 | |
a92eb762 SA |
2013 | /* Loop starting from the root node to the current node. */ |
2014 | for (depth = fwnode_count_parents(fwnode); depth >= 0; depth--) { | |
2015 | struct fwnode_handle *__fwnode = | |
2016 | fwnode_get_nth_parent(fwnode, depth); | |
ce4fecf1 | 2017 | |
a92eb762 | 2018 | buf = string(buf, end, fwnode_get_name_prefix(__fwnode), |
abd4fe62 | 2019 | default_str_spec); |
a92eb762 | 2020 | buf = string(buf, end, fwnode_get_name(__fwnode), |
abd4fe62 | 2021 | default_str_spec); |
a92eb762 SA |
2022 | |
2023 | fwnode_handle_put(__fwnode); | |
ce4fecf1 | 2024 | } |
a92eb762 | 2025 | |
ce4fecf1 PA |
2026 | return buf; |
2027 | } | |
2028 | ||
2029 | static noinline_for_stack | |
2030 | char *device_node_string(char *buf, char *end, struct device_node *dn, | |
2031 | struct printf_spec spec, const char *fmt) | |
2032 | { | |
2033 | char tbuf[sizeof("xxxx") + 1]; | |
2034 | const char *p; | |
2035 | int ret; | |
2036 | char *buf_start = buf; | |
2037 | struct property *prop; | |
2038 | bool has_mult, pass; | |
ce4fecf1 PA |
2039 | |
2040 | struct printf_spec str_spec = spec; | |
2041 | str_spec.field_width = -1; | |
2042 | ||
83abc5a7 SA |
2043 | if (fmt[0] != 'F') |
2044 | return error_string(buf, end, "(%pO?)", spec); | |
2045 | ||
ce4fecf1 | 2046 | if (!IS_ENABLED(CONFIG_OF)) |
c8c3b584 | 2047 | return error_string(buf, end, "(%pOF?)", spec); |
ce4fecf1 | 2048 | |
3e5903eb PM |
2049 | if (check_pointer(&buf, end, dn, spec)) |
2050 | return buf; | |
ce4fecf1 PA |
2051 | |
2052 | /* simple case without anything any more format specifiers */ | |
2053 | fmt++; | |
2054 | if (fmt[0] == '\0' || strcspn(fmt,"fnpPFcC") > 0) | |
2055 | fmt = "f"; | |
2056 | ||
2057 | for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) { | |
6d0a70a2 | 2058 | int precision; |
ce4fecf1 PA |
2059 | if (pass) { |
2060 | if (buf < end) | |
2061 | *buf = ':'; | |
2062 | buf++; | |
2063 | } | |
2064 | ||
2065 | switch (*fmt) { | |
2066 | case 'f': /* full_name */ | |
a92eb762 SA |
2067 | buf = fwnode_full_name_string(of_fwnode_handle(dn), buf, |
2068 | end); | |
ce4fecf1 PA |
2069 | break; |
2070 | case 'n': /* name */ | |
a92eb762 | 2071 | p = fwnode_get_name(of_fwnode_handle(dn)); |
6d0a70a2 RH |
2072 | precision = str_spec.precision; |
2073 | str_spec.precision = strchrnul(p, '@') - p; | |
2074 | buf = string(buf, end, p, str_spec); | |
2075 | str_spec.precision = precision; | |
ce4fecf1 PA |
2076 | break; |
2077 | case 'p': /* phandle */ | |
09ceb8d7 | 2078 | buf = number(buf, end, (unsigned int)dn->phandle, default_dec_spec); |
ce4fecf1 PA |
2079 | break; |
2080 | case 'P': /* path-spec */ | |
a92eb762 | 2081 | p = fwnode_get_name(of_fwnode_handle(dn)); |
ce4fecf1 PA |
2082 | if (!p[1]) |
2083 | p = "/"; | |
2084 | buf = string(buf, end, p, str_spec); | |
2085 | break; | |
2086 | case 'F': /* flags */ | |
2087 | tbuf[0] = of_node_check_flag(dn, OF_DYNAMIC) ? 'D' : '-'; | |
2088 | tbuf[1] = of_node_check_flag(dn, OF_DETACHED) ? 'd' : '-'; | |
2089 | tbuf[2] = of_node_check_flag(dn, OF_POPULATED) ? 'P' : '-'; | |
2090 | tbuf[3] = of_node_check_flag(dn, OF_POPULATED_BUS) ? 'B' : '-'; | |
2091 | tbuf[4] = 0; | |
d529ac41 | 2092 | buf = string_nocheck(buf, end, tbuf, str_spec); |
ce4fecf1 PA |
2093 | break; |
2094 | case 'c': /* major compatible string */ | |
2095 | ret = of_property_read_string(dn, "compatible", &p); | |
2096 | if (!ret) | |
2097 | buf = string(buf, end, p, str_spec); | |
2098 | break; | |
2099 | case 'C': /* full compatible string */ | |
2100 | has_mult = false; | |
2101 | of_property_for_each_string(dn, "compatible", prop, p) { | |
2102 | if (has_mult) | |
d529ac41 PM |
2103 | buf = string_nocheck(buf, end, ",", str_spec); |
2104 | buf = string_nocheck(buf, end, "\"", str_spec); | |
ce4fecf1 | 2105 | buf = string(buf, end, p, str_spec); |
d529ac41 | 2106 | buf = string_nocheck(buf, end, "\"", str_spec); |
ce4fecf1 PA |
2107 | |
2108 | has_mult = true; | |
2109 | } | |
2110 | break; | |
2111 | default: | |
2112 | break; | |
2113 | } | |
2114 | } | |
2115 | ||
2116 | return widen_string(buf, buf - buf_start, end, spec); | |
2117 | } | |
2118 | ||
3bd32d6a SA |
2119 | static noinline_for_stack |
2120 | char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode, | |
2121 | struct printf_spec spec, const char *fmt) | |
798cc27a | 2122 | { |
3bd32d6a SA |
2123 | struct printf_spec str_spec = spec; |
2124 | char *buf_start = buf; | |
2125 | ||
2126 | str_spec.field_width = -1; | |
2127 | ||
2128 | if (*fmt != 'w') | |
2129 | return error_string(buf, end, "(%pf?)", spec); | |
2130 | ||
2131 | if (check_pointer(&buf, end, fwnode, spec)) | |
2132 | return buf; | |
2133 | ||
2134 | fmt++; | |
2135 | ||
2136 | switch (*fmt) { | |
2137 | case 'P': /* name */ | |
2138 | buf = string(buf, end, fwnode_get_name(fwnode), str_spec); | |
2139 | break; | |
2140 | case 'f': /* full_name */ | |
2141 | default: | |
2142 | buf = fwnode_full_name_string(fwnode, buf, end); | |
2143 | break; | |
798cc27a PM |
2144 | } |
2145 | ||
3bd32d6a | 2146 | return widen_string(buf, buf - buf_start, end, spec); |
798cc27a PM |
2147 | } |
2148 | ||
5ead723a TT |
2149 | /* Disable pointer hashing if requested */ |
2150 | bool no_hash_pointers __ro_after_init; | |
2151 | EXPORT_SYMBOL_GPL(no_hash_pointers); | |
2152 | ||
2153 | static int __init no_hash_pointers_enable(char *str) | |
2154 | { | |
9f961c2e ME |
2155 | if (no_hash_pointers) |
2156 | return 0; | |
2157 | ||
5ead723a TT |
2158 | no_hash_pointers = true; |
2159 | ||
2160 | pr_warn("**********************************************************\n"); | |
2161 | pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n"); | |
2162 | pr_warn("** **\n"); | |
2163 | pr_warn("** This system shows unhashed kernel memory addresses **\n"); | |
2164 | pr_warn("** via the console, logs, and other interfaces. This **\n"); | |
2165 | pr_warn("** might reduce the security of your system. **\n"); | |
2166 | pr_warn("** **\n"); | |
2167 | pr_warn("** If you see this message and you are not debugging **\n"); | |
2168 | pr_warn("** the kernel, report this immediately to your system **\n"); | |
2169 | pr_warn("** administrator! **\n"); | |
2170 | pr_warn("** **\n"); | |
2171 | pr_warn("** NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE **\n"); | |
2172 | pr_warn("**********************************************************\n"); | |
2173 | ||
2174 | return 0; | |
2175 | } | |
2176 | early_param("no_hash_pointers", no_hash_pointers_enable); | |
2177 | ||
4d8a743c LT |
2178 | /* |
2179 | * Show a '%p' thing. A kernel extension is that the '%p' is followed | |
2180 | * by an extra set of alphanumeric characters that are extended format | |
2181 | * specifiers. | |
2182 | * | |
0b523769 JP |
2183 | * Please update scripts/checkpatch.pl when adding/removing conversion |
2184 | * characters. (Search for "check for vsprintf extension"). | |
2185 | * | |
332d2e78 LT |
2186 | * Right now we handle: |
2187 | * | |
cdb7e52d SS |
2188 | * - 'S' For symbolic direct pointers (or function descriptors) with offset |
2189 | * - 's' For symbolic direct pointers (or function descriptors) without offset | |
9af77064 | 2190 | * - '[Ss]R' as above with __builtin_extract_return_addr() translation |
1586c5ae SA |
2191 | * - '[Ff]' %pf and %pF were obsoleted and later removed in favor of |
2192 | * %ps and %pS. Be careful when re-using these specifiers. | |
0f77a8d3 | 2193 | * - 'B' For backtraced symbolic direct pointers with offset |
c7dabef8 BH |
2194 | * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] |
2195 | * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201] | |
dbc760bc TH |
2196 | * - 'b[l]' For a bitmap, the number of bits is determined by the field |
2197 | * width which must be explicitly specified either as part of the | |
2198 | * format string '%32b[l]' or through '%*b[l]', [l] selects | |
2199 | * range-list format instead of hex format | |
dd45c9cf HH |
2200 | * - 'M' For a 6-byte MAC address, it prints the address in the |
2201 | * usual colon-separated hex notation | |
8a27f7c9 | 2202 | * - 'm' For a 6-byte MAC address, it prints the hex address without colons |
bc7259a2 | 2203 | * - 'MF' For a 6-byte MAC FDDI address, it prints the address |
c8e00060 | 2204 | * with a dash-separated hex notation |
7c59154e | 2205 | * - '[mM]R' For a 6-byte MAC address, Reverse order (Bluetooth) |
8a27f7c9 JP |
2206 | * - 'I' [46] for IPv4/IPv6 addresses printed in the usual way |
2207 | * IPv4 uses dot-separated decimal without leading 0's (1.2.3.4) | |
2208 | * IPv6 uses colon separated network-order 16 bit hex with leading 0's | |
10679643 DB |
2209 | * [S][pfs] |
2210 | * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to | |
2211 | * [4] or [6] and is able to print port [p], flowinfo [f], scope [s] | |
8a27f7c9 JP |
2212 | * - 'i' [46] for 'raw' IPv4/IPv6 addresses |
2213 | * IPv6 omits the colons (01020304...0f) | |
2214 | * IPv4 uses dot-separated decimal with leading 0's (010.123.045.006) | |
10679643 DB |
2215 | * [S][pfs] |
2216 | * Generic IPv4/IPv6 address (struct sockaddr *) that falls back to | |
2217 | * [4] or [6] and is able to print port [p], flowinfo [f], scope [s] | |
2218 | * - '[Ii][4S][hnbl]' IPv4 addresses in host, network, big or little endian order | |
2219 | * - 'I[6S]c' for IPv6 addresses printed as specified by | |
8eda94bd | 2220 | * https://tools.ietf.org/html/rfc5952 |
71dca95d AS |
2221 | * - 'E[achnops]' For an escaped buffer, where rules are defined by combination |
2222 | * of the following flags (see string_escape_mem() for the | |
2223 | * details): | |
2224 | * a - ESCAPE_ANY | |
2225 | * c - ESCAPE_SPECIAL | |
2226 | * h - ESCAPE_HEX | |
2227 | * n - ESCAPE_NULL | |
2228 | * o - ESCAPE_OCTAL | |
2229 | * p - ESCAPE_NP | |
2230 | * s - ESCAPE_SPACE | |
2231 | * By default ESCAPE_ANY_NP is used. | |
9ac6e44e JP |
2232 | * - 'U' For a 16 byte UUID/GUID, it prints the UUID/GUID in the form |
2233 | * "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" | |
2234 | * Options for %pU are: | |
2235 | * b big endian lower case hex (default) | |
2236 | * B big endian UPPER case hex | |
2237 | * l little endian lower case hex | |
2238 | * L little endian UPPER case hex | |
2239 | * big endian output byte order is: | |
2240 | * [0][1][2][3]-[4][5]-[6][7]-[8][9]-[10][11][12][13][14][15] | |
2241 | * little endian output byte order is: | |
2242 | * [3][2][1][0]-[5][4]-[7][6]-[8][9]-[10][11][12][13][14][15] | |
7db6f5fb JP |
2243 | * - 'V' For a struct va_format which contains a format string * and va_list *, |
2244 | * call vsnprintf(->format, *->va_list). | |
2245 | * Implements a "recursive vsnprintf". | |
2246 | * Do not use this feature without some mechanism to verify the | |
2247 | * correctness of the format string and va_list arguments. | |
a48849e2 VB |
2248 | * - 'K' For a kernel pointer that should be hidden from unprivileged users. |
2249 | * Use only for procfs, sysfs and similar files, not printk(); please | |
2250 | * read the documentation (path below) first. | |
c8f44aff | 2251 | * - 'NF' For a netdev_features_t |
31550a16 AS |
2252 | * - 'h[CDN]' For a variable-length buffer, it prints it as a hex string with |
2253 | * a certain separator (' ' by default): | |
2254 | * C colon | |
2255 | * D dash | |
2256 | * N no separator | |
2257 | * The maximum supported length is 64 bytes of the input. Consider | |
2258 | * to use print_hex_dump() for the larger input. | |
aaf07621 JP |
2259 | * - 'a[pd]' For address types [p] phys_addr_t, [d] dma_addr_t and derivatives |
2260 | * (default assumed to be phys_addr_t, passed by reference) | |
c0d92a57 OJ |
2261 | * - 'd[234]' For a dentry name (optionally 2-4 last components) |
2262 | * - 'D[234]' Same as 'd' but for a struct file | |
1031bc58 | 2263 | * - 'g' For block_device name (gendisk + partition number) |
7daac5b2 | 2264 | * - 't[RT][dt][r]' For time and date as represented by: |
4d42c447 | 2265 | * R struct rtc_time |
7daac5b2 | 2266 | * T time64_t |
900cca29 GU |
2267 | * - 'C' For a clock, it prints the name (Common Clock Framework) or address |
2268 | * (legacy clock framework) of the clock | |
2269 | * - 'Cn' For a clock, it prints the name (Common Clock Framework) or address | |
2270 | * (legacy clock framework) of the clock | |
edf14cdb VB |
2271 | * - 'G' For flags to be printed as a collection of symbolic strings that would |
2272 | * construct the specific value. Supported flags given by option: | |
2273 | * p page flags (see struct page) given as pointer to unsigned long | |
2274 | * g gfp flags (GFP_* and __GFP_*) given as pointer to gfp_t | |
2275 | * v vma flags (VM_*) given as pointer to unsigned long | |
94ac8f20 GU |
2276 | * - 'OF[fnpPcCF]' For a device tree object |
2277 | * Without any optional arguments prints the full_name | |
2278 | * f device node full_name | |
2279 | * n device node name | |
2280 | * p device node phandle | |
2281 | * P device node path spec (name + @unit) | |
2282 | * F device node flags | |
2283 | * c major compatible string | |
2284 | * C full compatible string | |
3bd32d6a SA |
2285 | * - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer |
2286 | * Without an option prints the full name of the node | |
2287 | * f full name | |
2288 | * P node name, including a possible unit address | |
a48849e2 VB |
2289 | * - 'x' For printing the address unmodified. Equivalent to "%lx". |
2290 | * Please read the documentation (path below) before using! | |
b2a5212f DB |
2291 | * - '[ku]s' For a BPF/tracing related format specifier, e.g. used out of |
2292 | * bpf_trace_printk() where [ku] prefix specifies either kernel (k) | |
2293 | * or user (u) memory to probe, and: | |
2294 | * s a string, equivalent to "%s" on direct vsnprintf() use | |
7b1924a1 | 2295 | * |
b3ed2321 TH |
2296 | * ** When making changes please also update: |
2297 | * Documentation/core-api/printk-formats.rst | |
9ac6e44e | 2298 | * |
ad67b74d TH |
2299 | * Note: The default behaviour (unadorned %p) is to hash the address, |
2300 | * rendering it useful as a unique identifier. | |
4d8a743c | 2301 | */ |
cf3b429b JP |
2302 | static noinline_for_stack |
2303 | char *pointer(const char *fmt, char *buf, char *end, void *ptr, | |
2304 | struct printf_spec spec) | |
78a8bf69 | 2305 | { |
0fe1ef24 | 2306 | switch (*fmt) { |
0fe1ef24 | 2307 | case 'S': |
9ac6e44e | 2308 | case 's': |
04b8eb7a | 2309 | ptr = dereference_symbol_descriptor(ptr); |
4c1ca831 | 2310 | fallthrough; |
0f77a8d3 | 2311 | case 'B': |
b0d33c2b | 2312 | return symbol_string(buf, end, ptr, spec, fmt); |
332d2e78 | 2313 | case 'R': |
c7dabef8 | 2314 | case 'r': |
fd95541e | 2315 | return resource_string(buf, end, ptr, spec, fmt); |
31550a16 AS |
2316 | case 'h': |
2317 | return hex_string(buf, end, ptr, spec, fmt); | |
dbc760bc TH |
2318 | case 'b': |
2319 | switch (fmt[1]) { | |
2320 | case 'l': | |
2321 | return bitmap_list_string(buf, end, ptr, spec, fmt); | |
2322 | default: | |
2323 | return bitmap_string(buf, end, ptr, spec, fmt); | |
2324 | } | |
8a27f7c9 JP |
2325 | case 'M': /* Colon separated: 00:01:02:03:04:05 */ |
2326 | case 'm': /* Contiguous: 000102030405 */ | |
76597ff9 AE |
2327 | /* [mM]F (FDDI) */ |
2328 | /* [mM]R (Reverse order; Bluetooth) */ | |
8a27f7c9 JP |
2329 | return mac_address_string(buf, end, ptr, spec, fmt); |
2330 | case 'I': /* Formatted IP supported | |
2331 | * 4: 1.2.3.4 | |
2332 | * 6: 0001:0203:...:0708 | |
2333 | * 6c: 1::708 or 1::1.2.3.4 | |
2334 | */ | |
2335 | case 'i': /* Contiguous: | |
2336 | * 4: 001.002.003.004 | |
2337 | * 6: 000102...0f | |
2338 | */ | |
f00cc102 | 2339 | return ip_addr_string(buf, end, ptr, spec, fmt); |
71dca95d AS |
2340 | case 'E': |
2341 | return escaped_string(buf, end, ptr, spec, fmt); | |
9ac6e44e JP |
2342 | case 'U': |
2343 | return uuid_string(buf, end, ptr, spec, fmt); | |
7db6f5fb | 2344 | case 'V': |
3e5903eb | 2345 | return va_format(buf, end, ptr, spec, fmt); |
455cd5ab | 2346 | case 'K': |
57e73442 | 2347 | return restricted_pointer(buf, end, ptr, spec); |
c8f44aff | 2348 | case 'N': |
431bca24 | 2349 | return netdev_bits(buf, end, ptr, spec, fmt); |
7d799210 | 2350 | case 'a': |
3e5903eb | 2351 | return address_val(buf, end, ptr, spec, fmt); |
4b6ccca7 AV |
2352 | case 'd': |
2353 | return dentry_name(buf, end, ptr, spec, fmt); | |
4d42c447 AS |
2354 | case 't': |
2355 | return time_and_date(buf, end, ptr, spec, fmt); | |
900cca29 GU |
2356 | case 'C': |
2357 | return clock(buf, end, ptr, spec, fmt); | |
4b6ccca7 | 2358 | case 'D': |
36594b31 | 2359 | return file_dentry_name(buf, end, ptr, spec, fmt); |
1031bc58 DM |
2360 | #ifdef CONFIG_BLOCK |
2361 | case 'g': | |
2362 | return bdev_name(buf, end, ptr, spec, fmt); | |
2363 | #endif | |
2364 | ||
edf14cdb | 2365 | case 'G': |
0b74d4d7 | 2366 | return flags_string(buf, end, ptr, spec, fmt); |
ce4fecf1 | 2367 | case 'O': |
83abc5a7 | 2368 | return device_node_string(buf, end, ptr, spec, fmt + 1); |
3bd32d6a SA |
2369 | case 'f': |
2370 | return fwnode_string(buf, end, ptr, spec, fmt + 1); | |
7b1924a1 TH |
2371 | case 'x': |
2372 | return pointer_string(buf, end, ptr, spec); | |
57f5677e RV |
2373 | case 'e': |
2374 | /* %pe with a non-ERR_PTR gets treated as plain %p */ | |
2375 | if (!IS_ERR(ptr)) | |
2376 | break; | |
2377 | return err_ptr(buf, end, ptr, spec); | |
b2a5212f DB |
2378 | case 'u': |
2379 | case 'k': | |
2380 | switch (fmt[1]) { | |
2381 | case 's': | |
2382 | return string(buf, end, ptr, spec); | |
2383 | default: | |
2384 | return error_string(buf, end, "(einval)", spec); | |
2385 | } | |
fef20d9c | 2386 | } |
fef20d9c | 2387 | |
5ead723a TT |
2388 | /* |
2389 | * default is to _not_ leak addresses, so hash before printing, | |
2390 | * unless no_hash_pointers is specified on the command line. | |
2391 | */ | |
2392 | if (unlikely(no_hash_pointers)) | |
2393 | return pointer_string(buf, end, ptr, spec); | |
2394 | else | |
2395 | return ptr_to_id(buf, end, ptr, spec); | |
fef20d9c FW |
2396 | } |
2397 | ||
2398 | /* | |
2399 | * Helper function to decode printf style format. | |
2400 | * Each call decode a token from the format and return the | |
2401 | * number of characters read (or likely the delta where it wants | |
2402 | * to go on the next call). | |
2403 | * The decoded token is returned through the parameters | |
2404 | * | |
2405 | * 'h', 'l', or 'L' for integer fields | |
2406 | * 'z' support added 23/7/1999 S.H. | |
2407 | * 'z' changed to 'Z' --davidm 1/25/99 | |
5b5e0928 | 2408 | * 'Z' changed to 'z' --adobriyan 2017-01-25 |
fef20d9c FW |
2409 | * 't' added for ptrdiff_t |
2410 | * | |
2411 | * @fmt: the format string | |
2412 | * @type of the token returned | |
2413 | * @flags: various flags such as +, -, # tokens.. | |
2414 | * @field_width: overwritten width | |
2415 | * @base: base of the number (octal, hex, ...) | |
2416 | * @precision: precision of a number | |
2417 | * @qualifier: qualifier of a number (long, size_t, ...) | |
2418 | */ | |
cf3b429b JP |
2419 | static noinline_for_stack |
2420 | int format_decode(const char *fmt, struct printf_spec *spec) | |
fef20d9c FW |
2421 | { |
2422 | const char *start = fmt; | |
d0484193 | 2423 | char qualifier; |
fef20d9c FW |
2424 | |
2425 | /* we finished early by reading the field width */ | |
ed681a91 | 2426 | if (spec->type == FORMAT_TYPE_WIDTH) { |
fef20d9c FW |
2427 | if (spec->field_width < 0) { |
2428 | spec->field_width = -spec->field_width; | |
2429 | spec->flags |= LEFT; | |
2430 | } | |
2431 | spec->type = FORMAT_TYPE_NONE; | |
2432 | goto precision; | |
2433 | } | |
2434 | ||
2435 | /* we finished early by reading the precision */ | |
2436 | if (spec->type == FORMAT_TYPE_PRECISION) { | |
2437 | if (spec->precision < 0) | |
2438 | spec->precision = 0; | |
2439 | ||
2440 | spec->type = FORMAT_TYPE_NONE; | |
2441 | goto qualifier; | |
2442 | } | |
2443 | ||
2444 | /* By default */ | |
2445 | spec->type = FORMAT_TYPE_NONE; | |
2446 | ||
2447 | for (; *fmt ; ++fmt) { | |
2448 | if (*fmt == '%') | |
2449 | break; | |
2450 | } | |
2451 | ||
2452 | /* Return the current non-format string */ | |
2453 | if (fmt != start || !*fmt) | |
2454 | return fmt - start; | |
2455 | ||
2456 | /* Process flags */ | |
2457 | spec->flags = 0; | |
2458 | ||
2459 | while (1) { /* this also skips first '%' */ | |
2460 | bool found = true; | |
2461 | ||
2462 | ++fmt; | |
2463 | ||
2464 | switch (*fmt) { | |
2465 | case '-': spec->flags |= LEFT; break; | |
2466 | case '+': spec->flags |= PLUS; break; | |
2467 | case ' ': spec->flags |= SPACE; break; | |
2468 | case '#': spec->flags |= SPECIAL; break; | |
2469 | case '0': spec->flags |= ZEROPAD; break; | |
2470 | default: found = false; | |
2471 | } | |
2472 | ||
2473 | if (!found) | |
2474 | break; | |
2475 | } | |
2476 | ||
2477 | /* get field width */ | |
2478 | spec->field_width = -1; | |
2479 | ||
2480 | if (isdigit(*fmt)) | |
2481 | spec->field_width = skip_atoi(&fmt); | |
2482 | else if (*fmt == '*') { | |
2483 | /* it's the next argument */ | |
ed681a91 | 2484 | spec->type = FORMAT_TYPE_WIDTH; |
fef20d9c FW |
2485 | return ++fmt - start; |
2486 | } | |
2487 | ||
2488 | precision: | |
2489 | /* get the precision */ | |
2490 | spec->precision = -1; | |
2491 | if (*fmt == '.') { | |
2492 | ++fmt; | |
2493 | if (isdigit(*fmt)) { | |
2494 | spec->precision = skip_atoi(&fmt); | |
2495 | if (spec->precision < 0) | |
2496 | spec->precision = 0; | |
2497 | } else if (*fmt == '*') { | |
2498 | /* it's the next argument */ | |
adf26f84 | 2499 | spec->type = FORMAT_TYPE_PRECISION; |
fef20d9c FW |
2500 | return ++fmt - start; |
2501 | } | |
2502 | } | |
2503 | ||
2504 | qualifier: | |
2505 | /* get the conversion qualifier */ | |
d0484193 | 2506 | qualifier = 0; |
75fb8f26 | 2507 | if (*fmt == 'h' || _tolower(*fmt) == 'l' || |
5b5e0928 | 2508 | *fmt == 'z' || *fmt == 't') { |
d0484193 RV |
2509 | qualifier = *fmt++; |
2510 | if (unlikely(qualifier == *fmt)) { | |
2511 | if (qualifier == 'l') { | |
2512 | qualifier = 'L'; | |
a4e94ef0 | 2513 | ++fmt; |
d0484193 RV |
2514 | } else if (qualifier == 'h') { |
2515 | qualifier = 'H'; | |
a4e94ef0 Z |
2516 | ++fmt; |
2517 | } | |
fef20d9c FW |
2518 | } |
2519 | } | |
2520 | ||
2521 | /* default base */ | |
2522 | spec->base = 10; | |
2523 | switch (*fmt) { | |
2524 | case 'c': | |
2525 | spec->type = FORMAT_TYPE_CHAR; | |
2526 | return ++fmt - start; | |
2527 | ||
2528 | case 's': | |
2529 | spec->type = FORMAT_TYPE_STR; | |
2530 | return ++fmt - start; | |
2531 | ||
2532 | case 'p': | |
2533 | spec->type = FORMAT_TYPE_PTR; | |
ffbfed03 | 2534 | return ++fmt - start; |
fef20d9c | 2535 | |
fef20d9c FW |
2536 | case '%': |
2537 | spec->type = FORMAT_TYPE_PERCENT_CHAR; | |
2538 | return ++fmt - start; | |
2539 | ||
2540 | /* integer number formats - set up the flags and "break" */ | |
2541 | case 'o': | |
2542 | spec->base = 8; | |
2543 | break; | |
2544 | ||
2545 | case 'x': | |
2546 | spec->flags |= SMALL; | |
4c1ca831 | 2547 | fallthrough; |
fef20d9c FW |
2548 | |
2549 | case 'X': | |
2550 | spec->base = 16; | |
2551 | break; | |
2552 | ||
2553 | case 'd': | |
2554 | case 'i': | |
39e874f8 | 2555 | spec->flags |= SIGN; |
36f9ff9e | 2556 | break; |
fef20d9c | 2557 | case 'u': |
4aa99606 | 2558 | break; |
fef20d9c | 2559 | |
708d96fd RM |
2560 | case 'n': |
2561 | /* | |
b006f19b RV |
2562 | * Since %n poses a greater security risk than |
2563 | * utility, treat it as any other invalid or | |
2564 | * unsupported format specifier. | |
708d96fd | 2565 | */ |
4c1ca831 | 2566 | fallthrough; |
708d96fd | 2567 | |
fef20d9c | 2568 | default: |
b006f19b | 2569 | WARN_ONCE(1, "Please remove unsupported %%%c in format string\n", *fmt); |
fef20d9c FW |
2570 | spec->type = FORMAT_TYPE_INVALID; |
2571 | return fmt - start; | |
0fe1ef24 | 2572 | } |
fef20d9c | 2573 | |
d0484193 | 2574 | if (qualifier == 'L') |
fef20d9c | 2575 | spec->type = FORMAT_TYPE_LONG_LONG; |
d0484193 | 2576 | else if (qualifier == 'l') { |
51be17df RV |
2577 | BUILD_BUG_ON(FORMAT_TYPE_ULONG + SIGN != FORMAT_TYPE_LONG); |
2578 | spec->type = FORMAT_TYPE_ULONG + (spec->flags & SIGN); | |
5b5e0928 | 2579 | } else if (qualifier == 'z') { |
fef20d9c | 2580 | spec->type = FORMAT_TYPE_SIZE_T; |
d0484193 | 2581 | } else if (qualifier == 't') { |
fef20d9c | 2582 | spec->type = FORMAT_TYPE_PTRDIFF; |
d0484193 | 2583 | } else if (qualifier == 'H') { |
51be17df RV |
2584 | BUILD_BUG_ON(FORMAT_TYPE_UBYTE + SIGN != FORMAT_TYPE_BYTE); |
2585 | spec->type = FORMAT_TYPE_UBYTE + (spec->flags & SIGN); | |
d0484193 | 2586 | } else if (qualifier == 'h') { |
51be17df RV |
2587 | BUILD_BUG_ON(FORMAT_TYPE_USHORT + SIGN != FORMAT_TYPE_SHORT); |
2588 | spec->type = FORMAT_TYPE_USHORT + (spec->flags & SIGN); | |
fef20d9c | 2589 | } else { |
51be17df RV |
2590 | BUILD_BUG_ON(FORMAT_TYPE_UINT + SIGN != FORMAT_TYPE_INT); |
2591 | spec->type = FORMAT_TYPE_UINT + (spec->flags & SIGN); | |
78a8bf69 | 2592 | } |
fef20d9c FW |
2593 | |
2594 | return ++fmt - start; | |
78a8bf69 LT |
2595 | } |
2596 | ||
4d72ba01 RV |
2597 | static void |
2598 | set_field_width(struct printf_spec *spec, int width) | |
2599 | { | |
2600 | spec->field_width = width; | |
2601 | if (WARN_ONCE(spec->field_width != width, "field width %d too large", width)) { | |
2602 | spec->field_width = clamp(width, -FIELD_WIDTH_MAX, FIELD_WIDTH_MAX); | |
2603 | } | |
2604 | } | |
2605 | ||
2606 | static void | |
2607 | set_precision(struct printf_spec *spec, int prec) | |
2608 | { | |
2609 | spec->precision = prec; | |
2610 | if (WARN_ONCE(spec->precision != prec, "precision %d too large", prec)) { | |
2611 | spec->precision = clamp(prec, 0, PRECISION_MAX); | |
2612 | } | |
2613 | } | |
2614 | ||
1da177e4 LT |
2615 | /** |
2616 | * vsnprintf - Format a string and place it in a buffer | |
2617 | * @buf: The buffer to place the result into | |
2618 | * @size: The size of the buffer, including the trailing null space | |
2619 | * @fmt: The format string to use | |
2620 | * @args: Arguments for the format string | |
2621 | * | |
d7ec9a05 RV |
2622 | * This function generally follows C99 vsnprintf, but has some |
2623 | * extensions and a few limitations: | |
2624 | * | |
6cc89134 MCC |
2625 | * - ``%n`` is unsupported |
2626 | * - ``%p*`` is handled by pointer() | |
5e4ee7b1 | 2627 | * |
27e7c0e8 | 2628 | * See pointer() or Documentation/core-api/printk-formats.rst for more |
5e4ee7b1 | 2629 | * extensive description. |
20036fdc | 2630 | * |
6cc89134 | 2631 | * **Please update the documentation in both places when making changes** |
80f548e0 | 2632 | * |
1da177e4 LT |
2633 | * The return value is the number of characters which would |
2634 | * be generated for the given input, excluding the trailing | |
2635 | * '\0', as per ISO C99. If you want to have the exact | |
2636 | * number of characters written into @buf as return value | |
72fd4a35 | 2637 | * (not including the trailing '\0'), use vscnprintf(). If the |
1da177e4 LT |
2638 | * return is greater than or equal to @size, the resulting |
2639 | * string is truncated. | |
2640 | * | |
ba1835eb | 2641 | * If you're not already dealing with a va_list consider using snprintf(). |
1da177e4 LT |
2642 | */ |
2643 | int vsnprintf(char *buf, size_t size, const char *fmt, va_list args) | |
2644 | { | |
1da177e4 | 2645 | unsigned long long num; |
d4be151b | 2646 | char *str, *end; |
fef20d9c | 2647 | struct printf_spec spec = {0}; |
1da177e4 | 2648 | |
f796937a JF |
2649 | /* Reject out-of-range values early. Large positive sizes are |
2650 | used for unknown buffer sizes. */ | |
2aa2f9e2 | 2651 | if (WARN_ON_ONCE(size > INT_MAX)) |
1da177e4 | 2652 | return 0; |
1da177e4 LT |
2653 | |
2654 | str = buf; | |
f796937a | 2655 | end = buf + size; |
1da177e4 | 2656 | |
f796937a JF |
2657 | /* Make sure end is always >= buf */ |
2658 | if (end < buf) { | |
2659 | end = ((void *)-1); | |
2660 | size = end - buf; | |
1da177e4 LT |
2661 | } |
2662 | ||
fef20d9c FW |
2663 | while (*fmt) { |
2664 | const char *old_fmt = fmt; | |
d4be151b | 2665 | int read = format_decode(fmt, &spec); |
1da177e4 | 2666 | |
fef20d9c | 2667 | fmt += read; |
1da177e4 | 2668 | |
fef20d9c FW |
2669 | switch (spec.type) { |
2670 | case FORMAT_TYPE_NONE: { | |
2671 | int copy = read; | |
2672 | if (str < end) { | |
2673 | if (copy > end - str) | |
2674 | copy = end - str; | |
2675 | memcpy(str, old_fmt, copy); | |
1da177e4 | 2676 | } |
fef20d9c FW |
2677 | str += read; |
2678 | break; | |
1da177e4 LT |
2679 | } |
2680 | ||
ed681a91 | 2681 | case FORMAT_TYPE_WIDTH: |
4d72ba01 | 2682 | set_field_width(&spec, va_arg(args, int)); |
fef20d9c | 2683 | break; |
1da177e4 | 2684 | |
fef20d9c | 2685 | case FORMAT_TYPE_PRECISION: |
4d72ba01 | 2686 | set_precision(&spec, va_arg(args, int)); |
fef20d9c | 2687 | break; |
1da177e4 | 2688 | |
d4be151b AGR |
2689 | case FORMAT_TYPE_CHAR: { |
2690 | char c; | |
2691 | ||
fef20d9c FW |
2692 | if (!(spec.flags & LEFT)) { |
2693 | while (--spec.field_width > 0) { | |
f796937a | 2694 | if (str < end) |
1da177e4 LT |
2695 | *str = ' '; |
2696 | ++str; | |
1da177e4 | 2697 | |
fef20d9c FW |
2698 | } |
2699 | } | |
2700 | c = (unsigned char) va_arg(args, int); | |
2701 | if (str < end) | |
2702 | *str = c; | |
2703 | ++str; | |
2704 | while (--spec.field_width > 0) { | |
f796937a | 2705 | if (str < end) |
fef20d9c | 2706 | *str = ' '; |
1da177e4 | 2707 | ++str; |
fef20d9c FW |
2708 | } |
2709 | break; | |
d4be151b | 2710 | } |
1da177e4 | 2711 | |
fef20d9c FW |
2712 | case FORMAT_TYPE_STR: |
2713 | str = string(str, end, va_arg(args, char *), spec); | |
2714 | break; | |
1da177e4 | 2715 | |
fef20d9c | 2716 | case FORMAT_TYPE_PTR: |
ffbfed03 | 2717 | str = pointer(fmt, str, end, va_arg(args, void *), |
fef20d9c FW |
2718 | spec); |
2719 | while (isalnum(*fmt)) | |
2720 | fmt++; | |
2721 | break; | |
1da177e4 | 2722 | |
fef20d9c FW |
2723 | case FORMAT_TYPE_PERCENT_CHAR: |
2724 | if (str < end) | |
2725 | *str = '%'; | |
2726 | ++str; | |
2727 | break; | |
1da177e4 | 2728 | |
fef20d9c | 2729 | case FORMAT_TYPE_INVALID: |
b006f19b RV |
2730 | /* |
2731 | * Presumably the arguments passed gcc's type | |
2732 | * checking, but there is no safe or sane way | |
2733 | * for us to continue parsing the format and | |
2734 | * fetching from the va_list; the remaining | |
2735 | * specifiers and arguments would be out of | |
2736 | * sync. | |
2737 | */ | |
2738 | goto out; | |
fef20d9c | 2739 | |
fef20d9c FW |
2740 | default: |
2741 | switch (spec.type) { | |
2742 | case FORMAT_TYPE_LONG_LONG: | |
2743 | num = va_arg(args, long long); | |
2744 | break; | |
2745 | case FORMAT_TYPE_ULONG: | |
2746 | num = va_arg(args, unsigned long); | |
2747 | break; | |
2748 | case FORMAT_TYPE_LONG: | |
2749 | num = va_arg(args, long); | |
2750 | break; | |
2751 | case FORMAT_TYPE_SIZE_T: | |
ef124960 JG |
2752 | if (spec.flags & SIGN) |
2753 | num = va_arg(args, ssize_t); | |
2754 | else | |
2755 | num = va_arg(args, size_t); | |
fef20d9c FW |
2756 | break; |
2757 | case FORMAT_TYPE_PTRDIFF: | |
2758 | num = va_arg(args, ptrdiff_t); | |
2759 | break; | |
a4e94ef0 Z |
2760 | case FORMAT_TYPE_UBYTE: |
2761 | num = (unsigned char) va_arg(args, int); | |
2762 | break; | |
2763 | case FORMAT_TYPE_BYTE: | |
2764 | num = (signed char) va_arg(args, int); | |
2765 | break; | |
fef20d9c FW |
2766 | case FORMAT_TYPE_USHORT: |
2767 | num = (unsigned short) va_arg(args, int); | |
2768 | break; | |
2769 | case FORMAT_TYPE_SHORT: | |
2770 | num = (short) va_arg(args, int); | |
2771 | break; | |
39e874f8 FW |
2772 | case FORMAT_TYPE_INT: |
2773 | num = (int) va_arg(args, int); | |
fef20d9c FW |
2774 | break; |
2775 | default: | |
2776 | num = va_arg(args, unsigned int); | |
2777 | } | |
2778 | ||
2779 | str = number(str, end, num, spec); | |
1da177e4 | 2780 | } |
1da177e4 | 2781 | } |
fef20d9c | 2782 | |
b006f19b | 2783 | out: |
f796937a JF |
2784 | if (size > 0) { |
2785 | if (str < end) | |
2786 | *str = '\0'; | |
2787 | else | |
0a6047ee | 2788 | end[-1] = '\0'; |
f796937a | 2789 | } |
fef20d9c | 2790 | |
f796937a | 2791 | /* the trailing null byte doesn't count towards the total */ |
1da177e4 | 2792 | return str-buf; |
fef20d9c | 2793 | |
1da177e4 | 2794 | } |
1da177e4 LT |
2795 | EXPORT_SYMBOL(vsnprintf); |
2796 | ||
2797 | /** | |
2798 | * vscnprintf - Format a string and place it in a buffer | |
2799 | * @buf: The buffer to place the result into | |
2800 | * @size: The size of the buffer, including the trailing null space | |
2801 | * @fmt: The format string to use | |
2802 | * @args: Arguments for the format string | |
2803 | * | |
2804 | * The return value is the number of characters which have been written into | |
b921c69f | 2805 | * the @buf not including the trailing '\0'. If @size is == 0 the function |
1da177e4 LT |
2806 | * returns 0. |
2807 | * | |
ba1835eb | 2808 | * If you're not already dealing with a va_list consider using scnprintf(). |
20036fdc AK |
2809 | * |
2810 | * See the vsnprintf() documentation for format string extensions over C99. | |
1da177e4 LT |
2811 | */ |
2812 | int vscnprintf(char *buf, size_t size, const char *fmt, va_list args) | |
2813 | { | |
2814 | int i; | |
2815 | ||
7b9186f5 AGR |
2816 | i = vsnprintf(buf, size, fmt, args); |
2817 | ||
b921c69f AA |
2818 | if (likely(i < size)) |
2819 | return i; | |
2820 | if (size != 0) | |
2821 | return size - 1; | |
2822 | return 0; | |
1da177e4 | 2823 | } |
1da177e4 LT |
2824 | EXPORT_SYMBOL(vscnprintf); |
2825 | ||
2826 | /** | |
2827 | * snprintf - Format a string and place it in a buffer | |
2828 | * @buf: The buffer to place the result into | |
2829 | * @size: The size of the buffer, including the trailing null space | |
2830 | * @fmt: The format string to use | |
2831 | * @...: Arguments for the format string | |
2832 | * | |
2833 | * The return value is the number of characters which would be | |
2834 | * generated for the given input, excluding the trailing null, | |
2835 | * as per ISO C99. If the return is greater than or equal to | |
2836 | * @size, the resulting string is truncated. | |
20036fdc AK |
2837 | * |
2838 | * See the vsnprintf() documentation for format string extensions over C99. | |
1da177e4 | 2839 | */ |
7b9186f5 | 2840 | int snprintf(char *buf, size_t size, const char *fmt, ...) |
1da177e4 LT |
2841 | { |
2842 | va_list args; | |
2843 | int i; | |
2844 | ||
2845 | va_start(args, fmt); | |
7b9186f5 | 2846 | i = vsnprintf(buf, size, fmt, args); |
1da177e4 | 2847 | va_end(args); |
7b9186f5 | 2848 | |
1da177e4 LT |
2849 | return i; |
2850 | } | |
1da177e4 LT |
2851 | EXPORT_SYMBOL(snprintf); |
2852 | ||
2853 | /** | |
2854 | * scnprintf - Format a string and place it in a buffer | |
2855 | * @buf: The buffer to place the result into | |
2856 | * @size: The size of the buffer, including the trailing null space | |
2857 | * @fmt: The format string to use | |
2858 | * @...: Arguments for the format string | |
2859 | * | |
2860 | * The return value is the number of characters written into @buf not including | |
b903c0b8 | 2861 | * the trailing '\0'. If @size is == 0 the function returns 0. |
1da177e4 LT |
2862 | */ |
2863 | ||
7b9186f5 | 2864 | int scnprintf(char *buf, size_t size, const char *fmt, ...) |
1da177e4 LT |
2865 | { |
2866 | va_list args; | |
2867 | int i; | |
2868 | ||
2869 | va_start(args, fmt); | |
b921c69f | 2870 | i = vscnprintf(buf, size, fmt, args); |
1da177e4 | 2871 | va_end(args); |
7b9186f5 | 2872 | |
b921c69f | 2873 | return i; |
1da177e4 LT |
2874 | } |
2875 | EXPORT_SYMBOL(scnprintf); | |
2876 | ||
2877 | /** | |
2878 | * vsprintf - Format a string and place it in a buffer | |
2879 | * @buf: The buffer to place the result into | |
2880 | * @fmt: The format string to use | |
2881 | * @args: Arguments for the format string | |
2882 | * | |
2883 | * The function returns the number of characters written | |
72fd4a35 | 2884 | * into @buf. Use vsnprintf() or vscnprintf() in order to avoid |
1da177e4 LT |
2885 | * buffer overflows. |
2886 | * | |
ba1835eb | 2887 | * If you're not already dealing with a va_list consider using sprintf(). |
20036fdc AK |
2888 | * |
2889 | * See the vsnprintf() documentation for format string extensions over C99. | |
1da177e4 LT |
2890 | */ |
2891 | int vsprintf(char *buf, const char *fmt, va_list args) | |
2892 | { | |
2893 | return vsnprintf(buf, INT_MAX, fmt, args); | |
2894 | } | |
1da177e4 LT |
2895 | EXPORT_SYMBOL(vsprintf); |
2896 | ||
2897 | /** | |
2898 | * sprintf - Format a string and place it in a buffer | |
2899 | * @buf: The buffer to place the result into | |
2900 | * @fmt: The format string to use | |
2901 | * @...: Arguments for the format string | |
2902 | * | |
2903 | * The function returns the number of characters written | |
72fd4a35 | 2904 | * into @buf. Use snprintf() or scnprintf() in order to avoid |
1da177e4 | 2905 | * buffer overflows. |
20036fdc AK |
2906 | * |
2907 | * See the vsnprintf() documentation for format string extensions over C99. | |
1da177e4 | 2908 | */ |
7b9186f5 | 2909 | int sprintf(char *buf, const char *fmt, ...) |
1da177e4 LT |
2910 | { |
2911 | va_list args; | |
2912 | int i; | |
2913 | ||
2914 | va_start(args, fmt); | |
7b9186f5 | 2915 | i = vsnprintf(buf, INT_MAX, fmt, args); |
1da177e4 | 2916 | va_end(args); |
7b9186f5 | 2917 | |
1da177e4 LT |
2918 | return i; |
2919 | } | |
1da177e4 LT |
2920 | EXPORT_SYMBOL(sprintf); |
2921 | ||
4370aa4a LJ |
2922 | #ifdef CONFIG_BINARY_PRINTF |
2923 | /* | |
2924 | * bprintf service: | |
2925 | * vbin_printf() - VA arguments to binary data | |
2926 | * bstr_printf() - Binary data to text string | |
2927 | */ | |
2928 | ||
2929 | /** | |
2930 | * vbin_printf - Parse a format string and place args' binary value in a buffer | |
2931 | * @bin_buf: The buffer to place args' binary value | |
2932 | * @size: The size of the buffer(by words(32bits), not characters) | |
2933 | * @fmt: The format string to use | |
2934 | * @args: Arguments for the format string | |
2935 | * | |
2936 | * The format follows C99 vsnprintf, except %n is ignored, and its argument | |
da3dae54 | 2937 | * is skipped. |
4370aa4a LJ |
2938 | * |
2939 | * The return value is the number of words(32bits) which would be generated for | |
2940 | * the given input. | |
2941 | * | |
2942 | * NOTE: | |
2943 | * If the return value is greater than @size, the resulting bin_buf is NOT | |
2944 | * valid for bstr_printf(). | |
2945 | */ | |
2946 | int vbin_printf(u32 *bin_buf, size_t size, const char *fmt, va_list args) | |
2947 | { | |
fef20d9c | 2948 | struct printf_spec spec = {0}; |
4370aa4a | 2949 | char *str, *end; |
841a915d | 2950 | int width; |
4370aa4a LJ |
2951 | |
2952 | str = (char *)bin_buf; | |
2953 | end = (char *)(bin_buf + size); | |
2954 | ||
2955 | #define save_arg(type) \ | |
841a915d SRV |
2956 | ({ \ |
2957 | unsigned long long value; \ | |
4370aa4a | 2958 | if (sizeof(type) == 8) { \ |
841a915d | 2959 | unsigned long long val8; \ |
4370aa4a | 2960 | str = PTR_ALIGN(str, sizeof(u32)); \ |
841a915d | 2961 | val8 = va_arg(args, unsigned long long); \ |
4370aa4a | 2962 | if (str + sizeof(type) <= end) { \ |
841a915d SRV |
2963 | *(u32 *)str = *(u32 *)&val8; \ |
2964 | *(u32 *)(str + 4) = *((u32 *)&val8 + 1); \ | |
4370aa4a | 2965 | } \ |
841a915d | 2966 | value = val8; \ |
4370aa4a | 2967 | } else { \ |
841a915d | 2968 | unsigned int val4; \ |
4370aa4a | 2969 | str = PTR_ALIGN(str, sizeof(type)); \ |
841a915d | 2970 | val4 = va_arg(args, int); \ |
4370aa4a | 2971 | if (str + sizeof(type) <= end) \ |
841a915d SRV |
2972 | *(typeof(type) *)str = (type)(long)val4; \ |
2973 | value = (unsigned long long)val4; \ | |
4370aa4a LJ |
2974 | } \ |
2975 | str += sizeof(type); \ | |
841a915d SRV |
2976 | value; \ |
2977 | }) | |
4370aa4a | 2978 | |
fef20d9c | 2979 | while (*fmt) { |
d4be151b | 2980 | int read = format_decode(fmt, &spec); |
4370aa4a | 2981 | |
fef20d9c | 2982 | fmt += read; |
4370aa4a | 2983 | |
fef20d9c FW |
2984 | switch (spec.type) { |
2985 | case FORMAT_TYPE_NONE: | |
d4be151b | 2986 | case FORMAT_TYPE_PERCENT_CHAR: |
fef20d9c | 2987 | break; |
b006f19b RV |
2988 | case FORMAT_TYPE_INVALID: |
2989 | goto out; | |
fef20d9c | 2990 | |
ed681a91 | 2991 | case FORMAT_TYPE_WIDTH: |
fef20d9c | 2992 | case FORMAT_TYPE_PRECISION: |
841a915d SRV |
2993 | width = (int)save_arg(int); |
2994 | /* Pointers may require the width */ | |
2995 | if (*fmt == 'p') | |
2996 | set_field_width(&spec, width); | |
fef20d9c FW |
2997 | break; |
2998 | ||
2999 | case FORMAT_TYPE_CHAR: | |
4370aa4a | 3000 | save_arg(char); |
fef20d9c FW |
3001 | break; |
3002 | ||
3003 | case FORMAT_TYPE_STR: { | |
4370aa4a | 3004 | const char *save_str = va_arg(args, char *); |
3e5903eb | 3005 | const char *err_msg; |
4370aa4a | 3006 | size_t len; |
6c356634 | 3007 | |
3e5903eb PM |
3008 | err_msg = check_pointer_msg(save_str); |
3009 | if (err_msg) | |
3010 | save_str = err_msg; | |
3011 | ||
6c356634 AGR |
3012 | len = strlen(save_str) + 1; |
3013 | if (str + len < end) | |
3014 | memcpy(str, save_str, len); | |
3015 | str += len; | |
fef20d9c | 3016 | break; |
4370aa4a | 3017 | } |
fef20d9c FW |
3018 | |
3019 | case FORMAT_TYPE_PTR: | |
841a915d SRV |
3020 | /* Dereferenced pointers must be done now */ |
3021 | switch (*fmt) { | |
3022 | /* Dereference of functions is still OK */ | |
3023 | case 'S': | |
3024 | case 's': | |
1e6338cf SRV |
3025 | case 'x': |
3026 | case 'K': | |
57f5677e | 3027 | case 'e': |
841a915d SRV |
3028 | save_arg(void *); |
3029 | break; | |
3030 | default: | |
3031 | if (!isalnum(*fmt)) { | |
3032 | save_arg(void *); | |
3033 | break; | |
3034 | } | |
3035 | str = pointer(fmt, str, end, va_arg(args, void *), | |
3036 | spec); | |
3037 | if (str + 1 < end) | |
3038 | *str++ = '\0'; | |
3039 | else | |
3040 | end[-1] = '\0'; /* Must be nul terminated */ | |
3041 | } | |
4370aa4a | 3042 | /* skip all alphanumeric pointer suffixes */ |
fef20d9c | 3043 | while (isalnum(*fmt)) |
4370aa4a | 3044 | fmt++; |
fef20d9c FW |
3045 | break; |
3046 | ||
fef20d9c FW |
3047 | default: |
3048 | switch (spec.type) { | |
3049 | ||
3050 | case FORMAT_TYPE_LONG_LONG: | |
4370aa4a | 3051 | save_arg(long long); |
fef20d9c FW |
3052 | break; |
3053 | case FORMAT_TYPE_ULONG: | |
3054 | case FORMAT_TYPE_LONG: | |
4370aa4a | 3055 | save_arg(unsigned long); |
fef20d9c FW |
3056 | break; |
3057 | case FORMAT_TYPE_SIZE_T: | |
4370aa4a | 3058 | save_arg(size_t); |
fef20d9c FW |
3059 | break; |
3060 | case FORMAT_TYPE_PTRDIFF: | |
4370aa4a | 3061 | save_arg(ptrdiff_t); |
fef20d9c | 3062 | break; |
a4e94ef0 Z |
3063 | case FORMAT_TYPE_UBYTE: |
3064 | case FORMAT_TYPE_BYTE: | |
3065 | save_arg(char); | |
3066 | break; | |
fef20d9c FW |
3067 | case FORMAT_TYPE_USHORT: |
3068 | case FORMAT_TYPE_SHORT: | |
4370aa4a | 3069 | save_arg(short); |
fef20d9c FW |
3070 | break; |
3071 | default: | |
4370aa4a | 3072 | save_arg(int); |
fef20d9c | 3073 | } |
4370aa4a LJ |
3074 | } |
3075 | } | |
fef20d9c | 3076 | |
b006f19b | 3077 | out: |
7b9186f5 | 3078 | return (u32 *)(PTR_ALIGN(str, sizeof(u32))) - bin_buf; |
fef20d9c | 3079 | #undef save_arg |
4370aa4a LJ |
3080 | } |
3081 | EXPORT_SYMBOL_GPL(vbin_printf); | |
3082 | ||
3083 | /** | |
3084 | * bstr_printf - Format a string from binary arguments and place it in a buffer | |
3085 | * @buf: The buffer to place the result into | |
3086 | * @size: The size of the buffer, including the trailing null space | |
3087 | * @fmt: The format string to use | |
3088 | * @bin_buf: Binary arguments for the format string | |
3089 | * | |
3090 | * This function like C99 vsnprintf, but the difference is that vsnprintf gets | |
3091 | * arguments from stack, and bstr_printf gets arguments from @bin_buf which is | |
3092 | * a binary buffer that generated by vbin_printf. | |
3093 | * | |
3094 | * The format follows C99 vsnprintf, but has some extensions: | |
0efb4d20 | 3095 | * see vsnprintf comment for details. |
4370aa4a LJ |
3096 | * |
3097 | * The return value is the number of characters which would | |
3098 | * be generated for the given input, excluding the trailing | |
3099 | * '\0', as per ISO C99. If you want to have the exact | |
3100 | * number of characters written into @buf as return value | |
3101 | * (not including the trailing '\0'), use vscnprintf(). If the | |
3102 | * return is greater than or equal to @size, the resulting | |
3103 | * string is truncated. | |
3104 | */ | |
3105 | int bstr_printf(char *buf, size_t size, const char *fmt, const u32 *bin_buf) | |
3106 | { | |
fef20d9c | 3107 | struct printf_spec spec = {0}; |
d4be151b AGR |
3108 | char *str, *end; |
3109 | const char *args = (const char *)bin_buf; | |
4370aa4a | 3110 | |
762abb51 | 3111 | if (WARN_ON_ONCE(size > INT_MAX)) |
4370aa4a | 3112 | return 0; |
4370aa4a LJ |
3113 | |
3114 | str = buf; | |
3115 | end = buf + size; | |
3116 | ||
3117 | #define get_arg(type) \ | |
3118 | ({ \ | |
3119 | typeof(type) value; \ | |
3120 | if (sizeof(type) == 8) { \ | |
3121 | args = PTR_ALIGN(args, sizeof(u32)); \ | |
3122 | *(u32 *)&value = *(u32 *)args; \ | |
3123 | *((u32 *)&value + 1) = *(u32 *)(args + 4); \ | |
3124 | } else { \ | |
3125 | args = PTR_ALIGN(args, sizeof(type)); \ | |
3126 | value = *(typeof(type) *)args; \ | |
3127 | } \ | |
3128 | args += sizeof(type); \ | |
3129 | value; \ | |
3130 | }) | |
3131 | ||
3132 | /* Make sure end is always >= buf */ | |
3133 | if (end < buf) { | |
3134 | end = ((void *)-1); | |
3135 | size = end - buf; | |
3136 | } | |
3137 | ||
fef20d9c | 3138 | while (*fmt) { |
fef20d9c | 3139 | const char *old_fmt = fmt; |
d4be151b | 3140 | int read = format_decode(fmt, &spec); |
4370aa4a | 3141 | |
fef20d9c | 3142 | fmt += read; |
4370aa4a | 3143 | |
fef20d9c FW |
3144 | switch (spec.type) { |
3145 | case FORMAT_TYPE_NONE: { | |
3146 | int copy = read; | |
3147 | if (str < end) { | |
3148 | if (copy > end - str) | |
3149 | copy = end - str; | |
3150 | memcpy(str, old_fmt, copy); | |
4370aa4a | 3151 | } |
fef20d9c FW |
3152 | str += read; |
3153 | break; | |
4370aa4a LJ |
3154 | } |
3155 | ||
ed681a91 | 3156 | case FORMAT_TYPE_WIDTH: |
4d72ba01 | 3157 | set_field_width(&spec, get_arg(int)); |
fef20d9c | 3158 | break; |
4370aa4a | 3159 | |
fef20d9c | 3160 | case FORMAT_TYPE_PRECISION: |
4d72ba01 | 3161 | set_precision(&spec, get_arg(int)); |
fef20d9c | 3162 | break; |
4370aa4a | 3163 | |
d4be151b AGR |
3164 | case FORMAT_TYPE_CHAR: { |
3165 | char c; | |
3166 | ||
fef20d9c FW |
3167 | if (!(spec.flags & LEFT)) { |
3168 | while (--spec.field_width > 0) { | |
4370aa4a LJ |
3169 | if (str < end) |
3170 | *str = ' '; | |
3171 | ++str; | |
3172 | } | |
3173 | } | |
3174 | c = (unsigned char) get_arg(char); | |
3175 | if (str < end) | |
3176 | *str = c; | |
3177 | ++str; | |
fef20d9c | 3178 | while (--spec.field_width > 0) { |
4370aa4a LJ |
3179 | if (str < end) |
3180 | *str = ' '; | |
3181 | ++str; | |
3182 | } | |
fef20d9c | 3183 | break; |
d4be151b | 3184 | } |
4370aa4a | 3185 | |
fef20d9c | 3186 | case FORMAT_TYPE_STR: { |
4370aa4a | 3187 | const char *str_arg = args; |
d4be151b | 3188 | args += strlen(str_arg) + 1; |
fef20d9c FW |
3189 | str = string(str, end, (char *)str_arg, spec); |
3190 | break; | |
4370aa4a LJ |
3191 | } |
3192 | ||
841a915d SRV |
3193 | case FORMAT_TYPE_PTR: { |
3194 | bool process = false; | |
3195 | int copy, len; | |
3196 | /* Non function dereferences were already done */ | |
3197 | switch (*fmt) { | |
3198 | case 'S': | |
3199 | case 's': | |
1e6338cf SRV |
3200 | case 'x': |
3201 | case 'K': | |
57f5677e | 3202 | case 'e': |
841a915d SRV |
3203 | process = true; |
3204 | break; | |
3205 | default: | |
3206 | if (!isalnum(*fmt)) { | |
3207 | process = true; | |
3208 | break; | |
3209 | } | |
3210 | /* Pointer dereference was already processed */ | |
3211 | if (str < end) { | |
3212 | len = copy = strlen(args); | |
3213 | if (copy > end - str) | |
3214 | copy = end - str; | |
3215 | memcpy(str, args, copy); | |
3216 | str += len; | |
62165600 | 3217 | args += len + 1; |
841a915d SRV |
3218 | } |
3219 | } | |
3220 | if (process) | |
3221 | str = pointer(fmt, str, end, get_arg(void *), spec); | |
3222 | ||
fef20d9c | 3223 | while (isalnum(*fmt)) |
4370aa4a | 3224 | fmt++; |
fef20d9c | 3225 | break; |
841a915d | 3226 | } |
4370aa4a | 3227 | |
fef20d9c | 3228 | case FORMAT_TYPE_PERCENT_CHAR: |
4370aa4a LJ |
3229 | if (str < end) |
3230 | *str = '%'; | |
3231 | ++str; | |
fef20d9c FW |
3232 | break; |
3233 | ||
b006f19b RV |
3234 | case FORMAT_TYPE_INVALID: |
3235 | goto out; | |
3236 | ||
d4be151b AGR |
3237 | default: { |
3238 | unsigned long long num; | |
3239 | ||
fef20d9c FW |
3240 | switch (spec.type) { |
3241 | ||
3242 | case FORMAT_TYPE_LONG_LONG: | |
3243 | num = get_arg(long long); | |
3244 | break; | |
3245 | case FORMAT_TYPE_ULONG: | |
fef20d9c FW |
3246 | case FORMAT_TYPE_LONG: |
3247 | num = get_arg(unsigned long); | |
3248 | break; | |
3249 | case FORMAT_TYPE_SIZE_T: | |
3250 | num = get_arg(size_t); | |
3251 | break; | |
3252 | case FORMAT_TYPE_PTRDIFF: | |
3253 | num = get_arg(ptrdiff_t); | |
3254 | break; | |
a4e94ef0 Z |
3255 | case FORMAT_TYPE_UBYTE: |
3256 | num = get_arg(unsigned char); | |
3257 | break; | |
3258 | case FORMAT_TYPE_BYTE: | |
3259 | num = get_arg(signed char); | |
3260 | break; | |
fef20d9c FW |
3261 | case FORMAT_TYPE_USHORT: |
3262 | num = get_arg(unsigned short); | |
3263 | break; | |
3264 | case FORMAT_TYPE_SHORT: | |
3265 | num = get_arg(short); | |
3266 | break; | |
3267 | case FORMAT_TYPE_UINT: | |
3268 | num = get_arg(unsigned int); | |
3269 | break; | |
3270 | default: | |
3271 | num = get_arg(int); | |
3272 | } | |
3273 | ||
3274 | str = number(str, end, num, spec); | |
d4be151b AGR |
3275 | } /* default: */ |
3276 | } /* switch(spec.type) */ | |
3277 | } /* while(*fmt) */ | |
fef20d9c | 3278 | |
b006f19b | 3279 | out: |
4370aa4a LJ |
3280 | if (size > 0) { |
3281 | if (str < end) | |
3282 | *str = '\0'; | |
3283 | else | |
3284 | end[-1] = '\0'; | |
3285 | } | |
fef20d9c | 3286 | |
4370aa4a LJ |
3287 | #undef get_arg |
3288 | ||
3289 | /* the trailing null byte doesn't count towards the total */ | |
3290 | return str - buf; | |
3291 | } | |
3292 | EXPORT_SYMBOL_GPL(bstr_printf); | |
3293 | ||
3294 | /** | |
3295 | * bprintf - Parse a format string and place args' binary value in a buffer | |
3296 | * @bin_buf: The buffer to place args' binary value | |
3297 | * @size: The size of the buffer(by words(32bits), not characters) | |
3298 | * @fmt: The format string to use | |
3299 | * @...: Arguments for the format string | |
3300 | * | |
3301 | * The function returns the number of words(u32) written | |
3302 | * into @bin_buf. | |
3303 | */ | |
3304 | int bprintf(u32 *bin_buf, size_t size, const char *fmt, ...) | |
3305 | { | |
3306 | va_list args; | |
3307 | int ret; | |
3308 | ||
3309 | va_start(args, fmt); | |
3310 | ret = vbin_printf(bin_buf, size, fmt, args); | |
3311 | va_end(args); | |
7b9186f5 | 3312 | |
4370aa4a LJ |
3313 | return ret; |
3314 | } | |
3315 | EXPORT_SYMBOL_GPL(bprintf); | |
3316 | ||
3317 | #endif /* CONFIG_BINARY_PRINTF */ | |
3318 | ||
1da177e4 LT |
3319 | /** |
3320 | * vsscanf - Unformat a buffer into a list of arguments | |
3321 | * @buf: input buffer | |
3322 | * @fmt: format of buffer | |
3323 | * @args: arguments | |
3324 | */ | |
7b9186f5 | 3325 | int vsscanf(const char *buf, const char *fmt, va_list args) |
1da177e4 LT |
3326 | { |
3327 | const char *str = buf; | |
3328 | char *next; | |
3329 | char digit; | |
3330 | int num = 0; | |
ef0658f3 | 3331 | u8 qualifier; |
53809751 JB |
3332 | unsigned int base; |
3333 | union { | |
3334 | long long s; | |
3335 | unsigned long long u; | |
3336 | } val; | |
ef0658f3 | 3337 | s16 field_width; |
d4be151b | 3338 | bool is_sign; |
1da177e4 | 3339 | |
da99075c | 3340 | while (*fmt) { |
1da177e4 LT |
3341 | /* skip any white space in format */ |
3342 | /* white space in format matchs any amount of | |
3343 | * white space, including none, in the input. | |
3344 | */ | |
3345 | if (isspace(*fmt)) { | |
e7d2860b AGR |
3346 | fmt = skip_spaces(++fmt); |
3347 | str = skip_spaces(str); | |
1da177e4 LT |
3348 | } |
3349 | ||
3350 | /* anything that is not a conversion must match exactly */ | |
3351 | if (*fmt != '%' && *fmt) { | |
3352 | if (*fmt++ != *str++) | |
3353 | break; | |
3354 | continue; | |
3355 | } | |
3356 | ||
3357 | if (!*fmt) | |
3358 | break; | |
3359 | ++fmt; | |
7b9186f5 | 3360 | |
1da177e4 LT |
3361 | /* skip this conversion. |
3362 | * advance both strings to next white space | |
3363 | */ | |
3364 | if (*fmt == '*') { | |
da99075c JB |
3365 | if (!*str) |
3366 | break; | |
f9310b2f JY |
3367 | while (!isspace(*fmt) && *fmt != '%' && *fmt) { |
3368 | /* '%*[' not yet supported, invalid format */ | |
3369 | if (*fmt == '[') | |
3370 | return num; | |
1da177e4 | 3371 | fmt++; |
f9310b2f | 3372 | } |
1da177e4 LT |
3373 | while (!isspace(*str) && *str) |
3374 | str++; | |
3375 | continue; | |
3376 | } | |
3377 | ||
3378 | /* get field width */ | |
3379 | field_width = -1; | |
53809751 | 3380 | if (isdigit(*fmt)) { |
1da177e4 | 3381 | field_width = skip_atoi(&fmt); |
53809751 JB |
3382 | if (field_width <= 0) |
3383 | break; | |
3384 | } | |
1da177e4 LT |
3385 | |
3386 | /* get conversion qualifier */ | |
3387 | qualifier = -1; | |
75fb8f26 | 3388 | if (*fmt == 'h' || _tolower(*fmt) == 'l' || |
5b5e0928 | 3389 | *fmt == 'z') { |
1da177e4 LT |
3390 | qualifier = *fmt++; |
3391 | if (unlikely(qualifier == *fmt)) { | |
3392 | if (qualifier == 'h') { | |
3393 | qualifier = 'H'; | |
3394 | fmt++; | |
3395 | } else if (qualifier == 'l') { | |
3396 | qualifier = 'L'; | |
3397 | fmt++; | |
3398 | } | |
3399 | } | |
3400 | } | |
1da177e4 | 3401 | |
da99075c JB |
3402 | if (!*fmt) |
3403 | break; | |
3404 | ||
3405 | if (*fmt == 'n') { | |
3406 | /* return number of characters read so far */ | |
3407 | *va_arg(args, int *) = str - buf; | |
3408 | ++fmt; | |
3409 | continue; | |
3410 | } | |
3411 | ||
3412 | if (!*str) | |
1da177e4 LT |
3413 | break; |
3414 | ||
d4be151b | 3415 | base = 10; |
3f623eba | 3416 | is_sign = false; |
d4be151b | 3417 | |
7b9186f5 | 3418 | switch (*fmt++) { |
1da177e4 LT |
3419 | case 'c': |
3420 | { | |
7b9186f5 | 3421 | char *s = (char *)va_arg(args, char*); |
1da177e4 LT |
3422 | if (field_width == -1) |
3423 | field_width = 1; | |
3424 | do { | |
3425 | *s++ = *str++; | |
3426 | } while (--field_width > 0 && *str); | |
3427 | num++; | |
3428 | } | |
3429 | continue; | |
3430 | case 's': | |
3431 | { | |
7b9186f5 AGR |
3432 | char *s = (char *)va_arg(args, char *); |
3433 | if (field_width == -1) | |
4be929be | 3434 | field_width = SHRT_MAX; |
1da177e4 | 3435 | /* first, skip leading white space in buffer */ |
e7d2860b | 3436 | str = skip_spaces(str); |
1da177e4 LT |
3437 | |
3438 | /* now copy until next white space */ | |
7b9186f5 | 3439 | while (*str && !isspace(*str) && field_width--) |
1da177e4 | 3440 | *s++ = *str++; |
1da177e4 LT |
3441 | *s = '\0'; |
3442 | num++; | |
3443 | } | |
3444 | continue; | |
f9310b2f JY |
3445 | /* |
3446 | * Warning: This implementation of the '[' conversion specifier | |
3447 | * deviates from its glibc counterpart in the following ways: | |
3448 | * (1) It does NOT support ranges i.e. '-' is NOT a special | |
3449 | * character | |
3450 | * (2) It cannot match the closing bracket ']' itself | |
3451 | * (3) A field width is required | |
3452 | * (4) '%*[' (discard matching input) is currently not supported | |
3453 | * | |
3454 | * Example usage: | |
3455 | * ret = sscanf("00:0a:95","%2[^:]:%2[^:]:%2[^:]", | |
3456 | * buf1, buf2, buf3); | |
3457 | * if (ret < 3) | |
3458 | * // etc.. | |
3459 | */ | |
3460 | case '[': | |
3461 | { | |
3462 | char *s = (char *)va_arg(args, char *); | |
3463 | DECLARE_BITMAP(set, 256) = {0}; | |
3464 | unsigned int len = 0; | |
3465 | bool negate = (*fmt == '^'); | |
3466 | ||
3467 | /* field width is required */ | |
3468 | if (field_width == -1) | |
3469 | return num; | |
3470 | ||
3471 | if (negate) | |
3472 | ++fmt; | |
3473 | ||
3474 | for ( ; *fmt && *fmt != ']'; ++fmt, ++len) | |
3475 | set_bit((u8)*fmt, set); | |
3476 | ||
3477 | /* no ']' or no character set found */ | |
3478 | if (!*fmt || !len) | |
3479 | return num; | |
3480 | ++fmt; | |
3481 | ||
3482 | if (negate) { | |
3483 | bitmap_complement(set, set, 256); | |
3484 | /* exclude null '\0' byte */ | |
3485 | clear_bit(0, set); | |
3486 | } | |
3487 | ||
3488 | /* match must be non-empty */ | |
3489 | if (!test_bit((u8)*str, set)) | |
3490 | return num; | |
3491 | ||
3492 | while (test_bit((u8)*str, set) && field_width--) | |
3493 | *s++ = *str++; | |
3494 | *s = '\0'; | |
3495 | ++num; | |
3496 | } | |
3497 | continue; | |
1da177e4 LT |
3498 | case 'o': |
3499 | base = 8; | |
3500 | break; | |
3501 | case 'x': | |
3502 | case 'X': | |
3503 | base = 16; | |
3504 | break; | |
3505 | case 'i': | |
7b9186f5 | 3506 | base = 0; |
4c1ca831 | 3507 | fallthrough; |
1da177e4 | 3508 | case 'd': |
3f623eba | 3509 | is_sign = true; |
4c1ca831 | 3510 | fallthrough; |
1da177e4 LT |
3511 | case 'u': |
3512 | break; | |
3513 | case '%': | |
3514 | /* looking for '%' in str */ | |
7b9186f5 | 3515 | if (*str++ != '%') |
1da177e4 LT |
3516 | return num; |
3517 | continue; | |
3518 | default: | |
3519 | /* invalid format; stop here */ | |
3520 | return num; | |
3521 | } | |
3522 | ||
3523 | /* have some sort of integer conversion. | |
3524 | * first, skip white space in buffer. | |
3525 | */ | |
e7d2860b | 3526 | str = skip_spaces(str); |
1da177e4 LT |
3527 | |
3528 | digit = *str; | |
3529 | if (is_sign && digit == '-') | |
3530 | digit = *(str + 1); | |
3531 | ||
3532 | if (!digit | |
7b9186f5 AGR |
3533 | || (base == 16 && !isxdigit(digit)) |
3534 | || (base == 10 && !isdigit(digit)) | |
3535 | || (base == 8 && (!isdigit(digit) || digit > '7')) | |
3536 | || (base == 0 && !isdigit(digit))) | |
3537 | break; | |
1da177e4 | 3538 | |
53809751 JB |
3539 | if (is_sign) |
3540 | val.s = qualifier != 'L' ? | |
3541 | simple_strtol(str, &next, base) : | |
3542 | simple_strtoll(str, &next, base); | |
3543 | else | |
3544 | val.u = qualifier != 'L' ? | |
3545 | simple_strtoul(str, &next, base) : | |
3546 | simple_strtoull(str, &next, base); | |
3547 | ||
3548 | if (field_width > 0 && next - str > field_width) { | |
3549 | if (base == 0) | |
3550 | _parse_integer_fixup_radix(str, &base); | |
3551 | while (next - str > field_width) { | |
3552 | if (is_sign) | |
3553 | val.s = div_s64(val.s, base); | |
3554 | else | |
3555 | val.u = div_u64(val.u, base); | |
3556 | --next; | |
3557 | } | |
3558 | } | |
3559 | ||
7b9186f5 | 3560 | switch (qualifier) { |
1da177e4 | 3561 | case 'H': /* that's 'hh' in format */ |
53809751 JB |
3562 | if (is_sign) |
3563 | *va_arg(args, signed char *) = val.s; | |
3564 | else | |
3565 | *va_arg(args, unsigned char *) = val.u; | |
1da177e4 LT |
3566 | break; |
3567 | case 'h': | |
53809751 JB |
3568 | if (is_sign) |
3569 | *va_arg(args, short *) = val.s; | |
3570 | else | |
3571 | *va_arg(args, unsigned short *) = val.u; | |
1da177e4 LT |
3572 | break; |
3573 | case 'l': | |
53809751 JB |
3574 | if (is_sign) |
3575 | *va_arg(args, long *) = val.s; | |
3576 | else | |
3577 | *va_arg(args, unsigned long *) = val.u; | |
1da177e4 LT |
3578 | break; |
3579 | case 'L': | |
53809751 JB |
3580 | if (is_sign) |
3581 | *va_arg(args, long long *) = val.s; | |
3582 | else | |
3583 | *va_arg(args, unsigned long long *) = val.u; | |
1da177e4 | 3584 | break; |
1da177e4 | 3585 | case 'z': |
53809751 JB |
3586 | *va_arg(args, size_t *) = val.u; |
3587 | break; | |
1da177e4 | 3588 | default: |
53809751 JB |
3589 | if (is_sign) |
3590 | *va_arg(args, int *) = val.s; | |
3591 | else | |
3592 | *va_arg(args, unsigned int *) = val.u; | |
1da177e4 LT |
3593 | break; |
3594 | } | |
3595 | num++; | |
3596 | ||
3597 | if (!next) | |
3598 | break; | |
3599 | str = next; | |
3600 | } | |
c6b40d16 | 3601 | |
1da177e4 LT |
3602 | return num; |
3603 | } | |
1da177e4 LT |
3604 | EXPORT_SYMBOL(vsscanf); |
3605 | ||
3606 | /** | |
3607 | * sscanf - Unformat a buffer into a list of arguments | |
3608 | * @buf: input buffer | |
3609 | * @fmt: formatting of buffer | |
3610 | * @...: resulting arguments | |
3611 | */ | |
7b9186f5 | 3612 | int sscanf(const char *buf, const char *fmt, ...) |
1da177e4 LT |
3613 | { |
3614 | va_list args; | |
3615 | int i; | |
3616 | ||
7b9186f5 AGR |
3617 | va_start(args, fmt); |
3618 | i = vsscanf(buf, fmt, args); | |
1da177e4 | 3619 | va_end(args); |
7b9186f5 | 3620 | |
1da177e4 LT |
3621 | return i; |
3622 | } | |
1da177e4 | 3623 | EXPORT_SYMBOL(sscanf); |