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.
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.
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]
22 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
26 #include <sys/zfs_context.h>
27 #include <sys/kstat.h>
30 int zfs_dbgmsg_size
= 0;
31 kmutex_t zfs_dbgmsgs_lock
;
32 int zfs_dbgmsg_maxsize
= 4<<20; /* 4MB */
33 kstat_t
*zfs_dbgmsg_kstat
;
36 * Internal ZFS debug messages are enabled by default.
38 * # Print debug messages
39 * cat /proc/spl/kstat/zfs/dbgmsg
41 * # Disable the kernel debug message log.
42 * echo 0 > /sys/module/zfs/parameters/zfs_dbgmsg_enable
44 * # Clear the kernel debug message log.
45 * echo 0 >/proc/spl/kstat/zfs/dbgmsg
47 int zfs_dbgmsg_enable
= 1;
50 zfs_dbgmsg_headers(char *buf
, size_t size
)
52 (void) snprintf(buf
, size
, "%-12s %-8s\n", "timestamp", "message");
58 zfs_dbgmsg_data(char *buf
, size_t size
, void *data
)
60 zfs_dbgmsg_t
*zdm
= (zfs_dbgmsg_t
*)data
;
62 (void) snprintf(buf
, size
, "%-12llu %-s\n",
63 (u_longlong_t
)zdm
->zdm_timestamp
, zdm
->zdm_msg
);
69 zfs_dbgmsg_addr(kstat_t
*ksp
, loff_t n
)
71 zfs_dbgmsg_t
*zdm
= (zfs_dbgmsg_t
*)ksp
->ks_private
;
73 ASSERT(MUTEX_HELD(&zfs_dbgmsgs_lock
));
76 ksp
->ks_private
= list_head(&zfs_dbgmsgs
);
78 ksp
->ks_private
= list_next(&zfs_dbgmsgs
, zdm
);
80 return (ksp
->ks_private
);
84 zfs_dbgmsg_purge(int max_size
)
89 ASSERT(MUTEX_HELD(&zfs_dbgmsgs_lock
));
91 while (zfs_dbgmsg_size
> max_size
) {
92 zdm
= list_remove_head(&zfs_dbgmsgs
);
98 zfs_dbgmsg_size
-= size
;
103 zfs_dbgmsg_update(kstat_t
*ksp
, int rw
)
105 if (rw
== KSTAT_WRITE
)
112 zfs_dbgmsg_init(void)
114 list_create(&zfs_dbgmsgs
, sizeof (zfs_dbgmsg_t
),
115 offsetof(zfs_dbgmsg_t
, zdm_node
));
116 mutex_init(&zfs_dbgmsgs_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
118 zfs_dbgmsg_kstat
= kstat_create("zfs", 0, "dbgmsg", "misc",
119 KSTAT_TYPE_RAW
, 0, KSTAT_FLAG_VIRTUAL
);
120 if (zfs_dbgmsg_kstat
) {
121 zfs_dbgmsg_kstat
->ks_lock
= &zfs_dbgmsgs_lock
;
122 zfs_dbgmsg_kstat
->ks_ndata
= UINT32_MAX
;
123 zfs_dbgmsg_kstat
->ks_private
= NULL
;
124 zfs_dbgmsg_kstat
->ks_update
= zfs_dbgmsg_update
;
125 kstat_set_raw_ops(zfs_dbgmsg_kstat
, zfs_dbgmsg_headers
,
126 zfs_dbgmsg_data
, zfs_dbgmsg_addr
);
127 kstat_install(zfs_dbgmsg_kstat
);
132 zfs_dbgmsg_fini(void)
134 if (zfs_dbgmsg_kstat
)
135 kstat_delete(zfs_dbgmsg_kstat
);
137 mutex_enter(&zfs_dbgmsgs_lock
);
139 mutex_exit(&zfs_dbgmsgs_lock
);
140 mutex_destroy(&zfs_dbgmsgs_lock
);
144 __zfs_dbgmsg(char *buf
)
149 size
= sizeof (zfs_dbgmsg_t
) + strlen(buf
);
150 zdm
= kmem_zalloc(size
, KM_SLEEP
);
151 zdm
->zdm_size
= size
;
152 zdm
->zdm_timestamp
= gethrestime_sec();
153 strcpy(zdm
->zdm_msg
, buf
);
155 mutex_enter(&zfs_dbgmsgs_lock
);
156 list_insert_tail(&zfs_dbgmsgs
, zdm
);
157 zfs_dbgmsg_size
+= size
;
158 zfs_dbgmsg_purge(MAX(zfs_dbgmsg_maxsize
, 0));
159 mutex_exit(&zfs_dbgmsgs_lock
);
163 __set_error(const char *file
, const char *func
, int line
, int err
)
168 * $ echo 512 >/sys/module/zfs/parameters/zfs_flags
170 if (zfs_flags
& ZFS_DEBUG_SET_ERROR
)
171 __dprintf(file
, func
, line
, "error %lu", err
);
176 __dprintf(const char *file
, const char *func
, int line
, const char *fmt
, ...)
186 buf
= kmem_alloc(size
, KM_SLEEP
);
189 * Get rid of annoying prefix to filename.
191 newfile
= strrchr(file
, '/');
192 if (newfile
!= NULL
) {
193 newfile
= newfile
+ 1; /* Get rid of leading / */
198 i
= snprintf(buf
, size
, "%s:%d:%s(): ", newfile
, line
, func
);
202 (void) vsnprintf(buf
+ i
, size
- i
, fmt
, adx
);
207 * Get rid of trailing newline.
209 nl
= strrchr(buf
, '\n');
214 * To get this data enable the zfs__dprintf trace point as shown:
216 * # Enable zfs__dprintf tracepoint, clear the tracepoint ring buffer
217 * $ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable
218 * $ echo 0 > /sys/kernel/debug/tracing/trace
220 * # Dump the ring buffer.
221 * $ cat /sys/kernel/debug/tracing/trace
223 DTRACE_PROBE1(zfs__dprintf
, char *, buf
);
228 * $ cat /proc/spl/kstat/zfs/dbgmsg
230 * To clear the buffer:
231 * $ echo 0 > /proc/spl/kstat/zfs/dbgmsg
235 kmem_free(buf
, size
);
241 zfs_dbgmsg_print(const char *tag
)
245 (void) printf("ZFS_DBGMSG(%s):\n", tag
);
246 mutex_enter(&zfs_dbgmsgs_lock
);
247 for (zdm
= list_head(&zfs_dbgmsgs
); zdm
;
248 zdm
= list_next(&zfs_dbgmsgs
, zdm
))
249 (void) printf("%s\n", zdm
->zdm_msg
);
250 mutex_exit(&zfs_dbgmsgs_lock
);
255 module_param(zfs_dbgmsg_enable
, int, 0644);
256 MODULE_PARM_DESC(zfs_dbgmsg_enable
, "Enable ZFS debug message log");
258 module_param(zfs_dbgmsg_maxsize
, int, 0644);
259 MODULE_PARM_DESC(zfs_dbgmsg_maxsize
, "Maximum ZFS debug log size");