Home | History | Annotate | Line # | Download | only in linux
printk.h revision 1.5 
      1 /*	$NetBSD: printk.h,v 1.5 2018/08/28 08:48:42 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_CRIT	"kern crit: "
     49 #define	KERN_ERR	"kern error: "
     50 #define	KERN_WARNING	"kern warning: "
     51 #define	KERN_INFO	"kern info: "
     52 #define	KERN_DEBUG	"kern debug: "
     53 #define	KERN_CONT	""
     54 
     55 #define	DUMP_PREFIX_NONE	0
     56 #define	DUMP_PREFIX_OFFSET	1
     57 #define	DUMP_PREFIX_ADDRESS	2
     58 
     59 static inline void
     60 hex_dump_to_buffer(const void *buf, size_t buf_size, int bytes_per_line,
     61     int bytes_per_group, char *output, size_t output_size, bool ascii __unused)
     62 {
     63 	const uint8_t *bytes = buf;
     64 	size_t i = 0, n;
     65 
     66 	KASSERT(output_size >= 1);
     67 	KASSERT((bytes_per_line == 16) || (bytes_per_line == 32));
     68 	KASSERT(powerof2(bytes_per_group));
     69 	KASSERT(0 < bytes_per_group);
     70 	KASSERT(bytes_per_group <= 8);
     71 
     72 	output[output_size - 1] = '\0';
     73 	while (i < buf_size) {
     74 		n = snprintf(output, output_size, "%02x", bytes[i++]);
     75 		if (n >= output_size)
     76 			break;
     77 		output += n; output_size -= n;
     78 		if ((i == buf_size) || (0 == (i % bytes_per_line)))
     79 			n = snprintf(output, output_size, "\n");
     80 		else if ((0 < i) && (0 == (i % bytes_per_group)))
     81 			n = snprintf(output, output_size, " ");
     82 		else
     83 			n = 0;
     84 		if (n >= output_size)
     85 			break;
     86 		output += n; output_size -= n;
     87 	}
     88 }
     89 
     90 static inline void
     91 print_hex_dump(const char *level, const char *prefix, int prefix_type,
     92     int bytes_per_line, int bytes_per_group, const void *buf, size_t buf_size,
     93     bool ascii)
     94 {
     95 	const uint8_t *bytes = buf;
     96 	/* Two digits and one space/newline per byte, plus a null.  */
     97 	char line[32*3 + 1];
     98 
     99 	KASSERT((bytes_per_line == 16) || (bytes_per_line == 32));
    100 	KASSERT(powerof2(bytes_per_group));
    101 	KASSERT(0 < bytes_per_group);
    102 	KASSERT(bytes_per_group <= 8);
    103 
    104 	while (0 < buf_size) {
    105 		const size_t n = MIN(buf_size, 32);
    106 
    107 		switch (prefix_type) {
    108 		case DUMP_PREFIX_OFFSET:
    109 			printf("%08zu: ", (bytes - (const uint8_t *)buf));
    110 			break;
    111 
    112 		case DUMP_PREFIX_ADDRESS:
    113 			printf("%p: ", bytes);
    114 			break;
    115 
    116 		case DUMP_PREFIX_NONE:
    117 		default:
    118 			break;
    119 		}
    120 
    121 		hex_dump_to_buffer(bytes, n, bytes_per_line, bytes_per_group,
    122 		    line, sizeof(line), ascii);
    123 		KASSERT(0 < strnlen(line, sizeof(line)));
    124 		KASSERT(line[strnlen(line, sizeof(line)) - 1] == '\n');
    125 		printf("%s", line);
    126 
    127 		bytes += n;
    128 		buf_size -= n;
    129 	}
    130 }
    131 
    132 #endif  /* _LINUX_PRINTK_H_ */
    133