[mirror_ubuntu-artful-kernel.git] / lib / hexdump.c

/*
 * 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>

const char hex_asc[] = "0123456789abcdef";
EXPORT_SYMBOL(hex_asc);

/**
 * 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
 * @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)
 * @linebuf: where to put the converted data
 * @linebuflen: total size of @linebuf, including space for terminating NUL
 * @ascii: include ASCII after the hex output
 *
 * hex_dump_to_buffer() works on one "line" of output at a time, i.e.,
 * 16 or 32 bytes of input data converted to hex + ASCII output.
 *
 * 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.:
 *   hex_dump_to_buffer(frame->data, frame->len, 16, 1,
 *			linebuf, sizeof(linebuf), 1);
 *
 * example output buffer:
 * 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f  @ABCDEFGHIJKLMNO
 */
void hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
			int groupsize, char *linebuf, size_t linebuflen,
			bool ascii)
{
	const u8 *ptr = buf;
	u8 ch;
	int j, lx = 0;
	int ascii_column;

	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,
				"%16.16llx ", (unsigned long long)*(ptr8 + j));
		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,
				"%8.8x ", *(ptr4 + j));
		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,
				"%4.4x ", *(ptr2 + j));
		ascii_column = 5 * ngroups + 2;
		break;
	}

	default:
		for (j = 0; (j < rowsize) && (j < len) && (lx + 4) < linebuflen;
		     j++) {
			ch = ptr[j];
			linebuf[lx++] = hex_asc_hi(ch);
			linebuf[lx++] = hex_asc_lo(ch);
			linebuf[lx++] = ' ';
		}
		ascii_column = 3 * rowsize + 2;
		break;
	}
	if (!ascii)
		goto nil;

	while (lx < (linebuflen - 1) && lx < (ascii_column - 1))
		linebuf[lx++] = ' ';
	for (j = 0; (j < rowsize) && (j < len) && (lx + 2) < linebuflen; j++)
		linebuf[lx++] = (isascii(ptr[j]) && isprint(ptr[j])) ? ptr[j]
				: '.';
nil:
	linebuf[lx++] = '\0';
}
EXPORT_SYMBOL(hex_dump_to_buffer);

/**
 * print_hex_dump - print a text hex dump to syslog for a binary blob of data
 * @level: kernel log level (e.g. KERN_DEBUG)
 * @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)
 * @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)
 * @buf: data blob to dump
 * @len: number of bytes in the @buf
 * @ascii: include ASCII after the hex output
 *
 * 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.
 *
 * 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.
 *
 * E.g.:
 *   print_hex_dump(KERN_DEBUG, "raw data: ", DUMP_PREFIX_ADDRESS,
 *		16, 1, frame->data, frame->len, 1);
 *
 * 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{|}~.
 */
void print_hex_dump(const char *level, const char *prefix_str, int prefix_type,
			int rowsize, int groupsize,
			const void *buf, size_t len, bool ascii)
{
	const u8 *ptr = buf;
	int i, linelen, remaining = len;
	unsigned char linebuf[200];

	if (rowsize != 16 && rowsize != 32)
		rowsize = 16;

	for (i = 0; i < len; i += rowsize) {
		linelen = min(remaining, rowsize);
		remaining -= rowsize;
		hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
				linebuf, sizeof(linebuf), ascii);

		switch (prefix_type) {
		case DUMP_PREFIX_ADDRESS:
			printk("%s%s%*p: %s\n", level, prefix_str,
				(int)(2 * sizeof(void *)), ptr + i, linebuf);
			break;
		case DUMP_PREFIX_OFFSET:
			printk("%s%s%.8x: %s\n", level, prefix_str, i, linebuf);
			break;
		default:
			printk("%s%s%s\n", level, prefix_str, linebuf);
			break;
		}
	}
}
EXPORT_SYMBOL(print_hex_dump);

/**
 * 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,
			const void *buf, size_t len)
{
	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, 16, 1,
			buf, len, 1);
}
EXPORT_SYMBOL(print_hex_dump_bytes);
Commit	Line	Data
99eaf3c4 RD	1	/*
	2	* lib/hexdump.c
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2 as
	6	* published by the Free Software Foundation. See README and COPYING for
	7	* more details.
	8	*/
	9
	10	#include <linux/types.h>
	11	#include <linux/ctype.h>
	12	#include <linux/kernel.h>
	13	#include <linux/module.h>
	14
3fc95772 HH	15	const char hex_asc[] = "0123456789abcdef";
	16	EXPORT_SYMBOL(hex_asc);
	17
