xref: /freebsd/lib/libutil/hexdump.c (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1986, 1988, 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  * (c) UNIX System Laboratories, Inc.
7  * All or some portions of this file are derived from material licensed
8  * to the University of California by American Telephone and Telegraph
9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10  * the permission of UNIX System Laboratories, Inc.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #include <sys/types.h>
38 #include <libutil.h>
39 #include <stdio.h>
40 
41 void
42 hexdump(const void *ptr, int length, const char *hdr, int flags)
43 {
44 	int i, j, k;
45 	int cols;
46 	const unsigned char *cp;
47 	char delim;
48 
49 	if ((flags & HD_DELIM_MASK) != 0)
50 		delim = (flags & HD_DELIM_MASK) >> 8;
51 	else
52 		delim = ' ';
53 
54 	if ((flags & HD_COLUMN_MASK) != 0)
55 		cols = flags & HD_COLUMN_MASK;
56 	else
57 		cols = 16;
58 
59 	cp = ptr;
60 	for (i = 0; i < length; i+= cols) {
61 		if (hdr != NULL)
62 			printf("%s", hdr);
63 
64 		if ((flags & HD_OMIT_COUNT) == 0)
65 			printf("%04x  ", i);
66 
67 		if ((flags & HD_OMIT_HEX) == 0) {
68 			for (j = 0; j < cols; j++) {
69 				k = i + j;
70 				if (k < length)
71 					printf("%c%02x", delim, cp[k]);
72 				else
73 					printf("   ");
74 			}
75 		}
76 
77 		if ((flags & HD_OMIT_CHARS) == 0) {
78 			printf("  |");
79 			for (j = 0; j < cols; j++) {
80 				k = i + j;
81 				if (k >= length)
82 					printf(" ");
83 				else if (cp[k] >= ' ' && cp[k] <= '~')
84 					printf("%c", cp[k]);
85 				else
86 					printf(".");
87 			}
88 			printf("|");
89 		}
90 		printf("\n");
91 	}
92 }
93 
94