1 /* Copyright (C) 2010-2017 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/debugfs.h>
22 #include <linux/err.h>
23 #include <linux/errno.h>
24 #include <linux/export.h>
26 #include <linux/netdevice.h>
27 #include <linux/printk.h>
28 #include <linux/sched.h> /* for linux/wait.h */
29 #include <linux/seq_file.h>
30 #include <linux/stat.h>
31 #include <linux/stddef.h>
32 #include <linux/stringify.h>
33 #include <linux/sysfs.h>
34 #include <net/net_namespace.h>
37 #include "bridge_loop_avoidance.h"
38 #include "distributed-arp-table.h"
39 #include "gateway_client.h"
40 #include "icmp_socket.h"
42 #include "multicast.h"
43 #include "network-coding.h"
44 #include "originator.h"
45 #include "translation-table.h"
47 static struct dentry *batadv_debugfs;
49 static int batadv_algorithms_open(struct inode *inode, struct file *file)
51 return single_open(file, batadv_algo_seq_print_text, NULL);
54 static int neighbors_open(struct inode *inode, struct file *file)
56 struct net_device *net_dev = (struct net_device *)inode->i_private;
58 return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
61 static int batadv_originators_open(struct inode *inode, struct file *file)
63 struct net_device *net_dev = (struct net_device *)inode->i_private;
65 return single_open(file, batadv_orig_seq_print_text, net_dev);
69 * batadv_originators_hardif_open - handles debugfs output for the
70 * originator table of an hard interface
71 * @inode: inode pointer to debugfs file
72 * @file: pointer to the seq_file
74 * Return: 0 on success or negative error number in case of failure
76 static int batadv_originators_hardif_open(struct inode *inode,
79 struct net_device *net_dev = (struct net_device *)inode->i_private;
81 return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
84 static int batadv_gateways_open(struct inode *inode, struct file *file)
86 struct net_device *net_dev = (struct net_device *)inode->i_private;
88 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
91 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
93 struct net_device *net_dev = (struct net_device *)inode->i_private;
95 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
98 #ifdef CONFIG_BATMAN_ADV_BLA
99 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
101 struct net_device *net_dev = (struct net_device *)inode->i_private;
103 return single_open(file, batadv_bla_claim_table_seq_print_text,
107 static int batadv_bla_backbone_table_open(struct inode *inode,
110 struct net_device *net_dev = (struct net_device *)inode->i_private;
112 return single_open(file, batadv_bla_backbone_table_seq_print_text,
118 #ifdef CONFIG_BATMAN_ADV_DAT
120 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
121 * @inode: inode which was opened
122 * @file: file handle to be initialized
124 * Return: 0 on success or negative error number in case of failure
126 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
128 struct net_device *net_dev = (struct net_device *)inode->i_private;
130 return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
134 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
136 struct net_device *net_dev = (struct net_device *)inode->i_private;
138 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
141 struct batadv_debuginfo {
142 struct attribute attr;
143 const struct file_operations fops;
146 #ifdef CONFIG_BATMAN_ADV_NC
147 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
149 struct net_device *net_dev = (struct net_device *)inode->i_private;
151 return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
155 #ifdef CONFIG_BATMAN_ADV_MCAST
157 * batadv_mcast_flags_open - prepare file handler for reads from mcast_flags
158 * @inode: inode which was opened
159 * @file: file handle to be initialized
161 * Return: 0 on success or negative error number in case of failure
163 static int batadv_mcast_flags_open(struct inode *inode, struct file *file)
165 struct net_device *net_dev = (struct net_device *)inode->i_private;
167 return single_open(file, batadv_mcast_flags_seq_print_text, net_dev);
171 #define BATADV_DEBUGINFO(_name, _mode, _open) \
172 struct batadv_debuginfo batadv_debuginfo_##_name = { \
174 .name = __stringify(_name), \
178 .owner = THIS_MODULE, \
181 .llseek = seq_lseek, \
182 .release = single_release, \
186 /* the following attributes are general and therefore they will be directly
187 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
189 static BATADV_DEBUGINFO(routing_algos, 0444, batadv_algorithms_open);
191 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
192 &batadv_debuginfo_routing_algos,
196 /* The following attributes are per soft interface */
197 static BATADV_DEBUGINFO(neighbors, 0444, neighbors_open);
198 static BATADV_DEBUGINFO(originators, 0444, batadv_originators_open);
199 static BATADV_DEBUGINFO(gateways, 0444, batadv_gateways_open);
200 static BATADV_DEBUGINFO(transtable_global, 0444, batadv_transtable_global_open);
201 #ifdef CONFIG_BATMAN_ADV_BLA
202 static BATADV_DEBUGINFO(bla_claim_table, 0444, batadv_bla_claim_table_open);
203 static BATADV_DEBUGINFO(bla_backbone_table, 0444,
204 batadv_bla_backbone_table_open);
206 #ifdef CONFIG_BATMAN_ADV_DAT
207 static BATADV_DEBUGINFO(dat_cache, 0444, batadv_dat_cache_open);
209 static BATADV_DEBUGINFO(transtable_local, 0444, batadv_transtable_local_open);
210 #ifdef CONFIG_BATMAN_ADV_NC
211 static BATADV_DEBUGINFO(nc_nodes, 0444, batadv_nc_nodes_open);
213 #ifdef CONFIG_BATMAN_ADV_MCAST
214 static BATADV_DEBUGINFO(mcast_flags, 0444, batadv_mcast_flags_open);
217 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
218 &batadv_debuginfo_neighbors,
219 &batadv_debuginfo_originators,
220 &batadv_debuginfo_gateways,
221 &batadv_debuginfo_transtable_global,
222 #ifdef CONFIG_BATMAN_ADV_BLA
223 &batadv_debuginfo_bla_claim_table,
224 &batadv_debuginfo_bla_backbone_table,
226 #ifdef CONFIG_BATMAN_ADV_DAT
227 &batadv_debuginfo_dat_cache,
229 &batadv_debuginfo_transtable_local,
230 #ifdef CONFIG_BATMAN_ADV_NC
231 &batadv_debuginfo_nc_nodes,
233 #ifdef CONFIG_BATMAN_ADV_MCAST
234 &batadv_debuginfo_mcast_flags,
239 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
240 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
242 .name = __stringify(_name), \
246 .owner = THIS_MODULE, \
249 .llseek = seq_lseek, \
250 .release = single_release, \
254 static BATADV_HARDIF_DEBUGINFO(originators, 0444,
255 batadv_originators_hardif_open);
257 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
258 &batadv_hardif_debuginfo_originators,
262 void batadv_debugfs_init(void)
264 struct batadv_debuginfo **bat_debug;
267 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
268 if (batadv_debugfs == ERR_PTR(-ENODEV))
269 batadv_debugfs = NULL;
274 for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
275 file = debugfs_create_file(((*bat_debug)->attr).name,
276 S_IFREG | ((*bat_debug)->attr).mode,
277 batadv_debugfs, NULL,
278 &(*bat_debug)->fops);
280 pr_err("Can't add general debugfs file: %s\n",
281 ((*bat_debug)->attr).name);
288 debugfs_remove_recursive(batadv_debugfs);
289 batadv_debugfs = NULL;
292 void batadv_debugfs_destroy(void)
294 debugfs_remove_recursive(batadv_debugfs);
295 batadv_debugfs = NULL;
299 * batadv_debugfs_add_hardif - creates the base directory for a hard interface
301 * @hard_iface: hard interface which should be added.
303 * Return: 0 on success or negative error number in case of failure
305 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
307 struct net *net = dev_net(hard_iface->net_dev);
308 struct batadv_debuginfo **bat_debug;
314 if (net != &init_net)
317 hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
319 if (!hard_iface->debug_dir)
322 for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
323 file = debugfs_create_file(((*bat_debug)->attr).name,
324 S_IFREG | ((*bat_debug)->attr).mode,
325 hard_iface->debug_dir,
327 &(*bat_debug)->fops);
334 debugfs_remove_recursive(hard_iface->debug_dir);
335 hard_iface->debug_dir = NULL;
341 * batadv_debugfs_del_hardif - delete the base directory for a hard interface
343 * @hard_iface: hard interface which is deleted.
345 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
347 struct net *net = dev_net(hard_iface->net_dev);
349 if (net != &init_net)
352 if (batadv_debugfs) {
353 debugfs_remove_recursive(hard_iface->debug_dir);
354 hard_iface->debug_dir = NULL;
358 int batadv_debugfs_add_meshif(struct net_device *dev)
360 struct batadv_priv *bat_priv = netdev_priv(dev);
361 struct batadv_debuginfo **bat_debug;
362 struct net *net = dev_net(dev);
368 if (net != &init_net)
371 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
372 if (!bat_priv->debug_dir)
375 if (batadv_socket_setup(bat_priv) < 0)
378 if (batadv_debug_log_setup(bat_priv) < 0)
381 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
382 file = debugfs_create_file(((*bat_debug)->attr).name,
383 S_IFREG | ((*bat_debug)->attr).mode,
385 dev, &(*bat_debug)->fops);
387 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
388 dev->name, ((*bat_debug)->attr).name);
393 if (batadv_nc_init_debugfs(bat_priv) < 0)
398 debugfs_remove_recursive(bat_priv->debug_dir);
399 bat_priv->debug_dir = NULL;
404 void batadv_debugfs_del_meshif(struct net_device *dev)
406 struct batadv_priv *bat_priv = netdev_priv(dev);
407 struct net *net = dev_net(dev);
409 if (net != &init_net)
412 batadv_debug_log_cleanup(bat_priv);
414 if (batadv_debugfs) {
415 debugfs_remove_recursive(bat_priv->debug_dir);
416 bat_priv->debug_dir = NULL;