99eaf3c4 RD	18	/**
	19	* hex_dump_to_buffer - convert a blob of data to "hex ASCII" in memory
	20	* @buf: data blob to dump
	21	* @len: number of bytes in the @buf
c7909234 RD	22	* @rowsize: number of bytes to print per line; must be 16 or 32
c7909234 RD	23	* @groupsize: number of bytes to print at a time (1, 2, 4, 8; default = 1)
99eaf3c4 RD	24	* @linebuf: where to put the converted data
99eaf3c4 RD	25	* @linebuflen: total size of @linebuf, including space for terminating NUL
c7909234	26	* @ascii: include ASCII after the hex output
99eaf3c4 RD	27	*
99eaf3c4 RD	28	* hex_dump_to_buffer() works on one "line" of output at a time, i.e.,
c7909234	29	* 16 or 32 bytes of input data converted to hex + ASCII output.
99eaf3c4 RD	30	*
	31	* Given a buffer of u8 data, hex_dump_to_buffer() converts the input data
	32	* to a hex + ASCII dump at the supplied memory location.
	33	* The converted output is always NUL-terminated.
	34	*
	35	* E.g.:
c7909234 RD	36	* hex_dump_to_buffer(frame->data, frame->len, 16, 1,
c7909234 RD	37	* linebuf, sizeof(linebuf), 1);
99eaf3c4 RD	38	*
99eaf3c4 RD	39	* example output buffer:
c7909234	40	* 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO
99eaf3c4	41	*/
c7909234 RD	42	void hex_dump_to_buffer(const void *buf, size_t len, int rowsize,
	43	int groupsize, char *linebuf, size_t linebuflen,
	44	bool ascii)
