Commit | Line | Data |
---|---|---|
21042e41 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
99eaf3c4 RD |
2 | /* |
3 | * lib/hexdump.c | |
99eaf3c4 RD |
4 | */ |
5 | ||
6 | #include <linux/types.h> | |
7 | #include <linux/ctype.h> | |
9888a588 | 8 | #include <linux/errno.h> |
99eaf3c4 | 9 | #include <linux/kernel.h> |
8bc3bcc9 | 10 | #include <linux/export.h> |
0f70fe60 | 11 | #include <asm/unaligned.h> |
99eaf3c4 | 12 | |
3fc95772 HH |
13 | const char hex_asc[] = "0123456789abcdef"; |
14 | EXPORT_SYMBOL(hex_asc); | |
c26d436c AN |
15 | const char hex_asc_upper[] = "0123456789ABCDEF"; |
16 | EXPORT_SYMBOL(hex_asc_upper); | |
3fc95772 | 17 | |
90378889 AS |
18 | /** |
19 | * hex_to_bin - convert a hex digit to its real value | |
20 | * @ch: ascii character represents hex digit | |
21 | * | |
22 | * hex_to_bin() converts one hex digit to its actual value or -1 in case of bad | |
23 | * input. | |
24 | */ | |
25 | int hex_to_bin(char ch) | |
26 | { | |
27 | if ((ch >= '0') && (ch <= '9')) | |
28 | return ch - '0'; | |
29 | ch = tolower(ch); | |
30 | if ((ch >= 'a') && (ch <= 'f')) | |
31 | return ch - 'a' + 10; | |
32 | return -1; | |
33 | } | |
34 | EXPORT_SYMBOL(hex_to_bin); | |
35 | ||
dc88e460 MZ |
36 | /** |
37 | * hex2bin - convert an ascii hexadecimal string to its binary representation | |
38 | * @dst: binary result | |
39 | * @src: ascii hexadecimal string | |
40 | * @count: result length | |
b7804983 | 41 | * |
9888a588 | 42 | * Return 0 on success, -EINVAL in case of bad input. |
dc88e460 | 43 | */ |
b7804983 | 44 | int hex2bin(u8 *dst, const char *src, size_t count) |
dc88e460 MZ |
45 | { |
46 | while (count--) { | |
b7804983 MZ |
47 | int hi = hex_to_bin(*src++); |
48 | int lo = hex_to_bin(*src++); | |
49 | ||
50 | if ((hi < 0) || (lo < 0)) | |
9888a588 | 51 | return -EINVAL; |
b7804983 MZ |
52 | |
53 | *dst++ = (hi << 4) | lo; | |
dc88e460 | 54 | } |
b7804983 | 55 | return 0; |
dc88e460 MZ |
56 | } |
57 | EXPORT_SYMBOL(hex2bin); | |
58 | ||
53d91c5c DH |
59 | /** |
60 | * bin2hex - convert binary data to an ascii hexadecimal string | |
61 | * @dst: ascii hexadecimal result | |
62 | * @src: binary data | |
63 | * @count: binary data length | |
64 | */ | |
65 | char *bin2hex(char *dst, const void *src, size_t count) | |
66 | { | |
67 | const unsigned char *_src = src; | |
68 | ||
69 | while (count--) | |
70 | dst = hex_byte_pack(dst, *_src++); | |
71 | return dst; | |
72 | } | |
73 | EXPORT_SYMBOL(bin2hex); | |
74 | ||
99eaf3c4 RD |
75 | /** |
76 | * hex_dump_to_buffer - convert a blob of data to "hex ASCII" in memory | |
77 | * @buf: data blob to dump | |
78 | * @len: number of bytes in the @buf | |
c7909234 RD |
79 | * @rowsize: number of bytes to print per line; must be 16 or 32 |
80 | * @groupsize: number of bytes to print at a time (1, 2, 4, 8; default = 1) | |
99eaf3c4 RD |
81 | * @linebuf: where to put the converted data |
82 | * @linebuflen: total size of @linebuf, including space for terminating NUL | |
c7909234 | 83 | * @ascii: include ASCII after the hex output |
99eaf3c4 RD |
84 | * |
85 | * hex_dump_to_buffer() works on one "line" of output at a time, i.e., | |
c7909234 | 86 | * 16 or 32 bytes of input data converted to hex + ASCII output. |
99eaf3c4 RD |
87 | * |
88 | * Given a buffer of u8 data, hex_dump_to_buffer() converts the input data | |
89 | * to a hex + ASCII dump at the supplied memory location. | |
90 | * The converted output is always NUL-terminated. | |
91 | * | |
92 | * E.g.: | |
c7909234 | 93 | * hex_dump_to_buffer(frame->data, frame->len, 16, 1, |
db0fd97c | 94 | * linebuf, sizeof(linebuf), true); |
99eaf3c4 RD |
95 | * |
96 | * example output buffer: | |
c7909234 | 97 | * 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO |
114fc1af AS |
98 | * |
99 | * Return: | |
100 | * The amount of bytes placed in the buffer without terminating NUL. If the | |
101 | * output was truncated, then the return value is the number of bytes | |
102 | * (excluding the terminating NUL) which would have been written to the final | |
103 | * string if enough space had been available. | |
99eaf3c4 | 104 | */ |
114fc1af AS |
105 | int hex_dump_to_buffer(const void *buf, size_t len, int rowsize, int groupsize, |
106 | char *linebuf, size_t linebuflen, bool ascii) | |
99eaf3c4 RD |
107 | { |
108 | const u8 *ptr = buf; | |
5d909c8d | 109 | int ngroups; |
99eaf3c4 RD |
110 | u8 ch; |
111 | int j, lx = 0; | |
c7909234 | 112 | int ascii_column; |
114fc1af | 113 | int ret; |
99eaf3c4 | 114 | |
c7909234 RD |
115 | if (rowsize != 16 && rowsize != 32) |
116 | rowsize = 16; | |
117 | ||
c7909234 RD |
118 | if (len > rowsize) /* limit to one line at a time */ |
119 | len = rowsize; | |
5d909c8d AS |
120 | if (!is_power_of_2(groupsize) || groupsize > 8) |
121 | groupsize = 1; | |
c7909234 RD |
122 | if ((len % groupsize) != 0) /* no mixed size output */ |
123 | groupsize = 1; | |
124 | ||
5d909c8d AS |
125 | ngroups = len / groupsize; |
126 | ascii_column = rowsize * 2 + rowsize / groupsize + 1; | |
114fc1af AS |
127 | |
128 | if (!linebuflen) | |
129 | goto overflow1; | |
130 | ||
131 | if (!len) | |
132 | goto nil; | |
133 | ||
5d909c8d | 134 | if (groupsize == 8) { |
c7909234 | 135 | const u64 *ptr8 = buf; |
c7909234 | 136 | |
114fc1af AS |
137 | for (j = 0; j < ngroups; j++) { |
138 | ret = snprintf(linebuf + lx, linebuflen - lx, | |
139 | "%s%16.16llx", j ? " " : "", | |
0f70fe60 | 140 | get_unaligned(ptr8 + j)); |
114fc1af AS |
141 | if (ret >= linebuflen - lx) |
142 | goto overflow1; | |
143 | lx += ret; | |
144 | } | |
5d909c8d | 145 | } else if (groupsize == 4) { |
c7909234 | 146 | const u32 *ptr4 = buf; |
c7909234 | 147 | |
114fc1af AS |
148 | for (j = 0; j < ngroups; j++) { |
149 | ret = snprintf(linebuf + lx, linebuflen - lx, | |
150 | "%s%8.8x", j ? " " : "", | |
0f70fe60 | 151 | get_unaligned(ptr4 + j)); |
114fc1af AS |
152 | if (ret >= linebuflen - lx) |
153 | goto overflow1; | |
154 | lx += ret; | |
155 | } | |
5d909c8d | 156 | } else if (groupsize == 2) { |
c7909234 | 157 | const u16 *ptr2 = buf; |
c7909234 | 158 | |
114fc1af AS |
159 | for (j = 0; j < ngroups; j++) { |
160 | ret = snprintf(linebuf + lx, linebuflen - lx, | |
161 | "%s%4.4x", j ? " " : "", | |
0f70fe60 | 162 | get_unaligned(ptr2 + j)); |
114fc1af AS |
163 | if (ret >= linebuflen - lx) |
164 | goto overflow1; | |
165 | lx += ret; | |
166 | } | |
5d909c8d | 167 | } else { |
114fc1af | 168 | for (j = 0; j < len; j++) { |
9f029f54 | 169 | if (linebuflen < lx + 2) |
114fc1af | 170 | goto overflow2; |
c7909234 | 171 | ch = ptr[j]; |
3fc95772 | 172 | linebuf[lx++] = hex_asc_hi(ch); |
9f029f54 AS |
173 | if (linebuflen < lx + 2) |
174 | goto overflow2; | |
3fc95772 | 175 | linebuf[lx++] = hex_asc_lo(ch); |
9f029f54 AS |
176 | if (linebuflen < lx + 2) |
177 | goto overflow2; | |
99eaf3c4 | 178 | linebuf[lx++] = ' '; |
c7909234 | 179 | } |
c67ae69b LZ |
180 | if (j) |
181 | lx--; | |
99eaf3c4 | 182 | } |
c7909234 RD |
183 | if (!ascii) |
184 | goto nil; | |
185 | ||
114fc1af AS |
186 | while (lx < ascii_column) { |
187 | if (linebuflen < lx + 2) | |
188 | goto overflow2; | |
99eaf3c4 | 189 | linebuf[lx++] = ' '; |
114fc1af AS |
190 | } |
191 | for (j = 0; j < len; j++) { | |
192 | if (linebuflen < lx + 2) | |
193 | goto overflow2; | |
db0fd97c JP |
194 | ch = ptr[j]; |
195 | linebuf[lx++] = (isascii(ch) && isprint(ch)) ? ch : '.'; | |
196 | } | |
c7909234 | 197 | nil: |
114fc1af AS |
198 | linebuf[lx] = '\0'; |
199 | return lx; | |
200 | overflow2: | |
99eaf3c4 | 201 | linebuf[lx++] = '\0'; |
114fc1af AS |
202 | overflow1: |
203 | return ascii ? ascii_column + len : (groupsize * 2 + 1) * ngroups - 1; | |
99eaf3c4 RD |
204 | } |
205 | EXPORT_SYMBOL(hex_dump_to_buffer); | |
206 | ||
ac83ed68 | 207 | #ifdef CONFIG_PRINTK |
99eaf3c4 RD |
208 | /** |
209 | * print_hex_dump - print a text hex dump to syslog for a binary blob of data | |
210 | * @level: kernel log level (e.g. KERN_DEBUG) | |
c7909234 RD |
211 | * @prefix_str: string to prefix each line with; |
212 | * caller supplies trailing spaces for alignment if desired | |
99eaf3c4 RD |
213 | * @prefix_type: controls whether prefix of an offset, address, or none |
214 | * is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE) | |
c7909234 RD |
215 | * @rowsize: number of bytes to print per line; must be 16 or 32 |
216 | * @groupsize: number of bytes to print at a time (1, 2, 4, 8; default = 1) | |
99eaf3c4 RD |
217 | * @buf: data blob to dump |
218 | * @len: number of bytes in the @buf | |
c7909234 | 219 | * @ascii: include ASCII after the hex output |
99eaf3c4 RD |
220 | * |
221 | * Given a buffer of u8 data, print_hex_dump() prints a hex + ASCII dump | |
222 | * to the kernel log at the specified kernel log level, with an optional | |
223 | * leading prefix. | |
224 | * | |
c7909234 RD |
225 | * print_hex_dump() works on one "line" of output at a time, i.e., |
226 | * 16 or 32 bytes of input data converted to hex + ASCII output. | |
227 | * print_hex_dump() iterates over the entire input @buf, breaking it into | |
228 | * "line size" chunks to format and print. | |
229 | * | |
99eaf3c4 | 230 | * E.g.: |
c7909234 | 231 | * print_hex_dump(KERN_DEBUG, "raw data: ", DUMP_PREFIX_ADDRESS, |
db0fd97c | 232 | * 16, 1, frame->data, frame->len, true); |
99eaf3c4 | 233 | * |
c7909234 RD |
234 | * Example output using %DUMP_PREFIX_OFFSET and 1-byte mode: |
235 | * 0009ab42: 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO | |
236 | * Example output using %DUMP_PREFIX_ADDRESS and 4-byte mode: | |
237 | * ffffffff88089af0: 73727170 77767574 7b7a7978 7f7e7d7c pqrstuvwxyz{|}~. | |
99eaf3c4 | 238 | */ |
c7909234 | 239 | void print_hex_dump(const char *level, const char *prefix_str, int prefix_type, |
db0fd97c JP |
240 | int rowsize, int groupsize, |
241 | const void *buf, size_t len, bool ascii) | |
99eaf3c4 | 242 | { |
6a0ed91e | 243 | const u8 *ptr = buf; |
99eaf3c4 | 244 | int i, linelen, remaining = len; |
db0fd97c | 245 | unsigned char linebuf[32 * 3 + 2 + 32 + 1]; |
99eaf3c4 | 246 | |
c7909234 RD |
247 | if (rowsize != 16 && rowsize != 32) |
248 | rowsize = 16; | |
249 | ||
250 | for (i = 0; i < len; i += rowsize) { | |
251 | linelen = min(remaining, rowsize); | |
252 | remaining -= rowsize; | |
db0fd97c | 253 | |
c7909234 | 254 | hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize, |
db0fd97c | 255 | linebuf, sizeof(linebuf), ascii); |
99eaf3c4 RD |
256 | |
257 | switch (prefix_type) { | |
258 | case DUMP_PREFIX_ADDRESS: | |
db0fd97c JP |
259 | printk("%s%s%p: %s\n", |
260 | level, prefix_str, ptr + i, linebuf); | |
99eaf3c4 RD |
261 | break; |
262 | case DUMP_PREFIX_OFFSET: | |
c7909234 | 263 | printk("%s%s%.8x: %s\n", level, prefix_str, i, linebuf); |
99eaf3c4 RD |
264 | break; |
265 | default: | |
c7909234 | 266 | printk("%s%s%s\n", level, prefix_str, linebuf); |
99eaf3c4 RD |
267 | break; |
268 | } | |
269 | } | |
270 | } | |
271 | EXPORT_SYMBOL(print_hex_dump); | |
c7909234 | 272 | |
7a555613 | 273 | #if !defined(CONFIG_DYNAMIC_DEBUG) |
c7909234 RD |
274 | /** |
275 | * print_hex_dump_bytes - shorthand form of print_hex_dump() with default params | |
276 | * @prefix_str: string to prefix each line with; | |
277 | * caller supplies trailing spaces for alignment if desired | |
278 | * @prefix_type: controls whether prefix of an offset, address, or none | |
279 | * is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE) | |
280 | * @buf: data blob to dump | |
281 | * @len: number of bytes in the @buf | |
282 | * | |
283 | * Calls print_hex_dump(), with log level of KERN_DEBUG, | |
284 | * rowsize of 16, groupsize of 1, and ASCII output included. | |
285 | */ | |
286 | void print_hex_dump_bytes(const char *prefix_str, int prefix_type, | |
db0fd97c | 287 | const void *buf, size_t len) |
c7909234 RD |
288 | { |
289 | print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, 16, 1, | |
db0fd97c | 290 | buf, len, true); |
c7909234 RD |
291 | } |
292 | EXPORT_SYMBOL(print_hex_dump_bytes); | |
7a555613 VK |
293 | #endif /* !defined(CONFIG_DYNAMIC_DEBUG) */ |
294 | #endif /* defined(CONFIG_PRINTK) */ |