aboutsummaryrefslogtreecommitdiffstats
path: root/include/sys/zfs_debug.h
blob: 41e8c08a15fe78f02da17523cb706a2f93ac2f1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2012 by Delphix. All rights reserved.
 */

#ifndef _SYS_ZFS_DEBUG_H
#define	_SYS_ZFS_DEBUG_H

#ifdef	__cplusplus
extern "C" {
#endif

#ifndef TRUE
#define	TRUE 1
#endif

#ifndef FALSE
#define	FALSE 0
#endif

/*
 * ZFS debugging - Always enabled for user space builds.
 */

#if !defined(ZFS_DEBUG) && !defined(_KERNEL)
#define	ZFS_DEBUG
#endif

extern int zfs_flags;
extern int zfs_recover;

#define	ZFS_DEBUG_DPRINTF	(1<<0)
#define	ZFS_DEBUG_DBUF_VERIFY	(1<<1)
#define	ZFS_DEBUG_DNODE_VERIFY	(1<<2)
#define	ZFS_DEBUG_SNAPNAMES	(1<<3)
#define	ZFS_DEBUG_MODIFY	(1<<4)
#define	ZFS_DEBUG_SPA		(1<<5)
#define	ZFS_DEBUG_ZIO_FREE	(1<<6)

/*
 * Always log zfs debug messages to the spl debug subsystem as SS_USER1.
 * When the SPL is configured with debugging enabled these messages will
 * appear in the internal spl debug log, otherwise they are a no-op.
 */
#if defined(_KERNEL)

#include <spl-debug.h>
#define	dprintf(...)                                                   \
	if (zfs_flags & ZFS_DEBUG_DPRINTF)                             \
		__SDEBUG(NULL, SS_USER1, SD_DPRINTF, __VA_ARGS__)

/*
 * When zfs is running is user space the debugging is always enabled.
 * The messages will be printed using the __dprintf() function and
 * filtered based on the zfs_flags variable.
 */
#else
#define dprintf(...)                                                   \
	if (zfs_flags & ZFS_DEBUG_DPRINTF)                             \
		__dprintf(__FILE__, __func__, __LINE__, __VA_ARGS__)

#endif /* _KERNEL */

extern void zfs_panic_recover(const char *fmt, ...);

typedef struct zfs_dbgmsg {
	list_node_t zdm_node;
	time_t zdm_timestamp;
	char zdm_msg[1]; /* variable length allocation */
} zfs_dbgmsg_t;

extern void zfs_dbgmsg_init(void);
extern void zfs_dbgmsg_fini(void);
#if defined(_KERNEL) && defined(__linux__)
#define        zfs_dbgmsg(...) dprintf(__VA_ARGS__)
#else
extern void zfs_dbgmsg(const char *fmt, ...);
#endif

#ifndef _KERNEL
extern int dprintf_find_string(const char *string);
#endif

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_ZFS_DEBUG_H */