Blame view

lib/hexdump.c 6.99 KB
99eaf3c45   Randy Dunlap   lib/hexdump
1
2
3
4
5
6
7
8
9
10
11
12
  /*
   * 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>
8bc3bcc93   Paul Gortmaker   lib: reduce the u...
13
  #include <linux/export.h>
99eaf3c45   Randy Dunlap   lib/hexdump
14

3fc957721   Harvey Harrison   lib: create commo...
15
16
  const char hex_asc[] = "0123456789abcdef";
  EXPORT_SYMBOL(hex_asc);
99eaf3c45   Randy Dunlap   lib/hexdump
17
  /**
903788892   Andy Shevchenko   lib: introduce co...
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
   * 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   Mimi Zohar   lib: hex2bin conv...
36
37
38
39
   * hex2bin - convert an ascii hexadecimal string to its binary representation
   * @dst: binary result
   * @src: ascii hexadecimal string
   * @count: result length
b78049831   Mimi Zohar   lib: add error ch...
40
41
   *
   * Return 0 on success, -1 in case of bad input.
dc88e4602   Mimi Zohar   lib: hex2bin conv...
42
   */
b78049831   Mimi Zohar   lib: add error ch...
43
  int hex2bin(u8 *dst, const char *src, size_t count)
dc88e4602   Mimi Zohar   lib: hex2bin conv...
44
45
  {
  	while (count--) {
b78049831   Mimi Zohar   lib: add error ch...
46
47
48
49
50
51
52
  		int hi = hex_to_bin(*src++);
  		int lo = hex_to_bin(*src++);
  
  		if ((hi < 0) || (lo < 0))
  			return -1;
  
  		*dst++ = (hi << 4) | lo;
dc88e4602   Mimi Zohar   lib: hex2bin conv...
53
  	}
b78049831   Mimi Zohar   lib: add error ch...
54
  	return 0;
dc88e4602   Mimi Zohar   lib: hex2bin conv...
55
56
57
58
  }
  EXPORT_SYMBOL(hex2bin);
  
  /**
99eaf3c45   Randy Dunlap   lib/hexdump
59
60
61
   * 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   Randy Dunlap   hexdump: more out...
62
63
   * @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   Randy Dunlap   lib/hexdump
64
65
   * @linebuf: where to put the converted data
   * @linebuflen: total size of @linebuf, including space for terminating NUL
c79092349   Randy Dunlap   hexdump: more out...
66
   * @ascii: include ASCII after the hex output
99eaf3c45   Randy Dunlap   lib/hexdump
67
68
   *
   * hex_dump_to_buffer() works on one "line" of output at a time, i.e.,
c79092349   Randy Dunlap   hexdump: more out...
69
   * 16 or 32 bytes of input data converted to hex + ASCII output.
99eaf3c45   Randy Dunlap   lib/hexdump
70
71
72
73
74
75
   *
   * 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   Randy Dunlap   hexdump: more out...
76
   *   hex_dump_to_buffer(frame->data, frame->len, 16, 1,
db0fd97c2   Joe Perches   lib/hexdump.c: re...
77
   *			linebuf, sizeof(linebuf), true);
99eaf3c45   Randy Dunlap   lib/hexdump
78
79
   *
   * example output buffer:
c79092349   Randy Dunlap   hexdump: more out...
80
   * 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f  @ABCDEFGHIJKLMNO
99eaf3c45   Randy Dunlap   lib/hexdump
81
   */
c79092349   Randy Dunlap   hexdump: more out...
82
83
84
  void hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
  			int groupsize, char *linebuf, size_t linebuflen,
  			bool ascii)
99eaf3c45   Randy Dunlap   lib/hexdump
85
86
87
88
  {
  	const u8 *ptr = buf;
  	u8 ch;
  	int j, lx = 0;
c79092349   Randy Dunlap   hexdump: more out...
89
  	int ascii_column;
99eaf3c45   Randy Dunlap   lib/hexdump
90

c79092349   Randy Dunlap   hexdump: more out...
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
  	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   Joe Perches   lib/hexdump.c: re...
108
109
  					"%s%16.16llx", j ? " " : "",
  					(unsigned long long)*(ptr8 + j));
c79092349   Randy Dunlap   hexdump: more out...
110
111
112
113
114
115
116
117
118
119
  		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   Joe Perches   lib/hexdump.c: re...
120
  					"%s%8.8x", j ? " " : "", *(ptr4 + j));
c79092349   Randy Dunlap   hexdump: more out...
121
122
123
124
125
126
127
128
129
130
  		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   Joe Perches   lib/hexdump.c: re...
131
  					"%s%4.4x", j ? " " : "", *(ptr2 + j));
c79092349   Randy Dunlap   hexdump: more out...
132
133
134
135
136
  		ascii_column = 5 * ngroups + 2;
  		break;
  	}
  
  	default:
c67ae69b6   Li Zefan   hexdump: remove t...
137
  		for (j = 0; (j < len) && (lx + 3) <= linebuflen; j++) {
c79092349   Randy Dunlap   hexdump: more out...
138
  			ch = ptr[j];
3fc957721   Harvey Harrison   lib: create commo...
139
140
  			linebuf[lx++] = hex_asc_hi(ch);
  			linebuf[lx++] = hex_asc_lo(ch);
99eaf3c45   Randy Dunlap   lib/hexdump
141
  			linebuf[lx++] = ' ';
c79092349   Randy Dunlap   hexdump: more out...
142
  		}
c67ae69b6   Li Zefan   hexdump: remove t...
143
144
  		if (j)
  			lx--;
c79092349   Randy Dunlap   hexdump: more out...
145
146
  		ascii_column = 3 * rowsize + 2;
  		break;
