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 int 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
);
71 return seq_printf(s
, "\n");
74 static int print_format1(struct dlm_rsb
*res
, struct seq_file
*s
)
77 int i
, lvblen
= res
->res_ls
->ls_lvblen
, recover_list
, root_list
;
82 rv
= seq_printf(s
, "\nResource %p Name (len=%d) \"",
83 res
, res
->res_length
);
87 for (i
= 0; i
< res
->res_length
; i
++) {
88 if (isprint(res
->res_name
[i
]))
89 seq_printf(s
, "%c", res
->res_name
[i
]);
91 seq_printf(s
, "%c", '.');
94 if (res
->res_nodeid
> 0)
95 rv
= seq_printf(s
, "\" \nLocal Copy, Master is node %d\n",
97 else if (res
->res_nodeid
== 0)
98 rv
= seq_printf(s
, "\" \nMaster Copy\n");
99 else if (res
->res_nodeid
== -1)
100 rv
= seq_printf(s
, "\" \nLooking up master (lkid %x)\n",
101 res
->res_first_lkid
);
103 rv
= seq_printf(s
, "\" \nInvalid master %d\n",
109 if (res
->res_lvbptr
) {
110 seq_printf(s
, "LVB: ");
111 for (i
= 0; i
< lvblen
; i
++) {
113 seq_printf(s
, "\n ");
114 seq_printf(s
, "%02x ",
115 (unsigned char) res
->res_lvbptr
[i
]);
117 if (rsb_flag(res
, RSB_VALNOTVALID
))
118 seq_printf(s
, " (INVALID)");
119 rv
= seq_printf(s
, "\n");
124 root_list
= !list_empty(&res
->res_root_list
);
125 recover_list
= !list_empty(&res
->res_recover_list
);
127 if (root_list
|| recover_list
) {
128 rv
= seq_printf(s
, "Recovery: root %d recover %d flags %lx "
129 "count %d\n", root_list
, recover_list
,
130 res
->res_flags
, res
->res_recover_locks_count
);
135 /* Print the locks attached to this resource */
136 seq_printf(s
, "Granted Queue\n");
137 list_for_each_entry(lkb
, &res
->res_grantqueue
, lkb_statequeue
) {
138 rv
= print_format1_lock(s
, lkb
, res
);
143 seq_printf(s
, "Conversion Queue\n");
144 list_for_each_entry(lkb
, &res
->res_convertqueue
, lkb_statequeue
) {
145 rv
= print_format1_lock(s
, lkb
, res
);
150 seq_printf(s
, "Waiting Queue\n");
151 list_for_each_entry(lkb
, &res
->res_waitqueue
, lkb_statequeue
) {
152 rv
= print_format1_lock(s
, lkb
, res
);
157 if (list_empty(&res
->res_lookup
))
160 seq_printf(s
, "Lookup Queue\n");
161 list_for_each_entry(lkb
, &res
->res_lookup
, lkb_rsb_lookup
) {
162 rv
= seq_printf(s
, "%08x %s", lkb
->lkb_id
,
163 print_lockmode(lkb
->lkb_rqmode
));
164 if (lkb
->lkb_wait_type
)
165 seq_printf(s
, " wait_type: %d", lkb
->lkb_wait_type
);
166 rv
= seq_printf(s
, "\n");
173 static int print_format2_lock(struct seq_file
*s
, struct dlm_lkb
*lkb
,
180 if (lkb
->lkb_flags
& DLM_IFL_USER
) {
182 xid
= lkb
->lkb_ua
->xid
;
185 /* microseconds since lkb was added to current queue */
186 us
= ktime_to_us(ktime_sub(ktime_get(), lkb
->lkb_timestamp
));
188 /* id nodeid remid pid xid exflags flags sts grmode rqmode time_us
189 r_nodeid r_len r_name */
191 rv
= seq_printf(s
, "%x %d %x %u %llu %x %x %d %d %d %llu %u %d \"%s\"\n",
196 (unsigned long long)xid
,
202 (unsigned long long)us
,
209 static int print_format2(struct dlm_rsb
*r
, struct seq_file
*s
)
216 list_for_each_entry(lkb
, &r
->res_grantqueue
, lkb_statequeue
) {
217 rv
= print_format2_lock(s
, lkb
, r
);
222 list_for_each_entry(lkb
, &r
->res_convertqueue
, lkb_statequeue
) {
223 rv
= print_format2_lock(s
, lkb
, r
);
228 list_for_each_entry(lkb
, &r
->res_waitqueue
, lkb_statequeue
) {
229 rv
= print_format2_lock(s
, lkb
, r
);
238 static int print_format3_lock(struct seq_file
*s
, struct dlm_lkb
*lkb
,
244 if (lkb
->lkb_flags
& DLM_IFL_USER
) {
246 xid
= lkb
->lkb_ua
->xid
;
249 rv
= seq_printf(s
, "lkb %x %d %x %u %llu %x %x %d %d %d %d %d %d %u %llu %llu\n",
254 (unsigned long long)xid
,
264 (unsigned long long)ktime_to_ns(lkb
->lkb_timestamp
),
265 (unsigned long long)ktime_to_ns(lkb
->lkb_time_bast
));
269 static int print_format3(struct dlm_rsb
*r
, struct seq_file
*s
)
272 int i
, lvblen
= r
->res_ls
->ls_lvblen
;
278 rv
= seq_printf(s
, "rsb %p %d %x %lx %d %d %u %d ",
283 !list_empty(&r
->res_root_list
),
284 !list_empty(&r
->res_recover_list
),
285 r
->res_recover_locks_count
,
290 for (i
= 0; i
< r
->res_length
; i
++) {
291 if (!isascii(r
->res_name
[i
]) || !isprint(r
->res_name
[i
]))
295 seq_printf(s
, "%s", print_name
? "str " : "hex");
297 for (i
= 0; i
< r
->res_length
; i
++) {
299 seq_printf(s
, "%c", r
->res_name
[i
]);
301 seq_printf(s
, " %02x", (unsigned char)r
->res_name
[i
]);
303 rv
= seq_printf(s
, "\n");
310 seq_printf(s
, "lvb %u %d", r
->res_lvbseq
, lvblen
);
312 for (i
= 0; i
< lvblen
; i
++)
313 seq_printf(s
, " %02x", (unsigned char)r
->res_lvbptr
[i
]);
314 rv
= seq_printf(s
, "\n");
319 list_for_each_entry(lkb
, &r
->res_grantqueue
, lkb_statequeue
) {
320 rv
= print_format3_lock(s
, lkb
, 0);
325 list_for_each_entry(lkb
, &r
->res_convertqueue
, lkb_statequeue
) {
326 rv
= print_format3_lock(s
, lkb
, 0);
331 list_for_each_entry(lkb
, &r
->res_waitqueue
, lkb_statequeue
) {
332 rv
= print_format3_lock(s
, lkb
, 0);
337 list_for_each_entry(lkb
, &r
->res_lookup
, lkb_rsb_lookup
) {
338 rv
= print_format3_lock(s
, lkb
, 1);
354 /* seq_printf returns -1 if the buffer is full, and 0 otherwise.
355 If the buffer is full, seq_printf can be called again, but it
356 does nothing and just returns -1. So, the these printing routines
357 periodically check the return value to avoid wasting too much time
358 trying to print to a full buffer. */
360 static int table_seq_show(struct seq_file
*seq
, void *iter_ptr
)
362 struct rsbtbl_iter
*ri
= iter_ptr
;
365 switch (ri
->format
) {
367 rv
= print_format1(ri
->rsb
, seq
);
371 seq_printf(seq
, "id nodeid remid pid xid exflags "
372 "flags sts grmode rqmode time_ms "
373 "r_nodeid r_len r_name\n");
376 rv
= print_format2(ri
->rsb
, seq
);
380 seq_printf(seq
, "version rsb 1.1 lvb 1.1 lkb 1.1\n");
383 rv
= print_format3(ri
->rsb
, seq
);
390 static const struct seq_operations format1_seq_ops
;
391 static const struct seq_operations format2_seq_ops
;
392 static const struct seq_operations format3_seq_ops
;
394 static void *table_seq_start(struct seq_file
*seq
, loff_t
*pos
)
396 struct dlm_ls
*ls
= seq
->private;
397 struct rsbtbl_iter
*ri
;
400 unsigned bucket
, entry
;
403 entry
= n
& ((1LL << 32) - 1);
405 if (bucket
>= ls
->ls_rsbtbl_size
)
408 ri
= kzalloc(sizeof(struct rsbtbl_iter
), GFP_NOFS
);
413 if (seq
->op
== &format1_seq_ops
)
415 if (seq
->op
== &format2_seq_ops
)
417 if (seq
->op
== &format3_seq_ops
)
420 spin_lock(&ls
->ls_rsbtbl
[bucket
].lock
);
421 if (!list_empty(&ls
->ls_rsbtbl
[bucket
].list
)) {
422 list_for_each_entry(r
, &ls
->ls_rsbtbl
[bucket
].list
,
428 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
433 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
436 * move to the first rsb in the next non-empty bucket
440 n
&= ~((1LL << 32) - 1);
446 if (bucket
>= ls
->ls_rsbtbl_size
) {
451 spin_lock(&ls
->ls_rsbtbl
[bucket
].lock
);
452 if (!list_empty(&ls
->ls_rsbtbl
[bucket
].list
)) {
453 r
= list_first_entry(&ls
->ls_rsbtbl
[bucket
].list
,
454 struct dlm_rsb
, res_hashchain
);
458 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
462 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
466 static void *table_seq_next(struct seq_file
*seq
, void *iter_ptr
, loff_t
*pos
)
468 struct dlm_ls
*ls
= seq
->private;
469 struct rsbtbl_iter
*ri
= iter_ptr
;
470 struct list_head
*next
;
471 struct dlm_rsb
*r
, *rp
;
478 * move to the next rsb in the same bucket
481 spin_lock(&ls
->ls_rsbtbl
[bucket
].lock
);
483 next
= rp
->res_hashchain
.next
;
485 if (next
!= &ls
->ls_rsbtbl
[bucket
].list
) {
486 r
= list_entry(next
, struct dlm_rsb
, res_hashchain
);
489 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
494 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
498 * move to the first rsb in the next non-empty bucket
502 n
&= ~((1LL << 32) - 1);
508 if (bucket
>= ls
->ls_rsbtbl_size
) {
513 spin_lock(&ls
->ls_rsbtbl
[bucket
].lock
);
514 if (!list_empty(&ls
->ls_rsbtbl
[bucket
].list
)) {
515 r
= list_first_entry(&ls
->ls_rsbtbl
[bucket
].list
,
516 struct dlm_rsb
, res_hashchain
);
520 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
524 spin_unlock(&ls
->ls_rsbtbl
[bucket
].lock
);
528 static void table_seq_stop(struct seq_file
*seq
, void *iter_ptr
)
530 struct rsbtbl_iter
*ri
= iter_ptr
;
533 dlm_put_rsb(ri
->rsb
);
538 static const struct seq_operations format1_seq_ops
= {
539 .start
= table_seq_start
,
540 .next
= table_seq_next
,
541 .stop
= table_seq_stop
,
542 .show
= table_seq_show
,
545 static const struct seq_operations format2_seq_ops
= {
546 .start
= table_seq_start
,
547 .next
= table_seq_next
,
548 .stop
= table_seq_stop
,
549 .show
= table_seq_show
,
552 static const struct seq_operations format3_seq_ops
= {
553 .start
= table_seq_start
,
554 .next
= table_seq_next
,
555 .stop
= table_seq_stop
,
556 .show
= table_seq_show
,
559 static const struct file_operations format1_fops
;
560 static const struct file_operations format2_fops
;
561 static const struct file_operations format3_fops
;
563 static int table_open(struct inode
*inode
, struct file
*file
)
565 struct seq_file
*seq
;
568 if (file
->f_op
== &format1_fops
)
569 ret
= seq_open(file
, &format1_seq_ops
);
570 else if (file
->f_op
== &format2_fops
)
571 ret
= seq_open(file
, &format2_seq_ops
);
572 else if (file
->f_op
== &format3_fops
)
573 ret
= seq_open(file
, &format3_seq_ops
);
578 seq
= file
->private_data
;
579 seq
->private = inode
->i_private
; /* the dlm_ls */
583 static const struct file_operations format1_fops
= {
584 .owner
= THIS_MODULE
,
588 .release
= seq_release
591 static const struct file_operations format2_fops
= {
592 .owner
= THIS_MODULE
,
596 .release
= seq_release
599 static const struct file_operations format3_fops
= {
600 .owner
= THIS_MODULE
,
604 .release
= seq_release
608 * dump lkb's on the ls_waiters list
611 static int waiters_open(struct inode
*inode
, struct file
*file
)
613 file
->private_data
= inode
->i_private
;
617 static ssize_t
waiters_read(struct file
*file
, char __user
*userbuf
,
618 size_t count
, loff_t
*ppos
)
620 struct dlm_ls
*ls
= file
->private_data
;
622 size_t len
= DLM_DEBUG_BUF_LEN
, pos
= 0, ret
, rv
;
624 mutex_lock(&debug_buf_lock
);
625 mutex_lock(&ls
->ls_waiters_mutex
);
626 memset(debug_buf
, 0, sizeof(debug_buf
));
628 list_for_each_entry(lkb
, &ls
->ls_waiters
, lkb_wait_reply
) {
629 ret
= snprintf(debug_buf
+ pos
, len
- pos
, "%x %d %d %s\n",
630 lkb
->lkb_id
, lkb
->lkb_wait_type
,
631 lkb
->lkb_nodeid
, lkb
->lkb_resource
->res_name
);
632 if (ret
>= len
- pos
)
636 mutex_unlock(&ls
->ls_waiters_mutex
);
638 rv
= simple_read_from_buffer(userbuf
, count
, ppos
, debug_buf
, pos
);
639 mutex_unlock(&debug_buf_lock
);
643 static const struct file_operations waiters_fops
= {
644 .owner
= THIS_MODULE
,
645 .open
= waiters_open
,
646 .read
= waiters_read
,
647 .llseek
= default_llseek
,
650 void dlm_delete_debug_file(struct dlm_ls
*ls
)
652 if (ls
->ls_debug_rsb_dentry
)
653 debugfs_remove(ls
->ls_debug_rsb_dentry
);
654 if (ls
->ls_debug_waiters_dentry
)
655 debugfs_remove(ls
->ls_debug_waiters_dentry
);
656 if (ls
->ls_debug_locks_dentry
)
657 debugfs_remove(ls
->ls_debug_locks_dentry
);
658 if (ls
->ls_debug_all_dentry
)
659 debugfs_remove(ls
->ls_debug_all_dentry
);
662 int dlm_create_debug_file(struct dlm_ls
*ls
)
664 char name
[DLM_LOCKSPACE_LEN
+8];
668 ls
->ls_debug_rsb_dentry
= debugfs_create_file(ls
->ls_name
,
673 if (!ls
->ls_debug_rsb_dentry
)
678 memset(name
, 0, sizeof(name
));
679 snprintf(name
, DLM_LOCKSPACE_LEN
+8, "%s_locks", ls
->ls_name
);
681 ls
->ls_debug_locks_dentry
= debugfs_create_file(name
,
686 if (!ls
->ls_debug_locks_dentry
)
691 memset(name
, 0, sizeof(name
));
692 snprintf(name
, DLM_LOCKSPACE_LEN
+8, "%s_all", ls
->ls_name
);
694 ls
->ls_debug_all_dentry
= debugfs_create_file(name
,
699 if (!ls
->ls_debug_all_dentry
)
702 memset(name
, 0, sizeof(name
));
703 snprintf(name
, DLM_LOCKSPACE_LEN
+8, "%s_waiters", ls
->ls_name
);
705 ls
->ls_debug_waiters_dentry
= debugfs_create_file(name
,
710 if (!ls
->ls_debug_waiters_dentry
)
716 dlm_delete_debug_file(ls
);
720 int __init
dlm_register_debugfs(void)
722 mutex_init(&debug_buf_lock
);
723 dlm_root
= debugfs_create_dir("dlm", NULL
);
724 return dlm_root
? 0 : -ENOMEM
;
727 void dlm_unregister_debugfs(void)
729 debugfs_remove(dlm_root
);