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/dcache.h>
22 #include <linux/debugfs.h>
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/export.h>
27 #include <linux/netdevice.h>
28 #include <linux/printk.h>
29 #include <linux/sched.h> /* for linux/wait.h */
30 #include <linux/seq_file.h>
31 #include <linux/stat.h>
32 #include <linux/stddef.h>
33 #include <linux/stringify.h>
34 #include <linux/sysfs.h>
35 #include <net/net_namespace.h>
38 #include "bridge_loop_avoidance.h"
39 #include "distributed-arp-table.h"
40 #include "gateway_client.h"
41 #include "icmp_socket.h"
43 #include "multicast.h"
44 #include "network-coding.h"
45 #include "originator.h"
46 #include "translation-table.h"
48 static struct dentry *batadv_debugfs;
50 static int batadv_algorithms_open(struct inode *inode, struct file *file)
52 return single_open(file, batadv_algo_seq_print_text, NULL);
55 static int neighbors_open(struct inode *inode, struct file *file)
57 struct net_device *net_dev = (struct net_device *)inode->i_private;
59 return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
62 static int batadv_originators_open(struct inode *inode, struct file *file)
64 struct net_device *net_dev = (struct net_device *)inode->i_private;
66 return single_open(file, batadv_orig_seq_print_text, net_dev);
70 * batadv_originators_hardif_open - handles debugfs output for the
71 * originator table of an hard interface
72 * @inode: inode pointer to debugfs file
73 * @file: pointer to the seq_file
75 * Return: 0 on success or negative error number in case of failure
77 static int batadv_originators_hardif_open(struct inode *inode,
80 struct net_device *net_dev = (struct net_device *)inode->i_private;
82 return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
85 static int batadv_gateways_open(struct inode *inode, struct file *file)
87 struct net_device *net_dev = (struct net_device *)inode->i_private;
89 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
92 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
94 struct net_device *net_dev = (struct net_device *)inode->i_private;
96 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
99 #ifdef CONFIG_BATMAN_ADV_BLA
100 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
102 struct net_device *net_dev = (struct net_device *)inode->i_private;
104 return single_open(file, batadv_bla_claim_table_seq_print_text,
108 static int batadv_bla_backbone_table_open(struct inode *inode,
111 struct net_device *net_dev = (struct net_device *)inode->i_private;
113 return single_open(file, batadv_bla_backbone_table_seq_print_text,
119 #ifdef CONFIG_BATMAN_ADV_DAT
121 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
122 * @inode: inode which was opened
123 * @file: file handle to be initialized
125 * Return: 0 on success or negative error number in case of failure
127 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
129 struct net_device *net_dev = (struct net_device *)inode->i_private;
131 return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
135 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
137 struct net_device *net_dev = (struct net_device *)inode->i_private;
139 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
142 struct batadv_debuginfo {
143 struct attribute attr;
144 const struct file_operations fops;
147 #ifdef CONFIG_BATMAN_ADV_NC
148 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
150 struct net_device *net_dev = (struct net_device *)inode->i_private;
152 return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
156 #ifdef CONFIG_BATMAN_ADV_MCAST
158 * batadv_mcast_flags_open - prepare file handler for reads from mcast_flags
159 * @inode: inode which was opened
160 * @file: file handle to be initialized
162 * Return: 0 on success or negative error number in case of failure
164 static int batadv_mcast_flags_open(struct inode *inode, struct file *file)
166 struct net_device *net_dev = (struct net_device *)inode->i_private;
168 return single_open(file, batadv_mcast_flags_seq_print_text, net_dev);
172 #define BATADV_DEBUGINFO(_name, _mode, _open) \
173 struct batadv_debuginfo batadv_debuginfo_##_name = { \
175 .name = __stringify(_name), \
179 .owner = THIS_MODULE, \
182 .llseek = seq_lseek, \
183 .release = single_release, \
187 /* the following attributes are general and therefore they will be directly
188 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
190 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
192 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
193 &batadv_debuginfo_routing_algos,
197 /* The following attributes are per soft interface */
198 static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
199 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
200 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
201 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
202 batadv_transtable_global_open);
203 #ifdef CONFIG_BATMAN_ADV_BLA
204 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
205 static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
206 batadv_bla_backbone_table_open);
208 #ifdef CONFIG_BATMAN_ADV_DAT
209 static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
211 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
212 batadv_transtable_local_open);
213 #ifdef CONFIG_BATMAN_ADV_NC
214 static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
216 #ifdef CONFIG_BATMAN_ADV_MCAST
217 static BATADV_DEBUGINFO(mcast_flags, S_IRUGO, batadv_mcast_flags_open);
220 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
221 &batadv_debuginfo_neighbors,
222 &batadv_debuginfo_originators,
223 &batadv_debuginfo_gateways,
224 &batadv_debuginfo_transtable_global,
225 #ifdef CONFIG_BATMAN_ADV_BLA
226 &batadv_debuginfo_bla_claim_table,
227 &batadv_debuginfo_bla_backbone_table,
229 #ifdef CONFIG_BATMAN_ADV_DAT
230 &batadv_debuginfo_dat_cache,
232 &batadv_debuginfo_transtable_local,
233 #ifdef CONFIG_BATMAN_ADV_NC
234 &batadv_debuginfo_nc_nodes,
236 #ifdef CONFIG_BATMAN_ADV_MCAST
237 &batadv_debuginfo_mcast_flags,
242 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
243 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
245 .name = __stringify(_name), \
249 .owner = THIS_MODULE, \
252 .llseek = seq_lseek, \
253 .release = single_release, \
257 static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
258 batadv_originators_hardif_open);
260 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
261 &batadv_hardif_debuginfo_originators,
265 void batadv_debugfs_init(void)
267 struct batadv_debuginfo **bat_debug;
270 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
271 if (batadv_debugfs == ERR_PTR(-ENODEV))
272 batadv_debugfs = NULL;
277 for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
278 file = debugfs_create_file(((*bat_debug)->attr).name,
279 S_IFREG | ((*bat_debug)->attr).mode,
280 batadv_debugfs, NULL,
281 &(*bat_debug)->fops);
283 pr_err("Can't add general debugfs file: %s\n",
284 ((*bat_debug)->attr).name);
291 debugfs_remove_recursive(batadv_debugfs);
292 batadv_debugfs = NULL;
295 void batadv_debugfs_destroy(void)
297 debugfs_remove_recursive(batadv_debugfs);
298 batadv_debugfs = NULL;
302 * batadv_debugfs_add_hardif - creates the base directory for a hard interface
304 * @hard_iface: hard interface which should be added.
306 * Return: 0 on success or negative error number in case of failure
308 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
310 struct net *net = dev_net(hard_iface->net_dev);
311 struct batadv_debuginfo **bat_debug;
317 if (net != &init_net)
320 hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
322 if (!hard_iface->debug_dir)
325 for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
326 file = debugfs_create_file(((*bat_debug)->attr).name,
327 S_IFREG | ((*bat_debug)->attr).mode,
328 hard_iface->debug_dir,
330 &(*bat_debug)->fops);
337 debugfs_remove_recursive(hard_iface->debug_dir);
338 hard_iface->debug_dir = NULL;
344 * batadv_debugfs_rename_hardif() - Fix debugfs path for renamed hardif
345 * @hard_iface: hard interface which was renamed
347 void batadv_debugfs_rename_hardif(struct batadv_hard_iface *hard_iface)
349 const char *name = hard_iface->net_dev->name;
353 dir = hard_iface->debug_dir;
357 d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
359 pr_err("Can't rename debugfs dir to %s\n", name);
363 * batadv_debugfs_del_hardif - delete the base directory for a hard interface
365 * @hard_iface: hard interface which is deleted.
367 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
369 struct net *net = dev_net(hard_iface->net_dev);
371 if (net != &init_net)
374 if (batadv_debugfs) {
375 debugfs_remove_recursive(hard_iface->debug_dir);
376 hard_iface->debug_dir = NULL;
380 int batadv_debugfs_add_meshif(struct net_device *dev)
382 struct batadv_priv *bat_priv = netdev_priv(dev);
383 struct batadv_debuginfo **bat_debug;
384 struct net *net = dev_net(dev);
390 if (net != &init_net)
393 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
394 if (!bat_priv->debug_dir)
397 if (batadv_socket_setup(bat_priv) < 0)
400 if (batadv_debug_log_setup(bat_priv) < 0)
403 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
404 file = debugfs_create_file(((*bat_debug)->attr).name,
405 S_IFREG | ((*bat_debug)->attr).mode,
407 dev, &(*bat_debug)->fops);
409 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
410 dev->name, ((*bat_debug)->attr).name);
415 if (batadv_nc_init_debugfs(bat_priv) < 0)
420 debugfs_remove_recursive(bat_priv->debug_dir);
421 bat_priv->debug_dir = NULL;
427 * batadv_debugfs_rename_meshif() - Fix debugfs path for renamed softif
428 * @dev: net_device which was renamed
430 void batadv_debugfs_rename_meshif(struct net_device *dev)
432 struct batadv_priv *bat_priv = netdev_priv(dev);
433 const char *name = dev->name;
437 dir = bat_priv->debug_dir;
441 d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
443 pr_err("Can't rename debugfs dir to %s\n", name);
446 void batadv_debugfs_del_meshif(struct net_device *dev)
448 struct batadv_priv *bat_priv = netdev_priv(dev);
449 struct net *net = dev_net(dev);
451 if (net != &init_net)
454 batadv_debug_log_cleanup(bat_priv);
456 if (batadv_debugfs) {
457 debugfs_remove_recursive(bat_priv->debug_dir);
458 bat_priv->debug_dir = NULL;