blob: 9301578f98e8c6d4acb49df297aa5c47b590ea8b [file] [log] [blame]
Thomas Gleixner21042e42019-06-04 10:11:34 +02001// SPDX-License-Identifier: GPL-2.0-only
Randy Dunlap99eaf3c2007-05-10 22:22:39 -07002/*
3 * lib/hexdump.c
Randy Dunlap99eaf3c2007-05-10 22:22:39 -07004 */
5
6#include <linux/types.h>
7#include <linux/ctype.h>
Andy Shevchenko9888a582017-09-08 16:15:28 -07008#include <linux/errno.h>
Randy Dunlap99eaf3c2007-05-10 22:22:39 -07009#include <linux/kernel.h>
Andy Shevchenkob296a6d2020-10-15 20:10:21 -070010#include <linux/minmax.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050011#include <linux/export.h>
Horacio Mijail Anton Quiles0f70fe62015-07-17 16:24:04 -070012#include <asm/unaligned.h>
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070013
Harvey Harrison3fc95772008-05-14 16:05:49 -070014const char hex_asc[] = "0123456789abcdef";
15EXPORT_SYMBOL(hex_asc);
Andre Naujoksc26d4362013-09-13 19:37:12 +020016const char hex_asc_upper[] = "0123456789ABCDEF";
17EXPORT_SYMBOL(hex_asc_upper);
Harvey Harrison3fc95772008-05-14 16:05:49 -070018
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070019/**
Andy Shevchenko903788892010-05-24 14:33:23 -070020 * hex_to_bin - convert a hex digit to its real value
21 * @ch: ascii character represents hex digit
22 *
23 * hex_to_bin() converts one hex digit to its actual value or -1 in case of bad
24 * input.
25 */
26int hex_to_bin(char ch)
27{
28 if ((ch >= '0') && (ch <= '9'))
29 return ch - '0';
30 ch = tolower(ch);
31 if ((ch >= 'a') && (ch <= 'f'))
32 return ch - 'a' + 10;
33 return -1;
34}
35EXPORT_SYMBOL(hex_to_bin);
36
37/**
Mimi Zohardc88e462010-11-23 17:50:31 -050038 * hex2bin - convert an ascii hexadecimal string to its binary representation
39 * @dst: binary result
40 * @src: ascii hexadecimal string
41 * @count: result length
Mimi Zoharb7804982011-09-20 11:23:49 -040042 *
Andy Shevchenko9888a582017-09-08 16:15:28 -070043 * Return 0 on success, -EINVAL in case of bad input.
Mimi Zohardc88e462010-11-23 17:50:31 -050044 */
Mimi Zoharb7804982011-09-20 11:23:49 -040045int hex2bin(u8 *dst, const char *src, size_t count)
Mimi Zohardc88e462010-11-23 17:50:31 -050046{
47 while (count--) {
Mimi Zoharb7804982011-09-20 11:23:49 -040048 int hi = hex_to_bin(*src++);
49 int lo = hex_to_bin(*src++);
50
51 if ((hi < 0) || (lo < 0))
Andy Shevchenko9888a582017-09-08 16:15:28 -070052 return -EINVAL;
Mimi Zoharb7804982011-09-20 11:23:49 -040053
54 *dst++ = (hi << 4) | lo;
Mimi Zohardc88e462010-11-23 17:50:31 -050055 }
Mimi Zoharb7804982011-09-20 11:23:49 -040056 return 0;
Mimi Zohardc88e462010-11-23 17:50:31 -050057}
58EXPORT_SYMBOL(hex2bin);
59
60/**
David Howells53d91c52014-09-16 17:36:01 +010061 * bin2hex - convert binary data to an ascii hexadecimal string
62 * @dst: ascii hexadecimal result
63 * @src: binary data
64 * @count: binary data length
65 */
66char *bin2hex(char *dst, const void *src, size_t count)
67{
68 const unsigned char *_src = src;
69
70 while (count--)
71 dst = hex_byte_pack(dst, *_src++);
72 return dst;
73}
74EXPORT_SYMBOL(bin2hex);
75
76/**
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070077 * hex_dump_to_buffer - convert a blob of data to "hex ASCII" in memory
78 * @buf: data blob to dump
79 * @len: number of bytes in the @buf
Randy Dunlapc7909232007-06-08 13:47:04 -070080 * @rowsize: number of bytes to print per line; must be 16 or 32
81 * @groupsize: number of bytes to print at a time (1, 2, 4, 8; default = 1)
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070082 * @linebuf: where to put the converted data
83 * @linebuflen: total size of @linebuf, including space for terminating NUL
Randy Dunlapc7909232007-06-08 13:47:04 -070084 * @ascii: include ASCII after the hex output
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070085 *
86 * hex_dump_to_buffer() works on one "line" of output at a time, i.e.,
Randy Dunlapc7909232007-06-08 13:47:04 -070087 * 16 or 32 bytes of input data converted to hex + ASCII output.
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070088 *
89 * Given a buffer of u8 data, hex_dump_to_buffer() converts the input data
90 * to a hex + ASCII dump at the supplied memory location.
91 * The converted output is always NUL-terminated.
92 *
93 * E.g.:
Randy Dunlapc7909232007-06-08 13:47:04 -070094 * hex_dump_to_buffer(frame->data, frame->len, 16, 1,
Joe Perchesdb0fd972010-05-24 14:33:22 -070095 * linebuf, sizeof(linebuf), true);
Randy Dunlap99eaf3c2007-05-10 22:22:39 -070096 *
97 * example output buffer:
Randy Dunlapc7909232007-06-08 13:47:04 -070098 * 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO
Andy Shevchenko114fc1a2015-02-12 15:02:29 -080099 *
100 * Return:
101 * The amount of bytes placed in the buffer without terminating NUL. If the
102 * output was truncated, then the return value is the number of bytes
103 * (excluding the terminating NUL) which would have been written to the final
104 * string if enough space had been available.
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700105 */
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800106int hex_dump_to_buffer(const void *buf, size_t len, int rowsize, int groupsize,
107 char *linebuf, size_t linebuflen, bool ascii)
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700108{
109 const u8 *ptr = buf;
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800110 int ngroups;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700111 u8 ch;
112 int j, lx = 0;
Randy Dunlapc7909232007-06-08 13:47:04 -0700113 int ascii_column;
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800114 int ret;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700115
Randy Dunlapc7909232007-06-08 13:47:04 -0700116 if (rowsize != 16 && rowsize != 32)
117 rowsize = 16;
118
Randy Dunlapc7909232007-06-08 13:47:04 -0700119 if (len > rowsize) /* limit to one line at a time */
120 len = rowsize;
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800121 if (!is_power_of_2(groupsize) || groupsize > 8)
122 groupsize = 1;
Randy Dunlapc7909232007-06-08 13:47:04 -0700123 if ((len % groupsize) != 0) /* no mixed size output */
124 groupsize = 1;
125
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800126 ngroups = len / groupsize;
127 ascii_column = rowsize * 2 + rowsize / groupsize + 1;
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800128
129 if (!linebuflen)
130 goto overflow1;
131
132 if (!len)
133 goto nil;
134
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800135 if (groupsize == 8) {
Randy Dunlapc7909232007-06-08 13:47:04 -0700136 const u64 *ptr8 = buf;
Randy Dunlapc7909232007-06-08 13:47:04 -0700137
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800138 for (j = 0; j < ngroups; j++) {
139 ret = snprintf(linebuf + lx, linebuflen - lx,
140 "%s%16.16llx", j ? " " : "",
Horacio Mijail Anton Quiles0f70fe62015-07-17 16:24:04 -0700141 get_unaligned(ptr8 + j));
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800142 if (ret >= linebuflen - lx)
143 goto overflow1;
144 lx += ret;
145 }
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800146 } else if (groupsize == 4) {
Randy Dunlapc7909232007-06-08 13:47:04 -0700147 const u32 *ptr4 = buf;
Randy Dunlapc7909232007-06-08 13:47:04 -0700148
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800149 for (j = 0; j < ngroups; j++) {
150 ret = snprintf(linebuf + lx, linebuflen - lx,
151 "%s%8.8x", j ? " " : "",
Horacio Mijail Anton Quiles0f70fe62015-07-17 16:24:04 -0700152 get_unaligned(ptr4 + j));
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800153 if (ret >= linebuflen - lx)
154 goto overflow1;
155 lx += ret;
156 }
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800157 } else if (groupsize == 2) {
Randy Dunlapc7909232007-06-08 13:47:04 -0700158 const u16 *ptr2 = buf;
Randy Dunlapc7909232007-06-08 13:47:04 -0700159
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800160 for (j = 0; j < ngroups; j++) {
161 ret = snprintf(linebuf + lx, linebuflen - lx,
162 "%s%4.4x", j ? " " : "",
Horacio Mijail Anton Quiles0f70fe62015-07-17 16:24:04 -0700163 get_unaligned(ptr2 + j));
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800164 if (ret >= linebuflen - lx)
165 goto overflow1;
166 lx += ret;
167 }
Andy Shevchenko5d909c82015-02-12 15:02:26 -0800168 } else {
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800169 for (j = 0; j < len; j++) {
Andy Shevchenko9f029f52015-11-06 16:31:31 -0800170 if (linebuflen < lx + 2)
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800171 goto overflow2;
Randy Dunlapc7909232007-06-08 13:47:04 -0700172 ch = ptr[j];
Harvey Harrison3fc95772008-05-14 16:05:49 -0700173 linebuf[lx++] = hex_asc_hi(ch);
Andy Shevchenko9f029f52015-11-06 16:31:31 -0800174 if (linebuflen < lx + 2)
175 goto overflow2;
Harvey Harrison3fc95772008-05-14 16:05:49 -0700176 linebuf[lx++] = hex_asc_lo(ch);
Andy Shevchenko9f029f52015-11-06 16:31:31 -0800177 if (linebuflen < lx + 2)
178 goto overflow2;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700179 linebuf[lx++] = ' ';
Randy Dunlapc7909232007-06-08 13:47:04 -0700180 }
Li Zefanc67ae692009-06-16 15:33:45 -0700181 if (j)
182 lx--;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700183 }
Randy Dunlapc7909232007-06-08 13:47:04 -0700184 if (!ascii)
185 goto nil;
186
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800187 while (lx < ascii_column) {
188 if (linebuflen < lx + 2)
189 goto overflow2;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700190 linebuf[lx++] = ' ';
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800191 }
192 for (j = 0; j < len; j++) {
193 if (linebuflen < lx + 2)
194 goto overflow2;
Joe Perchesdb0fd972010-05-24 14:33:22 -0700195 ch = ptr[j];
196 linebuf[lx++] = (isascii(ch) && isprint(ch)) ? ch : '.';
197 }
Randy Dunlapc7909232007-06-08 13:47:04 -0700198nil:
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800199 linebuf[lx] = '\0';
200 return lx;
201overflow2:
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700202 linebuf[lx++] = '\0';
Andy Shevchenko114fc1a2015-02-12 15:02:29 -0800203overflow1:
204 return ascii ? ascii_column + len : (groupsize * 2 + 1) * ngroups - 1;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700205}
206EXPORT_SYMBOL(hex_dump_to_buffer);
207
Joe Perchesac83ed62011-01-12 16:59:47 -0800208#ifdef CONFIG_PRINTK
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700209/**
210 * print_hex_dump - print a text hex dump to syslog for a binary blob of data
211 * @level: kernel log level (e.g. KERN_DEBUG)
Randy Dunlapc7909232007-06-08 13:47:04 -0700212 * @prefix_str: string to prefix each line with;
213 * caller supplies trailing spaces for alignment if desired
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700214 * @prefix_type: controls whether prefix of an offset, address, or none
215 * is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
Randy Dunlapc7909232007-06-08 13:47:04 -0700216 * @rowsize: number of bytes to print per line; must be 16 or 32
217 * @groupsize: number of bytes to print at a time (1, 2, 4, 8; default = 1)
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700218 * @buf: data blob to dump
219 * @len: number of bytes in the @buf
Randy Dunlapc7909232007-06-08 13:47:04 -0700220 * @ascii: include ASCII after the hex output
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700221 *
222 * Given a buffer of u8 data, print_hex_dump() prints a hex + ASCII dump
223 * to the kernel log at the specified kernel log level, with an optional
224 * leading prefix.
225 *
Randy Dunlapc7909232007-06-08 13:47:04 -0700226 * print_hex_dump() works on one "line" of output at a time, i.e.,
227 * 16 or 32 bytes of input data converted to hex + ASCII output.
228 * print_hex_dump() iterates over the entire input @buf, breaking it into
229 * "line size" chunks to format and print.
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700230 *
Randy Dunlapc7909232007-06-08 13:47:04 -0700231 * E.g.:
232 * print_hex_dump(KERN_DEBUG, "raw data: ", DUMP_PREFIX_ADDRESS,
Joe Perchesdb0fd972010-05-24 14:33:22 -0700233 * 16, 1, frame->data, frame->len, true);
Randy Dunlapc7909232007-06-08 13:47:04 -0700234 *
235 * Example output using %DUMP_PREFIX_OFFSET and 1-byte mode:
236 * 0009ab42: 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO
237 * Example output using %DUMP_PREFIX_ADDRESS and 4-byte mode:
238 * ffffffff88089af0: 73727170 77767574 7b7a7978 7f7e7d7c pqrstuvwxyz{|}~.
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700239 */
Randy Dunlapc7909232007-06-08 13:47:04 -0700240void print_hex_dump(const char *level, const char *prefix_str, int prefix_type,
Joe Perchesdb0fd972010-05-24 14:33:22 -0700241 int rowsize, int groupsize,
242 const void *buf, size_t len, bool ascii)
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700243{
Artem Bityutskiy6a0ed912007-08-07 23:43:14 +0300244 const u8 *ptr = buf;
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700245 int i, linelen, remaining = len;
Joe Perchesdb0fd972010-05-24 14:33:22 -0700246 unsigned char linebuf[32 * 3 + 2 + 32 + 1];
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700247
Randy Dunlapc7909232007-06-08 13:47:04 -0700248 if (rowsize != 16 && rowsize != 32)
249 rowsize = 16;
250
251 for (i = 0; i < len; i += rowsize) {
252 linelen = min(remaining, rowsize);
253 remaining -= rowsize;
Joe Perchesdb0fd972010-05-24 14:33:22 -0700254
Randy Dunlapc7909232007-06-08 13:47:04 -0700255 hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
Joe Perchesdb0fd972010-05-24 14:33:22 -0700256 linebuf, sizeof(linebuf), ascii);
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700257
258 switch (prefix_type) {
259 case DUMP_PREFIX_ADDRESS:
Joe Perchesdb0fd972010-05-24 14:33:22 -0700260 printk("%s%s%p: %s\n",
261 level, prefix_str, ptr + i, linebuf);
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700262 break;
263 case DUMP_PREFIX_OFFSET:
Randy Dunlapc7909232007-06-08 13:47:04 -0700264 printk("%s%s%.8x: %s\n", level, prefix_str, i, linebuf);
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700265 break;
266 default:
Randy Dunlapc7909232007-06-08 13:47:04 -0700267 printk("%s%s%s\n", level, prefix_str, linebuf);
Randy Dunlap99eaf3c2007-05-10 22:22:39 -0700268 break;
269 }
270 }
271}
272EXPORT_SYMBOL(print_hex_dump);
Randy Dunlapc7909232007-06-08 13:47:04 -0700273
Vladimir Kondratiev7a555612012-12-05 16:48:27 -0500274#endif /* defined(CONFIG_PRINTK) */