99eaf3c45   Randy Dunlap   lib/hexdump
147
  	}
c79092349   Randy Dunlap   hexdump: more out...
148
149
150
151
  	if (!ascii)
  		goto nil;
  
  	while (lx < (linebuflen - 1) && lx < (ascii_column - 1))
99eaf3c45   Randy Dunlap   lib/hexdump
152
  		linebuf[lx++] = ' ';
db0fd97c2   Joe Perches   lib/hexdump.c: re...
153
154
155
156
  	for (j = 0; (j < len) && (lx + 2) < linebuflen; j++) {
  		ch = ptr[j];
  		linebuf[lx++] = (isascii(ch) && isprint(ch)) ? ch : '.';
  	}
c79092349   Randy Dunlap   hexdump: more out...
157
  nil:
99eaf3c45   Randy Dunlap   lib/hexdump
158
159
160
  	linebuf[lx++] = '\0';
  }
  EXPORT_SYMBOL(hex_dump_to_buffer);
ac83ed687   Joe Perches   include/linux/pri...
161
  #ifdef CONFIG_PRINTK
99eaf3c45   Randy Dunlap   lib/hexdump
162
163
164
  /**
   * 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   Randy Dunlap   hexdump: more out...
165
166
   * @prefix_str: string to prefix each line with;
   *  caller supplies trailing spaces for alignment if desired
99eaf3c45   Randy Dunlap   lib/hexdump
167
168
   * @prefix_type: controls whether prefix of an offset, address, or none
   *  is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
c79092349   Randy Dunlap   hexdump: more out...
169
170
   * @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   Randy Dunlap   lib/hexdump
171
172
   * @buf: data blob to dump
   * @len: number of bytes in the @buf
c79092349   Randy Dunlap   hexdump: more out...
173
   * @ascii: include ASCII after the hex output
99eaf3c45   Randy Dunlap   lib/hexdump
174
175
176
177
178
   *
   * 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   Randy Dunlap   hexdump: more out...
179
180
181
182
183
   * 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   Randy Dunlap   lib/hexdump
184
   * E.g.:
c79092349   Randy Dunlap   hexdump: more out...
185
   *   print_hex_dump(KERN_DEBUG, "raw data: ", DUMP_PREFIX_ADDRESS,
db0fd97c2   Joe Perches   lib/hexdump.c: re...
186
   *		    16, 1, frame->data, frame->len, true);
99eaf3c45   Randy Dunlap   lib/hexdump
187
   *
c79092349   Randy Dunlap   hexdump: more out...
188
189
190
191
   * 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   Randy Dunlap   lib/hexdump
192
   */
c79092349   Randy Dunlap   hexdump: more out...
193
  void print_hex_dump(const char *level, const char *prefix_str, int prefix_type,
db0fd97c2   Joe Perches   lib/hexdump.c: re...
194
195
  		    int rowsize, int groupsize,
  		    const void *buf, size_t len, bool ascii)
99eaf3c45   Randy Dunlap   lib/hexdump
196
  {
6a0ed91e3   Artem Bityutskiy   hexdump: use cons...
197
  	const u8 *ptr = buf;
99eaf3c45   Randy Dunlap   lib/hexdump
198
  	int i, linelen, remaining = len;
db0fd97c2   Joe Perches   lib/hexdump.c: re...
199
  	unsigned char linebuf[32 * 3 + 2 + 32 + 1];
99eaf3c45   Randy Dunlap   lib/hexdump
200

c79092349   Randy Dunlap   hexdump: more out...
201
202
203
204
205
206
  	if (rowsize != 16 && rowsize != 32)
  		rowsize = 16;
  
  	for (i = 0; i < len; i += rowsize) {
  		linelen = min(remaining, rowsize);
  		remaining -= rowsize;
db0fd97c2   Joe Perches   lib/hexdump.c: re...
207

c79092349   Randy Dunlap   hexdump: more out...
208
  		hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
db0fd97c2   Joe Perches   lib/hexdump.c: re...
209
  				   linebuf, sizeof(linebuf), ascii);
99eaf3c45   Randy Dunlap   lib/hexdump
210
211
212
  
  		switch (prefix_type) {
  		case DUMP_PREFIX_ADDRESS:
db0fd97c2   Joe Perches   lib/hexdump.c: re...
213
214
215
  			printk("%s%s%p: %s
  ",
  			       level, prefix_str, ptr + i, linebuf);
99eaf3c45   Randy Dunlap   lib/hexdump
216
217
  			break;
  		case DUMP_PREFIX_OFFSET:
c79092349   Randy Dunlap   hexdump: more out...
218
219
  			printk("%s%s%.8x: %s
  ", level, prefix_str, i, linebuf);
99eaf3c45   Randy Dunlap   lib/hexdump
220
221
  			break;
  		default:
c79092349   Randy Dunlap   hexdump: more out...
222
223
  			printk("%s%s%s
  ", level, prefix_str, linebuf);
99eaf3c45   Randy Dunlap   lib/hexdump
224
225
226
227
228
  			break;
  		}
  	}
  }
  EXPORT_SYMBOL(print_hex_dump);
c79092349   Randy Dunlap   hexdump: more out...
229
230
231
232
233
234
235
236
237
238
239
240
241
242
  
  /**
   * 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   Joe Perches   lib/hexdump.c: re...
243
  			  const void *buf, size_t len)
c79092349   Randy Dunlap   hexdump: more out...
244
245
  {
  	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, 16, 1,
db0fd97c2   Joe Perches   lib/hexdump.c: re...
246
  		       buf, len, true);
c79092349   Randy Dunlap   hexdump: more out...
247
248
  }
  EXPORT_SYMBOL(print_hex_dump_bytes);
ac83ed687   Joe Perches   include/linux/pri...
249
  #endif