xref: /netbsd-src/sys/external/bsd/common/include/linux/printk.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: printk.h,v 1.6 2018/08/28 08:50:46 skrll Exp $	*/
2 
3 /*-
4  * Copyright (c) 2013 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Taylor R. Campbell.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef _LINUX_PRINTK_H_
33 #define _LINUX_PRINTK_H_
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 
38 #define	printk		printf
39 #define	vprintk		vprintf
40 #define	printk_once	printf
41 #define	pr_err		printf	/* XXX */
42 #define	pr_cont		printf	/* XXX */
43 #define	pr_info		printf	/* XXX */
44 #define	pr_info_once	printf	/* XXX */
45 #define	pr_warn_once	printf	/* XXX */
46 #define	pr_notice	printf	/* XXX */
47 #define	pr_debug	printf	/* XXX */
48 #define	KERN_EMERG	"kern emerg: "
49 #define	KERN_ALERT	"kern alert: "
50 #define	KERN_CRIT	"kern crit: "
51 #define	KERN_ERR	"kern error: "
52 #define	KERN_WARNING	"kern warning: "
53 #define	KERN_NOTICE	"kern notice: "
54 #define	KERN_INFO	"kern info: "
55 #define	KERN_DEBUG	"kern debug: "
56 #define	KERN_CONT	""
57 
58 #define	DUMP_PREFIX_NONE	0
59 #define	DUMP_PREFIX_OFFSET	1
60 #define	DUMP_PREFIX_ADDRESS	2
61 
62 static inline void
63 hex_dump_to_buffer(const void *buf, size_t buf_size, int bytes_per_line,
64     int bytes_per_group, char *output, size_t output_size, bool ascii __unused)
65 {
66 	const uint8_t *bytes = buf;
67 	size_t i = 0, n;
68 
69 	KASSERT(output_size >= 1);
70 	KASSERT((bytes_per_line == 16) || (bytes_per_line == 32));
71 	KASSERT(powerof2(bytes_per_group));
72 	KASSERT(0 < bytes_per_group);
73 	KASSERT(bytes_per_group <= 8);
74 
75 	output[output_size - 1] = '\0';
76 	while (i < buf_size) {
77 		n = snprintf(output, output_size, "%02x", bytes[i++]);
78 		if (n >= output_size)
79 			break;
80 		output += n; output_size -= n;
81 		if ((i == buf_size) || (0 == (i % bytes_per_line)))
82 			n = snprintf(output, output_size, "\n");
83 		else if ((0 < i) && (0 == (i % bytes_per_group)))
84 			n = snprintf(output, output_size, " ");
85 		else
86 			n = 0;
87 		if (n >= output_size)
88 			break;
89 		output += n; output_size -= n;
90 	}
91 }
92 
93 static inline void
94 print_hex_dump(const char *level, const char *prefix, int prefix_type,
95     int bytes_per_line, int bytes_per_group, const void *buf, size_t buf_size,
96     bool ascii)
97 {
98 	const uint8_t *bytes = buf;
99 	/* Two digits and one space/newline per byte, plus a null.  */
100 	char line[32*3 + 1];
101 
102 	KASSERT((bytes_per_line == 16) || (bytes_per_line == 32));
103 	KASSERT(powerof2(bytes_per_group));
104 	KASSERT(0 < bytes_per_group);
105 	KASSERT(bytes_per_group <= 8);
106 
107 	while (0 < buf_size) {
108 		const size_t n = MIN(buf_size, 32);
109 
110 		switch (prefix_type) {
111 		case DUMP_PREFIX_OFFSET:
112 			printf("%08zu: ", (bytes - (const uint8_t *)buf));
113 			break;
114 
115 		case DUMP_PREFIX_ADDRESS:
116 			printf("%p: ", bytes);
117 			break;
118 
119 		case DUMP_PREFIX_NONE:
120 		default:
121 			break;
122 		}
123 
124 		hex_dump_to_buffer(bytes, n, bytes_per_line, bytes_per_group,
125 		    line, sizeof(line), ascii);
126 		KASSERT(0 < strnlen(line, sizeof(line)));
127 		KASSERT(line[strnlen(line, sizeof(line)) - 1] == '\n');
128 		printf("%s", line);
129 
130 		bytes += n;
131 		buf_size -= n;
132 	}
133 }
134 
135 #endif  /* _LINUX_PRINTK_H_ */
136