linux/net/batman-adv/debugfs.c
<<
>>
Prefs
   1/* Copyright (C) 2010-2013 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, write to the Free Software
  16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17 * 02110-1301, USA
  18 */
  19
  20#include "main.h"
  21
  22#include <linux/debugfs.h>
  23
  24#include "debugfs.h"
  25#include "translation-table.h"
  26#include "originator.h"
  27#include "hard-interface.h"
  28#include "gateway_common.h"
  29#include "gateway_client.h"
  30#include "soft-interface.h"
  31#include "vis.h"
  32#include "icmp_socket.h"
  33#include "bridge_loop_avoidance.h"
  34#include "distributed-arp-table.h"
  35#include "network-coding.h"
  36
  37static struct dentry *batadv_debugfs;
  38
  39#ifdef CONFIG_BATMAN_ADV_DEBUG
  40#define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
  41
  42static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
  43
  44static char *batadv_log_char_addr(struct batadv_priv_debug_log *debug_log,
  45                                  size_t idx)
  46{
  47        return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
  48}
  49
  50static void batadv_emit_log_char(struct batadv_priv_debug_log *debug_log,
  51                                 char c)
  52{
  53        char *char_addr;
  54
  55        char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
  56        *char_addr = c;
  57        debug_log->log_end++;
  58
  59        if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
  60                debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
  61}
  62
  63__printf(2, 3)
  64static int batadv_fdebug_log(struct batadv_priv_debug_log *debug_log,
  65                             const char *fmt, ...)
  66{
  67        va_list args;
  68        static char debug_log_buf[256];
  69        char *p;
  70
  71        if (!debug_log)
  72                return 0;
  73
  74        spin_lock_bh(&debug_log->lock);
  75        va_start(args, fmt);
  76        vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
  77        va_end(args);
  78
  79        for (p = debug_log_buf; *p != 0; p++)
  80                batadv_emit_log_char(debug_log, *p);
  81
  82        spin_unlock_bh(&debug_log->lock);
  83
  84        wake_up(&debug_log->queue_wait);
  85
  86        return 0;
  87}
  88
  89int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
  90{
  91        va_list args;
  92        char tmp_log_buf[256];
  93
  94        va_start(args, fmt);
  95        vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
  96        batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
  97                          jiffies_to_msecs(jiffies), tmp_log_buf);
  98        va_end(args);
  99
 100        return 0;
 101}
 102
 103static int batadv_log_open(struct inode *inode, struct file *file)
 104{
 105        if (!try_module_get(THIS_MODULE))
 106                return -EBUSY;
 107
 108        nonseekable_open(inode, file);
 109        file->private_data = inode->i_private;
 110        return 0;
 111}
 112
 113static int batadv_log_release(struct inode *inode, struct file *file)
 114{
 115        module_put(THIS_MODULE);
 116        return 0;
 117}
 118
 119static int batadv_log_empty(struct batadv_priv_debug_log *debug_log)
 120{
 121        return !(debug_log->log_start - debug_log->log_end);
 122}
 123
 124static ssize_t batadv_log_read(struct file *file, char __user *buf,
 125                               size_t count, loff_t *ppos)
 126{
 127        struct batadv_priv *bat_priv = file->private_data;
 128        struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
 129        int error, i = 0;
 130        char *char_addr;
 131        char c;
 132
 133        if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
 134                return -EAGAIN;
 135
 136        if (!buf)
 137                return -EINVAL;
 138
 139        if (count == 0)
 140                return 0;
 141
 142        if (!access_ok(VERIFY_WRITE, buf, count))
 143                return -EFAULT;
 144
 145        error = wait_event_interruptible(debug_log->queue_wait,
 146                                         (!batadv_log_empty(debug_log)));
 147
 148        if (error)
 149                return error;
 150
 151        spin_lock_bh(&debug_log->lock);
 152
 153        while ((!error) && (i < count) &&
 154               (debug_log->log_start != debug_log->log_end)) {
 155                char_addr = batadv_log_char_addr(debug_log,
 156                                                 debug_log->log_start);
 157                c = *char_addr;
 158
 159                debug_log->log_start++;
 160
 161                spin_unlock_bh(&debug_log->lock);
 162
 163                error = __put_user(c, buf);
 164
 165                spin_lock_bh(&debug_log->lock);
 166
 167                buf++;
 168                i++;
 169        }
 170
 171        spin_unlock_bh(&debug_log->lock);
 172
 173        if (!error)
 174                return i;
 175
 176        return error;
 177}
 178
 179static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
 180{
 181        struct batadv_priv *bat_priv = file->private_data;
 182        struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
 183
 184        poll_wait(file, &debug_log->queue_wait, wait);
 185
 186        if (!batadv_log_empty(debug_log))
 187                return POLLIN | POLLRDNORM;
 188
 189        return 0;
 190}
 191
 192static const struct file_operations batadv_log_fops = {
 193        .open           = batadv_log_open,
 194        .release        = batadv_log_release,
 195        .read           = batadv_log_read,
 196        .poll           = batadv_log_poll,
 197        .llseek         = no_llseek,
 198};
 199
 200static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
 201{
 202        struct dentry *d;
 203
 204        if (!bat_priv->debug_dir)
 205                goto err;
 206
 207        bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
 208        if (!bat_priv->debug_log)
 209                goto err;
 210
 211        spin_lock_init(&bat_priv->debug_log->lock);
 212        init_waitqueue_head(&bat_priv->debug_log->queue_wait);
 213
 214        d = debugfs_create_file("log", S_IFREG | S_IRUSR,
 215                                bat_priv->debug_dir, bat_priv,
 216                                &batadv_log_fops);
 217        if (!d)
 218                goto err;
 219
 220        return 0;
 221
 222err:
 223        return -ENOMEM;
 224}
 225
 226static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
 227{
 228        kfree(bat_priv->debug_log);
 229        bat_priv->debug_log = NULL;
 230}
 231#else /* CONFIG_BATMAN_ADV_DEBUG */
 232static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
 233{
 234        return 0;
 235}
 236
 237static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
 238{
 239        return;
 240}
 241#endif
 242
 243static int batadv_algorithms_open(struct inode *inode, struct file *file)
 244{
 245        return single_open(file, batadv_algo_seq_print_text, NULL);
 246}
 247
 248static int batadv_originators_open(struct inode *inode, struct file *file)
 249{
 250        struct net_device *net_dev = (struct net_device *)inode->i_private;
 251        return single_open(file, batadv_orig_seq_print_text, net_dev);
 252}
 253
 254static int batadv_gateways_open(struct inode *inode, struct file *file)
 255{
 256        struct net_device *net_dev = (struct net_device *)inode->i_private;
 257        return single_open(file, batadv_gw_client_seq_print_text, net_dev);
 258}
 259
 260static int batadv_transtable_global_open(struct inode *inode, struct file *file)
 261{
 262        struct net_device *net_dev = (struct net_device *)inode->i_private;
 263        return single_open(file, batadv_tt_global_seq_print_text, net_dev);
 264}
 265
 266#ifdef CONFIG_BATMAN_ADV_BLA
 267static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
 268{
 269        struct net_device *net_dev = (struct net_device *)inode->i_private;
 270        return single_open(file, batadv_bla_claim_table_seq_print_text,
 271                           net_dev);
 272}
 273
 274static int batadv_bla_backbone_table_open(struct inode *inode,
 275                                          struct file *file)
 276{
 277        struct net_device *net_dev = (struct net_device *)inode->i_private;
 278        return single_open(file, batadv_bla_backbone_table_seq_print_text,
 279                           net_dev);
 280}
 281
 282#endif
 283
 284#ifdef CONFIG_BATMAN_ADV_DAT
 285/**
 286 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
 287 * @inode: inode which was opened
 288 * @file: file handle to be initialized
 289 */
 290static int batadv_dat_cache_open(struct inode *inode, struct file *file)
 291{
 292        struct net_device *net_dev = (struct net_device *)inode->i_private;
 293        return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
 294}
 295#endif
 296
 297static int batadv_transtable_local_open(struct inode *inode, struct file *file)
 298{
 299        struct net_device *net_dev = (struct net_device *)inode->i_private;
 300        return single_open(file, batadv_tt_local_seq_print_text, net_dev);
 301}
 302
 303static int batadv_vis_data_open(struct inode *inode, struct file *file)
 304{
 305        struct net_device *net_dev = (struct net_device *)inode->i_private;
 306        return single_open(file, batadv_vis_seq_print_text, net_dev);
 307}
 308
 309struct batadv_debuginfo {
 310        struct attribute attr;
 311        const struct file_operations fops;
 312};
 313
 314#ifdef CONFIG_BATMAN_ADV_NC
 315static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
 316{
 317        struct net_device *net_dev = (struct net_device *)inode->i_private;
 318        return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
 319}
 320#endif
 321
 322#define BATADV_DEBUGINFO(_name, _mode, _open)           \
 323struct batadv_debuginfo batadv_debuginfo_##_name = {    \
 324        .attr = { .name = __stringify(_name),           \
 325                  .mode = _mode, },                     \
 326        .fops = { .owner = THIS_MODULE,                 \
 327                  .open = _open,                        \
 328                  .read = seq_read,                     \
 329                  .llseek = seq_lseek,                  \
 330                  .release = single_release,            \
 331                }                                       \
 332};
 333
 334/* the following attributes are general and therefore they will be directly
 335 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
 336 */
 337static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
 338
 339static struct batadv_debuginfo *batadv_general_debuginfos[] = {
 340        &batadv_debuginfo_routing_algos,
 341        NULL,
 342};
 343
 344/* The following attributes are per soft interface */
 345static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
 346static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
 347static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
 348                        batadv_transtable_global_open);
 349#ifdef CONFIG_BATMAN_ADV_BLA
 350static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
 351static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
 352                        batadv_bla_backbone_table_open);
 353#endif
 354#ifdef CONFIG_BATMAN_ADV_DAT
 355static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
 356#endif
 357static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
 358                        batadv_transtable_local_open);
 359static BATADV_DEBUGINFO(vis_data, S_IRUGO, batadv_vis_data_open);
 360#ifdef CONFIG_BATMAN_ADV_NC
 361static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
 362#endif
 363
 364static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
 365        &batadv_debuginfo_originators,
 366        &batadv_debuginfo_gateways,
 367        &batadv_debuginfo_transtable_global,
 368#ifdef CONFIG_BATMAN_ADV_BLA
 369        &batadv_debuginfo_bla_claim_table,
 370        &batadv_debuginfo_bla_backbone_table,
 371#endif
 372#ifdef CONFIG_BATMAN_ADV_DAT
 373        &batadv_debuginfo_dat_cache,
 374#endif
 375        &batadv_debuginfo_transtable_local,
 376        &batadv_debuginfo_vis_data,
 377#ifdef CONFIG_BATMAN_ADV_NC
 378        &batadv_debuginfo_nc_nodes,
 379#endif
 380        NULL,
 381};
 382
 383void batadv_debugfs_init(void)
 384{
 385        struct batadv_debuginfo **bat_debug;
 386        struct dentry *file;
 387
 388        batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
 389        if (batadv_debugfs == ERR_PTR(-ENODEV))
 390                batadv_debugfs = NULL;
 391
 392        if (!batadv_debugfs)
 393                goto err;
 394
 395        for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
 396                file = debugfs_create_file(((*bat_debug)->attr).name,
 397                                           S_IFREG | ((*bat_debug)->attr).mode,
 398                                           batadv_debugfs, NULL,
 399                                           &(*bat_debug)->fops);
 400                if (!file) {
 401                        pr_err("Can't add general debugfs file: %s\n",
 402                               ((*bat_debug)->attr).name);
 403                        goto err;
 404                }
 405        }
 406
 407        return;
 408err:
 409        debugfs_remove_recursive(batadv_debugfs);
 410}
 411
 412void batadv_debugfs_destroy(void)
 413{
 414        debugfs_remove_recursive(batadv_debugfs);
 415        batadv_debugfs = NULL;
 416}
 417
 418int batadv_debugfs_add_meshif(struct net_device *dev)
 419{
 420        struct batadv_priv *bat_priv = netdev_priv(dev);
 421        struct batadv_debuginfo **bat_debug;
 422        struct dentry *file;
 423
 424        if (!batadv_debugfs)
 425                goto out;
 426
 427        bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
 428        if (!bat_priv->debug_dir)
 429                goto out;
 430
 431        if (batadv_socket_setup(bat_priv) < 0)
 432                goto rem_attr;
 433
 434        if (batadv_debug_log_setup(bat_priv) < 0)
 435                goto rem_attr;
 436
 437        for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
 438                file = debugfs_create_file(((*bat_debug)->attr).name,
 439                                           S_IFREG | ((*bat_debug)->attr).mode,
 440                                           bat_priv->debug_dir,
 441                                           dev, &(*bat_debug)->fops);
 442                if (!file) {
 443                        batadv_err(dev, "Can't add debugfs file: %s/%s\n",
 444                                   dev->name, ((*bat_debug)->attr).name);
 445                        goto rem_attr;
 446                }
 447        }
 448
 449        if (batadv_nc_init_debugfs(bat_priv) < 0)
 450                goto rem_attr;
 451
 452        return 0;
 453rem_attr:
 454        debugfs_remove_recursive(bat_priv->debug_dir);
 455        bat_priv->debug_dir = NULL;
 456out:
 457#ifdef CONFIG_DEBUG_FS
 458        return -ENOMEM;
 459#else
 460        return 0;
 461#endif /* CONFIG_DEBUG_FS */
 462}
 463
 464void batadv_debugfs_del_meshif(struct net_device *dev)
 465{
 466        struct batadv_priv *bat_priv = netdev_priv(dev);
 467
 468        batadv_debug_log_cleanup(bat_priv);
 469
 470        if (batadv_debugfs) {
 471                debugfs_remove_recursive(bat_priv->debug_dir);
 472                bat_priv->debug_dir = NULL;
 473        }
 474}
 475