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