Blame view
lib/hexdump.c
6.99 KB
99eaf3c45
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
/* * lib/hexdump.c * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 as * published by the Free Software Foundation. See README and COPYING for * more details. */ #include <linux/types.h> #include <linux/ctype.h> #include <linux/kernel.h> #include <linux/module.h> |
3fc957721
|
14 15 |
const char hex_asc[] = "0123456789abcdef"; EXPORT_SYMBOL(hex_asc); |
99eaf3c45
|
16 |
/** |
903788892
|
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
* 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
|
35 36 37 38 |
* hex2bin - convert an ascii hexadecimal string to its binary representation * @dst: binary result * @src: ascii hexadecimal string * @count: result length |
b78049831
|
39 40 |
* * Return 0 on success, -1 in case of bad input. |
dc88e4602
|
41 |
*/ |
b78049831
|
42 |
int hex2bin(u8 *dst, const char *src, size_t count) |
dc88e4602
|
43 44 |
{ while (count--) { |
b78049831
|
45 46 47 48 49 50 51 |
int hi = hex_to_bin(*src++); int lo = hex_to_bin(*src++); if ((hi < 0) || (lo < 0)) return -1; *dst++ = (hi << 4) | lo; |
dc88e4602
|
52 |
} |
b78049831
|
53 |
return 0; |
dc88e4602
|
54 55 56 57 |
} EXPORT_SYMBOL(hex2bin); /** |
99eaf3c45
|
58 59 60 |
* 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
|
61 62 |
* @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
|
63 64 |
* @linebuf: where to put the converted data * @linebuflen: total size of @linebuf, including space for terminating NUL |
c79092349
|
65 |
* @ascii: include ASCII after the hex output |
99eaf3c45
|
66 67 |
* * hex_dump_to_buffer() works on one "line" of output at a time, i.e., |
c79092349
|
68 |
* 16 or 32 bytes of input data converted to hex + ASCII output. |
99eaf3c45
|
69 70 71 72 73 74 |
* * 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
|
75 |
* hex_dump_to_buffer(frame->data, frame->len, 16, 1, |
db0fd97c2
|
76 |
* linebuf, sizeof(linebuf), true); |
99eaf3c45
|
77 78 |
* * example output buffer: |
c79092349
|
79 |
* 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO |
99eaf3c45
|
80 |
*/ |
c79092349
|
81 82 83 |
void hex_dump_to_buffer(const void *buf, size_t len, int rowsize, int groupsize, char *linebuf, size_t linebuflen, bool ascii) |
99eaf3c45
|
84 85 86 87 |
{ const u8 *ptr = buf; u8 ch; int j, lx = 0; |
c79092349
|
88 |
int ascii_column; |
99eaf3c45
|
89 |
|
c79092349
|
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
if (rowsize != 16 && rowsize != 32) rowsize = 16; if (!len) goto nil; if (len > rowsize) /* limit to one line at a time */ len = rowsize; if ((len % groupsize) != 0) /* no mixed size output */ groupsize = 1; switch (groupsize) { case 8: { const u64 *ptr8 = buf; int ngroups = len / groupsize; for (j = 0; j < ngroups; j++) lx += scnprintf(linebuf + lx, linebuflen - lx, |
db0fd97c2
|
107 108 |
"%s%16.16llx", j ? " " : "", (unsigned long long)*(ptr8 + j)); |
c79092349
|
109 110 111 112 113 114 115 116 117 118 |
ascii_column = 17 * ngroups + 2; break; } case 4: { const u32 *ptr4 = buf; int ngroups = len / groupsize; for (j = 0; j < ngroups; j++) lx += scnprintf(linebuf + lx, linebuflen - lx, |
db0fd97c2
|
119 |
"%s%8.8x", j ? " " : "", *(ptr4 + j)); |
c79092349
|
120 121 122 123 124 125 126 127 128 129 |
ascii_column = 9 * ngroups + 2; break; } case 2: { const u16 *ptr2 = buf; int ngroups = len / groupsize; for (j = 0; j < ngroups; j++) lx += scnprintf(linebuf + lx, linebuflen - lx, |
db0fd97c2
|
130 |
"%s%4.4x", j ? " " : "", *(ptr2 + j)); |
c79092349
|
131 132 133 134 135 |
ascii_column = 5 * ngroups + 2; break; } default: |
c67ae69b6
|
136 |
for (j = 0; (j < len) && (lx + 3) <= linebuflen; j++) { |
c79092349
|
137 |
ch = ptr[j]; |
3fc957721
|
138 139 |
linebuf[lx++] = hex_asc_hi(ch); linebuf[lx++] = hex_asc_lo(ch); |
99eaf3c45
|
140 |
linebuf[lx++] = ' '; |
c79092349
|
141 |
} |
c67ae69b6
|
142 143 |
if (j) lx--; |
c79092349
|
144 145 |
ascii_column = 3 * rowsize + 2; break; |
99eaf3c45
|
146 |
} |
c79092349
|
147 148 149 150 |
if (!ascii) goto nil; while (lx < (linebuflen - 1) && lx < (ascii_column - 1)) |
99eaf3c45
|
151 |
linebuf[lx++] = ' '; |
db0fd97c2
|
152 153 154 155 |
for (j = 0; (j < len) && (lx + 2) < linebuflen; j++) { ch = ptr[j]; linebuf[lx++] = (isascii(ch) && isprint(ch)) ? ch : '.'; } |
c79092349
|
156 |
nil: |
99eaf3c45
|
157 158 159 |
linebuf[lx++] = '\0'; } EXPORT_SYMBOL(hex_dump_to_buffer); |
ac83ed687
|
160 |
#ifdef CONFIG_PRINTK |
99eaf3c45
|
161 162 163 |
/** * 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
|
164 165 |
* @prefix_str: string to prefix each line with; * caller supplies trailing spaces for alignment if desired |
99eaf3c45
|
166 167 |
* @prefix_type: controls whether prefix of an offset, address, or none * is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE) |
c79092349
|
168 169 |
* @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
|
170 171 |
* @buf: data blob to dump * @len: number of bytes in the @buf |
c79092349
|
172 |
* @ascii: include ASCII after the hex output |
99eaf3c45
|
173 174 175 176 177 |
* * 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
|
178 179 180 181 182 |
* 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
|
183 |
* E.g.: |
c79092349
|
184 |
* print_hex_dump(KERN_DEBUG, "raw data: ", DUMP_PREFIX_ADDRESS, |
db0fd97c2
|
185 |
* 16, 1, frame->data, frame->len, true); |
99eaf3c45
|
186 |
* |
c79092349
|
187 188 189 190 |
* 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
|
191 |
*/ |
c79092349
|
192 |
void print_hex_dump(const char *level, const char *prefix_str, int prefix_type, |
db0fd97c2
|
193 194 |
int rowsize, int groupsize, const void *buf, size_t len, bool ascii) |
99eaf3c45
|
195 |
{ |
6a0ed91e3
|
196 |
const u8 *ptr = buf; |
99eaf3c45
|
197 |
int i, linelen, remaining = len; |
db0fd97c2
|
198 |
unsigned char linebuf[32 * 3 + 2 + 32 + 1]; |
99eaf3c45
|
199 |
|
c79092349
|
200 201 202 203 204 205 |
if (rowsize != 16 && rowsize != 32) rowsize = 16; for (i = 0; i < len; i += rowsize) { linelen = min(remaining, rowsize); remaining -= rowsize; |
db0fd97c2
|
206 |
|
c79092349
|
207 |
hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize, |
db0fd97c2
|
208 |
linebuf, sizeof(linebuf), ascii); |
99eaf3c45
|
209 210 211 |
switch (prefix_type) { case DUMP_PREFIX_ADDRESS: |
db0fd97c2
|
212 213 214 |
printk("%s%s%p: %s ", level, prefix_str, ptr + i, linebuf); |
99eaf3c45
|
215 216 |
break; case DUMP_PREFIX_OFFSET: |
c79092349
|
217 218 |
printk("%s%s%.8x: %s ", level, prefix_str, i, linebuf); |
99eaf3c45
|
219 220 |
break; default: |
c79092349
|
221 222 |
printk("%s%s%s ", level, prefix_str, linebuf); |
99eaf3c45
|
223 224 225 226 227 |
break; } } } EXPORT_SYMBOL(print_hex_dump); |
c79092349
|
228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
/** * print_hex_dump_bytes - shorthand form of print_hex_dump() with default params * @prefix_str: string to prefix each line with; * caller supplies trailing spaces for alignment if desired * @prefix_type: controls whether prefix of an offset, address, or none * is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE) * @buf: data blob to dump * @len: number of bytes in the @buf * * Calls print_hex_dump(), with log level of KERN_DEBUG, * rowsize of 16, groupsize of 1, and ASCII output included. */ void print_hex_dump_bytes(const char *prefix_str, int prefix_type, |
db0fd97c2
|
242 |
const void *buf, size_t len) |
c79092349
|
243 244 |
{ print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, 16, 1, |
db0fd97c2
|
245 |
buf, len, true); |
c79092349
|
246 247 |
} EXPORT_SYMBOL(print_hex_dump_bytes); |
ac83ed687
|
248 |
#endif |