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  * Copyright (c) 2013 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 - Always enabled for user space builds.
  43  */
  44
  45 #if !defined(ZFS_DEBUG) && !defined(_KERNEL)
  46 #define ZFS_DEBUG
  47 #endif
  48
  49 extern int zfs_flags;
  50 extern int zfs_recover;
  51
  52 #define ZFS_DEBUG_DPRINTF       (1<<0)
  53 #define ZFS_DEBUG_DBUF_VERIFY   (1<<1)
  54 #define ZFS_DEBUG_DNODE_VERIFY  (1<<2)
  55 #define ZFS_DEBUG_SNAPNAMES     (1<<3)
  56 #define ZFS_DEBUG_MODIFY        (1<<4)
  57 #define ZFS_DEBUG_SPA           (1<<5)
  58 #define ZFS_DEBUG_ZIO_FREE      (1<<6)
  59
  60 /*
  61  * Always log zfs debug messages to the spl debug subsystem as SS_USER1.
  62  * When the SPL is configured with debugging enabled these messages will
  63  * appear in the internal spl debug log, otherwise they are a no-op.
  64  */
  65 #if defined(_KERNEL)
  66
  67 #include <spl-debug.h>
  68 #define dprintf(...)                                                   \
  69         if (zfs_flags & ZFS_DEBUG_DPRINTF)                             \
  70                 __SDEBUG(NULL, SS_USER1, SD_DPRINTF, __VA_ARGS__)
  71
  72 /*
  73  * When zfs is running is user space the debugging is always enabled.
  74  * The messages will be printed using the __dprintf() function and
  75  * filtered based on the zfs_flags variable.
  76  */
  77 #else
  78 #define dprintf(...)                                                   \
  79         if (zfs_flags & ZFS_DEBUG_DPRINTF)                             \
  80                 __dprintf(__FILE__, __func__, __LINE__, __VA_ARGS__)
  81
  82 #endif /* _KERNEL */
  83
  84 extern void zfs_panic_recover(const char *fmt, ...);
  85
  86 typedef struct zfs_dbgmsg {
  87         list_node_t zdm_node;
  88         time_t zdm_timestamp;
  89         char zdm_msg[1]; /* variable length allocation */
  90 } zfs_dbgmsg_t;
  91
  92 extern void zfs_dbgmsg_init(void);
  93 extern void zfs_dbgmsg_fini(void);
  94 #if defined(_KERNEL) && defined(__linux__)
  95 #define zfs_dbgmsg(...) dprintf(__VA_ARGS__)
  96 #else
  97 extern void zfs_dbgmsg(const char *fmt, ...);
  98 extern void zfs_dbgmsg_print(const char *tag);
  99 #endif
 100
 101 #ifndef _KERNEL
 102 extern int dprintf_find_string(const char *string);
 103 #endif
 104
 105 #ifdef  __cplusplus
 106 }
 107 #endif
 108
 109 #endif  /* _SYS_ZFS_DEBUG_H */