include/sys/zfs_debug.h

   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  */
  24
  25 #ifndef _SYS_ZFS_DEBUG_H
  26 #define _SYS_ZFS_DEBUG_H
  27
  28 #ifndef TRUE
  29 #define TRUE 1
  30 #endif
  31
  32 #ifndef FALSE
  33 #define FALSE 0
  34 #endif
  35
  36 /*
  37  * ZFS debugging - Always enabled for user space builds.
  38  */
  39 #if defined(DEBUG) || !defined(_KERNEL)
  40 #define ZFS_DEBUG
  41 #endif
  42
  43 extern int zfs_flags;
  44 extern int zfs_recover;
  45
  46 #define ZFS_DEBUG_DPRINTF       0x0001
  47 #define ZFS_DEBUG_DBUF_VERIFY   0x0002
  48 #define ZFS_DEBUG_DNODE_VERIFY  0x0004
  49 #define ZFS_DEBUG_SNAPNAMES     0x0008
  50 #define ZFS_DEBUG_MODIFY        0x0010
  51
  52 /*
  53  * Always log zfs debug messages to the spl debug subsystem as SS_USER1.
  54  * When the SPL is configured with debugging enabled these messages will
  55  * appear in the internal spl debug log, otherwise they are a no-op.
  56  */
  57 #if defined(_KERNEL)
  58
  59 #include <spl-debug.h>
  60 #define dprintf(...)                                                   \
  61         if (zfs_flags & ZFS_DEBUG_DPRINTF)                             \
  62                 __SDEBUG(NULL, SS_USER1, SD_DPRINTF, __VA_ARGS__)
  63
  64 /*
  65  * When zfs is running is user space the debugging is always enabled.
  66  * The messages will be printed using the __dprintf() function and
  67  * filtered based on the zfs_flags variable.
  68  */
  69 #else
  70 #define dprintf(...)                                                   \
  71         if (zfs_flags & ZFS_DEBUG_DPRINTF)                             \
  72                 __dprintf(__FILE__, __func__, __LINE__, __VA_ARGS__)
  73
  74 #endif /* _KERNEL */
  75
  76 void zfs_panic_recover(const char *fmt, ...);
  77 #define zfs_dbgmsg(...) dprintf(__VA_ARGS__)
  78 void zfs_dbgmsg_init(void);
  79 void zfs_dbgmsg_fini(void);
  80
  81 #endif  /* _SYS_ZFS_DEBUG_H */