fs/ocfs2/cluster/netdebug.c

   1 /* -*- mode: c; c-basic-offset: 8; -*-
   2  * vim: noexpandtab sw=8 ts=8 sts=0:
   3  *
   4  * netdebug.c
   5  *
   6  * debug functionality for o2net
   7  *
   8  * Copyright (C) 2005, 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 #ifdef CONFIG_DEBUG_FS
  28
  29 #include <linux/module.h>
  30 #include <linux/types.h>
  31 #include <linux/slab.h>
  32 #include <linux/idr.h>
  33 #include <linux/kref.h>
  34 #include <linux/seq_file.h>
  35 #include <linux/debugfs.h>
  36
  37 #include <linux/uaccess.h>
  38
  39 #include "tcp.h"
  40 #include "nodemanager.h"
  41 #define MLOG_MASK_PREFIX ML_TCP
  42 #include "masklog.h"
  43
  44 #include "tcp_internal.h"
  45
  46 #define O2NET_DEBUG_DIR         "o2net"
  47 #define SC_DEBUG_NAME           "sock_containers"
  48 #define NST_DEBUG_NAME          "send_tracking"
  49
  50 static struct dentry *o2net_dentry;
  51 static struct dentry *sc_dentry;
  52 static struct dentry *nst_dentry;
  53
  54 static DEFINE_SPINLOCK(o2net_debug_lock);
  55
  56 static LIST_HEAD(sock_containers);
  57 static LIST_HEAD(send_tracking);
  58
  59 void o2net_debug_add_nst(struct o2net_send_tracking *nst)
  60 {
  61         spin_lock(&o2net_debug_lock);
  62         list_add(&nst->st_net_debug_item, &send_tracking);
  63         spin_unlock(&o2net_debug_lock);
  64 }
  65
  66 void o2net_debug_del_nst(struct o2net_send_tracking *nst)
  67 {
  68         spin_lock(&o2net_debug_lock);
  69         if (!list_empty(&nst->st_net_debug_item))
  70                 list_del_init(&nst->st_net_debug_item);
  71         spin_unlock(&o2net_debug_lock);
  72 }
  73
  74 static struct o2net_send_tracking
  75                         *next_nst(struct o2net_send_tracking *nst_start)
  76 {
  77         struct o2net_send_tracking *nst, *ret = NULL;
  78
  79         assert_spin_locked(&o2net_debug_lock);
  80
  81         list_for_each_entry(nst, &nst_start->st_net_debug_item,
  82                             st_net_debug_item) {
  83                 /* discover the head of the list */
  84                 if (&nst->st_net_debug_item == &send_tracking)
  85                         break;
  86
  87                 /* use st_task to detect real nsts in the list */
  88                 if (nst->st_task != NULL) {
  89                         ret = nst;
  90                         break;
  91                 }
  92         }
  93
  94         return ret;
  95 }
  96
  97 static void *nst_seq_start(struct seq_file *seq, loff_t *pos)
  98 {
  99         struct o2net_send_tracking *nst, *dummy_nst = seq->private;
 100
 101         spin_lock(&o2net_debug_lock);
 102         nst = next_nst(dummy_nst);
 103         spin_unlock(&o2net_debug_lock);
 104
 105         return nst;
 106 }
 107
 108 static void *nst_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 109 {
 110         struct o2net_send_tracking *nst, *dummy_nst = seq->private;
 111
 112         spin_lock(&o2net_debug_lock);
 113         nst = next_nst(dummy_nst);
 114         list_del_init(&dummy_nst->st_net_debug_item);
 115         if (nst)
 116                 list_add(&dummy_nst->st_net_debug_item,
 117                          &nst->st_net_debug_item);
 118         spin_unlock(&o2net_debug_lock);
 119
 120         return nst; /* unused, just needs to be null when done */
 121 }
 122
 123 static int nst_seq_show(struct seq_file *seq, void *v)
 124 {
 125         struct o2net_send_tracking *nst, *dummy_nst = seq->private;
 126         ktime_t now;
 127         s64 sock, send, status;
 128
 129         spin_lock(&o2net_debug_lock);
 130         nst = next_nst(dummy_nst);
 131
 132         now = ktime_get();
 133         sock = ktime_to_us(ktime_sub(now, nst->st_sock_time));
 134         send = ktime_to_us(ktime_sub(now, nst->st_send_time));
 135         status = ktime_to_us(ktime_sub(now, nst->st_status_time));
 136
 137         if (nst != NULL) {
 138                 /* get_task_comm isn't exported.  oh well. */
 139                 seq_printf(seq, "%p:\n"
 140                            "  pid:          %lu\n"
 141                            "  tgid:         %lu\n"
 142                            "  process name: %s\n"
 143                            "  node:         %u\n"
 144                            "  sc:           %p\n"
 145                            "  message id:   %d\n"
 146                            "  message type: %u\n"
 147                            "  message key:  0x%08x\n"
 148                            "  sock acquiry: %lld usecs ago\n"
 149                            "  send start:   %lld usecs ago\n"
 150                            "  wait start:   %lld usecs ago\n",
 151                            nst, (unsigned long)task_pid_nr(nst->st_task),
 152                            (unsigned long)nst->st_task->tgid,
 153                            nst->st_task->comm, nst->st_node,
 154                            nst->st_sc, nst->st_id, nst->st_msg_type,
 155                            nst->st_msg_key,
 156                            (long long)sock,
 157                            (long long)send,
 158                            (long long)status);
 159         }
 160
 161         spin_unlock(&o2net_debug_lock);
 162
 163         return 0;
 164 }
 165
 166 static void nst_seq_stop(struct seq_file *seq, void *v)
 167 {
 168 }
 169
 170 static const struct seq_operations nst_seq_ops = {
 171         .start = nst_seq_start,
 172         .next = nst_seq_next,
 173         .stop = nst_seq_stop,
 174         .show = nst_seq_show,
 175 };
 176
 177 static int nst_fop_open(struct inode *inode, struct file *file)
 178 {
 179         struct o2net_send_tracking *dummy_nst;
 180         struct seq_file *seq;
 181         int ret;
 182
 183         dummy_nst = kmalloc(sizeof(struct o2net_send_tracking), GFP_KERNEL);
 184         if (dummy_nst == NULL) {
 185                 ret = -ENOMEM;
 186                 goto out;
 187         }
 188         dummy_nst->st_task = NULL;
 189
 190         ret = seq_open(file, &nst_seq_ops);
 191         if (ret)
 192                 goto out;
 193
 194         seq = file->private_data;
 195         seq->private = dummy_nst;
 196         o2net_debug_add_nst(dummy_nst);
 197
 198         dummy_nst = NULL;
 199
 200 out:
 201         kfree(dummy_nst);
 202         return ret;
 203 }
 204
 205 static int nst_fop_release(struct inode *inode, struct file *file)
 206 {
 207         struct seq_file *seq = file->private_data;
 208         struct o2net_send_tracking *dummy_nst = seq->private;
 209
 210         o2net_debug_del_nst(dummy_nst);
 211         return seq_release_private(inode, file);
 212 }
 213
 214 static const struct file_operations nst_seq_fops = {
 215         .open = nst_fop_open,
 216         .read = seq_read,
 217         .llseek = seq_lseek,
 218         .release = nst_fop_release,
 219 };
 220
 221 void o2net_debug_add_sc(struct o2net_sock_container *sc)
 222 {
 223         spin_lock(&o2net_debug_lock);
 224         list_add(&sc->sc_net_debug_item, &sock_containers);
 225         spin_unlock(&o2net_debug_lock);
 226 }
 227
 228 void o2net_debug_del_sc(struct o2net_sock_container *sc)
 229 {
 230         spin_lock(&o2net_debug_lock);
 231         list_del_init(&sc->sc_net_debug_item);
 232         spin_unlock(&o2net_debug_lock);
 233 }
 234
 235 static struct o2net_sock_container
 236                         *next_sc(struct o2net_sock_container *sc_start)
 237 {
 238         struct o2net_sock_container *sc, *ret = NULL;
 239
 240         assert_spin_locked(&o2net_debug_lock);
 241
 242         list_for_each_entry(sc, &sc_start->sc_net_debug_item,
 243                             sc_net_debug_item) {
 244                 /* discover the head of the list miscast as a sc */
 245                 if (&sc->sc_net_debug_item == &sock_containers)
 246                         break;
 247
 248                 /* use sc_page to detect real scs in the list */
 249                 if (sc->sc_page != NULL) {
 250                         ret = sc;
 251                         break;
 252                 }
 253         }
 254
 255         return ret;
 256 }
 257
 258 static void *sc_seq_start(struct seq_file *seq, loff_t *pos)
 259 {
 260         struct o2net_sock_container *sc, *dummy_sc = seq->private;
 261
 262         spin_lock(&o2net_debug_lock);
 263         sc = next_sc(dummy_sc);
 264         spin_unlock(&o2net_debug_lock);
 265
 266         return sc;
 267 }
 268
 269 static void *sc_seq_next(struct seq_file *seq, void *v, loff_t *pos)
 270 {
 271         struct o2net_sock_container *sc, *dummy_sc = seq->private;
 272
 273         spin_lock(&o2net_debug_lock);
 274         sc = next_sc(dummy_sc);
 275         list_del_init(&dummy_sc->sc_net_debug_item);
 276         if (sc)
 277                 list_add(&dummy_sc->sc_net_debug_item, &sc->sc_net_debug_item);
 278         spin_unlock(&o2net_debug_lock);
 279
 280         return sc; /* unused, just needs to be null when done */
 281 }
 282
 283 #define TV_SEC_USEC(TV) TV.tv_sec, (long)TV.tv_usec
 284
 285 static int sc_seq_show(struct seq_file *seq, void *v)
 286 {
 287         struct o2net_sock_container *sc, *dummy_sc = seq->private;
 288
 289         spin_lock(&o2net_debug_lock);
 290         sc = next_sc(dummy_sc);
 291
 292         if (sc != NULL) {
 293                 struct inet_sock *inet = NULL;
 294
 295                 __be32 saddr = 0, daddr = 0;
 296                 __be16 sport = 0, dport = 0;
 297
 298                 if (sc->sc_sock) {
 299                         inet = inet_sk(sc->sc_sock->sk);
 300                         /* the stack's structs aren't sparse endian clean */
 301                         saddr = (__force __be32)inet->inet_saddr;
 302                         daddr = (__force __be32)inet->inet_daddr;
 303                         sport = (__force __be16)inet->inet_sport;
 304                         dport = (__force __be16)inet->inet_dport;
 305                 }
 306
 307                 /* XXX sigh, inet-> doesn't have sparse annotation so any
 308                  * use of it here generates a warning with -Wbitwise */
 309                 seq_printf(seq, "%p:\n"
 310                            "  krefs:           %d\n"
 311                            "  sock:            %pI4:%u -> "
 312                                               "%pI4:%u\n"
 313                            "  remote node:     %s\n"
 314                            "  page off:        %zu\n"
 315                            "  handshake ok:    %u\n"
 316                            "  timer:           %lu.%ld\n"
 317                            "  data ready:      %lu.%ld\n"
 318                            "  advance start:   %lu.%ld\n"
 319                            "  advance stop:    %lu.%ld\n"
 320                            "  func start:      %lu.%ld\n"
 321                            "  func stop:       %lu.%ld\n"
 322                            "  func key:        %u\n"
 323                            "  func type:       %u\n",
 324                            sc,
 325                            atomic_read(&sc->sc_kref.refcount),
 326                            &saddr, inet ? ntohs(sport) : 0,
 327                            &daddr, inet ? ntohs(dport) : 0,
 328                            sc->sc_node->nd_name,
 329                            sc->sc_page_off,
 330                            sc->sc_handshake_ok,
 331                            TV_SEC_USEC(sc->sc_tv_timer),
 332                            TV_SEC_USEC(sc->sc_tv_data_ready),
 333                            TV_SEC_USEC(sc->sc_tv_advance_start),
 334                            TV_SEC_USEC(sc->sc_tv_advance_stop),
 335                            TV_SEC_USEC(sc->sc_tv_func_start),
 336                            TV_SEC_USEC(sc->sc_tv_func_stop),
 337                            sc->sc_msg_key,
 338                            sc->sc_msg_type);
 339         }
 340
 341
 342         spin_unlock(&o2net_debug_lock);
 343
 344         return 0;
 345 }
 346
 347 static void sc_seq_stop(struct seq_file *seq, void *v)
 348 {
 349 }
 350
 351 static const struct seq_operations sc_seq_ops = {
 352         .start = sc_seq_start,
 353         .next = sc_seq_next,
 354         .stop = sc_seq_stop,
 355         .show = sc_seq_show,
 356 };
 357
 358 static int sc_fop_open(struct inode *inode, struct file *file)
 359 {
 360         struct o2net_sock_container *dummy_sc;
 361         struct seq_file *seq;
 362         int ret;
 363
 364         dummy_sc = kmalloc(sizeof(struct o2net_sock_container), GFP_KERNEL);
 365         if (dummy_sc == NULL) {
 366                 ret = -ENOMEM;
 367                 goto out;
 368         }
 369         dummy_sc->sc_page = NULL;
 370
 371         ret = seq_open(file, &sc_seq_ops);
 372         if (ret)
 373                 goto out;
 374
 375         seq = file->private_data;
 376         seq->private = dummy_sc;
 377         o2net_debug_add_sc(dummy_sc);
 378
 379         dummy_sc = NULL;
 380
 381 out:
 382         kfree(dummy_sc);
 383         return ret;
 384 }
 385
 386 static int sc_fop_release(struct inode *inode, struct file *file)
 387 {
 388         struct seq_file *seq = file->private_data;
 389         struct o2net_sock_container *dummy_sc = seq->private;
 390
 391         o2net_debug_del_sc(dummy_sc);
 392         return seq_release_private(inode, file);
 393 }
 394
 395 static const struct file_operations sc_seq_fops = {
 396         .open = sc_fop_open,
 397         .read = seq_read,
 398         .llseek = seq_lseek,
 399         .release = sc_fop_release,
 400 };
 401
 402 int o2net_debugfs_init(void)
 403 {
 404         o2net_dentry = debugfs_create_dir(O2NET_DEBUG_DIR, NULL);
 405         if (!o2net_dentry) {
 406                 mlog_errno(-ENOMEM);
 407                 goto bail;
 408         }
 409
 410         nst_dentry = debugfs_create_file(NST_DEBUG_NAME, S_IFREG|S_IRUSR,
 411                                          o2net_dentry, NULL,
 412                                          &nst_seq_fops);
 413         if (!nst_dentry) {
 414                 mlog_errno(-ENOMEM);
 415                 goto bail;
 416         }
 417
 418         sc_dentry = debugfs_create_file(SC_DEBUG_NAME, S_IFREG|S_IRUSR,
 419                                         o2net_dentry, NULL,
 420                                         &sc_seq_fops);
 421         if (!sc_dentry) {
 422                 mlog_errno(-ENOMEM);
 423                 goto bail;
 424         }
 425
 426         return 0;
 427 bail:
 428         debugfs_remove(sc_dentry);
 429         debugfs_remove(nst_dentry);
 430         debugfs_remove(o2net_dentry);
 431         return -ENOMEM;
 432 }
 433
 434 void o2net_debugfs_exit(void)
 435 {
 436         debugfs_remove(sc_dentry);
 437         debugfs_remove(nst_dentry);
 438         debugfs_remove(o2net_dentry);
 439 }
 440
 441 #endif  /* CONFIG_DEBUG_FS */