1 // SPDX-License-Identifier: GPL-2.0-only
2 /******************************************************************************
3 *******************************************************************************
5 ** Copyright (C) 2005-2009 Red Hat, Inc. All rights reserved.
8 *******************************************************************************
9 ******************************************************************************/
11 #include <linux/pagemap.h>
12 #include <linux/seq_file.h>
13 #include <linux/init.h>
14 #include <linux/ctype.h>
15 #include <linux/debugfs.h>
16 #include <linux/slab.h>
18 #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;
28 static struct dentry *dlm_comms;
30 static char *print_lockmode(int mode)
52 static void print_format1_lock(struct seq_file *s, struct dlm_lkb *lkb,
55 seq_printf(s, "%08x %s", lkb->lkb_id, print_lockmode(lkb->lkb_grmode));
57 if (lkb->lkb_status == DLM_LKSTS_CONVERT ||
58 lkb->lkb_status == DLM_LKSTS_WAITING)
59 seq_printf(s, " (%s)", print_lockmode(lkb->lkb_rqmode));
61 if (lkb->lkb_nodeid) {
62 if (lkb->lkb_nodeid != res->res_nodeid)
63 seq_printf(s, " Remote: %3d %08x", lkb->lkb_nodeid,
66 seq_printf(s, " Master: %08x", lkb->lkb_remid);
69 if (lkb->lkb_wait_type)
70 seq_printf(s, " wait_type: %d", lkb->lkb_wait_type);
75 static void print_format1(struct dlm_rsb *res, struct seq_file *s)
78 int i, lvblen = res->res_ls->ls_lvblen, recover_list, root_list;
82 seq_printf(s, "\nResource %p Name (len=%d) \"", res, res->res_length);
84 for (i = 0; i < res->res_length; i++) {
85 if (isprint(res->res_name[i]))
86 seq_printf(s, "%c", res->res_name[i]);
88 seq_printf(s, "%c", '.');
91 if (res->res_nodeid > 0)
92 seq_printf(s, "\"\nLocal Copy, Master is node %d\n",
94 else if (res->res_nodeid == 0)
95 seq_puts(s, "\"\nMaster Copy\n");
96 else if (res->res_nodeid == -1)
97 seq_printf(s, "\"\nLooking up master (lkid %x)\n",
100 seq_printf(s, "\"\nInvalid master %d\n", res->res_nodeid);
101 if (seq_has_overflowed(s))
105 if (res->res_lvbptr) {
106 seq_puts(s, "LVB: ");
107 for (i = 0; i < lvblen; i++) {
110 seq_printf(s, "%02x ",
111 (unsigned char) res->res_lvbptr[i]);
113 if (rsb_flag(res, RSB_VALNOTVALID))
114 seq_puts(s, " (INVALID)");
116 if (seq_has_overflowed(s))
120 root_list = !list_empty(&res->res_root_list);
121 recover_list = !list_empty(&res->res_recover_list);
123 if (root_list || recover_list) {
124 seq_printf(s, "Recovery: root %d recover %d flags %lx count %d\n",
125 root_list, recover_list,
126 res->res_flags, res->res_recover_locks_count);
129 /* Print the locks attached to this resource */
130 seq_puts(s, "Granted Queue\n");
131 list_for_each_entry(lkb, &res->res_grantqueue, lkb_statequeue) {
132 print_format1_lock(s, lkb, res);
133 if (seq_has_overflowed(s))
137 seq_puts(s, "Conversion Queue\n");
138 list_for_each_entry(lkb, &res->res_convertqueue, lkb_statequeue) {
139 print_format1_lock(s, lkb, res);
140 if (seq_has_overflowed(s))
144 seq_puts(s, "Waiting Queue\n");
145 list_for_each_entry(lkb, &res->res_waitqueue, lkb_statequeue) {
146 print_format1_lock(s, lkb, res);
147 if (seq_has_overflowed(s))
151 if (list_empty(&res->res_lookup))
154 seq_puts(s, "Lookup Queue\n");
155 list_for_each_entry(lkb, &res->res_lookup, lkb_rsb_lookup) {
156 seq_printf(s, "%08x %s",
157 lkb->lkb_id, print_lockmode(lkb->lkb_rqmode));
158 if (lkb->lkb_wait_type)
159 seq_printf(s, " wait_type: %d", lkb->lkb_wait_type);
161 if (seq_has_overflowed(s))
168 static void print_format2_lock(struct seq_file *s, struct dlm_lkb *lkb,
174 if (test_bit(DLM_DFL_USER_BIT, &lkb->lkb_dflags)) {
176 xid = lkb->lkb_ua->xid;
179 /* microseconds since lkb was added to current queue */
180 us = ktime_to_us(ktime_sub(ktime_get(), lkb->lkb_timestamp));
182 /* id nodeid remid pid xid exflags flags sts grmode rqmode time_us
183 r_nodeid r_len r_name */
185 seq_printf(s, "%x %d %x %u %llu %x %x %d %d %d %llu %u %d \"%s\"\n",
190 (unsigned long long)xid,
196 (unsigned long long)us,
202 static void print_format2(struct dlm_rsb *r, struct seq_file *s)
208 list_for_each_entry(lkb, &r->res_grantqueue, lkb_statequeue) {
209 print_format2_lock(s, lkb, r);
210 if (seq_has_overflowed(s))
214 list_for_each_entry(lkb, &r->res_convertqueue, lkb_statequeue) {
215 print_format2_lock(s, lkb, r);
216 if (seq_has_overflowed(s))
220 list_for_each_entry(lkb, &r->res_waitqueue, lkb_statequeue) {
221 print_format2_lock(s, lkb, r);
222 if (seq_has_overflowed(s))
229 static void print_format3_lock(struct seq_file *s, struct dlm_lkb *lkb,
234 if (test_bit(DLM_DFL_USER_BIT, &lkb->lkb_dflags)) {
236 xid = lkb->lkb_ua->xid;
239 seq_printf(s, "lkb %x %d %x %u %llu %x %x %d %d %d %d %d %d %u %llu %llu\n",
244 (unsigned long long)xid,
250 lkb->lkb_last_bast_cb_mode,
254 (unsigned long long)ktime_to_ns(lkb->lkb_timestamp),
255 (unsigned long long)ktime_to_ns(lkb->lkb_last_bast_time));
258 static void print_format3(struct dlm_rsb *r, struct seq_file *s)
261 int i, lvblen = r->res_ls->ls_lvblen;
266 seq_printf(s, "rsb %p %d %x %lx %d %d %u %d ",
271 !list_empty(&r->res_root_list),
272 !list_empty(&r->res_recover_list),
273 r->res_recover_locks_count,
275 if (seq_has_overflowed(s))
278 for (i = 0; i < r->res_length; i++) {
279 if (!isascii(r->res_name[i]) || !isprint(r->res_name[i]))
283 seq_puts(s, print_name ? "str " : "hex");
285 for (i = 0; i < r->res_length; i++) {
287 seq_printf(s, "%c", r->res_name[i]);
289 seq_printf(s, " %02x", (unsigned char)r->res_name[i]);
292 if (seq_has_overflowed(s))
298 seq_printf(s, "lvb %u %d", r->res_lvbseq, lvblen);
300 for (i = 0; i < lvblen; i++)
301 seq_printf(s, " %02x", (unsigned char)r->res_lvbptr[i]);
303 if (seq_has_overflowed(s))
307 list_for_each_entry(lkb, &r->res_grantqueue, lkb_statequeue) {
308 print_format3_lock(s, lkb, 0);
309 if (seq_has_overflowed(s))
313 list_for_each_entry(lkb, &r->res_convertqueue, lkb_statequeue) {
314 print_format3_lock(s, lkb, 0);
315 if (seq_has_overflowed(s))
319 list_for_each_entry(lkb, &r->res_waitqueue, lkb_statequeue) {
320 print_format3_lock(s, lkb, 0);
321 if (seq_has_overflowed(s))
325 list_for_each_entry(lkb, &r->res_lookup, lkb_rsb_lookup) {
326 print_format3_lock(s, lkb, 1);
327 if (seq_has_overflowed(s))
334 static void print_format4(struct dlm_rsb *r, struct seq_file *s)
336 int our_nodeid = dlm_our_nodeid();
342 seq_printf(s, "rsb %p %d %d %d %d %lu %lx %d ",
345 r->res_master_nodeid,
352 for (i = 0; i < r->res_length; i++) {
353 if (!isascii(r->res_name[i]) || !isprint(r->res_name[i]))
357 seq_puts(s, print_name ? "str " : "hex");
359 for (i = 0; i < r->res_length; i++) {
361 seq_printf(s, "%c", r->res_name[i]);
363 seq_printf(s, " %02x", (unsigned char)r->res_name[i]);
369 static const struct seq_operations format1_seq_ops;
370 static const struct seq_operations format2_seq_ops;
371 static const struct seq_operations format3_seq_ops;
372 static const struct seq_operations format4_seq_ops;
375 * If the buffer is full, seq_printf can be called again, but it
376 * does nothing. So, the these printing routines periodically check
377 * seq_has_overflowed to avoid wasting too much time trying to print to
381 static int table_seq_show(struct seq_file *seq, void *iter_ptr)
383 struct dlm_rsb *rsb = list_entry(iter_ptr, struct dlm_rsb, res_slow_list);
385 if (seq->op == &format1_seq_ops)
386 print_format1(rsb, seq);
387 else if (seq->op == &format2_seq_ops)
388 print_format2(rsb, seq);
389 else if (seq->op == &format3_seq_ops)
390 print_format3(rsb, seq);
391 else if (seq->op == &format4_seq_ops)
392 print_format4(rsb, seq);
397 static void *table_seq_start(struct seq_file *seq, loff_t *pos)
399 struct dlm_ls *ls = seq->private;
400 struct list_head *list;
403 if (seq->op == &format2_seq_ops)
404 seq_puts(seq, "id nodeid remid pid xid exflags flags sts grmode rqmode time_ms r_nodeid r_len r_name\n");
405 else if (seq->op == &format3_seq_ops)
406 seq_puts(seq, "rsb ptr nodeid first_lkid flags !root_list_empty !recover_list_empty recover_locks_count len\n");
407 else if (seq->op == &format4_seq_ops)
408 seq_puts(seq, "rsb ptr nodeid master_nodeid dir_nodeid our_nodeid toss_time flags len str|hex name\n");
411 if (seq->op == &format4_seq_ops)
412 list = &ls->ls_slow_inactive;
414 list = &ls->ls_slow_active;
416 read_lock_bh(&ls->ls_rsbtbl_lock);
417 return seq_list_start(list, *pos);
420 static void *table_seq_next(struct seq_file *seq, void *iter_ptr, loff_t *pos)
422 struct dlm_ls *ls = seq->private;
423 struct list_head *list;
425 if (seq->op == &format4_seq_ops)
426 list = &ls->ls_slow_inactive;
428 list = &ls->ls_slow_active;
430 return seq_list_next(iter_ptr, list, pos);
433 static void table_seq_stop(struct seq_file *seq, void *iter_ptr)
435 struct dlm_ls *ls = seq->private;
437 read_unlock_bh(&ls->ls_rsbtbl_lock);
440 static const struct seq_operations format1_seq_ops = {
441 .start = table_seq_start,
442 .next = table_seq_next,
443 .stop = table_seq_stop,
444 .show = table_seq_show,
447 static const struct seq_operations format2_seq_ops = {
448 .start = table_seq_start,
449 .next = table_seq_next,
450 .stop = table_seq_stop,
451 .show = table_seq_show,
454 static const struct seq_operations format3_seq_ops = {
455 .start = table_seq_start,
456 .next = table_seq_next,
457 .stop = table_seq_stop,
458 .show = table_seq_show,
461 static const struct seq_operations format4_seq_ops = {
462 .start = table_seq_start,
463 .next = table_seq_next,
464 .stop = table_seq_stop,
465 .show = table_seq_show,
468 static const struct file_operations format1_fops;
469 static const struct file_operations format2_fops;
470 static const struct file_operations format3_fops;
471 static const struct file_operations format4_fops;
473 static int table_open1(struct inode *inode, struct file *file)
475 struct seq_file *seq;
478 ret = seq_open(file, &format1_seq_ops);
482 seq = file->private_data;
483 seq->private = inode->i_private; /* the dlm_ls */
487 static int table_open2(struct inode *inode, struct file *file)
489 struct seq_file *seq;
492 ret = seq_open(file, &format2_seq_ops);
496 seq = file->private_data;
497 seq->private = inode->i_private; /* the dlm_ls */
501 static ssize_t table_write2(struct file *file, const char __user *user_buf,
502 size_t count, loff_t *ppos)
504 struct seq_file *seq = file->private_data;
505 int n, len, lkb_nodeid, lkb_status, error;
506 char name[DLM_RESNAME_MAXLEN + 1] = {};
507 struct dlm_ls *ls = seq->private;
508 unsigned int lkb_flags;
512 if (copy_from_user(buf, user_buf,
513 min_t(size_t, sizeof(buf) - 1, count)))
516 n = sscanf(buf, "%x %" __stringify(DLM_RESNAME_MAXLEN) "s %x %d %d",
517 &lkb_id, name, &lkb_flags, &lkb_nodeid, &lkb_status);
521 len = strnlen(name, DLM_RESNAME_MAXLEN);
522 error = dlm_debug_add_lkb(ls, lkb_id, name, len, lkb_flags,
523 lkb_nodeid, lkb_status);
530 static int table_open3(struct inode *inode, struct file *file)
532 struct seq_file *seq;
535 ret = seq_open(file, &format3_seq_ops);
539 seq = file->private_data;
540 seq->private = inode->i_private; /* the dlm_ls */
544 static int table_open4(struct inode *inode, struct file *file)
546 struct seq_file *seq;
549 ret = seq_open(file, &format4_seq_ops);
553 seq = file->private_data;
554 seq->private = inode->i_private; /* the dlm_ls */
558 static const struct file_operations format1_fops = {
559 .owner = THIS_MODULE,
563 .release = seq_release
566 static const struct file_operations format2_fops = {
567 .owner = THIS_MODULE,
570 .write = table_write2,
572 .release = seq_release
575 static const struct file_operations format3_fops = {
576 .owner = THIS_MODULE,
580 .release = seq_release
583 static const struct file_operations format4_fops = {
584 .owner = THIS_MODULE,
588 .release = seq_release
592 * dump lkb's on the ls_waiters list
594 static ssize_t waiters_read(struct file *file, char __user *userbuf,
595 size_t count, loff_t *ppos)
597 struct dlm_ls *ls = file->private_data;
599 size_t len = DLM_DEBUG_BUF_LEN, pos = 0, ret, rv;
601 mutex_lock(&debug_buf_lock);
602 ret = dlm_lock_recovery_try(ls);
608 spin_lock_bh(&ls->ls_waiters_lock);
609 memset(debug_buf, 0, sizeof(debug_buf));
611 list_for_each_entry(lkb, &ls->ls_waiters, lkb_wait_reply) {
612 ret = snprintf(debug_buf + pos, len - pos, "%x %d %d %s\n",
613 lkb->lkb_id, lkb->lkb_wait_type,
614 lkb->lkb_nodeid, lkb->lkb_resource->res_name);
615 if (ret >= len - pos)
619 spin_unlock_bh(&ls->ls_waiters_lock);
620 dlm_unlock_recovery(ls);
622 rv = simple_read_from_buffer(userbuf, count, ppos, debug_buf, pos);
624 mutex_unlock(&debug_buf_lock);
628 static ssize_t waiters_write(struct file *file, const char __user *user_buf,
629 size_t count, loff_t *ppos)
631 struct dlm_ls *ls = file->private_data;
632 int mstype, to_nodeid;
637 if (copy_from_user(buf, user_buf,
638 min_t(size_t, sizeof(buf) - 1, count)))
641 n = sscanf(buf, "%x %d %d", &lkb_id, &mstype, &to_nodeid);
645 error = dlm_lock_recovery_try(ls);
649 error = dlm_debug_add_lkb_to_waiters(ls, lkb_id, mstype, to_nodeid);
650 dlm_unlock_recovery(ls);
657 static const struct file_operations waiters_fops = {
658 .owner = THIS_MODULE,
660 .read = waiters_read,
661 .write = waiters_write,
662 .llseek = default_llseek,
665 void dlm_delete_debug_file(struct dlm_ls *ls)
667 debugfs_remove(ls->ls_debug_rsb_dentry);
668 debugfs_remove(ls->ls_debug_waiters_dentry);
669 debugfs_remove(ls->ls_debug_locks_dentry);
670 debugfs_remove(ls->ls_debug_all_dentry);
671 debugfs_remove(ls->ls_debug_toss_dentry);
672 debugfs_remove(ls->ls_debug_queued_asts_dentry);
675 static int dlm_state_show(struct seq_file *file, void *offset)
677 seq_printf(file, "%s\n", dlm_midcomms_state(file->private));
680 DEFINE_SHOW_ATTRIBUTE(dlm_state);
682 static int dlm_flags_show(struct seq_file *file, void *offset)
684 seq_printf(file, "%lu\n", dlm_midcomms_flags(file->private));
687 DEFINE_SHOW_ATTRIBUTE(dlm_flags);
689 static int dlm_send_queue_cnt_show(struct seq_file *file, void *offset)
691 seq_printf(file, "%d\n", dlm_midcomms_send_queue_cnt(file->private));
694 DEFINE_SHOW_ATTRIBUTE(dlm_send_queue_cnt);
696 static int dlm_version_show(struct seq_file *file, void *offset)
698 seq_printf(file, "0x%08x\n", dlm_midcomms_version(file->private));
701 DEFINE_SHOW_ATTRIBUTE(dlm_version);
703 static ssize_t dlm_rawmsg_write(struct file *fp, const char __user *user_buf,
704 size_t count, loff_t *ppos)
709 if (count > PAGE_SIZE || count < sizeof(struct dlm_header))
712 buf = kmalloc(PAGE_SIZE, GFP_NOFS);
716 if (copy_from_user(buf, user_buf, count)) {
721 ret = dlm_midcomms_rawmsg_send(fp->private_data, buf, count);
733 static const struct file_operations dlm_rawmsg_fops = {
735 .write = dlm_rawmsg_write,
739 void *dlm_create_debug_comms_file(int nodeid, void *data)
741 struct dentry *d_node;
744 memset(name, 0, sizeof(name));
745 snprintf(name, 256, "%d", nodeid);
747 d_node = debugfs_create_dir(name, dlm_comms);
748 debugfs_create_file("state", 0444, d_node, data, &dlm_state_fops);
749 debugfs_create_file("flags", 0444, d_node, data, &dlm_flags_fops);
750 debugfs_create_file("send_queue_count", 0444, d_node, data,
751 &dlm_send_queue_cnt_fops);
752 debugfs_create_file("version", 0444, d_node, data, &dlm_version_fops);
753 debugfs_create_file("rawmsg", 0200, d_node, data, &dlm_rawmsg_fops);
758 void dlm_delete_debug_comms_file(void *ctx)
763 void dlm_create_debug_file(struct dlm_ls *ls)
765 /* Reserve enough space for the longest file name */
766 char name[DLM_LOCKSPACE_LEN + sizeof("_queued_asts")];
770 ls->ls_debug_rsb_dentry = debugfs_create_file(ls->ls_name,
778 snprintf(name, sizeof(name), "%s_locks", ls->ls_name);
780 ls->ls_debug_locks_dentry = debugfs_create_file(name,
788 snprintf(name, sizeof(name), "%s_all", ls->ls_name);
790 ls->ls_debug_all_dentry = debugfs_create_file(name,
798 snprintf(name, sizeof(name), "%s_toss", ls->ls_name);
800 ls->ls_debug_toss_dentry = debugfs_create_file(name,
806 snprintf(name, sizeof(name), "%s_waiters", ls->ls_name);
808 ls->ls_debug_waiters_dentry = debugfs_create_file(name,
815 void __init dlm_register_debugfs(void)
817 mutex_init(&debug_buf_lock);
818 dlm_root = debugfs_create_dir("dlm", NULL);
819 dlm_comms = debugfs_create_dir("comms", dlm_root);
822 void dlm_unregister_debugfs(void)
824 debugfs_remove(dlm_root);