1 /* Copyright (C) 2010-2012 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, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 #include <linux/debugfs.h>
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"
32 #include "icmp_socket.h"
33 #include "bridge_loop_avoidance.h"
35 static struct dentry *batadv_debugfs;
37 #ifdef CONFIG_BATMAN_ADV_DEBUG
38 #define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
40 static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
42 static char *batadv_log_char_addr(struct batadv_debug_log *debug_log,
45 return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
48 static void batadv_emit_log_char(struct batadv_debug_log *debug_log, char c)
52 char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
56 if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
57 debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
61 static int batadv_fdebug_log(struct batadv_debug_log *debug_log,
65 static char debug_log_buf[256];
71 spin_lock_bh(&debug_log->lock);
73 vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
76 for (p = debug_log_buf; *p != 0; p++)
77 batadv_emit_log_char(debug_log, *p);
79 spin_unlock_bh(&debug_log->lock);
81 wake_up(&debug_log->queue_wait);
86 int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
89 char tmp_log_buf[256];
92 vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
93 batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
94 jiffies_to_msecs(jiffies), tmp_log_buf);
100 static int batadv_log_open(struct inode *inode, struct file *file)
102 nonseekable_open(inode, file);
103 file->private_data = inode->i_private;
104 batadv_inc_module_count();
108 static int batadv_log_release(struct inode *inode, struct file *file)
110 batadv_dec_module_count();
114 static ssize_t batadv_log_read(struct file *file, char __user *buf,
115 size_t count, loff_t *ppos)
117 struct batadv_priv *bat_priv = file->private_data;
118 struct batadv_debug_log *debug_log = bat_priv->debug_log;
123 if ((file->f_flags & O_NONBLOCK) &&
124 !(debug_log->log_end - debug_log->log_start))
133 if (!access_ok(VERIFY_WRITE, buf, count))
136 error = wait_event_interruptible(debug_log->queue_wait,
137 (debug_log->log_start - debug_log->log_end));
142 spin_lock_bh(&debug_log->lock);
144 while ((!error) && (i < count) &&
145 (debug_log->log_start != debug_log->log_end)) {
146 char_addr = batadv_log_char_addr(debug_log,
147 debug_log->log_start);
150 debug_log->log_start++;
152 spin_unlock_bh(&debug_log->lock);
154 error = __put_user(c, buf);
156 spin_lock_bh(&debug_log->lock);
163 spin_unlock_bh(&debug_log->lock);
171 static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
173 struct batadv_priv *bat_priv = file->private_data;
174 struct batadv_debug_log *debug_log = bat_priv->debug_log;
176 poll_wait(file, &debug_log->queue_wait, wait);
178 if (debug_log->log_end - debug_log->log_start)
179 return POLLIN | POLLRDNORM;
184 static const struct file_operations batadv_log_fops = {
185 .open = batadv_log_open,
186 .release = batadv_log_release,
187 .read = batadv_log_read,
188 .poll = batadv_log_poll,
192 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
196 if (!bat_priv->debug_dir)
199 bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
200 if (!bat_priv->debug_log)
203 spin_lock_init(&bat_priv->debug_log->lock);
204 init_waitqueue_head(&bat_priv->debug_log->queue_wait);
206 d = debugfs_create_file("log", S_IFREG | S_IRUSR,
207 bat_priv->debug_dir, bat_priv,
218 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
220 kfree(bat_priv->debug_log);
221 bat_priv->debug_log = NULL;
223 #else /* CONFIG_BATMAN_ADV_DEBUG */
224 static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
226 bat_priv->debug_log = NULL;
230 static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
236 static int batadv_algorithms_open(struct inode *inode, struct file *file)
238 return single_open(file, batadv_algo_seq_print_text, NULL);
241 static int batadv_originators_open(struct inode *inode, struct file *file)
243 struct net_device *net_dev = (struct net_device *)inode->i_private;
244 return single_open(file, batadv_orig_seq_print_text, net_dev);
247 static int batadv_gateways_open(struct inode *inode, struct file *file)
249 struct net_device *net_dev = (struct net_device *)inode->i_private;
250 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
253 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
255 struct net_device *net_dev = (struct net_device *)inode->i_private;
256 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
259 #ifdef CONFIG_BATMAN_ADV_BLA
260 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
262 struct net_device *net_dev = (struct net_device *)inode->i_private;
263 return single_open(file, batadv_bla_claim_table_seq_print_text,
268 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
270 struct net_device *net_dev = (struct net_device *)inode->i_private;
271 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
274 static int batadv_vis_data_open(struct inode *inode, struct file *file)
276 struct net_device *net_dev = (struct net_device *)inode->i_private;
277 return single_open(file, batadv_vis_seq_print_text, net_dev);
280 struct batadv_debuginfo {
281 struct attribute attr;
282 const struct file_operations fops;
285 #define BATADV_DEBUGINFO(_name, _mode, _open) \
286 struct batadv_debuginfo batadv_debuginfo_##_name = { \
287 .attr = { .name = __stringify(_name), \
289 .fops = { .owner = THIS_MODULE, \
292 .llseek = seq_lseek, \
293 .release = single_release, \
297 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
298 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
299 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
300 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
301 batadv_transtable_global_open);
302 #ifdef CONFIG_BATMAN_ADV_BLA
303 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
305 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
306 batadv_transtable_local_open);
307 static BATADV_DEBUGINFO(vis_data, S_IRUGO, batadv_vis_data_open);
309 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
310 &batadv_debuginfo_originators,
311 &batadv_debuginfo_gateways,
312 &batadv_debuginfo_transtable_global,
313 #ifdef CONFIG_BATMAN_ADV_BLA
314 &batadv_debuginfo_bla_claim_table,
316 &batadv_debuginfo_transtable_local,
317 &batadv_debuginfo_vis_data,
321 void batadv_debugfs_init(void)
323 struct batadv_debuginfo *bat_debug;
326 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
327 if (batadv_debugfs == ERR_PTR(-ENODEV))
328 batadv_debugfs = NULL;
333 bat_debug = &batadv_debuginfo_routing_algos;
334 file = debugfs_create_file(bat_debug->attr.name,
335 S_IFREG | bat_debug->attr.mode,
336 batadv_debugfs, NULL, &bat_debug->fops);
338 pr_err("Can't add debugfs file: %s\n", bat_debug->attr.name);
344 void batadv_debugfs_destroy(void)
346 if (batadv_debugfs) {
347 debugfs_remove_recursive(batadv_debugfs);
348 batadv_debugfs = NULL;
352 int batadv_debugfs_add_meshif(struct net_device *dev)
354 struct batadv_priv *bat_priv = netdev_priv(dev);
355 struct batadv_debuginfo **bat_debug;
361 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
362 if (!bat_priv->debug_dir)
365 if (batadv_socket_setup(bat_priv) < 0)
368 if (batadv_debug_log_setup(bat_priv) < 0)
371 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
372 file = debugfs_create_file(((*bat_debug)->attr).name,
373 S_IFREG | ((*bat_debug)->attr).mode,
375 dev, &(*bat_debug)->fops);
377 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
378 dev->name, ((*bat_debug)->attr).name);
385 debugfs_remove_recursive(bat_priv->debug_dir);
386 bat_priv->debug_dir = NULL;
388 #ifdef CONFIG_DEBUG_FS
392 #endif /* CONFIG_DEBUG_FS */
395 void batadv_debugfs_del_meshif(struct net_device *dev)
397 struct batadv_priv *bat_priv = netdev_priv(dev);
399 batadv_debug_log_cleanup(bat_priv);
401 if (batadv_debugfs) {
402 debugfs_remove_recursive(bat_priv->debug_dir);
403 bat_priv->debug_dir = NULL;