net/batman-adv/debugfs.c

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