xref: /openbmc/linux/fs/ocfs2/dlm/dlmdebug.c (revision 384740dc)
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, 2008 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 static int stringify_lockname(const char *lockname, int locklen, char *buf,
48 			      int len);
49 
50 void dlm_print_one_lock_resource(struct dlm_lock_resource *res)
51 {
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 	printk("  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 static void __dlm_print_lock(struct dlm_lock *lock)
75 {
76 	spin_lock(&lock->spinlock);
77 
78 	printk("    type=%d, conv=%d, node=%u, cookie=%u:%llu, "
79 	       "ref=%u, ast=(empty=%c,pend=%c), bast=(empty=%c,pend=%c), "
80 	       "pending=(conv=%c,lock=%c,cancel=%c,unlock=%c)\n",
81 	       lock->ml.type, lock->ml.convert_type, lock->ml.node,
82 	       dlm_get_lock_cookie_node(be64_to_cpu(lock->ml.cookie)),
83 	       dlm_get_lock_cookie_seq(be64_to_cpu(lock->ml.cookie)),
84 	       atomic_read(&lock->lock_refs.refcount),
85 	       (list_empty(&lock->ast_list) ? 'y' : 'n'),
86 	       (lock->ast_pending ? 'y' : 'n'),
87 	       (list_empty(&lock->bast_list) ? 'y' : 'n'),
88 	       (lock->bast_pending ? 'y' : 'n'),
89 	       (lock->convert_pending ? 'y' : 'n'),
90 	       (lock->lock_pending ? 'y' : 'n'),
91 	       (lock->cancel_pending ? 'y' : 'n'),
92 	       (lock->unlock_pending ? 'y' : 'n'));
93 
94 	spin_unlock(&lock->spinlock);
95 }
96 
97 void __dlm_print_one_lock_resource(struct dlm_lock_resource *res)
98 {
99 	struct list_head *iter2;
100 	struct dlm_lock *lock;
101 	char buf[DLM_LOCKID_NAME_MAX];
102 
103 	assert_spin_locked(&res->spinlock);
104 
105 	stringify_lockname(res->lockname.name, res->lockname.len,
106 			   buf, sizeof(buf) - 1);
107 	printk("lockres: %s, owner=%u, state=%u\n",
108 	       buf, res->owner, res->state);
109 	printk("  last used: %lu, refcnt: %u, on purge list: %s\n",
110 	       res->last_used, atomic_read(&res->refs.refcount),
111 	       list_empty(&res->purge) ? "no" : "yes");
112 	printk("  on dirty list: %s, on reco list: %s, "
113 	       "migrating pending: %s\n",
114 	       list_empty(&res->dirty) ? "no" : "yes",
115 	       list_empty(&res->recovering) ? "no" : "yes",
116 	       res->migration_pending ? "yes" : "no");
117 	printk("  inflight locks: %d, asts reserved: %d\n",
118 	       res->inflight_locks, atomic_read(&res->asts_reserved));
119 	dlm_print_lockres_refmap(res);
120 	printk("  granted queue:\n");
121 	list_for_each(iter2, &res->granted) {
122 		lock = list_entry(iter2, struct dlm_lock, list);
123 		__dlm_print_lock(lock);
124 	}
125 	printk("  converting queue:\n");
126 	list_for_each(iter2, &res->converting) {
127 		lock = list_entry(iter2, struct dlm_lock, list);
128 		__dlm_print_lock(lock);
129 	}
130 	printk("  blocked queue:\n");
131 	list_for_each(iter2, &res->blocked) {
132 		lock = list_entry(iter2, struct dlm_lock, list);
133 		__dlm_print_lock(lock);
134 	}
135 }
136 
137 void dlm_print_one_lock(struct dlm_lock *lockid)
138 {
139 	dlm_print_one_lock_resource(lockid->lockres);
140 }
141 EXPORT_SYMBOL_GPL(dlm_print_one_lock);
142 
143 static const char *dlm_errnames[] = {
144 	[DLM_NORMAL] =			"DLM_NORMAL",
145 	[DLM_GRANTED] =			"DLM_GRANTED",
146 	[DLM_DENIED] =			"DLM_DENIED",
147 	[DLM_DENIED_NOLOCKS] =		"DLM_DENIED_NOLOCKS",
148 	[DLM_WORKING] =			"DLM_WORKING",
149 	[DLM_BLOCKED] =			"DLM_BLOCKED",
150 	[DLM_BLOCKED_ORPHAN] =		"DLM_BLOCKED_ORPHAN",
151 	[DLM_DENIED_GRACE_PERIOD] =	"DLM_DENIED_GRACE_PERIOD",
152 	[DLM_SYSERR] =			"DLM_SYSERR",
153 	[DLM_NOSUPPORT] =		"DLM_NOSUPPORT",
154 	[DLM_CANCELGRANT] =		"DLM_CANCELGRANT",
155 	[DLM_IVLOCKID] =		"DLM_IVLOCKID",
156 	[DLM_SYNC] =			"DLM_SYNC",
157 	[DLM_BADTYPE] =			"DLM_BADTYPE",
158 	[DLM_BADRESOURCE] =		"DLM_BADRESOURCE",
159 	[DLM_MAXHANDLES] =		"DLM_MAXHANDLES",
160 	[DLM_NOCLINFO] =		"DLM_NOCLINFO",
161 	[DLM_NOLOCKMGR] =		"DLM_NOLOCKMGR",
162 	[DLM_NOPURGED] =		"DLM_NOPURGED",
163 	[DLM_BADARGS] =			"DLM_BADARGS",
164 	[DLM_VOID] =			"DLM_VOID",
165 	[DLM_NOTQUEUED] =		"DLM_NOTQUEUED",
166 	[DLM_IVBUFLEN] =		"DLM_IVBUFLEN",
167 	[DLM_CVTUNGRANT] =		"DLM_CVTUNGRANT",
168 	[DLM_BADPARAM] =		"DLM_BADPARAM",
169 	[DLM_VALNOTVALID] =		"DLM_VALNOTVALID",
170 	[DLM_REJECTED] =		"DLM_REJECTED",
171 	[DLM_ABORT] =			"DLM_ABORT",
172 	[DLM_CANCEL] =			"DLM_CANCEL",
173 	[DLM_IVRESHANDLE] =		"DLM_IVRESHANDLE",
174 	[DLM_DEADLOCK] =		"DLM_DEADLOCK",
175 	[DLM_DENIED_NOASTS] =		"DLM_DENIED_NOASTS",
176 	[DLM_FORWARD] =			"DLM_FORWARD",
177 	[DLM_TIMEOUT] =			"DLM_TIMEOUT",
178 	[DLM_IVGROUPID] =		"DLM_IVGROUPID",
179 	[DLM_VERS_CONFLICT] =		"DLM_VERS_CONFLICT",
180 	[DLM_BAD_DEVICE_PATH] =		"DLM_BAD_DEVICE_PATH",
181 	[DLM_NO_DEVICE_PERMISSION] =	"DLM_NO_DEVICE_PERMISSION",
182 	[DLM_NO_CONTROL_DEVICE ] =	"DLM_NO_CONTROL_DEVICE ",
183 	[DLM_RECOVERING] =		"DLM_RECOVERING",
184 	[DLM_MIGRATING] =		"DLM_MIGRATING",
185 	[DLM_MAXSTATS] =		"DLM_MAXSTATS",
186 };
187 
188 static const char *dlm_errmsgs[] = {
189 	[DLM_NORMAL] = 			"request in progress",
190 	[DLM_GRANTED] = 		"request granted",
191 	[DLM_DENIED] = 			"request denied",
192 	[DLM_DENIED_NOLOCKS] = 		"request denied, out of system resources",
193 	[DLM_WORKING] = 		"async request in progress",
194 	[DLM_BLOCKED] = 		"lock request blocked",
195 	[DLM_BLOCKED_ORPHAN] = 		"lock request blocked by a orphan lock",
196 	[DLM_DENIED_GRACE_PERIOD] = 	"topological change in progress",
197 	[DLM_SYSERR] = 			"system error",
198 	[DLM_NOSUPPORT] = 		"unsupported",
199 	[DLM_CANCELGRANT] = 		"can't cancel convert: already granted",
200 	[DLM_IVLOCKID] = 		"bad lockid",
201 	[DLM_SYNC] = 			"synchronous request granted",
202 	[DLM_BADTYPE] = 		"bad resource type",
203 	[DLM_BADRESOURCE] = 		"bad resource handle",
204 	[DLM_MAXHANDLES] = 		"no more resource handles",
205 	[DLM_NOCLINFO] = 		"can't contact cluster manager",
206 	[DLM_NOLOCKMGR] = 		"can't contact lock manager",
207 	[DLM_NOPURGED] = 		"can't contact purge daemon",
208 	[DLM_BADARGS] = 		"bad api args",
209 	[DLM_VOID] = 			"no status",
210 	[DLM_NOTQUEUED] = 		"NOQUEUE was specified and request failed",
211 	[DLM_IVBUFLEN] = 		"invalid resource name length",
212 	[DLM_CVTUNGRANT] = 		"attempted to convert ungranted lock",
213 	[DLM_BADPARAM] = 		"invalid lock mode specified",
214 	[DLM_VALNOTVALID] = 		"value block has been invalidated",
215 	[DLM_REJECTED] = 		"request rejected, unrecognized client",
216 	[DLM_ABORT] = 			"blocked lock request cancelled",
217 	[DLM_CANCEL] = 			"conversion request cancelled",
218 	[DLM_IVRESHANDLE] = 		"invalid resource handle",
219 	[DLM_DEADLOCK] = 		"deadlock recovery refused this request",
220 	[DLM_DENIED_NOASTS] = 		"failed to allocate AST",
221 	[DLM_FORWARD] = 		"request must wait for primary's response",
222 	[DLM_TIMEOUT] = 		"timeout value for lock has expired",
223 	[DLM_IVGROUPID] = 		"invalid group specification",
224 	[DLM_VERS_CONFLICT] = 		"version conflicts prevent request handling",
225 	[DLM_BAD_DEVICE_PATH] = 	"Locks device does not exist or path wrong",
226 	[DLM_NO_DEVICE_PERMISSION] = 	"Client has insufficient perms for device",
227 	[DLM_NO_CONTROL_DEVICE] = 	"Cannot set options on opened device ",
228 	[DLM_RECOVERING] = 		"lock resource being recovered",
229 	[DLM_MIGRATING] = 		"lock resource being migrated",
230 	[DLM_MAXSTATS] = 		"invalid error number",
231 };
232 
233 const char *dlm_errmsg(enum dlm_status err)
234 {
235 	if (err >= DLM_MAXSTATS || err < 0)
236 		return dlm_errmsgs[DLM_MAXSTATS];
237 	return dlm_errmsgs[err];
238 }
239 EXPORT_SYMBOL_GPL(dlm_errmsg);
240 
241 const char *dlm_errname(enum dlm_status err)
242 {
243 	if (err >= DLM_MAXSTATS || err < 0)
244 		return dlm_errnames[DLM_MAXSTATS];
245 	return dlm_errnames[err];
246 }
247 EXPORT_SYMBOL_GPL(dlm_errname);
248 
249 /* NOTE: This function converts a lockname into a string. It uses knowledge
250  * of the format of the lockname that should be outside the purview of the dlm.
251  * We are adding only to make dlm debugging slightly easier.
252  *
253  * For more on lockname formats, please refer to dlmglue.c and ocfs2_lockid.h.
254  */
255 static int stringify_lockname(const char *lockname, int locklen, char *buf,
256 			      int len)
257 {
258 	int out = 0;
259 	__be64 inode_blkno_be;
260 
261 #define OCFS2_DENTRY_LOCK_INO_START	18
262 	if (*lockname == 'N') {
263 		memcpy((__be64 *)&inode_blkno_be,
264 		       (char *)&lockname[OCFS2_DENTRY_LOCK_INO_START],
265 		       sizeof(__be64));
266 		out += snprintf(buf + out, len - out, "%.*s%08x",
267 				OCFS2_DENTRY_LOCK_INO_START - 1, lockname,
268 				(unsigned int)be64_to_cpu(inode_blkno_be));
269 	} else
270 		out += snprintf(buf + out, len - out, "%.*s",
271 				locklen, lockname);
272 	return out;
273 }
274 
275 static int stringify_nodemap(unsigned long *nodemap, int maxnodes,
276 			     char *buf, int len)
277 {
278 	int out = 0;
279 	int i = -1;
280 
281 	while ((i = find_next_bit(nodemap, maxnodes, i + 1)) < maxnodes)
282 		out += snprintf(buf + out, len - out, "%d ", i);
283 
284 	return out;
285 }
286 
287 static int dump_mle(struct dlm_master_list_entry *mle, char *buf, int len)
288 {
289 	int out = 0;
290 	unsigned int namelen;
291 	const char *name;
292 	char *mle_type;
293 
294 	if (mle->type != DLM_MLE_MASTER) {
295 		namelen = mle->u.name.len;
296 		name = mle->u.name.name;
297 	} else {
298 		namelen = mle->u.res->lockname.len;
299 		name = mle->u.res->lockname.name;
300 	}
301 
302 	if (mle->type == DLM_MLE_BLOCK)
303 		mle_type = "BLK";
304 	else if (mle->type == DLM_MLE_MASTER)
305 		mle_type = "MAS";
306 	else
307 		mle_type = "MIG";
308 
309 	out += stringify_lockname(name, namelen, buf + out, len - out);
310 	out += snprintf(buf + out, len - out,
311 			"\t%3s\tmas=%3u\tnew=%3u\tevt=%1d\tuse=%1d\tref=%3d\n",
312 			mle_type, mle->master, mle->new_master,
313 			!list_empty(&mle->hb_events),
314 			!!mle->inuse,
315 			atomic_read(&mle->mle_refs.refcount));
316 
317 	out += snprintf(buf + out, len - out, "Maybe=");
318 	out += stringify_nodemap(mle->maybe_map, O2NM_MAX_NODES,
319 				 buf + out, len - out);
320 	out += snprintf(buf + out, len - out, "\n");
321 
322 	out += snprintf(buf + out, len - out, "Vote=");
323 	out += stringify_nodemap(mle->vote_map, O2NM_MAX_NODES,
324 				 buf + out, len - out);
325 	out += snprintf(buf + out, len - out, "\n");
326 
327 	out += snprintf(buf + out, len - out, "Response=");
328 	out += stringify_nodemap(mle->response_map, O2NM_MAX_NODES,
329 				 buf + out, len - out);
330 	out += snprintf(buf + out, len - out, "\n");
331 
332 	out += snprintf(buf + out, len - out, "Node=");
333 	out += stringify_nodemap(mle->node_map, O2NM_MAX_NODES,
334 				 buf + out, len - out);
335 	out += snprintf(buf + out, len - out, "\n");
336 
337 	out += snprintf(buf + out, len - out, "\n");
338 
339 	return out;
340 }
341 
342 void dlm_print_one_mle(struct dlm_master_list_entry *mle)
343 {
344 	char *buf;
345 
346 	buf = (char *) get_zeroed_page(GFP_NOFS);
347 	if (buf) {
348 		dump_mle(mle, buf, PAGE_SIZE - 1);
349 		free_page((unsigned long)buf);
350 	}
351 }
352 
353 #ifdef CONFIG_DEBUG_FS
354 
355 static struct dentry *dlm_debugfs_root = NULL;
356 
357 #define DLM_DEBUGFS_DIR				"o2dlm"
358 #define DLM_DEBUGFS_DLM_STATE			"dlm_state"
359 #define DLM_DEBUGFS_LOCKING_STATE		"locking_state"
360 #define DLM_DEBUGFS_MLE_STATE			"mle_state"
361 #define DLM_DEBUGFS_PURGE_LIST			"purge_list"
362 
363 /* begin - utils funcs */
364 static void dlm_debug_free(struct kref *kref)
365 {
366 	struct dlm_debug_ctxt *dc;
367 
368 	dc = container_of(kref, struct dlm_debug_ctxt, debug_refcnt);
369 
370 	kfree(dc);
371 }
372 
373 static void dlm_debug_put(struct dlm_debug_ctxt *dc)
374 {
375 	if (dc)
376 		kref_put(&dc->debug_refcnt, dlm_debug_free);
377 }
378 
379 static void dlm_debug_get(struct dlm_debug_ctxt *dc)
380 {
381 	kref_get(&dc->debug_refcnt);
382 }
383 
384 static struct debug_buffer *debug_buffer_allocate(void)
385 {
386 	struct debug_buffer *db = NULL;
387 
388 	db = kzalloc(sizeof(struct debug_buffer), GFP_KERNEL);
389 	if (!db)
390 		goto bail;
391 
392 	db->len = PAGE_SIZE;
393 	db->buf = kmalloc(db->len, GFP_KERNEL);
394 	if (!db->buf)
395 		goto bail;
396 
397 	return db;
398 bail:
399 	kfree(db);
400 	return NULL;
401 }
402 
403 static ssize_t debug_buffer_read(struct file *file, char __user *buf,
404 				 size_t nbytes, loff_t *ppos)
405 {
406 	struct debug_buffer *db = file->private_data;
407 
408 	return simple_read_from_buffer(buf, nbytes, ppos, db->buf, db->len);
409 }
410 
411 static loff_t debug_buffer_llseek(struct file *file, loff_t off, int whence)
412 {
413 	struct debug_buffer *db = file->private_data;
414 	loff_t new = -1;
415 
416 	switch (whence) {
417 	case 0:
418 		new = off;
419 		break;
420 	case 1:
421 		new = file->f_pos + off;
422 		break;
423 	}
424 
425 	if (new < 0 || new > db->len)
426 		return -EINVAL;
427 
428 	return (file->f_pos = new);
429 }
430 
431 static int debug_buffer_release(struct inode *inode, struct file *file)
432 {
433 	struct debug_buffer *db = (struct debug_buffer *)file->private_data;
434 
435 	if (db)
436 		kfree(db->buf);
437 	kfree(db);
438 
439 	return 0;
440 }
441 /* end - util funcs */
442 
443 /* begin - purge list funcs */
444 static int debug_purgelist_print(struct dlm_ctxt *dlm, struct debug_buffer *db)
445 {
446 	struct dlm_lock_resource *res;
447 	int out = 0;
448 	unsigned long total = 0;
449 
450 	out += snprintf(db->buf + out, db->len - out,
451 			"Dumping Purgelist for Domain: %s\n", dlm->name);
452 
453 	spin_lock(&dlm->spinlock);
454 	list_for_each_entry(res, &dlm->purge_list, purge) {
455 		++total;
456 		if (db->len - out < 100)
457 			continue;
458 		spin_lock(&res->spinlock);
459 		out += stringify_lockname(res->lockname.name,
460 					  res->lockname.len,
461 					  db->buf + out, db->len - out);
462 		out += snprintf(db->buf + out, db->len - out, "\t%ld\n",
463 				(jiffies - res->last_used)/HZ);
464 		spin_unlock(&res->spinlock);
465 	}
466 	spin_unlock(&dlm->spinlock);
467 
468 	out += snprintf(db->buf + out, db->len - out,
469 			"Total on list: %ld\n", total);
470 
471 	return out;
472 }
473 
474 static int debug_purgelist_open(struct inode *inode, struct file *file)
475 {
476 	struct dlm_ctxt *dlm = inode->i_private;
477 	struct debug_buffer *db;
478 
479 	db = debug_buffer_allocate();
480 	if (!db)
481 		goto bail;
482 
483 	db->len = debug_purgelist_print(dlm, db);
484 
485 	file->private_data = db;
486 
487 	return 0;
488 bail:
489 	return -ENOMEM;
490 }
491 
492 static struct file_operations debug_purgelist_fops = {
493 	.open =		debug_purgelist_open,
494 	.release =	debug_buffer_release,
495 	.read =		debug_buffer_read,
496 	.llseek =	debug_buffer_llseek,
497 };
498 /* end - purge list funcs */
499 
500 /* begin - debug mle funcs */
501 static int debug_mle_print(struct dlm_ctxt *dlm, struct debug_buffer *db)
502 {
503 	struct dlm_master_list_entry *mle;
504 	int out = 0;
505 	unsigned long total = 0;
506 
507 	out += snprintf(db->buf + out, db->len - out,
508 			"Dumping MLEs for Domain: %s\n", dlm->name);
509 
510 	spin_lock(&dlm->master_lock);
511 	list_for_each_entry(mle, &dlm->master_list, list) {
512 		++total;
513 		if (db->len - out < 200)
514 			continue;
515 		out += dump_mle(mle, db->buf + out, db->len - out);
516 	}
517 	spin_unlock(&dlm->master_lock);
518 
519 	out += snprintf(db->buf + out, db->len - out,
520 			"Total on list: %ld\n", total);
521 	return out;
522 }
523 
524 static int debug_mle_open(struct inode *inode, struct file *file)
525 {
526 	struct dlm_ctxt *dlm = inode->i_private;
527 	struct debug_buffer *db;
528 
529 	db = debug_buffer_allocate();
530 	if (!db)
531 		goto bail;
532 
533 	db->len = debug_mle_print(dlm, db);
534 
535 	file->private_data = db;
536 
537 	return 0;
538 bail:
539 	return -ENOMEM;
540 }
541 
542 static struct file_operations debug_mle_fops = {
543 	.open =		debug_mle_open,
544 	.release =	debug_buffer_release,
545 	.read =		debug_buffer_read,
546 	.llseek =	debug_buffer_llseek,
547 };
548 
549 /* end - debug mle funcs */
550 
551 /* begin - debug lockres funcs */
552 static int dump_lock(struct dlm_lock *lock, int list_type, char *buf, int len)
553 {
554 	int out;
555 
556 #define DEBUG_LOCK_VERSION	1
557 	spin_lock(&lock->spinlock);
558 	out = snprintf(buf, len, "LOCK:%d,%d,%d,%d,%d,%d:%lld,%d,%d,%d,%d,%d,"
559 		       "%d,%d,%d,%d\n",
560 		       DEBUG_LOCK_VERSION,
561 		       list_type, lock->ml.type, lock->ml.convert_type,
562 		       lock->ml.node,
563 		       dlm_get_lock_cookie_node(be64_to_cpu(lock->ml.cookie)),
564 		       dlm_get_lock_cookie_seq(be64_to_cpu(lock->ml.cookie)),
565 		       !list_empty(&lock->ast_list),
566 		       !list_empty(&lock->bast_list),
567 		       lock->ast_pending, lock->bast_pending,
568 		       lock->convert_pending, lock->lock_pending,
569 		       lock->cancel_pending, lock->unlock_pending,
570 		       atomic_read(&lock->lock_refs.refcount));
571 	spin_unlock(&lock->spinlock);
572 
573 	return out;
574 }
575 
576 static int dump_lockres(struct dlm_lock_resource *res, char *buf, int len)
577 {
578 	struct dlm_lock *lock;
579 	int i;
580 	int out = 0;
581 
582 	out += snprintf(buf + out, len - out, "NAME:");
583 	out += stringify_lockname(res->lockname.name, res->lockname.len,
584 				  buf + out, len - out);
585 	out += snprintf(buf + out, len - out, "\n");
586 
587 #define DEBUG_LRES_VERSION	1
588 	out += snprintf(buf + out, len - out,
589 			"LRES:%d,%d,%d,%ld,%d,%d,%d,%d,%d,%d,%d\n",
590 			DEBUG_LRES_VERSION,
591 			res->owner, res->state, res->last_used,
592 			!list_empty(&res->purge),
593 			!list_empty(&res->dirty),
594 			!list_empty(&res->recovering),
595 			res->inflight_locks, res->migration_pending,
596 			atomic_read(&res->asts_reserved),
597 			atomic_read(&res->refs.refcount));
598 
599 	/* refmap */
600 	out += snprintf(buf + out, len - out, "RMAP:");
601 	out += stringify_nodemap(res->refmap, O2NM_MAX_NODES,
602 				 buf + out, len - out);
603 	out += snprintf(buf + out, len - out, "\n");
604 
605 	/* lvb */
606 	out += snprintf(buf + out, len - out, "LVBX:");
607 	for (i = 0; i < DLM_LVB_LEN; i++)
608 		out += snprintf(buf + out, len - out,
609 					"%02x", (unsigned char)res->lvb[i]);
610 	out += snprintf(buf + out, len - out, "\n");
611 
612 	/* granted */
613 	list_for_each_entry(lock, &res->granted, list)
614 		out += dump_lock(lock, 0, buf + out, len - out);
615 
616 	/* converting */
617 	list_for_each_entry(lock, &res->converting, list)
618 		out += dump_lock(lock, 1, buf + out, len - out);
619 
620 	/* blocked */
621 	list_for_each_entry(lock, &res->blocked, list)
622 		out += dump_lock(lock, 2, buf + out, len - out);
623 
624 	out += snprintf(buf + out, len - out, "\n");
625 
626 	return out;
627 }
628 
629 static void *lockres_seq_start(struct seq_file *m, loff_t *pos)
630 {
631 	struct debug_lockres *dl = m->private;
632 	struct dlm_ctxt *dlm = dl->dl_ctxt;
633 	struct dlm_lock_resource *res = NULL;
634 
635 	spin_lock(&dlm->spinlock);
636 
637 	if (dl->dl_res) {
638 		list_for_each_entry(res, &dl->dl_res->tracking, tracking) {
639 			if (dl->dl_res) {
640 				dlm_lockres_put(dl->dl_res);
641 				dl->dl_res = NULL;
642 			}
643 			if (&res->tracking == &dlm->tracking_list) {
644 				mlog(0, "End of list found, %p\n", res);
645 				dl = NULL;
646 				break;
647 			}
648 			dlm_lockres_get(res);
649 			dl->dl_res = res;
650 			break;
651 		}
652 	} else {
653 		if (!list_empty(&dlm->tracking_list)) {
654 			list_for_each_entry(res, &dlm->tracking_list, tracking)
655 				break;
656 			dlm_lockres_get(res);
657 			dl->dl_res = res;
658 		} else
659 			dl = NULL;
660 	}
661 
662 	if (dl) {
663 		spin_lock(&dl->dl_res->spinlock);
664 		dump_lockres(dl->dl_res, dl->dl_buf, dl->dl_len - 1);
665 		spin_unlock(&dl->dl_res->spinlock);
666 	}
667 
668 	spin_unlock(&dlm->spinlock);
669 
670 	return dl;
671 }
672 
673 static void lockres_seq_stop(struct seq_file *m, void *v)
674 {
675 }
676 
677 static void *lockres_seq_next(struct seq_file *m, void *v, loff_t *pos)
678 {
679 	return NULL;
680 }
681 
682 static int lockres_seq_show(struct seq_file *s, void *v)
683 {
684 	struct debug_lockres *dl = (struct debug_lockres *)v;
685 
686 	seq_printf(s, "%s", dl->dl_buf);
687 
688 	return 0;
689 }
690 
691 static struct seq_operations debug_lockres_ops = {
692 	.start =	lockres_seq_start,
693 	.stop =		lockres_seq_stop,
694 	.next =		lockres_seq_next,
695 	.show =		lockres_seq_show,
696 };
697 
698 static int debug_lockres_open(struct inode *inode, struct file *file)
699 {
700 	struct dlm_ctxt *dlm = inode->i_private;
701 	int ret = -ENOMEM;
702 	struct seq_file *seq;
703 	struct debug_lockres *dl = NULL;
704 
705 	dl = kzalloc(sizeof(struct debug_lockres), GFP_KERNEL);
706 	if (!dl) {
707 		mlog_errno(ret);
708 		goto bail;
709 	}
710 
711 	dl->dl_len = PAGE_SIZE;
712 	dl->dl_buf = kmalloc(dl->dl_len, GFP_KERNEL);
713 	if (!dl->dl_buf) {
714 		mlog_errno(ret);
715 		goto bail;
716 	}
717 
718 	ret = seq_open(file, &debug_lockres_ops);
719 	if (ret) {
720 		mlog_errno(ret);
721 		goto bail;
722 	}
723 
724 	seq = (struct seq_file *) file->private_data;
725 	seq->private = dl;
726 
727 	dlm_grab(dlm);
728 	dl->dl_ctxt = dlm;
729 
730 	return 0;
731 bail:
732 	if (dl)
733 		kfree(dl->dl_buf);
734 	kfree(dl);
735 	return ret;
736 }
737 
738 static int debug_lockres_release(struct inode *inode, struct file *file)
739 {
740 	struct seq_file *seq = (struct seq_file *)file->private_data;
741 	struct debug_lockres *dl = (struct debug_lockres *)seq->private;
742 
743 	if (dl->dl_res)
744 		dlm_lockres_put(dl->dl_res);
745 	dlm_put(dl->dl_ctxt);
746 	kfree(dl->dl_buf);
747 	return seq_release_private(inode, file);
748 }
749 
750 static struct file_operations debug_lockres_fops = {
751 	.open =		debug_lockres_open,
752 	.release =	debug_lockres_release,
753 	.read =		seq_read,
754 	.llseek =	seq_lseek,
755 };
756 /* end - debug lockres funcs */
757 
758 /* begin - debug state funcs */
759 static int debug_state_print(struct dlm_ctxt *dlm, struct debug_buffer *db)
760 {
761 	int out = 0;
762 	struct dlm_reco_node_data *node;
763 	char *state;
764 	int lres, rres, ures, tres;
765 
766 	lres = atomic_read(&dlm->local_resources);
767 	rres = atomic_read(&dlm->remote_resources);
768 	ures = atomic_read(&dlm->unknown_resources);
769 	tres = lres + rres + ures;
770 
771 	spin_lock(&dlm->spinlock);
772 
773 	switch (dlm->dlm_state) {
774 	case DLM_CTXT_NEW:
775 		state = "NEW"; break;
776 	case DLM_CTXT_JOINED:
777 		state = "JOINED"; break;
778 	case DLM_CTXT_IN_SHUTDOWN:
779 		state = "SHUTDOWN"; break;
780 	case DLM_CTXT_LEAVING:
781 		state = "LEAVING"; break;
782 	default:
783 		state = "UNKNOWN"; break;
784 	}
785 
786 	/* Domain: xxxxxxxxxx  Key: 0xdfbac769 */
787 	out += snprintf(db->buf + out, db->len - out,
788 			"Domain: %s  Key: 0x%08x\n", dlm->name, dlm->key);
789 
790 	/* Thread Pid: xxx  Node: xxx  State: xxxxx */
791 	out += snprintf(db->buf + out, db->len - out,
792 			"Thread Pid: %d  Node: %d  State: %s\n",
793 			dlm->dlm_thread_task->pid, dlm->node_num, state);
794 
795 	/* Number of Joins: xxx  Joining Node: xxx */
796 	out += snprintf(db->buf + out, db->len - out,
797 			"Number of Joins: %d  Joining Node: %d\n",
798 			dlm->num_joins, dlm->joining_node);
799 
800 	/* Domain Map: xx xx xx */
801 	out += snprintf(db->buf + out, db->len - out, "Domain Map: ");
802 	out += stringify_nodemap(dlm->domain_map, O2NM_MAX_NODES,
803 				 db->buf + out, db->len - out);
804 	out += snprintf(db->buf + out, db->len - out, "\n");
805 
806 	/* Live Map: xx xx xx */
807 	out += snprintf(db->buf + out, db->len - out, "Live Map: ");
808 	out += stringify_nodemap(dlm->live_nodes_map, O2NM_MAX_NODES,
809 				 db->buf + out, db->len - out);
810 	out += snprintf(db->buf + out, db->len - out, "\n");
811 
812 	/* Mastered Resources Total: xxx  Locally: xxx  Remotely: ... */
813 	out += snprintf(db->buf + out, db->len - out,
814 			"Mastered Resources Total: %d  Locally: %d  "
815 			"Remotely: %d  Unknown: %d\n",
816 			tres, lres, rres, ures);
817 
818 	/* Lists: Dirty=Empty  Purge=InUse  PendingASTs=Empty  ... */
819 	out += snprintf(db->buf + out, db->len - out,
820 			"Lists: Dirty=%s  Purge=%s  PendingASTs=%s  "
821 			"PendingBASTs=%s  Master=%s\n",
822 			(list_empty(&dlm->dirty_list) ? "Empty" : "InUse"),
823 			(list_empty(&dlm->purge_list) ? "Empty" : "InUse"),
824 			(list_empty(&dlm->pending_asts) ? "Empty" : "InUse"),
825 			(list_empty(&dlm->pending_basts) ? "Empty" : "InUse"),
826 			(list_empty(&dlm->master_list) ? "Empty" : "InUse"));
827 
828 	/* Purge Count: xxx  Refs: xxx */
829 	out += snprintf(db->buf + out, db->len - out,
830 			"Purge Count: %d  Refs: %d\n", dlm->purge_count,
831 			atomic_read(&dlm->dlm_refs.refcount));
832 
833 	/* Dead Node: xxx */
834 	out += snprintf(db->buf + out, db->len - out,
835 			"Dead Node: %d\n", dlm->reco.dead_node);
836 
837 	/* What about DLM_RECO_STATE_FINALIZE? */
838 	if (dlm->reco.state == DLM_RECO_STATE_ACTIVE)
839 		state = "ACTIVE";
840 	else
841 		state = "INACTIVE";
842 
843 	/* Recovery Pid: xxxx  Master: xxx  State: xxxx */
844 	out += snprintf(db->buf + out, db->len - out,
845 			"Recovery Pid: %d  Master: %d  State: %s\n",
846 			dlm->dlm_reco_thread_task->pid,
847 			dlm->reco.new_master, state);
848 
849 	/* Recovery Map: xx xx */
850 	out += snprintf(db->buf + out, db->len - out, "Recovery Map: ");
851 	out += stringify_nodemap(dlm->recovery_map, O2NM_MAX_NODES,
852 				 db->buf + out, db->len - out);
853 	out += snprintf(db->buf + out, db->len - out, "\n");
854 
855 	/* Recovery Node State: */
856 	out += snprintf(db->buf + out, db->len - out, "Recovery Node State:\n");
857 	list_for_each_entry(node, &dlm->reco.node_data, list) {
858 		switch (node->state) {
859 		case DLM_RECO_NODE_DATA_INIT:
860 			state = "INIT";
861 			break;
862 		case DLM_RECO_NODE_DATA_REQUESTING:
863 			state = "REQUESTING";
864 			break;
865 		case DLM_RECO_NODE_DATA_DEAD:
866 			state = "DEAD";
867 			break;
868 		case DLM_RECO_NODE_DATA_RECEIVING:
869 			state = "RECEIVING";
870 			break;
871 		case DLM_RECO_NODE_DATA_REQUESTED:
872 			state = "REQUESTED";
873 			break;
874 		case DLM_RECO_NODE_DATA_DONE:
875 			state = "DONE";
876 			break;
877 		case DLM_RECO_NODE_DATA_FINALIZE_SENT:
878 			state = "FINALIZE-SENT";
879 			break;
880 		default:
881 			state = "BAD";
882 			break;
883 		}
884 		out += snprintf(db->buf + out, db->len - out, "\t%u - %s\n",
885 				node->node_num, state);
886 	}
887 
888 	spin_unlock(&dlm->spinlock);
889 
890 	return out;
891 }
892 
893 static int debug_state_open(struct inode *inode, struct file *file)
894 {
895 	struct dlm_ctxt *dlm = inode->i_private;
896 	struct debug_buffer *db = NULL;
897 
898 	db = debug_buffer_allocate();
899 	if (!db)
900 		goto bail;
901 
902 	db->len = debug_state_print(dlm, db);
903 
904 	file->private_data = db;
905 
906 	return 0;
907 bail:
908 	return -ENOMEM;
909 }
910 
911 static struct file_operations debug_state_fops = {
912 	.open =		debug_state_open,
913 	.release =	debug_buffer_release,
914 	.read =		debug_buffer_read,
915 	.llseek =	debug_buffer_llseek,
916 };
917 /* end  - debug state funcs */
918 
919 /* files in subroot */
920 int dlm_debug_init(struct dlm_ctxt *dlm)
921 {
922 	struct dlm_debug_ctxt *dc = dlm->dlm_debug_ctxt;
923 
924 	/* for dumping dlm_ctxt */
925 	dc->debug_state_dentry = debugfs_create_file(DLM_DEBUGFS_DLM_STATE,
926 						     S_IFREG|S_IRUSR,
927 						     dlm->dlm_debugfs_subroot,
928 						     dlm, &debug_state_fops);
929 	if (!dc->debug_state_dentry) {
930 		mlog_errno(-ENOMEM);
931 		goto bail;
932 	}
933 
934 	/* for dumping lockres */
935 	dc->debug_lockres_dentry =
936 			debugfs_create_file(DLM_DEBUGFS_LOCKING_STATE,
937 					    S_IFREG|S_IRUSR,
938 					    dlm->dlm_debugfs_subroot,
939 					    dlm, &debug_lockres_fops);
940 	if (!dc->debug_lockres_dentry) {
941 		mlog_errno(-ENOMEM);
942 		goto bail;
943 	}
944 
945 	/* for dumping mles */
946 	dc->debug_mle_dentry = debugfs_create_file(DLM_DEBUGFS_MLE_STATE,
947 						   S_IFREG|S_IRUSR,
948 						   dlm->dlm_debugfs_subroot,
949 						   dlm, &debug_mle_fops);
950 	if (!dc->debug_mle_dentry) {
951 		mlog_errno(-ENOMEM);
952 		goto bail;
953 	}
954 
955 	/* for dumping lockres on the purge list */
956 	dc->debug_purgelist_dentry =
957 			debugfs_create_file(DLM_DEBUGFS_PURGE_LIST,
958 					    S_IFREG|S_IRUSR,
959 					    dlm->dlm_debugfs_subroot,
960 					    dlm, &debug_purgelist_fops);
961 	if (!dc->debug_purgelist_dentry) {
962 		mlog_errno(-ENOMEM);
963 		goto bail;
964 	}
965 
966 	dlm_debug_get(dc);
967 	return 0;
968 
969 bail:
970 	dlm_debug_shutdown(dlm);
971 	return -ENOMEM;
972 }
973 
974 void dlm_debug_shutdown(struct dlm_ctxt *dlm)
975 {
976 	struct dlm_debug_ctxt *dc = dlm->dlm_debug_ctxt;
977 
978 	if (dc) {
979 		if (dc->debug_purgelist_dentry)
980 			debugfs_remove(dc->debug_purgelist_dentry);
981 		if (dc->debug_mle_dentry)
982 			debugfs_remove(dc->debug_mle_dentry);
983 		if (dc->debug_lockres_dentry)
984 			debugfs_remove(dc->debug_lockres_dentry);
985 		if (dc->debug_state_dentry)
986 			debugfs_remove(dc->debug_state_dentry);
987 		dlm_debug_put(dc);
988 	}
989 }
990 
991 /* subroot - domain dir */
992 int dlm_create_debugfs_subroot(struct dlm_ctxt *dlm)
993 {
994 	dlm->dlm_debugfs_subroot = debugfs_create_dir(dlm->name,
995 						      dlm_debugfs_root);
996 	if (!dlm->dlm_debugfs_subroot) {
997 		mlog_errno(-ENOMEM);
998 		goto bail;
999 	}
1000 
1001 	dlm->dlm_debug_ctxt = kzalloc(sizeof(struct dlm_debug_ctxt),
1002 				      GFP_KERNEL);
1003 	if (!dlm->dlm_debug_ctxt) {
1004 		mlog_errno(-ENOMEM);
1005 		goto bail;
1006 	}
1007 	kref_init(&dlm->dlm_debug_ctxt->debug_refcnt);
1008 
1009 	return 0;
1010 bail:
1011 	dlm_destroy_debugfs_subroot(dlm);
1012 	return -ENOMEM;
1013 }
1014 
1015 void dlm_destroy_debugfs_subroot(struct dlm_ctxt *dlm)
1016 {
1017 	if (dlm->dlm_debugfs_subroot)
1018 		debugfs_remove(dlm->dlm_debugfs_subroot);
1019 }
1020 
1021 /* debugfs root */
1022 int dlm_create_debugfs_root(void)
1023 {
1024 	dlm_debugfs_root = debugfs_create_dir(DLM_DEBUGFS_DIR, NULL);
1025 	if (!dlm_debugfs_root) {
1026 		mlog_errno(-ENOMEM);
1027 		return -ENOMEM;
1028 	}
1029 	return 0;
1030 }
1031 
1032 void dlm_destroy_debugfs_root(void)
1033 {
1034 	if (dlm_debugfs_root)
1035 		debugfs_remove(dlm_debugfs_root);
1036 }
1037 #endif	/* CONFIG_DEBUG_FS */
1038