99eaf3c4 RD	45	{
	46	const u8 *ptr = buf;
	47	u8 ch;
	48	int j, lx = 0;
c7909234	49	int ascii_column;
99eaf3c4	50
c7909234 RD	51	if (rowsize != 16 && rowsize != 32)
	52	rowsize = 16;
	53
	54	if (!len)
	55	goto nil;
	56	if (len > rowsize) /* limit to one line at a time */
	57	len = rowsize;
	58	if ((len % groupsize) != 0) /* no mixed size output */
	59	groupsize = 1;
	60
	61	switch (groupsize) {
	62	case 8: {
	63	const u64 *ptr8 = buf;
	64	int ngroups = len / groupsize;
	65
	66	for (j = 0; j < ngroups; j++)
	67	lx += scnprintf(linebuf + lx, linebuflen - lx,
	68	"%16.16llx ", (unsigned long long)*(ptr8 + j));
	69	ascii_column = 17 * ngroups + 2;
	70	break;
	71	}
	72
	73	case 4: {
	74	const u32 *ptr4 = buf;
	75	int ngroups = len / groupsize;
	76
	77	for (j = 0; j < ngroups; j++)
	78	lx += scnprintf(linebuf + lx, linebuflen - lx,
	79	"%8.8x ", *(ptr4 + j));
	80	ascii_column = 9 * ngroups + 2;
	81	break;
	82	}
	83
	84	case 2: {
	85	const u16 *ptr2 = buf;
	86	int ngroups = len / groupsize;
	87
	88	for (j = 0; j < ngroups; j++)
	89	lx += scnprintf(linebuf + lx, linebuflen - lx,
	90	"%4.4x ", *(ptr2 + j));
	91	ascii_column = 5 * ngroups + 2;
	92	break;
	93	}
	94
	95	default:
	96	for (j = 0; (j < rowsize) && (j < len) && (lx + 4) < linebuflen;
	97	j++) {
	98	ch = ptr[j];
3fc95772 HH	99	linebuf[lx++] = hex_asc_hi(ch);
3fc95772 HH	100	linebuf[lx++] = hex_asc_lo(ch);
99eaf3c4	101	linebuf[lx++] = ' ';
c7909234 RD	102	}
	103	ascii_column = 3 * rowsize + 2;
	104	break;
99eaf3c4	105	}
c7909234 RD	106	if (!ascii)
	107	goto nil;
	108
	109	while (lx < (linebuflen - 1) && lx < (ascii_column - 1))
99eaf3c4	110	linebuf[lx++] = ' ';
c7909234	111	for (j = 0; (j < rowsize) && (j < len) && (lx + 2) < linebuflen; j++)
d0eec99c RD	112	linebuf[lx++] = (isascii(ptr[j]) && isprint(ptr[j])) ? ptr[j]
d0eec99c RD	113	: '.';
c7909234	114	nil:
99eaf3c4 RD	115	linebuf[lx++] = '\0';
	116	}
	117	EXPORT_SYMBOL(hex_dump_to_buffer);
	118
	119	/**
	120	* print_hex_dump - print a text hex dump to syslog for a binary blob of data
	121	* @level: kernel log level (e.g. KERN_DEBUG)
c7909234 RD	122	* @prefix_str: string to prefix each line with;
c7909234 RD	123	* caller supplies trailing spaces for alignment if desired
99eaf3c4 RD	124	* @prefix_type: controls whether prefix of an offset, address, or none
99eaf3c4 RD	125	* is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
c7909234 RD	126	* @rowsize: number of bytes to print per line; must be 16 or 32
c7909234 RD	127	* @groupsize: number of bytes to print at a time (1, 2, 4, 8; default = 1)
99eaf3c4 RD	128	* @buf: data blob to dump
99eaf3c4 RD	129	* @len: number of bytes in the @buf
c7909234	130	* @ascii: include ASCII after the hex output
99eaf3c4 RD	131	*
	132	* Given a buffer of u8 data, print_hex_dump() prints a hex + ASCII dump
	133	* to the kernel log at the specified kernel log level, with an optional
	134	* leading prefix.
	135	*
c7909234 RD	136	* print_hex_dump() works on one "line" of output at a time, i.e.,
	137	* 16 or 32 bytes of input data converted to hex + ASCII output.
	138	* print_hex_dump() iterates over the entire input @buf, breaking it into
	139	* "line size" chunks to format and print.
	140	*
99eaf3c4	141	* E.g.:
c7909234 RD	142	* print_hex_dump(KERN_DEBUG, "raw data: ", DUMP_PREFIX_ADDRESS,
c7909234 RD	143	* 16, 1, frame->data, frame->len, 1);
99eaf3c4	144	*
c7909234 RD	145	* Example output using %DUMP_PREFIX_OFFSET and 1-byte mode:
	146	* 0009ab42: 40 41 42 43 44 45 46 47 48 49 4a 4b 4c 4d 4e 4f @ABCDEFGHIJKLMNO
	147	* Example output using %DUMP_PREFIX_ADDRESS and 4-byte mode:
	148	* ffffffff88089af0: 73727170 77767574 7b7a7978 7f7e7d7c pqrstuvwxyz{\|}~.
99eaf3c4	149	*/
c7909234 RD	150	void print_hex_dump(const char level, const char prefix_str, int prefix_type,
c7909234 RD	151	int rowsize, int groupsize,
6a0ed91e	152	const void *buf, size_t len, bool ascii)
99eaf3c4	153	{
6a0ed91e	154	const u8 *ptr = buf;
99eaf3c4	155	int i, linelen, remaining = len;
c7909234	156	unsigned char linebuf[200];
99eaf3c4	157
c7909234 RD	158	if (rowsize != 16 && rowsize != 32)
	159	rowsize = 16;
	160
	161	for (i = 0; i < len; i += rowsize) {
	162	linelen = min(remaining, rowsize);
	163	remaining -= rowsize;
	164	hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
	165	linebuf, sizeof(linebuf), ascii);
99eaf3c4 RD	166
	167	switch (prefix_type) {
	168	case DUMP_PREFIX_ADDRESS:
c7909234	169	printk("%s%s%*p: %s\n", level, prefix_str,
99eaf3c4 RD	170	(int)(2 * sizeof(void *)), ptr + i, linebuf);
	171	break;
	172	case DUMP_PREFIX_OFFSET:
c7909234	173	printk("%s%s%.8x: %s\n", level, prefix_str, i, linebuf);
99eaf3c4 RD	174	break;
99eaf3c4 RD	175	default:
c7909234	176	printk("%s%s%s\n", level, prefix_str, linebuf);
99eaf3c4 RD	177	break;
	178	}
	179	}
	180	}
	181	EXPORT_SYMBOL(print_hex_dump);
c7909234 RD	182
	183	/**
	184	* print_hex_dump_bytes - shorthand form of print_hex_dump() with default params
	185	* @prefix_str: string to prefix each line with;
	186	* caller supplies trailing spaces for alignment if desired
	187	* @prefix_type: controls whether prefix of an offset, address, or none
	188	* is printed (%DUMP_PREFIX_OFFSET, %DUMP_PREFIX_ADDRESS, %DUMP_PREFIX_NONE)
	189	* @buf: data blob to dump
	190	* @len: number of bytes in the @buf
	191	*
	192	* Calls print_hex_dump(), with log level of KERN_DEBUG,
	193	* rowsize of 16, groupsize of 1, and ASCII output included.
	194	*/
	195	void print_hex_dump_bytes(const char *prefix_str, int prefix_type,
eb9a9a56	196	const void *buf, size_t len)
c7909234 RD	197	{
	198	print_hex_dump(KERN_DEBUG, prefix_str, prefix_type, 16, 1,
	199	buf, len, 1);
	200	}
	201	EXPORT_SYMBOL(print_hex_dump_bytes);