2 * Copyright (C) 2010-2012 B.A.T.M.A.N. contributors:
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.
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.
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
24 #include <linux/debugfs.h>
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"
34 #include "icmp_socket.h"
35 #include "bridge_loop_avoidance.h"
37 static struct dentry *bat_debugfs;
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])
43 static int log_buff_len = LOG_BUF_LEN;
45 static void emit_log_char(struct debug_log *debug_log, char c)
47 LOG_BUFF(debug_log->log_end) = c;
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;
55 static int fdebug_log(struct debug_log *debug_log, const char *fmt, ...)
58 static char debug_log_buf[256];
64 spin_lock_bh(&debug_log->lock);
66 vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
69 for (p = debug_log_buf; *p != 0; p++)
70 emit_log_char(debug_log, *p);
72 spin_unlock_bh(&debug_log->lock);
74 wake_up(&debug_log->queue_wait);
79 int debug_log(struct bat_priv *bat_priv, const char *fmt, ...)
82 char tmp_log_buf[256];
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);
93 static int log_open(struct inode *inode, struct file *file)
95 nonseekable_open(inode, file);
96 file->private_data = inode->i_private;
101 static int log_release(struct inode *inode, struct file *file)
107 static ssize_t log_read(struct file *file, char __user *buf,
108 size_t count, loff_t *ppos)
110 struct bat_priv *bat_priv = file->private_data;
111 struct debug_log *debug_log = bat_priv->debug_log;
115 if ((file->f_flags & O_NONBLOCK) &&
116 !(debug_log->log_end - debug_log->log_start))
125 if (!access_ok(VERIFY_WRITE, buf, count))
128 error = wait_event_interruptible(debug_log->queue_wait,
129 (debug_log->log_start - debug_log->log_end));
134 spin_lock_bh(&debug_log->lock);
136 while ((!error) && (i < count) &&
137 (debug_log->log_start != debug_log->log_end)) {
138 c = LOG_BUFF(debug_log->log_start);
140 debug_log->log_start++;
142 spin_unlock_bh(&debug_log->lock);
144 error = __put_user(c, buf);
146 spin_lock_bh(&debug_log->lock);
153 spin_unlock_bh(&debug_log->lock);
161 static unsigned int log_poll(struct file *file, poll_table *wait)
163 struct bat_priv *bat_priv = file->private_data;
164 struct debug_log *debug_log = bat_priv->debug_log;
166 poll_wait(file, &debug_log->queue_wait, wait);
168 if (debug_log->log_end - debug_log->log_start)
169 return POLLIN | POLLRDNORM;
174 static const struct file_operations log_fops = {
176 .release = log_release,
182 static int debug_log_setup(struct bat_priv *bat_priv)
186 if (!bat_priv->debug_dir)
189 bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
190 if (!bat_priv->debug_log)
193 spin_lock_init(&bat_priv->debug_log->lock);
194 init_waitqueue_head(&bat_priv->debug_log->queue_wait);
196 d = debugfs_create_file("log", S_IFREG | S_IRUSR,
197 bat_priv->debug_dir, bat_priv, &log_fops);
207 static void debug_log_cleanup(struct bat_priv *bat_priv)
209 kfree(bat_priv->debug_log);
210 bat_priv->debug_log = NULL;
212 #else /* CONFIG_BATMAN_ADV_DEBUG */
213 static int debug_log_setup(struct bat_priv *bat_priv)
215 bat_priv->debug_log = NULL;
219 static void debug_log_cleanup(struct bat_priv *bat_priv)
225 static int bat_algorithms_open(struct inode *inode, struct file *file)
227 return single_open(file, bat_algo_seq_print_text, NULL);
230 static int originators_open(struct inode *inode, struct file *file)
232 struct net_device *net_dev = (struct net_device *)inode->i_private;
233 return single_open(file, orig_seq_print_text, net_dev);
236 static int gateways_open(struct inode *inode, struct file *file)
238 struct net_device *net_dev = (struct net_device *)inode->i_private;
239 return single_open(file, gw_client_seq_print_text, net_dev);
242 static int transtable_global_open(struct inode *inode, struct file *file)
244 struct net_device *net_dev = (struct net_device *)inode->i_private;
245 return single_open(file, tt_global_seq_print_text, net_dev);
248 #ifdef CONFIG_BATMAN_ADV_BLA
249 static int bla_claim_table_open(struct inode *inode, struct file *file)
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);
256 static int transtable_local_open(struct inode *inode, struct file *file)
258 struct net_device *net_dev = (struct net_device *)inode->i_private;
259 return single_open(file, tt_local_seq_print_text, net_dev);
262 static int vis_data_open(struct inode *inode, struct file *file)
264 struct net_device *net_dev = (struct net_device *)inode->i_private;
265 return single_open(file, vis_seq_print_text, net_dev);
268 struct bat_debuginfo {
269 struct attribute attr;
270 const struct file_operations fops;
273 #define BAT_DEBUGINFO(_name, _mode, _open) \
274 struct bat_debuginfo bat_debuginfo_##_name = { \
275 .attr = { .name = __stringify(_name), \
277 .fops = { .owner = THIS_MODULE, \
280 .llseek = seq_lseek, \
281 .release = single_release, \
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);
292 static BAT_DEBUGINFO(transtable_local, S_IRUGO, transtable_local_open);
293 static BAT_DEBUGINFO(vis_data, S_IRUGO, vis_data_open);
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,
302 &bat_debuginfo_transtable_local,
303 &bat_debuginfo_vis_data,
307 void debugfs_init(void)
309 struct bat_debuginfo *bat_debug;
312 bat_debugfs = debugfs_create_dir(DEBUGFS_BAT_SUBDIR, NULL);
313 if (bat_debugfs == ERR_PTR(-ENODEV))
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);
324 pr_err("Can't add debugfs file: %s\n", bat_debug->attr.name);
330 void debugfs_destroy(void)
333 debugfs_remove_recursive(bat_debugfs);
338 int debugfs_add_meshif(struct net_device *dev)
340 struct bat_priv *bat_priv = netdev_priv(dev);
341 struct bat_debuginfo **bat_debug;
347 bat_priv->debug_dir = debugfs_create_dir(dev->name, bat_debugfs);
348 if (!bat_priv->debug_dir)
351 bat_socket_setup(bat_priv);
352 debug_log_setup(bat_priv);
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,
358 dev, &(*bat_debug)->fops);
360 bat_err(dev, "Can't add debugfs file: %s/%s\n",
361 dev->name, ((*bat_debug)->attr).name);
368 debugfs_remove_recursive(bat_priv->debug_dir);
369 bat_priv->debug_dir = NULL;
371 #ifdef CONFIG_DEBUG_FS
375 #endif /* CONFIG_DEBUG_FS */
378 void debugfs_del_meshif(struct net_device *dev)
380 struct bat_priv *bat_priv = netdev_priv(dev);
382 debug_log_cleanup(bat_priv);
385 debugfs_remove_recursive(bat_priv->debug_dir);
386 bat_priv->debug_dir = NULL;