]>
Commit | Line | Data |
---|---|---|
428870ff BB |
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) 2010, Oracle and/or its affiliates. All rights reserved. | |
b02fe35d | 23 | * Copyright (c) 2012, 2014 by Delphix. All rights reserved. |
428870ff BB |
24 | */ |
25 | ||
26 | #include <sys/zfs_context.h> | |
27 | ||
d1261452 JG |
28 | typedef struct zfs_dbgmsg { |
29 | procfs_list_node_t zdm_node; | |
30 | time_t zdm_timestamp; | |
31 | int zdm_size; | |
32 | char zdm_msg[1]; /* variable length allocation */ | |
33 | } zfs_dbgmsg_t; | |
34 | ||
35 | procfs_list_t zfs_dbgmsgs; | |
3b36f831 | 36 | int zfs_dbgmsg_size = 0; |
fbeddd60 | 37 | int zfs_dbgmsg_maxsize = 4<<20; /* 4MB */ |
3b36f831 BB |
38 | |
39 | /* | |
2fd92c3d | 40 | * Internal ZFS debug messages are enabled by default. |
3b36f831 | 41 | * |
2fd92c3d MA |
42 | * # Print debug messages |
43 | * cat /proc/spl/kstat/zfs/dbgmsg | |
44 | * | |
45 | * # Disable the kernel debug message log. | |
46 | * echo 0 > /sys/module/zfs/parameters/zfs_dbgmsg_enable | |
3b36f831 BB |
47 | * |
48 | * # Clear the kernel debug message log. | |
49 | * echo 0 >/proc/spl/kstat/zfs/dbgmsg | |
50 | */ | |
3b36f831 | 51 | int zfs_dbgmsg_enable = 1; |
3b36f831 BB |
52 | |
53 | static int | |
d1261452 | 54 | zfs_dbgmsg_show_header(struct seq_file *f) |
3b36f831 | 55 | { |
d1261452 | 56 | seq_printf(f, "%-12s %-8s\n", "timestamp", "message"); |
3b36f831 BB |
57 | return (0); |
58 | } | |
59 | ||
60 | static int | |
d1261452 | 61 | zfs_dbgmsg_show(struct seq_file *f, void *p) |
3b36f831 | 62 | { |
d1261452 JG |
63 | zfs_dbgmsg_t *zdm = (zfs_dbgmsg_t *)p; |
64 | seq_printf(f, "%-12llu %-s\n", | |
02730c33 | 65 | (u_longlong_t)zdm->zdm_timestamp, zdm->zdm_msg); |
3b36f831 BB |
66 | return (0); |
67 | } | |
68 | ||
3b36f831 BB |
69 | static void |
70 | zfs_dbgmsg_purge(int max_size) | |
71 | { | |
3b36f831 | 72 | while (zfs_dbgmsg_size > max_size) { |
d1261452 | 73 | zfs_dbgmsg_t *zdm = list_remove_head(&zfs_dbgmsgs.pl_list); |
3b36f831 BB |
74 | if (zdm == NULL) |
75 | return; | |
76 | ||
d1261452 | 77 | int size = zdm->zdm_size; |
3b36f831 BB |
78 | kmem_free(zdm, size); |
79 | zfs_dbgmsg_size -= size; | |
80 | } | |
81 | } | |
82 | ||
83 | static int | |
d1261452 | 84 | zfs_dbgmsg_clear(procfs_list_t *procfs_list) |
3b36f831 | 85 | { |
d1261452 JG |
86 | mutex_enter(&zfs_dbgmsgs.pl_lock); |
87 | zfs_dbgmsg_purge(0); | |
88 | mutex_exit(&zfs_dbgmsgs.pl_lock); | |
3b36f831 BB |
89 | return (0); |
90 | } | |
495b25a9 | 91 | |
428870ff | 92 | void |
d7e398ce | 93 | zfs_dbgmsg_init(void) |
428870ff | 94 | { |
d1261452 JG |
95 | procfs_list_install("zfs", |
96 | "dbgmsg", | |
97 | &zfs_dbgmsgs, | |
98 | zfs_dbgmsg_show, | |
99 | zfs_dbgmsg_show_header, | |
100 | zfs_dbgmsg_clear, | |
495b25a9 | 101 | offsetof(zfs_dbgmsg_t, zdm_node)); |
d7e398ce | 102 | } |
428870ff | 103 | |
d7e398ce BB |
104 | void |
105 | zfs_dbgmsg_fini(void) | |
106 | { | |
d1261452 JG |
107 | procfs_list_uninstall(&zfs_dbgmsgs); |
108 | zfs_dbgmsg_purge(0); | |
109 | ||
cc99f275 DB |
110 | /* |
111 | * TODO - decide how to make this permanent | |
112 | */ | |
113 | #ifdef _KERNEL | |
d1261452 | 114 | procfs_list_destroy(&zfs_dbgmsgs); |
cc99f275 | 115 | #endif |
d7e398ce | 116 | } |
428870ff | 117 | |
8740cf4a NB |
118 | void |
119 | __set_error(const char *file, const char *func, int line, int err) | |
120 | { | |
2fd92c3d MA |
121 | /* |
122 | * To enable this: | |
123 | * | |
124 | * $ echo 512 >/sys/module/zfs/parameters/zfs_flags | |
125 | */ | |
8740cf4a NB |
126 | if (zfs_flags & ZFS_DEBUG_SET_ERROR) |
127 | __dprintf(file, func, line, "error %lu", err); | |
128 | } | |
129 | ||
3b36f831 | 130 | #ifdef _KERNEL |
d1261452 JG |
131 | static void |
132 | __zfs_dbgmsg(char *buf) | |
133 | { | |
134 | int size = sizeof (zfs_dbgmsg_t) + strlen(buf); | |
135 | zfs_dbgmsg_t *zdm = kmem_zalloc(size, KM_SLEEP); | |
136 | zdm->zdm_size = size; | |
137 | zdm->zdm_timestamp = gethrestime_sec(); | |
138 | strcpy(zdm->zdm_msg, buf); | |
139 | ||
140 | mutex_enter(&zfs_dbgmsgs.pl_lock); | |
141 | procfs_list_add(&zfs_dbgmsgs, zdm); | |
142 | zfs_dbgmsg_size += size; | |
143 | zfs_dbgmsg_purge(MAX(zfs_dbgmsg_maxsize, 0)); | |
144 | mutex_exit(&zfs_dbgmsgs.pl_lock); | |
145 | } | |
146 | ||
3b36f831 BB |
147 | void |
148 | __dprintf(const char *file, const char *func, int line, const char *fmt, ...) | |
149 | { | |
150 | const char *newfile; | |
495b25a9 | 151 | va_list adx; |
3b36f831 BB |
152 | size_t size; |
153 | char *buf; | |
0b39b9f9 | 154 | char *nl; |
8740cf4a | 155 | int i; |
495b25a9 | 156 | |
3b36f831 BB |
157 | size = 1024; |
158 | buf = kmem_alloc(size, KM_SLEEP); | |
495b25a9 RY |
159 | |
160 | /* | |
3b36f831 | 161 | * Get rid of annoying prefix to filename. |
495b25a9 | 162 | */ |
3b36f831 BB |
163 | newfile = strrchr(file, '/'); |
164 | if (newfile != NULL) { | |
165 | newfile = newfile + 1; /* Get rid of leading / */ | |
166 | } else { | |
167 | newfile = file; | |
168 | } | |
495b25a9 | 169 | |
8740cf4a NB |
170 | i = snprintf(buf, size, "%s:%d:%s(): ", newfile, line, func); |
171 | ||
172 | if (i < size) { | |
173 | va_start(adx, fmt); | |
174 | (void) vsnprintf(buf + i, size - i, fmt, adx); | |
175 | va_end(adx); | |
176 | } | |
495b25a9 | 177 | |
0b39b9f9 PS |
178 | /* |
179 | * Get rid of trailing newline. | |
180 | */ | |
3b36f831 | 181 | nl = strrchr(buf, '\n'); |
0b39b9f9 PS |
182 | if (nl != NULL) |
183 | *nl = '\0'; | |
184 | ||
3b36f831 BB |
185 | /* |
186 | * To get this data enable the zfs__dprintf trace point as shown: | |
187 | * | |
188 | * # Enable zfs__dprintf tracepoint, clear the tracepoint ring buffer | |
3b36f831 BB |
189 | * $ echo 1 > /sys/kernel/debug/tracing/events/zfs/enable |
190 | * $ echo 0 > /sys/kernel/debug/tracing/trace | |
191 | * | |
192 | * # Dump the ring buffer. | |
193 | * $ cat /sys/kernel/debug/tracing/trace | |
194 | */ | |
2fd92c3d | 195 | DTRACE_PROBE1(zfs__dprintf, char *, buf); |
495b25a9 | 196 | |
3b36f831 | 197 | /* |
2fd92c3d | 198 | * To get this data: |
3b36f831 | 199 | * |
3b36f831 | 200 | * $ cat /proc/spl/kstat/zfs/dbgmsg |
2fd92c3d MA |
201 | * |
202 | * To clear the buffer: | |
203 | * $ echo 0 > /proc/spl/kstat/zfs/dbgmsg | |
3b36f831 | 204 | */ |
2fd92c3d | 205 | __zfs_dbgmsg(buf); |
3b36f831 BB |
206 | |
207 | kmem_free(buf, size); | |
495b25a9 | 208 | } |
fa603f82 GM |
209 | |
210 | #else | |
211 | ||
212 | void | |
213 | zfs_dbgmsg_print(const char *tag) | |
214 | { | |
fa603f82 | 215 | (void) printf("ZFS_DBGMSG(%s):\n", tag); |
d1261452 JG |
216 | mutex_enter(&zfs_dbgmsgs.pl_lock); |
217 | for (zfs_dbgmsg_t *zdm = list_head(&zfs_dbgmsgs.pl_list); zdm != NULL; | |
218 | zdm = list_next(&zfs_dbgmsgs.pl_list, zdm)) | |
fa603f82 | 219 | (void) printf("%s\n", zdm->zdm_msg); |
d1261452 | 220 | mutex_exit(&zfs_dbgmsgs.pl_lock); |
fa603f82 | 221 | } |
3b36f831 | 222 | #endif /* _KERNEL */ |
5d1f7fb6 | 223 | |
3b36f831 BB |
224 | #ifdef _KERNEL |
225 | module_param(zfs_dbgmsg_enable, int, 0644); | |
226 | MODULE_PARM_DESC(zfs_dbgmsg_enable, "Enable ZFS debug message log"); | |
5d1f7fb6 | 227 | |
3b36f831 BB |
228 | module_param(zfs_dbgmsg_maxsize, int, 0644); |
229 | MODULE_PARM_DESC(zfs_dbgmsg_maxsize, "Maximum ZFS debug log size"); | |
230 | #endif |