1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2010-2018 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, see <http://www.gnu.org/licenses/>.
22 #include <linux/dcache.h>
23 #include <linux/debugfs.h>
24 #include <linux/err.h>
25 #include <linux/errno.h>
26 #include <linux/export.h>
28 #include <linux/netdevice.h>
29 #include <linux/printk.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;
51 * batadv_debugfs_deprecated() - Log use of deprecated batadv debugfs access
52 * @file: file which was accessed
53 * @alt: explanation what can be used as alternative
55 void batadv_debugfs_deprecated(struct file *file, const char *alt)
57 struct dentry *dentry = file_dentry(file);
58 const char *name = dentry->d_name.name;
60 pr_warn_ratelimited(DEPRECATED "%s (pid %d) Use of debugfs file \"%s\".\n%s",
61 current->comm, task_pid_nr(current), name, alt);
64 static int batadv_algorithms_open(struct inode *inode, struct file *file)
66 batadv_debugfs_deprecated(file,
67 "Use genl command BATADV_CMD_GET_ROUTING_ALGOS instead\n");
68 return single_open(file, batadv_algo_seq_print_text, NULL);
71 static int neighbors_open(struct inode *inode, struct file *file)
73 struct net_device *net_dev = (struct net_device *)inode->i_private;
75 batadv_debugfs_deprecated(file,
76 "Use genl command BATADV_CMD_GET_NEIGHBORS instead\n");
77 return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
80 static int batadv_originators_open(struct inode *inode, struct file *file)
82 struct net_device *net_dev = (struct net_device *)inode->i_private;
84 batadv_debugfs_deprecated(file,
85 "Use genl command BATADV_CMD_GET_ORIGINATORS instead\n");
86 return single_open(file, batadv_orig_seq_print_text, net_dev);
90 * batadv_originators_hardif_open() - handles debugfs output for the originator
91 * table of an hard interface
92 * @inode: inode pointer to debugfs file
93 * @file: pointer to the seq_file
95 * Return: 0 on success or negative error number in case of failure
97 static int batadv_originators_hardif_open(struct inode *inode,
100 struct net_device *net_dev = (struct net_device *)inode->i_private;
102 batadv_debugfs_deprecated(file,
103 "Use genl command BATADV_CMD_GET_HARDIFS instead\n");
104 return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
107 static int batadv_gateways_open(struct inode *inode, struct file *file)
109 struct net_device *net_dev = (struct net_device *)inode->i_private;
111 batadv_debugfs_deprecated(file,
112 "Use genl command BATADV_CMD_GET_GATEWAYS instead\n");
113 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
116 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
118 struct net_device *net_dev = (struct net_device *)inode->i_private;
120 batadv_debugfs_deprecated(file,
121 "Use genl command BATADV_CMD_GET_TRANSTABLE_GLOBAL instead\n");
122 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
125 #ifdef CONFIG_BATMAN_ADV_BLA
126 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
128 struct net_device *net_dev = (struct net_device *)inode->i_private;
130 batadv_debugfs_deprecated(file,
131 "Use genl command BATADV_CMD_GET_BLA_CLAIM instead\n");
132 return single_open(file, batadv_bla_claim_table_seq_print_text,
136 static int batadv_bla_backbone_table_open(struct inode *inode,
139 struct net_device *net_dev = (struct net_device *)inode->i_private;
141 batadv_debugfs_deprecated(file,
142 "Use genl command BATADV_CMD_GET_BLA_BACKBONE instead\n");
143 return single_open(file, batadv_bla_backbone_table_seq_print_text,
149 #ifdef CONFIG_BATMAN_ADV_DAT
151 * batadv_dat_cache_open() - Prepare file handler for reads from dat_cache
152 * @inode: inode which was opened
153 * @file: file handle to be initialized
155 * Return: 0 on success or negative error number in case of failure
157 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
159 struct net_device *net_dev = (struct net_device *)inode->i_private;
161 batadv_debugfs_deprecated(file,
162 "Use genl command BATADV_CMD_GET_DAT_CACHE instead\n");
163 return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
167 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
169 struct net_device *net_dev = (struct net_device *)inode->i_private;
171 batadv_debugfs_deprecated(file,
172 "Use genl command BATADV_CMD_GET_TRANSTABLE_LOCAL instead\n");
173 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
176 struct batadv_debuginfo {
177 struct attribute attr;
178 const struct file_operations fops;
181 #ifdef CONFIG_BATMAN_ADV_NC
182 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
184 struct net_device *net_dev = (struct net_device *)inode->i_private;
186 batadv_debugfs_deprecated(file, "");
187 return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
191 #ifdef CONFIG_BATMAN_ADV_MCAST
193 * batadv_mcast_flags_open() - prepare file handler for reads from mcast_flags
194 * @inode: inode which was opened
195 * @file: file handle to be initialized
197 * Return: 0 on success or negative error number in case of failure
199 static int batadv_mcast_flags_open(struct inode *inode, struct file *file)
201 struct net_device *net_dev = (struct net_device *)inode->i_private;
203 batadv_debugfs_deprecated(file,
204 "Use genl command BATADV_CMD_GET_MCAST_FLAGS instead\n");
205 return single_open(file, batadv_mcast_flags_seq_print_text, net_dev);
209 #define BATADV_DEBUGINFO(_name, _mode, _open) \
210 struct batadv_debuginfo batadv_debuginfo_##_name = { \
212 .name = __stringify(_name), \
216 .owner = THIS_MODULE, \
219 .llseek = seq_lseek, \
220 .release = single_release, \
224 /* the following attributes are general and therefore they will be directly
225 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
227 static BATADV_DEBUGINFO(routing_algos, 0444, batadv_algorithms_open);
229 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
230 &batadv_debuginfo_routing_algos,
234 /* The following attributes are per soft interface */
235 static BATADV_DEBUGINFO(neighbors, 0444, neighbors_open);
236 static BATADV_DEBUGINFO(originators, 0444, batadv_originators_open);
237 static BATADV_DEBUGINFO(gateways, 0444, batadv_gateways_open);
238 static BATADV_DEBUGINFO(transtable_global, 0444, batadv_transtable_global_open);
239 #ifdef CONFIG_BATMAN_ADV_BLA
240 static BATADV_DEBUGINFO(bla_claim_table, 0444, batadv_bla_claim_table_open);
241 static BATADV_DEBUGINFO(bla_backbone_table, 0444,
242 batadv_bla_backbone_table_open);
244 #ifdef CONFIG_BATMAN_ADV_DAT
245 static BATADV_DEBUGINFO(dat_cache, 0444, batadv_dat_cache_open);
247 static BATADV_DEBUGINFO(transtable_local, 0444, batadv_transtable_local_open);
248 #ifdef CONFIG_BATMAN_ADV_NC
249 static BATADV_DEBUGINFO(nc_nodes, 0444, batadv_nc_nodes_open);
251 #ifdef CONFIG_BATMAN_ADV_MCAST
252 static BATADV_DEBUGINFO(mcast_flags, 0444, batadv_mcast_flags_open);
255 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
256 &batadv_debuginfo_neighbors,
257 &batadv_debuginfo_originators,
258 &batadv_debuginfo_gateways,
259 &batadv_debuginfo_transtable_global,
260 #ifdef CONFIG_BATMAN_ADV_BLA
261 &batadv_debuginfo_bla_claim_table,
262 &batadv_debuginfo_bla_backbone_table,
264 #ifdef CONFIG_BATMAN_ADV_DAT
265 &batadv_debuginfo_dat_cache,
267 &batadv_debuginfo_transtable_local,
268 #ifdef CONFIG_BATMAN_ADV_NC
269 &batadv_debuginfo_nc_nodes,
271 #ifdef CONFIG_BATMAN_ADV_MCAST
272 &batadv_debuginfo_mcast_flags,
277 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
278 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
280 .name = __stringify(_name), \
284 .owner = THIS_MODULE, \
287 .llseek = seq_lseek, \
288 .release = single_release, \
292 static BATADV_HARDIF_DEBUGINFO(originators, 0444,
293 batadv_originators_hardif_open);
295 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
296 &batadv_hardif_debuginfo_originators,
301 * batadv_debugfs_init() - Initialize soft interface independent debugfs entries
303 void batadv_debugfs_init(void)
305 struct batadv_debuginfo **bat_debug;
308 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
309 if (batadv_debugfs == ERR_PTR(-ENODEV))
310 batadv_debugfs = NULL;
315 for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
316 file = debugfs_create_file(((*bat_debug)->attr).name,
317 S_IFREG | ((*bat_debug)->attr).mode,
318 batadv_debugfs, NULL,
319 &(*bat_debug)->fops);
321 pr_err("Can't add general debugfs file: %s\n",
322 ((*bat_debug)->attr).name);
329 debugfs_remove_recursive(batadv_debugfs);
330 batadv_debugfs = NULL;
334 * batadv_debugfs_destroy() - Remove all debugfs entries
336 void batadv_debugfs_destroy(void)
338 debugfs_remove_recursive(batadv_debugfs);
339 batadv_debugfs = NULL;
343 * batadv_debugfs_add_hardif() - creates the base directory for a hard interface
345 * @hard_iface: hard interface which should be added.
347 * Return: 0 on success or negative error number in case of failure
349 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
351 struct net *net = dev_net(hard_iface->net_dev);
352 struct batadv_debuginfo **bat_debug;
358 if (net != &init_net)
361 hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
363 if (!hard_iface->debug_dir)
366 for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
367 file = debugfs_create_file(((*bat_debug)->attr).name,
368 S_IFREG | ((*bat_debug)->attr).mode,
369 hard_iface->debug_dir,
371 &(*bat_debug)->fops);
378 debugfs_remove_recursive(hard_iface->debug_dir);
379 hard_iface->debug_dir = NULL;
385 * batadv_debugfs_rename_hardif() - Fix debugfs path for renamed hardif
386 * @hard_iface: hard interface which was renamed
388 void batadv_debugfs_rename_hardif(struct batadv_hard_iface *hard_iface)
390 const char *name = hard_iface->net_dev->name;
394 dir = hard_iface->debug_dir;
398 d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
400 pr_err("Can't rename debugfs dir to %s\n", name);
404 * batadv_debugfs_del_hardif() - delete the base directory for a hard interface
406 * @hard_iface: hard interface which is deleted.
408 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
410 struct net *net = dev_net(hard_iface->net_dev);
412 if (net != &init_net)
415 if (batadv_debugfs) {
416 debugfs_remove_recursive(hard_iface->debug_dir);
417 hard_iface->debug_dir = NULL;
422 * batadv_debugfs_add_meshif() - Initialize interface dependent debugfs entries
423 * @dev: netdev struct of the soft interface
425 * Return: 0 on success or negative error number in case of failure
427 int batadv_debugfs_add_meshif(struct net_device *dev)
429 struct batadv_priv *bat_priv = netdev_priv(dev);
430 struct batadv_debuginfo **bat_debug;
431 struct net *net = dev_net(dev);
437 if (net != &init_net)
440 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
441 if (!bat_priv->debug_dir)
444 if (batadv_socket_setup(bat_priv) < 0)
447 if (batadv_debug_log_setup(bat_priv) < 0)
450 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
451 file = debugfs_create_file(((*bat_debug)->attr).name,
452 S_IFREG | ((*bat_debug)->attr).mode,
454 dev, &(*bat_debug)->fops);
456 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
457 dev->name, ((*bat_debug)->attr).name);
462 if (batadv_nc_init_debugfs(bat_priv) < 0)
467 debugfs_remove_recursive(bat_priv->debug_dir);
468 bat_priv->debug_dir = NULL;
474 * batadv_debugfs_rename_meshif() - Fix debugfs path for renamed softif
475 * @dev: net_device which was renamed
477 void batadv_debugfs_rename_meshif(struct net_device *dev)
479 struct batadv_priv *bat_priv = netdev_priv(dev);
480 const char *name = dev->name;
484 dir = bat_priv->debug_dir;
488 d = debugfs_rename(dir->d_parent, dir, dir->d_parent, name);
490 pr_err("Can't rename debugfs dir to %s\n", name);
494 * batadv_debugfs_del_meshif() - Remove interface dependent debugfs entries
495 * @dev: netdev struct of the soft interface
497 void batadv_debugfs_del_meshif(struct net_device *dev)
499 struct batadv_priv *bat_priv = netdev_priv(dev);
500 struct net *net = dev_net(dev);
502 if (net != &init_net)
505 batadv_debug_log_cleanup(bat_priv);
507 if (batadv_debugfs) {
508 debugfs_remove_recursive(bat_priv->debug_dir);
509 bat_priv->debug_dir = NULL;