ocfs2/dlm: Create debugfs dirs
[linux-2.6] / fs / ocfs2 / dlm / dlmdebug.c
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * dlmdebug.c
5  *
6  * debug functionality for the dlm
7  *
8  * Copyright (C) 2004 Oracle.  All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public
21  * License along with this program; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 021110-1307, USA.
24  *
25  */
26
27 #include <linux/types.h>
28 #include <linux/slab.h>
29 #include <linux/highmem.h>
30 #include <linux/utsname.h>
31 #include <linux/sysctl.h>
32 #include <linux/spinlock.h>
33 #include <linux/debugfs.h>
34
35 #include "cluster/heartbeat.h"
36 #include "cluster/nodemanager.h"
37 #include "cluster/tcp.h"
38
39 #include "dlmapi.h"
40 #include "dlmcommon.h"
41 #include "dlmdomain.h"
42 #include "dlmdebug.h"
43
44 #define MLOG_MASK_PREFIX ML_DLM
45 #include "cluster/masklog.h"
46
47 void dlm_print_one_lock_resource(struct dlm_lock_resource *res)
48 {
49         mlog(ML_NOTICE, "lockres: %.*s, owner=%u, state=%u\n",
50                res->lockname.len, res->lockname.name,
51                res->owner, res->state);
52         spin_lock(&res->spinlock);
53         __dlm_print_one_lock_resource(res);
54         spin_unlock(&res->spinlock);
55 }
56
57 static void dlm_print_lockres_refmap(struct dlm_lock_resource *res)
58 {
59         int bit;
60         assert_spin_locked(&res->spinlock);
61
62         mlog(ML_NOTICE, "  refmap nodes: [ ");
63         bit = 0;
64         while (1) {
65                 bit = find_next_bit(res->refmap, O2NM_MAX_NODES, bit);
66                 if (bit >= O2NM_MAX_NODES)
67                         break;
68                 printk("%u ", bit);
69                 bit++;
70         }
71         printk("], inflight=%u\n", res->inflight_locks);
72 }
73
74 void __dlm_print_one_lock_resource(struct dlm_lock_resource *res)
75 {
76         struct list_head *iter2;
77         struct dlm_lock *lock;
78
79         assert_spin_locked(&res->spinlock);
80
81         mlog(ML_NOTICE, "lockres: %.*s, owner=%u, state=%u\n",
82                res->lockname.len, res->lockname.name,
83                res->owner, res->state);
84         mlog(ML_NOTICE, "  last used: %lu, on purge list: %s\n",
85              res->last_used, list_empty(&res->purge) ? "no" : "yes");
86         dlm_print_lockres_refmap(res);
87         mlog(ML_NOTICE, "  granted queue: \n");
88         list_for_each(iter2, &res->granted) {
89                 lock = list_entry(iter2, struct dlm_lock, list);
90                 spin_lock(&lock->spinlock);
91                 mlog(ML_NOTICE, "    type=%d, conv=%d, node=%u, "
92                        "cookie=%u:%llu, ast=(empty=%c,pend=%c), bast=(empty=%c,pend=%c)\n", 
93                        lock->ml.type, lock->ml.convert_type, lock->ml.node, 
94                      dlm_get_lock_cookie_node(be64_to_cpu(lock->ml.cookie)),
95                      dlm_get_lock_cookie_seq(be64_to_cpu(lock->ml.cookie)),
96                        list_empty(&lock->ast_list) ? 'y' : 'n',
97                        lock->ast_pending ? 'y' : 'n',
98                        list_empty(&lock->bast_list) ? 'y' : 'n',
99                        lock->bast_pending ? 'y' : 'n');
100                 spin_unlock(&lock->spinlock);
101         }
102         mlog(ML_NOTICE, "  converting queue: \n");
103         list_for_each(iter2, &res->converting) {
104                 lock = list_entry(iter2, struct dlm_lock, list);
105                 spin_lock(&lock->spinlock);
106                 mlog(ML_NOTICE, "    type=%d, conv=%d, node=%u, "
107                        "cookie=%u:%llu, ast=(empty=%c,pend=%c), bast=(empty=%c,pend=%c)\n", 
108                        lock->ml.type, lock->ml.convert_type, lock->ml.node, 
109                      dlm_get_lock_cookie_node(be64_to_cpu(lock->ml.cookie)),
110                      dlm_get_lock_cookie_seq(be64_to_cpu(lock->ml.cookie)),
111                        list_empty(&lock->ast_list) ? 'y' : 'n',
112                        lock->ast_pending ? 'y' : 'n',
113                        list_empty(&lock->bast_list) ? 'y' : 'n',
114                        lock->bast_pending ? 'y' : 'n');
115                 spin_unlock(&lock->spinlock);
116         }
117         mlog(ML_NOTICE, "  blocked queue: \n");
118         list_for_each(iter2, &res->blocked) {
119                 lock = list_entry(iter2, struct dlm_lock, list);
120                 spin_lock(&lock->spinlock);
121                 mlog(ML_NOTICE, "    type=%d, conv=%d, node=%u, "
122                        "cookie=%u:%llu, ast=(empty=%c,pend=%c), bast=(empty=%c,pend=%c)\n", 
123                        lock->ml.type, lock->ml.convert_type, lock->ml.node, 
124                      dlm_get_lock_cookie_node(be64_to_cpu(lock->ml.cookie)),
125                      dlm_get_lock_cookie_seq(be64_to_cpu(lock->ml.cookie)),
126                        list_empty(&lock->ast_list) ? 'y' : 'n',
127                        lock->ast_pending ? 'y' : 'n',
128                        list_empty(&lock->bast_list) ? 'y' : 'n',
129                        lock->bast_pending ? 'y' : 'n');
130                 spin_unlock(&lock->spinlock);
131         }
132 }
133
134 void dlm_print_one_lock(struct dlm_lock *lockid)
135 {
136         dlm_print_one_lock_resource(lockid->lockres);
137 }
138 EXPORT_SYMBOL_GPL(dlm_print_one_lock);
139
140 #if 0
141 void dlm_dump_lock_resources(struct dlm_ctxt *dlm)
142 {
143         struct dlm_lock_resource *res;
144         struct hlist_node *iter;
145         struct hlist_head *bucket;
146         int i;
147
148         mlog(ML_NOTICE, "struct dlm_ctxt: %s, node=%u, key=%u\n",
149                   dlm->name, dlm->node_num, dlm->key);
150         if (!dlm || !dlm->name) {
151                 mlog(ML_ERROR, "dlm=%p\n", dlm);
152                 return;
153         }
154
155         spin_lock(&dlm->spinlock);
156         for (i=0; i<DLM_HASH_BUCKETS; i++) {
157                 bucket = dlm_lockres_hash(dlm, i);
158                 hlist_for_each_entry(res, iter, bucket, hash_node)
159                         dlm_print_one_lock_resource(res);
160         }
161         spin_unlock(&dlm->spinlock);
162 }
163 #endif  /*  0  */
164
165 static const char *dlm_errnames[] = {
166         [DLM_NORMAL] =                  "DLM_NORMAL",
167         [DLM_GRANTED] =                 "DLM_GRANTED",
168         [DLM_DENIED] =                  "DLM_DENIED",
169         [DLM_DENIED_NOLOCKS] =          "DLM_DENIED_NOLOCKS",
170         [DLM_WORKING] =                 "DLM_WORKING",
171         [DLM_BLOCKED] =                 "DLM_BLOCKED",
172         [DLM_BLOCKED_ORPHAN] =          "DLM_BLOCKED_ORPHAN",
173         [DLM_DENIED_GRACE_PERIOD] =     "DLM_DENIED_GRACE_PERIOD",
174         [DLM_SYSERR] =                  "DLM_SYSERR",
175         [DLM_NOSUPPORT] =               "DLM_NOSUPPORT",
176         [DLM_CANCELGRANT] =             "DLM_CANCELGRANT",
177         [DLM_IVLOCKID] =                "DLM_IVLOCKID",
178         [DLM_SYNC] =                    "DLM_SYNC",
179         [DLM_BADTYPE] =                 "DLM_BADTYPE",
180         [DLM_BADRESOURCE] =             "DLM_BADRESOURCE",
181         [DLM_MAXHANDLES] =              "DLM_MAXHANDLES",
182         [DLM_NOCLINFO] =                "DLM_NOCLINFO",
183         [DLM_NOLOCKMGR] =               "DLM_NOLOCKMGR",
184         [DLM_NOPURGED] =                "DLM_NOPURGED",
185         [DLM_BADARGS] =                 "DLM_BADARGS",
186         [DLM_VOID] =                    "DLM_VOID",
187         [DLM_NOTQUEUED] =               "DLM_NOTQUEUED",
188         [DLM_IVBUFLEN] =                "DLM_IVBUFLEN",
189         [DLM_CVTUNGRANT] =              "DLM_CVTUNGRANT",
190         [DLM_BADPARAM] =                "DLM_BADPARAM",
191         [DLM_VALNOTVALID] =             "DLM_VALNOTVALID",
192         [DLM_REJECTED] =                "DLM_REJECTED",
193         [DLM_ABORT] =                   "DLM_ABORT",
194         [DLM_CANCEL] =                  "DLM_CANCEL",
195         [DLM_IVRESHANDLE] =             "DLM_IVRESHANDLE",
196         [DLM_DEADLOCK] =                "DLM_DEADLOCK",
197         [DLM_DENIED_NOASTS] =           "DLM_DENIED_NOASTS",
198         [DLM_FORWARD] =                 "DLM_FORWARD",
199         [DLM_TIMEOUT] =                 "DLM_TIMEOUT",
200         [DLM_IVGROUPID] =               "DLM_IVGROUPID",
201         [DLM_VERS_CONFLICT] =           "DLM_VERS_CONFLICT",
202         [DLM_BAD_DEVICE_PATH] =         "DLM_BAD_DEVICE_PATH",
203         [DLM_NO_DEVICE_PERMISSION] =    "DLM_NO_DEVICE_PERMISSION",
204         [DLM_NO_CONTROL_DEVICE ] =      "DLM_NO_CONTROL_DEVICE ",
205         [DLM_RECOVERING] =              "DLM_RECOVERING",
206         [DLM_MIGRATING] =               "DLM_MIGRATING",
207         [DLM_MAXSTATS] =                "DLM_MAXSTATS",
208 };
209
210 static const char *dlm_errmsgs[] = {
211         [DLM_NORMAL] =                  "request in progress",
212         [DLM_GRANTED] =                 "request granted",
213         [DLM_DENIED] =                  "request denied",
214         [DLM_DENIED_NOLOCKS] =          "request denied, out of system resources",
215         [DLM_WORKING] =                 "async request in progress",
216         [DLM_BLOCKED] =                 "lock request blocked",
217         [DLM_BLOCKED_ORPHAN] =          "lock request blocked by a orphan lock",
218         [DLM_DENIED_GRACE_PERIOD] =     "topological change in progress",
219         [DLM_SYSERR] =                  "system error",
220         [DLM_NOSUPPORT] =               "unsupported",
221         [DLM_CANCELGRANT] =             "can't cancel convert: already granted",
222         [DLM_IVLOCKID] =                "bad lockid",
223         [DLM_SYNC] =                    "synchronous request granted",
224         [DLM_BADTYPE] =                 "bad resource type",
225         [DLM_BADRESOURCE] =             "bad resource handle",
226         [DLM_MAXHANDLES] =              "no more resource handles",
227         [DLM_NOCLINFO] =                "can't contact cluster manager",
228         [DLM_NOLOCKMGR] =               "can't contact lock manager",
229         [DLM_NOPURGED] =                "can't contact purge daemon",
230         [DLM_BADARGS] =                 "bad api args",
231         [DLM_VOID] =                    "no status",
232         [DLM_NOTQUEUED] =               "NOQUEUE was specified and request failed",
233         [DLM_IVBUFLEN] =                "invalid resource name length",
234         [DLM_CVTUNGRANT] =              "attempted to convert ungranted lock",
235         [DLM_BADPARAM] =                "invalid lock mode specified",
236         [DLM_VALNOTVALID] =             "value block has been invalidated",
237         [DLM_REJECTED] =                "request rejected, unrecognized client",
238         [DLM_ABORT] =                   "blocked lock request cancelled",
239         [DLM_CANCEL] =                  "conversion request cancelled",
240         [DLM_IVRESHANDLE] =             "invalid resource handle",
241         [DLM_DEADLOCK] =                "deadlock recovery refused this request",
242         [DLM_DENIED_NOASTS] =           "failed to allocate AST",
243         [DLM_FORWARD] =                 "request must wait for primary's response",
244         [DLM_TIMEOUT] =                 "timeout value for lock has expired",
245         [DLM_IVGROUPID] =               "invalid group specification",
246         [DLM_VERS_CONFLICT] =           "version conflicts prevent request handling",
247         [DLM_BAD_DEVICE_PATH] =         "Locks device does not exist or path wrong",
248         [DLM_NO_DEVICE_PERMISSION] =    "Client has insufficient perms for device",
249         [DLM_NO_CONTROL_DEVICE] =       "Cannot set options on opened device ",
250         [DLM_RECOVERING] =              "lock resource being recovered",
251         [DLM_MIGRATING] =               "lock resource being migrated",
252         [DLM_MAXSTATS] =                "invalid error number",
253 };
254
255 const char *dlm_errmsg(enum dlm_status err)
256 {
257         if (err >= DLM_MAXSTATS || err < 0)
258                 return dlm_errmsgs[DLM_MAXSTATS];
259         return dlm_errmsgs[err];
260 }
261 EXPORT_SYMBOL_GPL(dlm_errmsg);
262
263 const char *dlm_errname(enum dlm_status err)
264 {
265         if (err >= DLM_MAXSTATS || err < 0)
266                 return dlm_errnames[DLM_MAXSTATS];
267         return dlm_errnames[err];
268 }
269 EXPORT_SYMBOL_GPL(dlm_errname);
270
271
272 #ifdef CONFIG_DEBUG_FS
273
274 static struct dentry *dlm_debugfs_root = NULL;
275
276 #define DLM_DEBUGFS_DIR                         "o2dlm"
277
278 /* subroot - domain dir */
279 int dlm_create_debugfs_subroot(struct dlm_ctxt *dlm)
280 {
281         dlm->dlm_debugfs_subroot = debugfs_create_dir(dlm->name,
282                                                       dlm_debugfs_root);
283         if (!dlm->dlm_debugfs_subroot) {
284                 mlog_errno(-ENOMEM);
285                 goto bail;
286         }
287
288         return 0;
289 bail:
290         dlm_destroy_debugfs_subroot(dlm);
291         return -ENOMEM;
292 }
293
294 void dlm_destroy_debugfs_subroot(struct dlm_ctxt *dlm)
295 {
296         if (dlm->dlm_debugfs_subroot)
297                 debugfs_remove(dlm->dlm_debugfs_subroot);
298 }
299
300 /* debugfs root */
301 int dlm_create_debugfs_root(void)
302 {
303         dlm_debugfs_root = debugfs_create_dir(DLM_DEBUGFS_DIR, NULL);
304         if (!dlm_debugfs_root) {
305                 mlog_errno(-ENOMEM);
306                 return -ENOMEM;
307         }
308         return 0;
309 }
310
311 void dlm_destroy_debugfs_root(void)
312 {
313         if (dlm_debugfs_root)
314                 debugfs_remove(dlm_debugfs_root);
315 }
316 #endif  /* CONFIG_DEBUG_FS */