xref: /freebsd/lib/libutil/hexdump.c (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
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/cdefs.h>
38 #include <sys/types.h>
39 #include <libutil.h>
40 #include <stdio.h>
41 
42 void
43 hexdump(const void *ptr, int length, const char *hdr, int flags)
44 {
45 	int i, j, k;
46 	int cols;
47 	const unsigned char *cp;
48 	char delim;
49 
50 	if ((flags & HD_DELIM_MASK) != 0)
51 		delim = (flags & HD_DELIM_MASK) >> 8;
52 	else
53 		delim = ' ';
54 
55 	if ((flags & HD_COLUMN_MASK) != 0)
56 		cols = flags & HD_COLUMN_MASK;
57 	else
58 		cols = 16;
59 
60 	cp = ptr;
61 	for (i = 0; i < length; i+= cols) {
62 		if (hdr != NULL)
63 			printf("%s", hdr);
64 
65 		if ((flags & HD_OMIT_COUNT) == 0)
66 			printf("%04x  ", i);
67 
68 		if ((flags & HD_OMIT_HEX) == 0) {
69 			for (j = 0; j < cols; j++) {
70 				k = i + j;
71 				if (k < length)
72 					printf("%c%02x", delim, cp[k]);
73 				else
74 					printf("   ");
75 			}
76 		}
77 
78 		if ((flags & HD_OMIT_CHARS) == 0) {
79 			printf("  |");
80 			for (j = 0; j < cols; j++) {
81 				k = i + j;
82 				if (k >= length)
83 					printf(" ");
84 				else if (cp[k] >= ' ' && cp[k] <= '~')
85 					printf("%c", cp[k]);
86 				else
87 					printf(".");
88 			}
89 			printf("|");
90 		}
91 		printf("\n");
92 	}
93 }
94 
95