net/batman-adv/debugfs.c

   1 /* Copyright (C) 2010-2016  B.A.T.M.A.N. contributors:
   2  *
   3  * Marek Lindner
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "debugfs.h"
  19 #include "main.h"
  20
  21 #include <linux/compiler.h>
  22 #include <linux/debugfs.h>
  23 #include <linux/device.h>
  24 #include <linux/errno.h>
  25 #include <linux/export.h>
  26 #include <linux/fcntl.h>
  27 #include <linux/fs.h>
  28 #include <linux/jiffies.h>
  29 #include <linux/kernel.h>
  30 #include <linux/module.h>
  31 #include <linux/netdevice.h>
  32 #include <linux/poll.h>
  33 #include <linux/printk.h>
  34 #include <linux/sched.h> /* for linux/wait.h */
  35 #include <linux/seq_file.h>
  36 #include <linux/slab.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/stat.h>
  39 #include <linux/stddef.h>
  40 #include <linux/stringify.h>
  41 #include <linux/sysfs.h>
  42 #include <linux/types.h>
  43 #include <linux/uaccess.h>
  44 #include <linux/wait.h>
  45 #include <stdarg.h>
  46
  47 #include "bridge_loop_avoidance.h"
  48 #include "distributed-arp-table.h"
  49 #include "gateway_client.h"
  50 #include "icmp_socket.h"
  51 #include "network-coding.h"
  52 #include "originator.h"
  53 #include "translation-table.h"
  54
  55 static struct dentry *batadv_debugfs;
  56
  57 #ifdef CONFIG_BATMAN_ADV_DEBUG
  58 #define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
  59
  60 static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
  61
  62 static char *batadv_log_char_addr(struct batadv_priv_debug_log *debug_log,
  63                                   size_t idx)
  64 {
  65         return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
  66 }
  67
  68 static void batadv_emit_log_char(struct batadv_priv_debug_log *debug_log,
  69                                  char c)
  70 {
  71         char *char_addr;
  72
  73         char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
  74         *char_addr = c;
  75         debug_log->log_end++;
  76
  77         if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
  78                 debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
  79 }
  80
  81 __printf(2, 3)
  82 static int batadv_fdebug_log(struct batadv_priv_debug_log *debug_log,
  83                              const char *fmt, ...)
  84 {
  85         va_list args;
  86         static char debug_log_buf[256];
  87         char *p;
  88
  89         if (!debug_log)
  90                 return 0;
  91
  92         spin_lock_bh(&debug_log->lock);
  93         va_start(args, fmt);
  94         vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
  95         va_end(args);
  96
  97         for (p = debug_log_buf; *p != 0; p++)
  98                 batadv_emit_log_char(debug_log, *p);
  99
 100         spin_unlock_bh(&debug_log->lock);
 101
 102         wake_up(&debug_log->queue_wait);
 103
 104         return 0;
 105 }
 106
 107 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
 108 {
 109         va_list args;
 110         char tmp_log_buf[256];
 111
 112         va_start(args, fmt);
 113         vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
 114         batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
 115                           jiffies_to_msecs(jiffies), tmp_log_buf);
 116         va_end(args);
 117
 118         return 0;
 119 }
 120
 121 static int batadv_log_open(struct inode *inode, struct file *file)
 122 {
 123         if (!try_module_get(THIS_MODULE))
 124                 return -EBUSY;
 125
 126         nonseekable_open(inode, file);
 127         file->private_data = inode->i_private;
 128         return 0;
 129 }
 130
 131 static int batadv_log_release(struct inode *inode, struct file *file)
 132 {
 133         module_put(THIS_MODULE);
 134         return 0;
 135 }
 136
 137 static int batadv_log_empty(struct batadv_priv_debug_log *debug_log)
 138 {
 139         return !(debug_log->log_start - debug_log->log_end);
 140 }
 141
 142 static ssize_t batadv_log_read(struct file *file, char __user *buf,
 143                                size_t count, loff_t *ppos)
 144 {
 145         struct batadv_priv *bat_priv = file->private_data;
 146         struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
 147         int error, i = 0;
 148         char *char_addr;
 149         char c;
 150
 151         if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
 152                 return -EAGAIN;
 153
 154         if (!buf)
 155                 return -EINVAL;
 156
 157         if (count == 0)
 158                 return 0;
 159
 160         if (!access_ok(VERIFY_WRITE, buf, count))
 161                 return -EFAULT;
 162
 163         error = wait_event_interruptible(debug_log->queue_wait,
 164                                          (!batadv_log_empty(debug_log)));
 165
 166         if (error)
 167                 return error;
 168
 169         spin_lock_bh(&debug_log->lock);
 170
 171         while ((!error) && (i < count) &&
 172                (debug_log->log_start != debug_log->log_end)) {
 173                 char_addr = batadv_log_char_addr(debug_log,
 174                                                  debug_log->log_start);
 175                 c = *char_addr;
 176
 177                 debug_log->log_start++;
 178
 179                 spin_unlock_bh(&debug_log->lock);
 180
 181                 error = __put_user(c, buf);
 182
 183                 spin_lock_bh(&debug_log->lock);
 184
 185                 buf++;
 186                 i++;
 187         }
 188
 189         spin_unlock_bh(&debug_log->lock);
 190
 191         if (!error)
 192                 return i;
 193
 194         return error;
 195 }
 196
 197 static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
 198 {
 199         struct batadv_priv *bat_priv = file->private_data;
 200         struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
 201
 202         poll_wait(file, &debug_log->queue_wait, wait);
 203
 204         if (!batadv_log_empty(debug_log))
 205                 return POLLIN | POLLRDNORM;
 206
 207         return 0;
 208 }
 209
 210 static const struct file_operations batadv_log_fops = {
 211         .open           = batadv_log_open,
 212         .release        = batadv_log_release,
 213         .read           = batadv_log_read,
 214         .poll           = batadv_log_poll,
 215         .llseek         = no_llseek,
 216 };
 217
 218 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
 219 {
 220         struct dentry *d;
 221
 222         if (!bat_priv->debug_dir)
 223                 goto err;
 224
 225         bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
 226         if (!bat_priv->debug_log)
 227                 goto err;
 228
 229         spin_lock_init(&bat_priv->debug_log->lock);
 230         init_waitqueue_head(&bat_priv->debug_log->queue_wait);
 231
 232         d = debugfs_create_file("log", S_IFREG | S_IRUSR,
 233                                 bat_priv->debug_dir, bat_priv,
 234                                 &batadv_log_fops);
 235         if (!d)
 236                 goto err;
 237
 238         return 0;
 239
 240 err:
 241         return -ENOMEM;
 242 }
 243
 244 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
 245 {
 246         kfree(bat_priv->debug_log);
 247         bat_priv->debug_log = NULL;
 248 }
 249 #else /* CONFIG_BATMAN_ADV_DEBUG */
 250 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
 251 {
 252         return 0;
 253 }
 254
 255 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
 256 {
 257 }
 258 #endif
 259
 260 static int batadv_algorithms_open(struct inode *inode, struct file *file)
 261 {
 262         return single_open(file, batadv_algo_seq_print_text, NULL);
 263 }
 264
 265 static int neighbors_open(struct inode *inode, struct file *file)
 266 {
 267         struct net_device *net_dev = (struct net_device *)inode->i_private;
 268
 269         return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
 270 }
 271
 272 static int batadv_originators_open(struct inode *inode, struct file *file)
 273 {
 274         struct net_device *net_dev = (struct net_device *)inode->i_private;
 275
 276         return single_open(file, batadv_orig_seq_print_text, net_dev);
 277 }
 278
 279 /**
 280  * batadv_originators_hardif_open - handles debugfs output for the
 281  *  originator table of an hard interface
 282  * @inode: inode pointer to debugfs file
 283  * @file: pointer to the seq_file
 284  *
 285  * Return: 0 on success or negative error number in case of failure
 286  */
 287 static int batadv_originators_hardif_open(struct inode *inode,
 288                                           struct file *file)
 289 {
 290         struct net_device *net_dev = (struct net_device *)inode->i_private;
 291
 292         return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
 293 }
 294
 295 static int batadv_gateways_open(struct inode *inode, struct file *file)
 296 {
 297         struct net_device *net_dev = (struct net_device *)inode->i_private;
 298
 299         return single_open(file, batadv_gw_client_seq_print_text, net_dev);
 300 }
 301
 302 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
 303 {
 304         struct net_device *net_dev = (struct net_device *)inode->i_private;
 305
 306         return single_open(file, batadv_tt_global_seq_print_text, net_dev);
 307 }
 308
 309 #ifdef CONFIG_BATMAN_ADV_BLA
 310 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
 311 {
 312         struct net_device *net_dev = (struct net_device *)inode->i_private;
 313
 314         return single_open(file, batadv_bla_claim_table_seq_print_text,
 315                            net_dev);
 316 }
 317
 318 static int batadv_bla_backbone_table_open(struct inode *inode,
 319                                           struct file *file)
 320 {
 321         struct net_device *net_dev = (struct net_device *)inode->i_private;
 322
 323         return single_open(file, batadv_bla_backbone_table_seq_print_text,
 324                            net_dev);
 325 }
 326
 327 #endif
 328
 329 #ifdef CONFIG_BATMAN_ADV_DAT
 330 /**
 331  * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
 332  * @inode: inode which was opened
 333  * @file: file handle to be initialized
 334  *
 335  * Return: 0 on success or negative error number in case of failure
 336  */
 337 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
 338 {
 339         struct net_device *net_dev = (struct net_device *)inode->i_private;
 340
 341         return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
 342 }
 343 #endif
 344
 345 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
 346 {
 347         struct net_device *net_dev = (struct net_device *)inode->i_private;
 348
 349         return single_open(file, batadv_tt_local_seq_print_text, net_dev);
 350 }
 351
 352 struct batadv_debuginfo {
 353         struct attribute attr;
 354         const struct file_operations fops;
 355 };
 356
 357 #ifdef CONFIG_BATMAN_ADV_NC
 358 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
 359 {
 360         struct net_device *net_dev = (struct net_device *)inode->i_private;
 361
 362         return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
 363 }
 364 #endif
 365
 366 #define BATADV_DEBUGINFO(_name, _mode, _open)           \
 367 struct batadv_debuginfo batadv_debuginfo_##_name = {    \
 368         .attr = { .name = __stringify(_name),           \
 369                   .mode = _mode, },                     \
 370         .fops = { .owner = THIS_MODULE,                 \
 371                   .open = _open,                        \
 372                   .read = seq_read,                     \
 373                   .llseek = seq_lseek,                  \
 374                   .release = single_release,            \
 375                 }                                       \
 376 }
 377
 378 /* the following attributes are general and therefore they will be directly
 379  * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
 380  */
 381 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
 382
 383 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
 384         &batadv_debuginfo_routing_algos,
 385         NULL,
 386 };
 387
 388 /* The following attributes are per soft interface */
 389 static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
 390 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
 391 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
 392 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
 393                         batadv_transtable_global_open);
 394 #ifdef CONFIG_BATMAN_ADV_BLA
 395 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
 396 static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
 397                         batadv_bla_backbone_table_open);
 398 #endif
 399 #ifdef CONFIG_BATMAN_ADV_DAT
 400 static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
 401 #endif
 402 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
 403                         batadv_transtable_local_open);
 404 #ifdef CONFIG_BATMAN_ADV_NC
 405 static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
 406 #endif
 407
 408 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
 409         &batadv_debuginfo_neighbors,
 410         &batadv_debuginfo_originators,
 411         &batadv_debuginfo_gateways,
 412         &batadv_debuginfo_transtable_global,
 413 #ifdef CONFIG_BATMAN_ADV_BLA
 414         &batadv_debuginfo_bla_claim_table,
 415         &batadv_debuginfo_bla_backbone_table,
 416 #endif
 417 #ifdef CONFIG_BATMAN_ADV_DAT
 418         &batadv_debuginfo_dat_cache,
 419 #endif
 420         &batadv_debuginfo_transtable_local,
 421 #ifdef CONFIG_BATMAN_ADV_NC
 422         &batadv_debuginfo_nc_nodes,
 423 #endif
 424         NULL,
 425 };
 426
 427 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open)            \
 428 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = {     \
 429         .attr = {                                               \
 430                 .name = __stringify(_name),                     \
 431                 .mode = _mode,                                  \
 432         },                                                      \
 433         .fops = {                                               \
 434                 .owner = THIS_MODULE,                           \
 435                 .open = _open,                                  \
 436                 .read   = seq_read,                             \
 437                 .llseek = seq_lseek,                            \
 438                 .release = single_release,                      \
 439         },                                                      \
 440 }
 441
 442 static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
 443                                batadv_originators_hardif_open);
 444
 445 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
 446         &batadv_hardif_debuginfo_originators,
 447         NULL,
 448 };
 449
 450 void batadv_debugfs_init(void)
 451 {
 452         struct batadv_debuginfo **bat_debug;
 453         struct dentry *file;
 454
 455         batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
 456         if (batadv_debugfs == ERR_PTR(-ENODEV))
 457                 batadv_debugfs = NULL;
 458
 459         if (!batadv_debugfs)
 460                 goto err;
 461
 462         for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
 463                 file = debugfs_create_file(((*bat_debug)->attr).name,
 464                                            S_IFREG | ((*bat_debug)->attr).mode,
 465                                            batadv_debugfs, NULL,
 466                                            &(*bat_debug)->fops);
 467                 if (!file) {
 468                         pr_err("Can't add general debugfs file: %s\n",
 469                                ((*bat_debug)->attr).name);
 470                         goto err;
 471                 }
 472         }
 473
 474         return;
 475 err:
 476         debugfs_remove_recursive(batadv_debugfs);
 477         batadv_debugfs = NULL;
 478 }
 479
 480 void batadv_debugfs_destroy(void)
 481 {
 482         debugfs_remove_recursive(batadv_debugfs);
 483         batadv_debugfs = NULL;
 484 }
 485
 486 /**
 487  * batadv_debugfs_add_hardif - creates the base directory for a hard interface
 488  *  in debugfs.
 489  * @hard_iface: hard interface which should be added.
 490  *
 491  * Return: 0 on success or negative error number in case of failure
 492  */
 493 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
 494 {
 495         struct batadv_debuginfo **bat_debug;
 496         struct dentry *file;
 497
 498         if (!batadv_debugfs)
 499                 goto out;
 500
 501         hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
 502                                                    batadv_debugfs);
 503         if (!hard_iface->debug_dir)
 504                 goto out;
 505
 506         for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
 507                 file = debugfs_create_file(((*bat_debug)->attr).name,
 508                                            S_IFREG | ((*bat_debug)->attr).mode,
 509                                            hard_iface->debug_dir,
 510                                            hard_iface->net_dev,
 511                                            &(*bat_debug)->fops);
 512                 if (!file)
 513                         goto rem_attr;
 514         }
 515
 516         return 0;
 517 rem_attr:
 518         debugfs_remove_recursive(hard_iface->debug_dir);
 519         hard_iface->debug_dir = NULL;
 520 out:
 521         return -ENOMEM;
 522 }
 523
 524 /**
 525  * batadv_debugfs_del_hardif - delete the base directory for a hard interface
 526  *  in debugfs.
 527  * @hard_iface: hard interface which is deleted.
 528  */
 529 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
 530 {
 531         if (batadv_debugfs) {
 532                 debugfs_remove_recursive(hard_iface->debug_dir);
 533                 hard_iface->debug_dir = NULL;
 534         }
 535 }
 536
 537 int batadv_debugfs_add_meshif(struct net_device *dev)
 538 {
 539         struct batadv_priv *bat_priv = netdev_priv(dev);
 540         struct batadv_debuginfo **bat_debug;
 541         struct dentry *file;
 542
 543         if (!batadv_debugfs)
 544                 goto out;
 545
 546         bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
 547         if (!bat_priv->debug_dir)
 548                 goto out;
 549
 550         if (batadv_socket_setup(bat_priv) < 0)
 551                 goto rem_attr;
 552
 553         if (batadv_debug_log_setup(bat_priv) < 0)
 554                 goto rem_attr;
 555
 556         for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
 557                 file = debugfs_create_file(((*bat_debug)->attr).name,
 558                                            S_IFREG | ((*bat_debug)->attr).mode,
 559                                            bat_priv->debug_dir,
 560                                            dev, &(*bat_debug)->fops);
 561                 if (!file) {
 562                         batadv_err(dev, "Can't add debugfs file: %s/%s\n",
 563                                    dev->name, ((*bat_debug)->attr).name);
 564                         goto rem_attr;
 565                 }
 566         }
 567
 568         if (batadv_nc_init_debugfs(bat_priv) < 0)
 569                 goto rem_attr;
 570
 571         return 0;
 572 rem_attr:
 573         debugfs_remove_recursive(bat_priv->debug_dir);
 574         bat_priv->debug_dir = NULL;
 575 out:
 576         return -ENOMEM;
 577 }
 578
 579 void batadv_debugfs_del_meshif(struct net_device *dev)
 580 {
 581         struct batadv_priv *bat_priv = netdev_priv(dev);
 582
 583         batadv_debug_log_cleanup(bat_priv);
 584
 585         if (batadv_debugfs) {
 586                 debugfs_remove_recursive(bat_priv->debug_dir);
 587                 bat_priv->debug_dir = NULL;
 588         }
 589 }