net/batman-adv/bat_debugfs.c

   1 /*
   2  * Copyright (C) 2010-2012 B.A.T.M.A.N. contributors:
   3  *
   4  * Marek Lindner
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of version 2 of the GNU General Public
   8  * License as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18  * 02110-1301, USA
  19  *
  20  */
  21
  22 #include "main.h"
  23
  24 #include <linux/debugfs.h>
  25
  26 #include "bat_debugfs.h"
  27 #include "translation-table.h"
  28 #include "originator.h"
  29 #include "hard-interface.h"
  30 #include "gateway_common.h"
  31 #include "gateway_client.h"
  32 #include "soft-interface.h"
  33 #include "vis.h"
  34 #include "icmp_socket.h"
  35 #include "bridge_loop_avoidance.h"
  36
  37 static struct dentry *bat_debugfs;
  38
  39 #ifdef CONFIG_BATMAN_ADV_DEBUG
  40 #define LOG_BUFF_MASK (log_buff_len-1)
  41 #define LOG_BUFF(idx) (debug_log->log_buff[(idx) & LOG_BUFF_MASK])
  42
  43 static int log_buff_len = LOG_BUF_LEN;
  44
  45 static void emit_log_char(struct debug_log *debug_log, char c)
  46 {
  47         LOG_BUFF(debug_log->log_end) = c;
  48         debug_log->log_end++;
  49
  50         if (debug_log->log_end - debug_log->log_start > log_buff_len)
  51                 debug_log->log_start = debug_log->log_end - log_buff_len;
  52 }
  53
  54 __printf(2, 3)
  55 static int fdebug_log(struct debug_log *debug_log, const char *fmt, ...)
  56 {
  57         va_list args;
  58         static char debug_log_buf[256];
  59         char *p;
  60
  61         if (!debug_log)
  62                 return 0;
  63
  64         spin_lock_bh(&debug_log->lock);
  65         va_start(args, fmt);
  66         vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
  67         va_end(args);
  68
  69         for (p = debug_log_buf; *p != 0; p++)
  70                 emit_log_char(debug_log, *p);
  71
  72         spin_unlock_bh(&debug_log->lock);
  73
  74         wake_up(&debug_log->queue_wait);
  75
  76         return 0;
  77 }
  78
  79 int debug_log(struct bat_priv *bat_priv, const char *fmt, ...)
  80 {
  81         va_list args;
  82         char tmp_log_buf[256];
  83
  84         va_start(args, fmt);
  85         vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
  86         fdebug_log(bat_priv->debug_log, "[%10u] %s",
  87                    jiffies_to_msecs(jiffies), tmp_log_buf);
  88         va_end(args);
  89
  90         return 0;
  91 }
  92
  93 static int log_open(struct inode *inode, struct file *file)
  94 {
  95         nonseekable_open(inode, file);
  96         file->private_data = inode->i_private;
  97         inc_module_count();
  98         return 0;
  99 }
 100
 101 static int log_release(struct inode *inode, struct file *file)
 102 {
 103         dec_module_count();
 104         return 0;
 105 }
 106
 107 static ssize_t log_read(struct file *file, char __user *buf,
 108                         size_t count, loff_t *ppos)
 109 {
 110         struct bat_priv *bat_priv = file->private_data;
 111         struct debug_log *debug_log = bat_priv->debug_log;
 112         int error, i = 0;
 113         char c;
 114
 115         if ((file->f_flags & O_NONBLOCK) &&
 116             !(debug_log->log_end - debug_log->log_start))
 117                 return -EAGAIN;
 118
 119         if (!buf)
 120                 return -EINVAL;
 121
 122         if (count == 0)
 123                 return 0;
 124
 125         if (!access_ok(VERIFY_WRITE, buf, count))
 126                 return -EFAULT;
 127
 128         error = wait_event_interruptible(debug_log->queue_wait,
 129                                 (debug_log->log_start - debug_log->log_end));
 130
 131         if (error)
 132                 return error;
 133
 134         spin_lock_bh(&debug_log->lock);
 135
 136         while ((!error) && (i < count) &&
 137                (debug_log->log_start != debug_log->log_end)) {
 138                 c = LOG_BUFF(debug_log->log_start);
 139
 140                 debug_log->log_start++;
 141
 142                 spin_unlock_bh(&debug_log->lock);
 143
 144                 error = __put_user(c, buf);
 145
 146                 spin_lock_bh(&debug_log->lock);
 147
 148                 buf++;
 149                 i++;
 150
 151         }
 152
 153         spin_unlock_bh(&debug_log->lock);
 154
 155         if (!error)
 156                 return i;
 157
 158         return error;
 159 }
 160
 161 static unsigned int log_poll(struct file *file, poll_table *wait)
 162 {
 163         struct bat_priv *bat_priv = file->private_data;
 164         struct debug_log *debug_log = bat_priv->debug_log;
 165
 166         poll_wait(file, &debug_log->queue_wait, wait);
 167
 168         if (debug_log->log_end - debug_log->log_start)
 169                 return POLLIN | POLLRDNORM;
 170
 171         return 0;
 172 }
 173
 174 static const struct file_operations log_fops = {
 175         .open           = log_open,
 176         .release        = log_release,
 177         .read           = log_read,
 178         .poll           = log_poll,
 179         .llseek         = no_llseek,
 180 };
 181
 182 static int debug_log_setup(struct bat_priv *bat_priv)
 183 {
 184         struct dentry *d;
 185
 186         if (!bat_priv->debug_dir)
 187                 goto err;
 188
 189         bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
 190         if (!bat_priv->debug_log)
 191                 goto err;
 192
 193         spin_lock_init(&bat_priv->debug_log->lock);
 194         init_waitqueue_head(&bat_priv->debug_log->queue_wait);
 195
 196         d = debugfs_create_file("log", S_IFREG | S_IRUSR,
 197                                 bat_priv->debug_dir, bat_priv, &log_fops);
 198         if (d)
 199                 goto err;
 200
 201         return 0;
 202
 203 err:
 204         return 1;
 205 }
 206
 207 static void debug_log_cleanup(struct bat_priv *bat_priv)
 208 {
 209         kfree(bat_priv->debug_log);
 210         bat_priv->debug_log = NULL;
 211 }
 212 #else /* CONFIG_BATMAN_ADV_DEBUG */
 213 static int debug_log_setup(struct bat_priv *bat_priv)
 214 {
 215         bat_priv->debug_log = NULL;
 216         return 0;
 217 }
 218
 219 static void debug_log_cleanup(struct bat_priv *bat_priv)
 220 {
 221         return;
 222 }
 223 #endif
 224
 225 static int bat_algorithms_open(struct inode *inode, struct file *file)
 226 {
 227         return single_open(file, bat_algo_seq_print_text, NULL);
 228 }
 229
 230 static int originators_open(struct inode *inode, struct file *file)
 231 {
 232         struct net_device *net_dev = (struct net_device *)inode->i_private;
 233         return single_open(file, orig_seq_print_text, net_dev);
 234 }
 235
 236 static int gateways_open(struct inode *inode, struct file *file)
 237 {
 238         struct net_device *net_dev = (struct net_device *)inode->i_private;
 239         return single_open(file, gw_client_seq_print_text, net_dev);
 240 }
 241
 242 static int transtable_global_open(struct inode *inode, struct file *file)
 243 {
 244         struct net_device *net_dev = (struct net_device *)inode->i_private;
 245         return single_open(file, tt_global_seq_print_text, net_dev);
 246 }
 247
 248 #ifdef CONFIG_BATMAN_ADV_BLA
 249 static int bla_claim_table_open(struct inode *inode, struct file *file)
 250 {
 251         struct net_device *net_dev = (struct net_device *)inode->i_private;
 252         return single_open(file, bla_claim_table_seq_print_text, net_dev);
 253 }
 254 #endif
 255
 256 static int transtable_local_open(struct inode *inode, struct file *file)
 257 {
 258         struct net_device *net_dev = (struct net_device *)inode->i_private;
 259         return single_open(file, tt_local_seq_print_text, net_dev);
 260 }
 261
 262 static int vis_data_open(struct inode *inode, struct file *file)
 263 {
 264         struct net_device *net_dev = (struct net_device *)inode->i_private;
 265         return single_open(file, vis_seq_print_text, net_dev);
 266 }
 267
 268 struct bat_debuginfo {
 269         struct attribute attr;
 270         const struct file_operations fops;
 271 };
 272
 273 #define BAT_DEBUGINFO(_name, _mode, _open)      \
 274 struct bat_debuginfo bat_debuginfo_##_name = {  \
 275         .attr = { .name = __stringify(_name),   \
 276                   .mode = _mode, },             \
 277         .fops = { .owner = THIS_MODULE,         \
 278                   .open = _open,                \
 279                   .read = seq_read,             \
 280                   .llseek = seq_lseek,          \
 281                   .release = single_release,    \
 282                 }                               \
 283 };
 284
 285 static BAT_DEBUGINFO(routing_algos, S_IRUGO, bat_algorithms_open);
 286 static BAT_DEBUGINFO(originators, S_IRUGO, originators_open);
 287 static BAT_DEBUGINFO(gateways, S_IRUGO, gateways_open);
 288 static BAT_DEBUGINFO(transtable_global, S_IRUGO, transtable_global_open);
 289 #ifdef CONFIG_BATMAN_ADV_BLA
 290 static BAT_DEBUGINFO(bla_claim_table, S_IRUGO, bla_claim_table_open);
 291 #endif
 292 static BAT_DEBUGINFO(transtable_local, S_IRUGO, transtable_local_open);
 293 static BAT_DEBUGINFO(vis_data, S_IRUGO, vis_data_open);
 294
 295 static struct bat_debuginfo *mesh_debuginfos[] = {
 296         &bat_debuginfo_originators,
 297         &bat_debuginfo_gateways,
 298         &bat_debuginfo_transtable_global,
 299 #ifdef CONFIG_BATMAN_ADV_BLA
 300         &bat_debuginfo_bla_claim_table,
 301 #endif
 302         &bat_debuginfo_transtable_local,
 303         &bat_debuginfo_vis_data,
 304         NULL,
 305 };
 306
 307 void debugfs_init(void)
 308 {
 309         struct bat_debuginfo *bat_debug;
 310         struct dentry *file;
 311
 312         bat_debugfs = debugfs_create_dir(DEBUGFS_BAT_SUBDIR, NULL);
 313         if (bat_debugfs == ERR_PTR(-ENODEV))
 314                 bat_debugfs = NULL;
 315
 316         if (!bat_debugfs)
 317                 goto out;
 318
 319         bat_debug = &bat_debuginfo_routing_algos;
 320         file = debugfs_create_file(bat_debug->attr.name,
 321                                    S_IFREG | bat_debug->attr.mode,
 322                                    bat_debugfs, NULL, &bat_debug->fops);
 323         if (!file)
 324                 pr_err("Can't add debugfs file: %s\n", bat_debug->attr.name);
 325
 326 out:
 327         return;
 328 }
 329
 330 void debugfs_destroy(void)
 331 {
 332         if (bat_debugfs) {
 333                 debugfs_remove_recursive(bat_debugfs);
 334                 bat_debugfs = NULL;
 335         }
 336 }
 337
 338 int debugfs_add_meshif(struct net_device *dev)
 339 {
 340         struct bat_priv *bat_priv = netdev_priv(dev);
 341         struct bat_debuginfo **bat_debug;
 342         struct dentry *file;
 343
 344         if (!bat_debugfs)
 345                 goto out;
 346
 347         bat_priv->debug_dir = debugfs_create_dir(dev->name, bat_debugfs);
 348         if (!bat_priv->debug_dir)
 349                 goto out;
 350
 351         bat_socket_setup(bat_priv);
 352         debug_log_setup(bat_priv);
 353
 354         for (bat_debug = mesh_debuginfos; *bat_debug; ++bat_debug) {
 355                 file = debugfs_create_file(((*bat_debug)->attr).name,
 356                                           S_IFREG | ((*bat_debug)->attr).mode,
 357                                           bat_priv->debug_dir,
 358                                           dev, &(*bat_debug)->fops);
 359                 if (!file) {
 360                         bat_err(dev, "Can't add debugfs file: %s/%s\n",
 361                                 dev->name, ((*bat_debug)->attr).name);
 362                         goto rem_attr;
 363                 }
 364         }
 365
 366         return 0;
 367 rem_attr:
 368         debugfs_remove_recursive(bat_priv->debug_dir);
 369         bat_priv->debug_dir = NULL;
 370 out:
 371 #ifdef CONFIG_DEBUG_FS
 372         return -ENOMEM;
 373 #else
 374         return 0;
 375 #endif /* CONFIG_DEBUG_FS */
 376 }
 377
 378 void debugfs_del_meshif(struct net_device *dev)
 379 {
 380         struct bat_priv *bat_priv = netdev_priv(dev);
 381
 382         debug_log_cleanup(bat_priv);
 383
 384         if (bat_debugfs) {
 385                 debugfs_remove_recursive(bat_priv->debug_dir);
 386                 bat_priv->debug_dir = NULL;
 387         }
 388 }