1 /******************************************************************************
2 *******************************************************************************
4 ** Copyright (C) 2005-2009 Red Hat, Inc. All rights reserved.
6 ** This copyrighted material is made available to anyone wishing to use,
7 ** modify, copy, or redistribute it subject to the terms and conditions
8 ** of the GNU General Public License v.2.
10 *******************************************************************************
11 ******************************************************************************/
13 #include <linux/pagemap.h>
14 #include <linux/seq_file.h>
15 #include <linux/module.h>
16 #include <linux/ctype.h>
17 #include <linux/debugfs.h>
18 #include <linux/slab.h>
20 #include "dlm_internal.h"
23 #define DLM_DEBUG_BUF_LEN 4096
24 static char debug_buf[DLM_DEBUG_BUF_LEN];
25 static struct mutex debug_buf_lock;
27 static struct dentry *dlm_root;
29 static char *print_lockmode(int mode)
51 static void print_format1_lock(struct seq_file *s, struct dlm_lkb *lkb,
54 seq_printf(s, "%08x %s", lkb->lkb_id, print_lockmode(lkb->lkb_grmode));
56 if (lkb->lkb_status == DLM_LKSTS_CONVERT ||
57 lkb->lkb_status == DLM_LKSTS_WAITING)
58 seq_printf(s, " (%s)", print_lockmode(lkb->lkb_rqmode));
60 if (lkb->lkb_nodeid) {
61 if (lkb->lkb_nodeid != res->res_nodeid)
62 seq_printf(s, " Remote: %3d %08x", lkb->lkb_nodeid,
65 seq_printf(s, " Master: %08x", lkb->lkb_remid);
68 if (lkb->lkb_wait_type)
69 seq_printf(s, " wait_type: %d", lkb->lkb_wait_type);
74 static void print_format1(struct dlm_rsb *res, struct seq_file *s)
77 int i, lvblen = res->res_ls->ls_lvblen, recover_list, root_list;
81 seq_printf(s, "\nResource %p Name (len=%d) \"", res, res->res_length);
83 for (i = 0; i < res->res_length; i++) {
84 if (isprint(res->res_name[i]))
85 seq_printf(s, "%c", res->res_name[i]);
87 seq_printf(s, "%c", '.');
90 if (res->res_nodeid > 0)
91 seq_printf(s, "\"\nLocal Copy, Master is node %d\n",
93 else if (res->res_nodeid == 0)
94 seq_puts(s, "\"\nMaster Copy\n");
95 else if (res->res_nodeid == -1)
96 seq_printf(s, "\"\nLooking up master (lkid %x)\n",
99 seq_printf(s, "\"\nInvalid master %d\n", res->res_nodeid);
100 if (seq_has_overflowed(s))
104 if (res->res_lvbptr) {
105 seq_puts(s, "LVB: ");
106 for (i = 0; i < lvblen; i++) {
109 seq_printf(s, "%02x ",
110 (unsigned char) res->res_lvbptr[i]);
112 if (rsb_flag(res, RSB_VALNOTVALID))
113 seq_puts(s, " (INVALID)");
115 if (seq_has_overflowed(s))
119 root_list = !list_empty(&res->res_root_list);
120 recover_list = !list_empty(&res->res_recover_list);
122 if (root_list || recover_list) {
123 seq_printf(s, "Recovery: root %d recover %d flags %lx count %d\n",
124 root_list, recover_list,
125 res->res_flags, res->res_recover_locks_count);
128 /* Print the locks attached to this resource */
129 seq_puts(s, "Granted Queue\n");
130 list_for_each_entry(lkb, &res->res_grantqueue, lkb_statequeue) {
131 print_format1_lock(s, lkb, res);
132 if (seq_has_overflowed(s))
136 seq_puts(s, "Conversion Queue\n");
137 list_for_each_entry(lkb, &res->res_convertqueue, lkb_statequeue) {
138 print_format1_lock(s, lkb, res);
139 if (seq_has_overflowed(s))
143 seq_puts(s, "Waiting Queue\n");
144 list_for_each_entry(lkb, &res->res_waitqueue, lkb_statequeue) {
145 print_format1_lock(s, lkb, res);
146 if (seq_has_overflowed(s))
150 if (list_empty(&res->res_lookup))
153 seq_puts(s, "Lookup Queue\n");
154 list_for_each_entry(lkb, &res->res_lookup, lkb_rsb_lookup) {
155 seq_printf(s, "%08x %s",
156 lkb->lkb_id, print_lockmode(lkb->lkb_rqmode));
157 if (lkb->lkb_wait_type)
158 seq_printf(s, " wait_type: %d", lkb->lkb_wait_type);
160 if (seq_has_overflowed(s))
167 static void print_format2_lock(struct seq_file *s, struct dlm_lkb *lkb,
173 if (lkb->lkb_flags & DLM_IFL_USER) {
175 xid = lkb->lkb_ua->xid;
178 /* microseconds since lkb was added to current queue */
179 us = ktime_to_us(ktime_sub(ktime_get(), lkb->lkb_timestamp));
181 /* id nodeid remid pid xid exflags flags sts grmode rqmode time_us
182 r_nodeid r_len r_name */
184 seq_printf(s, "%x %d %x %u %llu %x %x %d %d %d %llu %u %d \"%s\"\n",
189 (unsigned long long)xid,
195 (unsigned long long)us,
201 static void print_format2(struct dlm_rsb *r, struct seq_file *s)
207 list_for_each_entry(lkb, &r->res_grantqueue, lkb_statequeue) {
208 print_format2_lock(s, lkb, r);
209 if (seq_has_overflowed(s))
213 list_for_each_entry(lkb, &r->res_convertqueue, lkb_statequeue) {
214 print_format2_lock(s, lkb, r);
215 if (seq_has_overflowed(s))
219 list_for_each_entry(lkb, &r->res_waitqueue, lkb_statequeue) {
220 print_format2_lock(s, lkb, r);
221 if (seq_has_overflowed(s))
228 static void print_format3_lock(struct seq_file *s, struct dlm_lkb *lkb,
233 if (lkb->lkb_flags & DLM_IFL_USER) {
235 xid = lkb->lkb_ua->xid;
238 seq_printf(s, "lkb %x %d %x %u %llu %x %x %d %d %d %d %d %d %u %llu %llu\n",
243 (unsigned long long)xid,
249 lkb->lkb_last_bast.mode,
253 (unsigned long long)ktime_to_ns(lkb->lkb_timestamp),
254 (unsigned long long)ktime_to_ns(lkb->lkb_last_bast_time));
257 static void print_format3(struct dlm_rsb *r, struct seq_file *s)
260 int i, lvblen = r->res_ls->ls_lvblen;
265 seq_printf(s, "rsb %p %d %x %lx %d %d %u %d ",
270 !list_empty(&r->res_root_list),
271 !list_empty(&r->res_recover_list),
272 r->res_recover_locks_count,
274 if (seq_has_overflowed(s))
277 for (i = 0; i < r->res_length; i++) {
278 if (!isascii(r->res_name[i]) || !isprint(r->res_name[i]))
282 seq_puts(s, print_name ? "str " : "hex");
284 for (i = 0; i < r->res_length; i++) {
286 seq_printf(s, "%c", r->res_name[i]);
288 seq_printf(s, " %02x", (unsigned char)r->res_name[i]);
291 if (seq_has_overflowed(s))
297 seq_printf(s, "lvb %u %d", r->res_lvbseq, lvblen);
299 for (i = 0; i < lvblen; i++)
300 seq_printf(s, " %02x", (unsigned char)r->res_lvbptr[i]);
302 if (seq_has_overflowed(s))
306 list_for_each_entry(lkb, &r->res_grantqueue, lkb_statequeue) {
307 print_format3_lock(s, lkb, 0);
308 if (seq_has_overflowed(s))
312 list_for_each_entry(lkb, &r->res_convertqueue, lkb_statequeue) {
313 print_format3_lock(s, lkb, 0);
314 if (seq_has_overflowed(s))
318 list_for_each_entry(lkb, &r->res_waitqueue, lkb_statequeue) {
319 print_format3_lock(s, lkb, 0);
320 if (seq_has_overflowed(s))
324 list_for_each_entry(lkb, &r->res_lookup, lkb_rsb_lookup) {
325 print_format3_lock(s, lkb, 1);
326 if (seq_has_overflowed(s))
333 static void print_format4(struct dlm_rsb *r, struct seq_file *s)
335 int our_nodeid = dlm_our_nodeid();
341 seq_printf(s, "rsb %p %d %d %d %d %lu %lx %d ",
344 r->res_master_nodeid,
351 for (i = 0; i < r->res_length; i++) {
352 if (!isascii(r->res_name[i]) || !isprint(r->res_name[i]))
356 seq_puts(s, print_name ? "str " : "hex");
358 for (i = 0; i < r->res_length; i++) {
360 seq_printf(s, "%c", r->res_name[i]);
362 seq_printf(s, " %02x", (unsigned char)r->res_name[i]);
377 * If the buffer is full, seq_printf can be called again, but it
378 * does nothing. So, the these printing routines periodically check
379 * seq_has_overflowed to avoid wasting too much time trying to print to
383 static int table_seq_show(struct seq_file *seq, void *iter_ptr)
385 struct rsbtbl_iter *ri = iter_ptr;
387 switch (ri->format) {
389 print_format1(ri->rsb, seq);
393 seq_puts(seq, "id nodeid remid pid xid exflags flags sts grmode rqmode time_ms r_nodeid r_len r_name\n");
396 print_format2(ri->rsb, seq);
400 seq_puts(seq, "version rsb 1.1 lvb 1.1 lkb 1.1\n");
403 print_format3(ri->rsb, seq);
407 seq_puts(seq, "version 4 rsb 2\n");
410 print_format4(ri->rsb, seq);
417 static const struct seq_operations format1_seq_ops;
418 static const struct seq_operations format2_seq_ops;
419 static const struct seq_operations format3_seq_ops;
420 static const struct seq_operations format4_seq_ops;
422 static void *table_seq_start(struct seq_file *seq, loff_t *pos)
424 struct rb_root *tree;
425 struct rb_node *node;
426 struct dlm_ls *ls = seq->private;
427 struct rsbtbl_iter *ri;
430 unsigned bucket, entry;
431 int toss = (seq->op == &format4_seq_ops);
434 entry = n & ((1LL << 32) - 1);
436 if (bucket >= ls->ls_rsbtbl_size)
439 ri = kzalloc(sizeof(struct rsbtbl_iter), GFP_NOFS);
444 if (seq->op == &format1_seq_ops)
446 if (seq->op == &format2_seq_ops)
448 if (seq->op == &format3_seq_ops)
450 if (seq->op == &format4_seq_ops)
453 tree = toss ? &ls->ls_rsbtbl[bucket].toss : &ls->ls_rsbtbl[bucket].keep;
455 spin_lock(&ls->ls_rsbtbl[bucket].lock);
456 if (!RB_EMPTY_ROOT(tree)) {
457 for (node = rb_first(tree); node; node = rb_next(node)) {
458 r = rb_entry(node, struct dlm_rsb, res_hashnode);
463 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
468 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
471 * move to the first rsb in the next non-empty bucket
475 n &= ~((1LL << 32) - 1);
481 if (bucket >= ls->ls_rsbtbl_size) {
485 tree = toss ? &ls->ls_rsbtbl[bucket].toss : &ls->ls_rsbtbl[bucket].keep;
487 spin_lock(&ls->ls_rsbtbl[bucket].lock);
488 if (!RB_EMPTY_ROOT(tree)) {
489 node = rb_first(tree);
490 r = rb_entry(node, struct dlm_rsb, res_hashnode);
494 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
498 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
502 static void *table_seq_next(struct seq_file *seq, void *iter_ptr, loff_t *pos)
504 struct dlm_ls *ls = seq->private;
505 struct rsbtbl_iter *ri = iter_ptr;
506 struct rb_root *tree;
507 struct rb_node *next;
508 struct dlm_rsb *r, *rp;
511 int toss = (seq->op == &format4_seq_ops);
516 * move to the next rsb in the same bucket
519 spin_lock(&ls->ls_rsbtbl[bucket].lock);
521 next = rb_next(&rp->res_hashnode);
524 r = rb_entry(next, struct dlm_rsb, res_hashnode);
527 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
532 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
536 * move to the first rsb in the next non-empty bucket
540 n &= ~((1LL << 32) - 1);
546 if (bucket >= ls->ls_rsbtbl_size) {
551 tree = toss ? &ls->ls_rsbtbl[bucket].toss : &ls->ls_rsbtbl[bucket].keep;
553 spin_lock(&ls->ls_rsbtbl[bucket].lock);
554 if (!RB_EMPTY_ROOT(tree)) {
555 next = rb_first(tree);
556 r = rb_entry(next, struct dlm_rsb, res_hashnode);
560 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
564 spin_unlock(&ls->ls_rsbtbl[bucket].lock);
568 static void table_seq_stop(struct seq_file *seq, void *iter_ptr)
570 struct rsbtbl_iter *ri = iter_ptr;
573 dlm_put_rsb(ri->rsb);
578 static const struct seq_operations format1_seq_ops = {
579 .start = table_seq_start,
580 .next = table_seq_next,
581 .stop = table_seq_stop,
582 .show = table_seq_show,
585 static const struct seq_operations format2_seq_ops = {
586 .start = table_seq_start,
587 .next = table_seq_next,
588 .stop = table_seq_stop,
589 .show = table_seq_show,
592 static const struct seq_operations format3_seq_ops = {
593 .start = table_seq_start,
594 .next = table_seq_next,
595 .stop = table_seq_stop,
596 .show = table_seq_show,
599 static const struct seq_operations format4_seq_ops = {
600 .start = table_seq_start,
601 .next = table_seq_next,
602 .stop = table_seq_stop,
603 .show = table_seq_show,
606 static const struct file_operations format1_fops;
607 static const struct file_operations format2_fops;
608 static const struct file_operations format3_fops;
609 static const struct file_operations format4_fops;
611 static int table_open1(struct inode *inode, struct file *file)
613 struct seq_file *seq;
616 ret = seq_open(file, &format1_seq_ops);
620 seq = file->private_data;
621 seq->private = inode->i_private; /* the dlm_ls */
625 static int table_open2(struct inode *inode, struct file *file)
627 struct seq_file *seq;
630 ret = seq_open(file, &format2_seq_ops);
634 seq = file->private_data;
635 seq->private = inode->i_private; /* the dlm_ls */
639 static int table_open3(struct inode *inode, struct file *file)
641 struct seq_file *seq;
644 ret = seq_open(file, &format3_seq_ops);
648 seq = file->private_data;
649 seq->private = inode->i_private; /* the dlm_ls */
653 static int table_open4(struct inode *inode, struct file *file)
655 struct seq_file *seq;
658 ret = seq_open(file, &format4_seq_ops);
662 seq = file->private_data;
663 seq->private = inode->i_private; /* the dlm_ls */
667 static const struct file_operations format1_fops = {
668 .owner = THIS_MODULE,
672 .release = seq_release
675 static const struct file_operations format2_fops = {
676 .owner = THIS_MODULE,
680 .release = seq_release
683 static const struct file_operations format3_fops = {
684 .owner = THIS_MODULE,
688 .release = seq_release
691 static const struct file_operations format4_fops = {
692 .owner = THIS_MODULE,
696 .release = seq_release
700 * dump lkb's on the ls_waiters list
702 static ssize_t waiters_read(struct file *file, char __user *userbuf,
703 size_t count, loff_t *ppos)
705 struct dlm_ls *ls = file->private_data;
707 size_t len = DLM_DEBUG_BUF_LEN, pos = 0, ret, rv;
709 mutex_lock(&debug_buf_lock);
710 mutex_lock(&ls->ls_waiters_mutex);
711 memset(debug_buf, 0, sizeof(debug_buf));
713 list_for_each_entry(lkb, &ls->ls_waiters, lkb_wait_reply) {
714 ret = snprintf(debug_buf + pos, len - pos, "%x %d %d %s\n",
715 lkb->lkb_id, lkb->lkb_wait_type,
716 lkb->lkb_nodeid, lkb->lkb_resource->res_name);
717 if (ret >= len - pos)
721 mutex_unlock(&ls->ls_waiters_mutex);
723 rv = simple_read_from_buffer(userbuf, count, ppos, debug_buf, pos);
724 mutex_unlock(&debug_buf_lock);
728 static const struct file_operations waiters_fops = {
729 .owner = THIS_MODULE,
731 .read = waiters_read,
732 .llseek = default_llseek,
735 void dlm_delete_debug_file(struct dlm_ls *ls)
737 debugfs_remove(ls->ls_debug_rsb_dentry);
738 debugfs_remove(ls->ls_debug_waiters_dentry);
739 debugfs_remove(ls->ls_debug_locks_dentry);
740 debugfs_remove(ls->ls_debug_all_dentry);
741 debugfs_remove(ls->ls_debug_toss_dentry);
744 int dlm_create_debug_file(struct dlm_ls *ls)
746 char name[DLM_LOCKSPACE_LEN+8];
750 ls->ls_debug_rsb_dentry = debugfs_create_file(ls->ls_name,
755 if (!ls->ls_debug_rsb_dentry)
760 memset(name, 0, sizeof(name));
761 snprintf(name, DLM_LOCKSPACE_LEN+8, "%s_locks", ls->ls_name);
763 ls->ls_debug_locks_dentry = debugfs_create_file(name,
768 if (!ls->ls_debug_locks_dentry)
773 memset(name, 0, sizeof(name));
774 snprintf(name, DLM_LOCKSPACE_LEN+8, "%s_all", ls->ls_name);
776 ls->ls_debug_all_dentry = debugfs_create_file(name,
781 if (!ls->ls_debug_all_dentry)
786 memset(name, 0, sizeof(name));
787 snprintf(name, DLM_LOCKSPACE_LEN+8, "%s_toss", ls->ls_name);
789 ls->ls_debug_toss_dentry = debugfs_create_file(name,
794 if (!ls->ls_debug_toss_dentry)
797 memset(name, 0, sizeof(name));
798 snprintf(name, DLM_LOCKSPACE_LEN+8, "%s_waiters", ls->ls_name);
800 ls->ls_debug_waiters_dentry = debugfs_create_file(name,
805 if (!ls->ls_debug_waiters_dentry)
811 dlm_delete_debug_file(ls);
815 int __init dlm_register_debugfs(void)
817 mutex_init(&debug_buf_lock);
818 dlm_root = debugfs_create_dir("dlm", NULL);
819 return dlm_root ? 0 : -ENOMEM;
822 void dlm_unregister_debugfs(void)
824 debugfs_remove(dlm_root);