1 /* Copyright (C) 2010-2016 B.A.T.M.A.N. contributors:
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.
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.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <linux/compiler.h>
22 #include <linux/debugfs.h>
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/export.h>
26 #include <linux/fcntl.h>
28 #include <linux/jiffies.h>
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/netdevice.h>
32 #include <linux/poll.h>
33 #include <linux/printk.h>
34 #include <linux/sched.h> /* for linux/wait.h */
35 #include <linux/seq_file.h>
36 #include <linux/slab.h>
37 #include <linux/spinlock.h>
38 #include <linux/stat.h>
39 #include <linux/stddef.h>
40 #include <linux/stringify.h>
41 #include <linux/sysfs.h>
42 #include <linux/types.h>
43 #include <linux/uaccess.h>
44 #include <linux/wait.h>
47 #include "bridge_loop_avoidance.h"
48 #include "distributed-arp-table.h"
49 #include "gateway_client.h"
50 #include "icmp_socket.h"
51 #include "network-coding.h"
52 #include "originator.h"
53 #include "translation-table.h"
55 static struct dentry *batadv_debugfs;
57 #ifdef CONFIG_BATMAN_ADV_DEBUG
58 #define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
60 static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
62 static char *batadv_log_char_addr(struct batadv_priv_debug_log *debug_log,
65 return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
68 static void batadv_emit_log_char(struct batadv_priv_debug_log *debug_log,
73 char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
77 if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
78 debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
82 static int batadv_fdebug_log(struct batadv_priv_debug_log *debug_log,
86 static char debug_log_buf[256];
92 spin_lock_bh(&debug_log->lock);
94 vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
97 for (p = debug_log_buf; *p != 0; p++)
98 batadv_emit_log_char(debug_log, *p);
100 spin_unlock_bh(&debug_log->lock);
102 wake_up(&debug_log->queue_wait);
107 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
110 char tmp_log_buf[256];
113 vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
114 batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
115 jiffies_to_msecs(jiffies), tmp_log_buf);
121 static int batadv_log_open(struct inode *inode, struct file *file)
123 if (!try_module_get(THIS_MODULE))
126 nonseekable_open(inode, file);
127 file->private_data = inode->i_private;
131 static int batadv_log_release(struct inode *inode, struct file *file)
133 module_put(THIS_MODULE);
137 static bool batadv_log_empty(struct batadv_priv_debug_log *debug_log)
139 return !(debug_log->log_start - debug_log->log_end);
142 static ssize_t batadv_log_read(struct file *file, char __user *buf,
143 size_t count, loff_t *ppos)
145 struct batadv_priv *bat_priv = file->private_data;
146 struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
151 if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
160 if (!access_ok(VERIFY_WRITE, buf, count))
163 error = wait_event_interruptible(debug_log->queue_wait,
164 (!batadv_log_empty(debug_log)));
169 spin_lock_bh(&debug_log->lock);
171 while ((!error) && (i < count) &&
172 (debug_log->log_start != debug_log->log_end)) {
173 char_addr = batadv_log_char_addr(debug_log,
174 debug_log->log_start);
177 debug_log->log_start++;
179 spin_unlock_bh(&debug_log->lock);
181 error = __put_user(c, buf);
183 spin_lock_bh(&debug_log->lock);
189 spin_unlock_bh(&debug_log->lock);
197 static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
199 struct batadv_priv *bat_priv = file->private_data;
200 struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
202 poll_wait(file, &debug_log->queue_wait, wait);
204 if (!batadv_log_empty(debug_log))
205 return POLLIN | POLLRDNORM;
210 static const struct file_operations batadv_log_fops = {
211 .open = batadv_log_open,
212 .release = batadv_log_release,
213 .read = batadv_log_read,
214 .poll = batadv_log_poll,
218 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
222 if (!bat_priv->debug_dir)
225 bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
226 if (!bat_priv->debug_log)
229 spin_lock_init(&bat_priv->debug_log->lock);
230 init_waitqueue_head(&bat_priv->debug_log->queue_wait);
232 d = debugfs_create_file("log", S_IFREG | S_IRUSR,
233 bat_priv->debug_dir, bat_priv,
244 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
246 kfree(bat_priv->debug_log);
247 bat_priv->debug_log = NULL;
249 #else /* CONFIG_BATMAN_ADV_DEBUG */
250 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
255 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
260 static int batadv_algorithms_open(struct inode *inode, struct file *file)
262 return single_open(file, batadv_algo_seq_print_text, NULL);
265 static int neighbors_open(struct inode *inode, struct file *file)
267 struct net_device *net_dev = (struct net_device *)inode->i_private;
269 return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
272 static int batadv_originators_open(struct inode *inode, struct file *file)
274 struct net_device *net_dev = (struct net_device *)inode->i_private;
276 return single_open(file, batadv_orig_seq_print_text, net_dev);
280 * batadv_originators_hardif_open - handles debugfs output for the
281 * originator table of an hard interface
282 * @inode: inode pointer to debugfs file
283 * @file: pointer to the seq_file
285 * Return: 0 on success or negative error number in case of failure
287 static int batadv_originators_hardif_open(struct inode *inode,
290 struct net_device *net_dev = (struct net_device *)inode->i_private;
292 return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
295 static int batadv_gateways_open(struct inode *inode, struct file *file)
297 struct net_device *net_dev = (struct net_device *)inode->i_private;
299 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
302 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
304 struct net_device *net_dev = (struct net_device *)inode->i_private;
306 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
309 #ifdef CONFIG_BATMAN_ADV_BLA
310 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
312 struct net_device *net_dev = (struct net_device *)inode->i_private;
314 return single_open(file, batadv_bla_claim_table_seq_print_text,
318 static int batadv_bla_backbone_table_open(struct inode *inode,
321 struct net_device *net_dev = (struct net_device *)inode->i_private;
323 return single_open(file, batadv_bla_backbone_table_seq_print_text,
329 #ifdef CONFIG_BATMAN_ADV_DAT
331 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
332 * @inode: inode which was opened
333 * @file: file handle to be initialized
335 * Return: 0 on success or negative error number in case of failure
337 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
339 struct net_device *net_dev = (struct net_device *)inode->i_private;
341 return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
345 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
347 struct net_device *net_dev = (struct net_device *)inode->i_private;
349 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
352 struct batadv_debuginfo {
353 struct attribute attr;
354 const struct file_operations fops;
357 #ifdef CONFIG_BATMAN_ADV_NC
358 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
360 struct net_device *net_dev = (struct net_device *)inode->i_private;
362 return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
366 #define BATADV_DEBUGINFO(_name, _mode, _open) \
367 struct batadv_debuginfo batadv_debuginfo_##_name = { \
369 .name = __stringify(_name), \
373 .owner = THIS_MODULE, \
376 .llseek = seq_lseek, \
377 .release = single_release, \
381 /* the following attributes are general and therefore they will be directly
382 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
384 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
386 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
387 &batadv_debuginfo_routing_algos,
391 /* The following attributes are per soft interface */
392 static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
393 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
394 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
395 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
396 batadv_transtable_global_open);
397 #ifdef CONFIG_BATMAN_ADV_BLA
398 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
399 static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
400 batadv_bla_backbone_table_open);
402 #ifdef CONFIG_BATMAN_ADV_DAT
403 static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
405 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
406 batadv_transtable_local_open);
407 #ifdef CONFIG_BATMAN_ADV_NC
408 static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
411 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
412 &batadv_debuginfo_neighbors,
413 &batadv_debuginfo_originators,
414 &batadv_debuginfo_gateways,
415 &batadv_debuginfo_transtable_global,
416 #ifdef CONFIG_BATMAN_ADV_BLA
417 &batadv_debuginfo_bla_claim_table,
418 &batadv_debuginfo_bla_backbone_table,
420 #ifdef CONFIG_BATMAN_ADV_DAT
421 &batadv_debuginfo_dat_cache,
423 &batadv_debuginfo_transtable_local,
424 #ifdef CONFIG_BATMAN_ADV_NC
425 &batadv_debuginfo_nc_nodes,
430 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
431 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
433 .name = __stringify(_name), \
437 .owner = THIS_MODULE, \
440 .llseek = seq_lseek, \
441 .release = single_release, \
445 static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
446 batadv_originators_hardif_open);
448 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
449 &batadv_hardif_debuginfo_originators,
453 void batadv_debugfs_init(void)
455 struct batadv_debuginfo **bat_debug;
458 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
459 if (batadv_debugfs == ERR_PTR(-ENODEV))
460 batadv_debugfs = NULL;
465 for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
466 file = debugfs_create_file(((*bat_debug)->attr).name,
467 S_IFREG | ((*bat_debug)->attr).mode,
468 batadv_debugfs, NULL,
469 &(*bat_debug)->fops);
471 pr_err("Can't add general debugfs file: %s\n",
472 ((*bat_debug)->attr).name);
479 debugfs_remove_recursive(batadv_debugfs);
480 batadv_debugfs = NULL;
483 void batadv_debugfs_destroy(void)
485 debugfs_remove_recursive(batadv_debugfs);
486 batadv_debugfs = NULL;
490 * batadv_debugfs_add_hardif - creates the base directory for a hard interface
492 * @hard_iface: hard interface which should be added.
494 * Return: 0 on success or negative error number in case of failure
496 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
498 struct batadv_debuginfo **bat_debug;
504 hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
506 if (!hard_iface->debug_dir)
509 for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
510 file = debugfs_create_file(((*bat_debug)->attr).name,
511 S_IFREG | ((*bat_debug)->attr).mode,
512 hard_iface->debug_dir,
514 &(*bat_debug)->fops);
521 debugfs_remove_recursive(hard_iface->debug_dir);
522 hard_iface->debug_dir = NULL;
528 * batadv_debugfs_del_hardif - delete the base directory for a hard interface
530 * @hard_iface: hard interface which is deleted.
532 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
534 if (batadv_debugfs) {
535 debugfs_remove_recursive(hard_iface->debug_dir);
536 hard_iface->debug_dir = NULL;
540 int batadv_debugfs_add_meshif(struct net_device *dev)
542 struct batadv_priv *bat_priv = netdev_priv(dev);
543 struct batadv_debuginfo **bat_debug;
549 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
550 if (!bat_priv->debug_dir)
553 if (batadv_socket_setup(bat_priv) < 0)
556 if (batadv_debug_log_setup(bat_priv) < 0)
559 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
560 file = debugfs_create_file(((*bat_debug)->attr).name,
561 S_IFREG | ((*bat_debug)->attr).mode,
563 dev, &(*bat_debug)->fops);
565 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
566 dev->name, ((*bat_debug)->attr).name);
571 if (batadv_nc_init_debugfs(bat_priv) < 0)
576 debugfs_remove_recursive(bat_priv->debug_dir);
577 bat_priv->debug_dir = NULL;
582 void batadv_debugfs_del_meshif(struct net_device *dev)
584 struct batadv_priv *bat_priv = netdev_priv(dev);
586 batadv_debug_log_cleanup(bat_priv);
588 if (batadv_debugfs) {
589 debugfs_remove_recursive(bat_priv->debug_dir);
590 bat_priv->debug_dir = NULL;