net/batman-adv/bat_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 "bat_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
  35 static struct dentry *bat_debugfs;
  36
  37 #ifdef CONFIG_BATMAN_ADV_DEBUG
  38 #define LOG_BUFF_MASK (log_buff_len-1)
  39 #define LOG_BUFF(idx) (debug_log->log_buff[(idx) & LOG_BUFF_MASK])
  40
  41 static int log_buff_len = LOG_BUF_LEN;
  42
  43 static void emit_log_char(struct debug_log *debug_log, char c)
  44 {
  45         LOG_BUFF(debug_log->log_end) = c;
  46         debug_log->log_end++;
  47
  48         if (debug_log->log_end - debug_log->log_start > log_buff_len)
  49                 debug_log->log_start = debug_log->log_end - log_buff_len;
  50 }
  51
  52 __printf(2, 3)
  53 static int fdebug_log(struct debug_log *debug_log, const char *fmt, ...)
  54 {
  55         va_list args;
  56         static char debug_log_buf[256];
  57         char *p;
  58
  59         if (!debug_log)
  60                 return 0;
  61
  62         spin_lock_bh(&debug_log->lock);
  63         va_start(args, fmt);
  64         vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
  65         va_end(args);
  66
  67         for (p = debug_log_buf; *p != 0; p++)
  68                 emit_log_char(debug_log, *p);
  69
  70         spin_unlock_bh(&debug_log->lock);
  71
  72         wake_up(&debug_log->queue_wait);
  73
  74         return 0;
  75 }
  76
  77 int batadv_debug_log(struct bat_priv *bat_priv, const char *fmt, ...)
  78 {
  79         va_list args;
  80         char tmp_log_buf[256];
  81
  82         va_start(args, fmt);
  83         vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
  84         fdebug_log(bat_priv->debug_log, "[%10u] %s",
  85                    jiffies_to_msecs(jiffies), tmp_log_buf);
  86         va_end(args);
  87
  88         return 0;
  89 }
  90
  91 static int log_open(struct inode *inode, struct file *file)
  92 {
  93         nonseekable_open(inode, file);
  94         file->private_data = inode->i_private;
  95         batadv_inc_module_count();
  96         return 0;
  97 }
  98
  99 static int log_release(struct inode *inode, struct file *file)
 100 {
 101         batadv_dec_module_count();
 102         return 0;
 103 }
 104
 105 static ssize_t log_read(struct file *file, char __user *buf,
 106                         size_t count, loff_t *ppos)
 107 {
 108         struct bat_priv *bat_priv = file->private_data;
 109         struct debug_log *debug_log = bat_priv->debug_log;
 110         int error, i = 0;
 111         char c;
 112
 113         if ((file->f_flags & O_NONBLOCK) &&
 114             !(debug_log->log_end - debug_log->log_start))
 115                 return -EAGAIN;
 116
 117         if (!buf)
 118                 return -EINVAL;
 119
 120         if (count == 0)
 121                 return 0;
 122
 123         if (!access_ok(VERIFY_WRITE, buf, count))
 124                 return -EFAULT;
 125
 126         error = wait_event_interruptible(debug_log->queue_wait,
 127                                 (debug_log->log_start - debug_log->log_end));
 128
 129         if (error)
 130                 return error;
 131
 132         spin_lock_bh(&debug_log->lock);
 133
 134         while ((!error) && (i < count) &&
 135                (debug_log->log_start != debug_log->log_end)) {
 136                 c = LOG_BUFF(debug_log->log_start);
 137
 138                 debug_log->log_start++;
 139
 140                 spin_unlock_bh(&debug_log->lock);
 141
 142                 error = __put_user(c, buf);
 143
 144                 spin_lock_bh(&debug_log->lock);
 145
 146                 buf++;
 147                 i++;
 148
 149         }
 150
 151         spin_unlock_bh(&debug_log->lock);
 152
 153         if (!error)
 154                 return i;
 155
 156         return error;
 157 }
 158
 159 static unsigned int log_poll(struct file *file, poll_table *wait)
 160 {
 161         struct bat_priv *bat_priv = file->private_data;
 162         struct debug_log *debug_log = bat_priv->debug_log;
 163
 164         poll_wait(file, &debug_log->queue_wait, wait);
 165
 166         if (debug_log->log_end - debug_log->log_start)
 167                 return POLLIN | POLLRDNORM;
 168
 169         return 0;
 170 }
 171
 172 static const struct file_operations log_fops = {
 173         .open           = log_open,
 174         .release        = log_release,
 175         .read           = log_read,
 176         .poll           = log_poll,
 177         .llseek         = no_llseek,
 178 };
 179
 180 static int debug_log_setup(struct bat_priv *bat_priv)
 181 {
 182         struct dentry *d;
 183
 184         if (!bat_priv->debug_dir)
 185                 goto err;
 186
 187         bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
 188         if (!bat_priv->debug_log)
 189                 goto err;
 190
 191         spin_lock_init(&bat_priv->debug_log->lock);
 192         init_waitqueue_head(&bat_priv->debug_log->queue_wait);
 193
 194         d = debugfs_create_file("log", S_IFREG | S_IRUSR,
 195                                 bat_priv->debug_dir, bat_priv, &log_fops);
 196         if (!d)
 197                 goto err;
 198
 199         return 0;
 200
 201 err:
 202         return -ENOMEM;
 203 }
 204
 205 static void debug_log_cleanup(struct bat_priv *bat_priv)
 206 {
 207         kfree(bat_priv->debug_log);
 208         bat_priv->debug_log = NULL;
 209 }
 210 #else /* CONFIG_BATMAN_ADV_DEBUG */
 211 static int debug_log_setup(struct bat_priv *bat_priv)
 212 {
 213         bat_priv->debug_log = NULL;
 214         return 0;
 215 }
 216
 217 static void debug_log_cleanup(struct bat_priv *bat_priv)
 218 {
 219         return;
 220 }
 221 #endif
 222
 223 static int bat_algorithms_open(struct inode *inode, struct file *file)
 224 {
 225         return single_open(file, batadv_algo_seq_print_text, NULL);
 226 }
 227
 228 static int originators_open(struct inode *inode, struct file *file)
 229 {
 230         struct net_device *net_dev = (struct net_device *)inode->i_private;
 231         return single_open(file, batadv_orig_seq_print_text, net_dev);
 232 }
 233
 234 static int gateways_open(struct inode *inode, struct file *file)
 235 {
 236         struct net_device *net_dev = (struct net_device *)inode->i_private;
 237         return single_open(file, batadv_gw_client_seq_print_text, net_dev);
 238 }
 239
 240 static int transtable_global_open(struct inode *inode, struct file *file)
 241 {
 242         struct net_device *net_dev = (struct net_device *)inode->i_private;
 243         return single_open(file, batadv_tt_global_seq_print_text, net_dev);
 244 }
 245
 246 #ifdef CONFIG_BATMAN_ADV_BLA
 247 static int bla_claim_table_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_bla_claim_table_seq_print_text,
 251                            net_dev);
 252 }
 253 #endif
 254
 255 static int transtable_local_open(struct inode *inode, struct file *file)
 256 {
 257         struct net_device *net_dev = (struct net_device *)inode->i_private;
 258         return single_open(file, batadv_tt_local_seq_print_text, net_dev);
 259 }
 260
 261 static int vis_data_open(struct inode *inode, struct file *file)
 262 {
 263         struct net_device *net_dev = (struct net_device *)inode->i_private;
 264         return single_open(file, batadv_vis_seq_print_text, net_dev);
 265 }
 266
 267 struct bat_debuginfo {
 268         struct attribute attr;
 269         const struct file_operations fops;
 270 };
 271
 272 #define BAT_DEBUGINFO(_name, _mode, _open)      \
 273 struct bat_debuginfo bat_debuginfo_##_name = {  \
 274         .attr = { .name = __stringify(_name),   \
 275                   .mode = _mode, },             \
 276         .fops = { .owner = THIS_MODULE,         \
 277                   .open = _open,                \
 278                   .read = seq_read,             \
 279                   .llseek = seq_lseek,          \
 280                   .release = single_release,    \
 281                 }                               \
 282 };
 283
 284 static BAT_DEBUGINFO(routing_algos, S_IRUGO, bat_algorithms_open);
 285 static BAT_DEBUGINFO(originators, S_IRUGO, originators_open);
 286 static BAT_DEBUGINFO(gateways, S_IRUGO, gateways_open);
 287 static BAT_DEBUGINFO(transtable_global, S_IRUGO, transtable_global_open);
 288 #ifdef CONFIG_BATMAN_ADV_BLA
 289 static BAT_DEBUGINFO(bla_claim_table, S_IRUGO, bla_claim_table_open);
 290 #endif
 291 static BAT_DEBUGINFO(transtable_local, S_IRUGO, transtable_local_open);
 292 static BAT_DEBUGINFO(vis_data, S_IRUGO, vis_data_open);
 293
 294 static struct bat_debuginfo *mesh_debuginfos[] = {
 295         &bat_debuginfo_originators,
 296         &bat_debuginfo_gateways,
 297         &bat_debuginfo_transtable_global,
 298 #ifdef CONFIG_BATMAN_ADV_BLA
 299         &bat_debuginfo_bla_claim_table,
 300 #endif
 301         &bat_debuginfo_transtable_local,
 302         &bat_debuginfo_vis_data,
 303         NULL,
 304 };
 305
 306 void batadv_debugfs_init(void)
 307 {
 308         struct bat_debuginfo *bat_debug;
 309         struct dentry *file;
 310
 311         bat_debugfs = debugfs_create_dir(DEBUGFS_BAT_SUBDIR, NULL);
 312         if (bat_debugfs == ERR_PTR(-ENODEV))
 313                 bat_debugfs = NULL;
 314
 315         if (!bat_debugfs)
 316                 goto out;
 317
 318         bat_debug = &bat_debuginfo_routing_algos;
 319         file = debugfs_create_file(bat_debug->attr.name,
 320                                    S_IFREG | bat_debug->attr.mode,
 321                                    bat_debugfs, NULL, &bat_debug->fops);
 322         if (!file)
 323                 pr_err("Can't add debugfs file: %s\n", bat_debug->attr.name);
 324
 325 out:
 326         return;
 327 }
 328
 329 void batadv_debugfs_destroy(void)
 330 {
 331         if (bat_debugfs) {
 332                 debugfs_remove_recursive(bat_debugfs);
 333                 bat_debugfs = NULL;
 334         }
 335 }
 336
 337 int batadv_debugfs_add_meshif(struct net_device *dev)
 338 {
 339         struct bat_priv *bat_priv = netdev_priv(dev);
 340         struct bat_debuginfo **bat_debug;
 341         struct dentry *file;
 342
 343         if (!bat_debugfs)
 344                 goto out;
 345
 346         bat_priv->debug_dir = debugfs_create_dir(dev->name, bat_debugfs);
 347         if (!bat_priv->debug_dir)
 348                 goto out;
 349
 350         if (batadv_socket_setup(bat_priv) < 0)
 351                 goto rem_attr;
 352
 353         if (debug_log_setup(bat_priv) < 0)
 354                 goto rem_attr;
 355
 356         for (bat_debug = mesh_debuginfos; *bat_debug; ++bat_debug) {
 357                 file = debugfs_create_file(((*bat_debug)->attr).name,
 358                                           S_IFREG | ((*bat_debug)->attr).mode,
 359                                           bat_priv->debug_dir,
 360                                           dev, &(*bat_debug)->fops);
 361                 if (!file) {
 362                         bat_err(dev, "Can't add debugfs file: %s/%s\n",
 363                                 dev->name, ((*bat_debug)->attr).name);
 364                         goto rem_attr;
 365                 }
 366         }
 367
 368         return 0;
 369 rem_attr:
 370         debugfs_remove_recursive(bat_priv->debug_dir);
 371         bat_priv->debug_dir = NULL;
 372 out:
 373 #ifdef CONFIG_DEBUG_FS
 374         return -ENOMEM;
 375 #else
 376         return 0;
 377 #endif /* CONFIG_DEBUG_FS */
 378 }
 379
 380 void batadv_debugfs_del_meshif(struct net_device *dev)
 381 {
 382         struct bat_priv *bat_priv = netdev_priv(dev);
 383
 384         debug_log_cleanup(bat_priv);
 385
 386         if (bat_debugfs) {
 387                 debugfs_remove_recursive(bat_priv->debug_dir);
 388                 bat_priv->debug_dir = NULL;
 389         }
 390 }