Home | History | Annotate | Line # | Download | only in linux
printk.h revision 1.11 
      1 /*	$NetBSD: printk.h,v 1.11 2021/12/19 11:38:37 riastradh 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 #include <linux/export.h>
     38 
     39 #define	printk		printf
     40 #define	vprintk		vprintf
     41 #define	printk_once	printf
     42 #define	pr_err		printf	/* XXX */
     43 #define	pr_cont		printf	/* XXX */
     44 #define	pr_info		printf	/* XXX */
     45 #define	pr_info_once	printf	/* XXX */
     46 #define	pr_info_ratelimited	printf	/* XXX */
     47 #define	pr_warn		printf	/* XXX */
     48 #define	pr_warn_once	printf	/* XXX */
     49 #define	pr_notice	printf	/* XXX */
     50 #define	pr_debug	printf	/* XXX */
     51 #define	KERN_EMERG	"kern emerg: "
     52 #define	KERN_ALERT	"kern alert: "
     53 #define	KERN_CRIT	"kern crit: "
     54 #define	KERN_ERR	"kern error: "
     55 #define	KERN_WARNING	"kern warning: "
     56 #define	KERN_NOTICE	"kern notice: "
     57 #define	KERN_INFO	"kern info: "
     58 #define	KERN_DEBUG	"kern debug: "
     59 #define	KERN_CONT	""
     60 
     61 struct va_format {
     62 	const char	*fmt;
     63 	va_list		*va;
     64 };
     65 
     66 #define	DUMP_PREFIX_NONE	0
     67 #define	DUMP_PREFIX_OFFSET	1
     68 #define	DUMP_PREFIX_ADDRESS	2
     69 
     70 static inline size_t
     71 hex_dump_to_buffer(const void *buf, size_t buf_size, int bytes_per_line,
     72     int bytes_per_group, char *output, size_t output_size, bool ascii __unused)
     73 {
     74 	const uint8_t *bytes = buf;
     75 	int i = 0, t = 0, n;
     76 
     77 	KASSERT(output_size >= 1);
     78 	KASSERT((bytes_per_line == 16) || (bytes_per_line == 32));
     79 	KASSERT(powerof2(bytes_per_group));
     80 	KASSERT(0 < bytes_per_group);
     81 	KASSERT(bytes_per_group <= 8);
     82 
     83 	output[output_size - 1] = '\0';
     84 	while (i < buf_size) {
     85 		n = snprintf(output, output_size, "%02x", bytes[i++]);
     86 		t += n;
     87 		if (n >= output_size)
     88 			break;
     89 		output += n; output_size -= n;
     90 		if ((i == buf_size) || (0 == (i % bytes_per_line)))
     91 			n = snprintf(output, output_size, "\n");
     92 		else if ((0 < i) && (0 == (i % bytes_per_group)))
     93 			n = snprintf(output, output_size, " ");
     94 		else
     95 			n = 0;
     96 		t += n;
     97 		if (n >= output_size)
     98 			break;
     99 		output += n; output_size -= n;
    100 	}
    101 
    102 	return t;
    103 }
    104 
    105 static inline void
    106 print_hex_dump(const char *level, const char *prefix, int prefix_type,
    107     int bytes_per_line, int bytes_per_group, const void *buf, size_t buf_size,
    108     bool ascii)
    109 {
    110 	const uint8_t *bytes = buf;
    111 	/* Two digits and one space/newline per byte, plus a null.  */
    112 	char line[32*3 + 1];
    113 
    114 	KASSERT((bytes_per_line == 16) || (bytes_per_line == 32));
    115 	KASSERT(powerof2(bytes_per_group));
    116 	KASSERT(0 < bytes_per_group);
    117 	KASSERT(bytes_per_group <= 8);
    118 
    119 	while (0 < buf_size) {
    120 		const size_t n = MIN(buf_size, 32);
    121 
    122 		switch (prefix_type) {
    123 		case DUMP_PREFIX_OFFSET:
    124 			printf("%08zu: ", (bytes - (const uint8_t *)buf));
    125 			break;
    126 
    127 		case DUMP_PREFIX_ADDRESS:
    128 			printf("%p: ", bytes);
    129 			break;
    130 
    131 		case DUMP_PREFIX_NONE:
    132 		default:
    133 			break;
    134 		}
    135 
    136 		hex_dump_to_buffer(bytes, n, bytes_per_line, bytes_per_group,
    137 		    line, sizeof(line), ascii);
    138 		KASSERT(0 < strnlen(line, sizeof(line)));
    139 		KASSERT(line[strnlen(line, sizeof(line)) - 1] == '\n');
    140 		printf("%s", line);
    141 
    142 		bytes += n;
    143 		buf_size -= n;
    144 	}
    145 }
    146 
    147 #endif  /* _LINUX_PRINTK_H_ */
    148