xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_debug.h (revision eb9a1df2aeb866bf1de4494433b6d7e5fa07b3ae)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2012, 2019 by Delphix. All rights reserved.
24  */
25 
26 #ifndef _SYS_ZFS_DEBUG_H
27 #define	_SYS_ZFS_DEBUG_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 #ifndef TRUE
34 #define	TRUE 1
35 #endif
36 
37 #ifndef FALSE
38 #define	FALSE 0
39 #endif
40 
41 /*
42  * ZFS debugging
43  */
44 
45 #if defined(DEBUG) || !defined(_KERNEL)
46 #define	ZFS_DEBUG
47 #endif
48 
49 extern int zfs_flags;
50 extern boolean_t zfs_recover;
51 extern boolean_t zfs_free_leak_on_eio;
52 
53 #define	ZFS_DEBUG_DPRINTF		(1 << 0)
54 #define	ZFS_DEBUG_DBUF_VERIFY		(1 << 1)
55 #define	ZFS_DEBUG_DNODE_VERIFY		(1 << 2)
56 #define	ZFS_DEBUG_SNAPNAMES		(1 << 3)
57 #define	ZFS_DEBUG_MODIFY		(1 << 4)
58 /* 1<<5 was previously used, try not to reuse */
59 #define	ZFS_DEBUG_ZIO_FREE		(1 << 6)
60 #define	ZFS_DEBUG_HISTOGRAM_VERIFY	(1 << 7)
61 #define	ZFS_DEBUG_METASLAB_VERIFY	(1 << 8)
62 #define	ZFS_DEBUG_INDIRECT_REMAP	(1 << 9)
63 #define	ZFS_DEBUG_TRIM			(1 << 11)
64 #define	ZFS_DEBUG_LOG_SPACEMAP		(1 << 12)
65 
66 #ifdef ZFS_DEBUG
67 extern void __dprintf(const char *file, const char *func,
68     int line, const char *fmt, ...);
69 #define	dprintf(...) \
70 	if (zfs_flags & ZFS_DEBUG_DPRINTF) \
71 		__dprintf(__FILE__, __func__, __LINE__, __VA_ARGS__)
72 #else
73 #define	dprintf(...) ((void)0)
74 #endif /* ZFS_DEBUG */
75 
76 extern void zfs_panic_recover(const char *fmt, ...);
77 
78 typedef struct zfs_dbgmsg {
79 	list_node_t zdm_node;
80 	time_t zdm_timestamp;
81 	char zdm_msg[1]; /* variable length allocation */
82 } zfs_dbgmsg_t;
83 
84 extern void zfs_dbgmsg_init(void);
85 extern void zfs_dbgmsg_fini(void);
86 extern void zfs_dbgmsg(const char *fmt, ...);
87 extern void zfs_dbgmsg_print(const char *tag);
88 
89 #ifndef _KERNEL
90 extern int dprintf_find_string(const char *string);
91 #endif
92 
93 #ifdef	__cplusplus
94 }
95 #endif
96 
97 #endif	/* _SYS_ZFS_DEBUG_H */
98