net/batman-adv/debugfs.c

   1 /* Copyright (C) 2010-2012 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_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_debug_log *debug_log, char c)
  50 {
  51         char *char_addr;
  52
  53         char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
  54         *char_addr = c;
  55         debug_log->log_end++;
  56
  57         if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
  58                 debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
  59 }
  60
  61 __printf(2, 3)
  62 static int batadv_fdebug_log(struct batadv_debug_log *debug_log,
  63                              const char *fmt, ...)
  64 {
  65         va_list args;
  66         static char debug_log_buf[256];
  67         char *p;
  68
  69         if (!debug_log)
  70                 return 0;
  71
  72         spin_lock_bh(&debug_log->lock);
  73         va_start(args, fmt);
  74         vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
  75         va_end(args);
  76
  77         for (p = debug_log_buf; *p != 0; p++)
  78                 batadv_emit_log_char(debug_log, *p);
  79
  80         spin_unlock_bh(&debug_log->lock);
  81
  82         wake_up(&debug_log->queue_wait);
  83
  84         return 0;
  85 }
  86
  87 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
  88 {
  89         va_list args;
  90         char tmp_log_buf[256];
  91
  92         va_start(args, fmt);
  93         vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
  94         batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
  95                           jiffies_to_msecs(jiffies), tmp_log_buf);
  96         va_end(args);
  97
  98         return 0;
  99 }
 100
 101 static int batadv_log_open(struct inode *inode, struct file *file)
 102 {
 103         if (!try_module_get(THIS_MODULE))
 104                 return -EBUSY;
 105
 106         nonseekable_open(inode, file);
 107         file->private_data = inode->i_private;
 108         return 0;
 109 }
 110
 111 static int batadv_log_release(struct inode *inode, struct file *file)
 112 {
 113         module_put(THIS_MODULE);
 114         return 0;
 115 }
 116
 117 static int batadv_log_empty(struct batadv_debug_log *debug_log)
 118 {
 119         return !(debug_log->log_start - debug_log->log_end);
 120 }
 121
 122 static ssize_t batadv_log_read(struct file *file, char __user *buf,
 123                                size_t count, loff_t *ppos)
 124 {
 125         struct batadv_priv *bat_priv = file->private_data;
 126         struct batadv_debug_log *debug_log = bat_priv->debug_log;
 127         int error, i = 0;
 128         char *char_addr;
 129         char c;
 130
 131         if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
 132                 return -EAGAIN;
 133
 134         if (!buf)
 135                 return -EINVAL;
 136
 137         if (count == 0)
 138                 return 0;
 139
 140         if (!access_ok(VERIFY_WRITE, buf, count))
 141                 return -EFAULT;
 142
 143         error = wait_event_interruptible(debug_log->queue_wait,
 144                                          (!batadv_log_empty(debug_log)));
 145
 146         if (error)
 147                 return error;
 148
 149         spin_lock_bh(&debug_log->lock);
 150
 151         while ((!error) && (i < count) &&
 152                (debug_log->log_start != debug_log->log_end)) {
 153                 char_addr = batadv_log_char_addr(debug_log,
 154                                                  debug_log->log_start);
 155                 c = *char_addr;
 156
 157                 debug_log->log_start++;
 158
 159                 spin_unlock_bh(&debug_log->lock);
 160
 161                 error = __put_user(c, buf);
 162
 163                 spin_lock_bh(&debug_log->lock);
 164
 165                 buf++;
 166                 i++;
 167         }
 168
 169         spin_unlock_bh(&debug_log->lock);
 170
 171         if (!error)
 172                 return i;
 173
 174         return error;
 175 }
 176
 177 static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
 178 {
 179         struct batadv_priv *bat_priv = file->private_data;
 180         struct batadv_debug_log *debug_log = bat_priv->debug_log;
 181
 182         poll_wait(file, &debug_log->queue_wait, wait);
 183
 184         if (!batadv_log_empty(debug_log))
 185                 return POLLIN | POLLRDNORM;
 186
 187         return 0;
 188 }
 189
 190 static const struct file_operations batadv_log_fops = {
 191         .open           = batadv_log_open,
 192         .release        = batadv_log_release,
 193         .read           = batadv_log_read,
 194         .poll           = batadv_log_poll,
 195         .llseek         = no_llseek,
 196 };
 197
 198 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
 199 {
 200         struct dentry *d;
 201
 202         if (!bat_priv->debug_dir)
 203                 goto err;
 204
 205         bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
 206         if (!bat_priv->debug_log)
 207                 goto err;
 208
 209         spin_lock_init(&bat_priv->debug_log->lock);
 210         init_waitqueue_head(&bat_priv->debug_log->queue_wait);
 211
 212         d = debugfs_create_file("log", S_IFREG | S_IRUSR,
 213                                 bat_priv->debug_dir, bat_priv,
 214                                 &batadv_log_fops);
 215         if (!d)
 216                 goto err;
 217
 218         return 0;
 219
 220 err:
 221         return -ENOMEM;
 222 }
 223
 224 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
 225 {
 226         kfree(bat_priv->debug_log);
 227         bat_priv->debug_log = NULL;
 228 }
 229 #else /* CONFIG_BATMAN_ADV_DEBUG */
 230 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
 231 {
 232         bat_priv->debug_log = NULL;
 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 }