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 https://opensource.org/licenses/CDDL-1.0.
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
30extern "C" {
31#endif
32
33#ifndef TRUE
34#define	TRUE 1
35#endif
36
37#ifndef FALSE
38#define	FALSE 0
39#endif
40
41extern int zfs_flags;
42extern int zfs_recover;
43extern int zfs_free_leak_on_eio;
44extern int zfs_dbgmsg_enable;
45
46#define	ZFS_DEBUG_DPRINTF		(1 << 0)
47#define	ZFS_DEBUG_DBUF_VERIFY		(1 << 1)
48#define	ZFS_DEBUG_DNODE_VERIFY		(1 << 2)
49#define	ZFS_DEBUG_SNAPNAMES		(1 << 3)
50#define	ZFS_DEBUG_MODIFY		(1 << 4)
51/* 1<<5 was previously used, try not to reuse */
52#define	ZFS_DEBUG_ZIO_FREE		(1 << 6)
53#define	ZFS_DEBUG_HISTOGRAM_VERIFY	(1 << 7)
54#define	ZFS_DEBUG_METASLAB_VERIFY	(1 << 8)
55#define	ZFS_DEBUG_SET_ERROR		(1 << 9)
56#define	ZFS_DEBUG_INDIRECT_REMAP	(1 << 10)
57#define	ZFS_DEBUG_TRIM			(1 << 11)
58#define	ZFS_DEBUG_LOG_SPACEMAP		(1 << 12)
59#define	ZFS_DEBUG_METASLAB_ALLOC	(1 << 13)
60#define	ZFS_DEBUG_BRT			(1 << 14)
61#define	ZFS_DEBUG_RAIDZ_RECONSTRUCT	(1 << 15)
62
63extern void __set_error(const char *file, const char *func, int line, int err);
64extern void __zfs_dbgmsg(char *buf);
65extern void __dprintf(boolean_t dprint, const char *file, const char *func,
66    int line, const char *fmt, ...)  __attribute__((format(printf, 5, 6)));
67
68/*
69 * Some general principles for using zfs_dbgmsg():
70 * 1. We don't want to pollute the log with typically-irrelevant messages,
71 *    so don't print too many messages in the "normal" code path - O(1)
72 *    per txg.
73 * 2. We want to know for sure what happened, so make the message specific
74 *    (e.g. *which* thing am I operating on).
75 * 3. Do print a message when something unusual or unexpected happens
76 *    (e.g. error cases).
77 * 4. Print a message when making user-initiated on-disk changes.
78 *
79 * Note that besides principle 1, another reason that we don't want to
80 * use zfs_dbgmsg in high-frequency routines is the potential impact
81 * that it can have on performance.
82 */
83#define	zfs_dbgmsg(...) \
84	if (zfs_dbgmsg_enable) \
85		__dprintf(B_FALSE, __FILE__, __func__, __LINE__, __VA_ARGS__)
86
87#ifdef ZFS_DEBUG
88/*
89 * To enable this:
90 *
91 * $ echo 1 >/sys/module/zfs/parameters/zfs_flags
92 */
93#define	dprintf(...) \
94	if (zfs_flags & ZFS_DEBUG_DPRINTF) \
95		__dprintf(B_TRUE, __FILE__, __func__, __LINE__, __VA_ARGS__)
96#else
97#define	dprintf(...) ((void)0)
98#endif /* ZFS_DEBUG */
99
100extern void zfs_panic_recover(const char *fmt, ...);
101
102extern void zfs_dbgmsg_init(void);
103extern void zfs_dbgmsg_fini(void);
104
105#ifndef _KERNEL
106extern int dprintf_find_string(const char *string);
107extern void zfs_dbgmsg_print(int fd, const char *tag);
108#endif
109
110#ifdef	__cplusplus
111}
112#endif
113
114#endif	/* _SYS_ZFS_DEBUG_H */
115