1 /* Copyright (C) 2010-2016 B.A.T.M.A.N. contributors:
2 *
3 * Marek Lindner
4 *
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.
8 *
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.
13 *
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/>.
16 */
17
18 #include "debugfs.h"
19 #include "main.h"
20
21 #include <linux/debugfs.h>
22 #include <linux/device.h>
23 #include <linux/errno.h>
24 #include <linux/export.h>
25 #include <linux/fs.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>
35
36 #include "bat_algo.h"
37 #include "bridge_loop_avoidance.h"
38 #include "distributed-arp-table.h"
39 #include "gateway_client.h"
40 #include "icmp_socket.h"
41 #include "log.h"
42 #include "multicast.h"
43 #include "network-coding.h"
44 #include "originator.h"
45 #include "translation-table.h"
46
47 static struct dentry *batadv_debugfs;
48
batadv_algorithms_open(struct inode * inode,struct file * file)49 static int batadv_algorithms_open(struct inode *inode, struct file *file)
50 {
51 return single_open(file, batadv_algo_seq_print_text, NULL);
52 }
53
neighbors_open(struct inode * inode,struct file * file)54 static int neighbors_open(struct inode *inode, struct file *file)
55 {
56 struct net_device *net_dev = (struct net_device *)inode->i_private;
57
58 return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
59 }
60
batadv_originators_open(struct inode * inode,struct file * file)61 static int batadv_originators_open(struct inode *inode, struct file *file)
62 {
63 struct net_device *net_dev = (struct net_device *)inode->i_private;
64
65 return single_open(file, batadv_orig_seq_print_text, net_dev);
66 }
67
68 /**
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
73 *
74 * Return: 0 on success or negative error number in case of failure
75 */
batadv_originators_hardif_open(struct inode * inode,struct file * file)76 static int batadv_originators_hardif_open(struct inode *inode,
77 struct file *file)
78 {
79 struct net_device *net_dev = (struct net_device *)inode->i_private;
80
81 return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
82 }
83
batadv_gateways_open(struct inode * inode,struct file * file)84 static int batadv_gateways_open(struct inode *inode, struct file *file)
85 {
86 struct net_device *net_dev = (struct net_device *)inode->i_private;
87
88 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
89 }
90
batadv_transtable_global_open(struct inode * inode,struct file * file)91 static int batadv_transtable_global_open(struct inode *inode, struct file *file)
92 {
93 struct net_device *net_dev = (struct net_device *)inode->i_private;
94
95 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
96 }
97
98 #ifdef CONFIG_BATMAN_ADV_BLA
batadv_bla_claim_table_open(struct inode * inode,struct file * file)99 static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
100 {
101 struct net_device *net_dev = (struct net_device *)inode->i_private;
102
103 return single_open(file, batadv_bla_claim_table_seq_print_text,
104 net_dev);
105 }
106
batadv_bla_backbone_table_open(struct inode * inode,struct file * file)107 static int batadv_bla_backbone_table_open(struct inode *inode,
108 struct file *file)
109 {
110 struct net_device *net_dev = (struct net_device *)inode->i_private;
111
112 return single_open(file, batadv_bla_backbone_table_seq_print_text,
113 net_dev);
114 }
115
116 #endif
117
118 #ifdef CONFIG_BATMAN_ADV_DAT
119 /**
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
123 *
124 * Return: 0 on success or negative error number in case of failure
125 */
batadv_dat_cache_open(struct inode * inode,struct file * file)126 static int batadv_dat_cache_open(struct inode *inode, struct file *file)
127 {
128 struct net_device *net_dev = (struct net_device *)inode->i_private;
129
130 return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
131 }
132 #endif
133
batadv_transtable_local_open(struct inode * inode,struct file * file)134 static int batadv_transtable_local_open(struct inode *inode, struct file *file)
135 {
136 struct net_device *net_dev = (struct net_device *)inode->i_private;
137
138 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
139 }
140
141 struct batadv_debuginfo {
142 struct attribute attr;
143 const struct file_operations fops;
144 };
145
146 #ifdef CONFIG_BATMAN_ADV_NC
batadv_nc_nodes_open(struct inode * inode,struct file * file)147 static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
148 {
149 struct net_device *net_dev = (struct net_device *)inode->i_private;
150
151 return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
152 }
153 #endif
154
155 #ifdef CONFIG_BATMAN_ADV_MCAST
156 /**
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
160 *
161 * Return: 0 on success or negative error number in case of failure
162 */
batadv_mcast_flags_open(struct inode * inode,struct file * file)163 static int batadv_mcast_flags_open(struct inode *inode, struct file *file)
164 {
165 struct net_device *net_dev = (struct net_device *)inode->i_private;
166
167 return single_open(file, batadv_mcast_flags_seq_print_text, net_dev);
168 }
169 #endif
170
171 #define BATADV_DEBUGINFO(_name, _mode, _open) \
172 struct batadv_debuginfo batadv_debuginfo_##_name = { \
173 .attr = { \
174 .name = __stringify(_name), \
175 .mode = _mode, \
176 }, \
177 .fops = { \
178 .owner = THIS_MODULE, \
179 .open = _open, \
180 .read = seq_read, \
181 .llseek = seq_lseek, \
182 .release = single_release, \
183 }, \
184 }
185
186 /* the following attributes are general and therefore they will be directly
187 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
188 */
189 static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
190
191 static struct batadv_debuginfo *batadv_general_debuginfos[] = {
192 &batadv_debuginfo_routing_algos,
193 NULL,
194 };
195
196 /* The following attributes are per soft interface */
197 static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
198 static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
199 static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
200 static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
201 batadv_transtable_global_open);
202 #ifdef CONFIG_BATMAN_ADV_BLA
203 static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
204 static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
205 batadv_bla_backbone_table_open);
206 #endif
207 #ifdef CONFIG_BATMAN_ADV_DAT
208 static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
209 #endif
210 static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
211 batadv_transtable_local_open);
212 #ifdef CONFIG_BATMAN_ADV_NC
213 static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
214 #endif
215 #ifdef CONFIG_BATMAN_ADV_MCAST
216 static BATADV_DEBUGINFO(mcast_flags, S_IRUGO, batadv_mcast_flags_open);
217 #endif
218
219 static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
220 &batadv_debuginfo_neighbors,
221 &batadv_debuginfo_originators,
222 &batadv_debuginfo_gateways,
223 &batadv_debuginfo_transtable_global,
224 #ifdef CONFIG_BATMAN_ADV_BLA
225 &batadv_debuginfo_bla_claim_table,
226 &batadv_debuginfo_bla_backbone_table,
227 #endif
228 #ifdef CONFIG_BATMAN_ADV_DAT
229 &batadv_debuginfo_dat_cache,
230 #endif
231 &batadv_debuginfo_transtable_local,
232 #ifdef CONFIG_BATMAN_ADV_NC
233 &batadv_debuginfo_nc_nodes,
234 #endif
235 #ifdef CONFIG_BATMAN_ADV_MCAST
236 &batadv_debuginfo_mcast_flags,
237 #endif
238 NULL,
239 };
240
241 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
242 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
243 .attr = { \
244 .name = __stringify(_name), \
245 .mode = _mode, \
246 }, \
247 .fops = { \
248 .owner = THIS_MODULE, \
249 .open = _open, \
250 .read = seq_read, \
251 .llseek = seq_lseek, \
252 .release = single_release, \
253 }, \
254 }
255
256 static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
257 batadv_originators_hardif_open);
258
259 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
260 &batadv_hardif_debuginfo_originators,
261 NULL,
262 };
263
batadv_debugfs_init(void)264 void batadv_debugfs_init(void)
265 {
266 struct batadv_debuginfo **bat_debug;
267 struct dentry *file;
268
269 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
270 if (batadv_debugfs == ERR_PTR(-ENODEV))
271 batadv_debugfs = NULL;
272
273 if (!batadv_debugfs)
274 goto err;
275
276 for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
277 file = debugfs_create_file(((*bat_debug)->attr).name,
278 S_IFREG | ((*bat_debug)->attr).mode,
279 batadv_debugfs, NULL,
280 &(*bat_debug)->fops);
281 if (!file) {
282 pr_err("Can't add general debugfs file: %s\n",
283 ((*bat_debug)->attr).name);
284 goto err;
285 }
286 }
287
288 return;
289 err:
290 debugfs_remove_recursive(batadv_debugfs);
291 batadv_debugfs = NULL;
292 }
293
batadv_debugfs_destroy(void)294 void batadv_debugfs_destroy(void)
295 {
296 debugfs_remove_recursive(batadv_debugfs);
297 batadv_debugfs = NULL;
298 }
299
300 /**
301 * batadv_debugfs_add_hardif - creates the base directory for a hard interface
302 * in debugfs.
303 * @hard_iface: hard interface which should be added.
304 *
305 * Return: 0 on success or negative error number in case of failure
306 */
batadv_debugfs_add_hardif(struct batadv_hard_iface * hard_iface)307 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
308 {
309 struct net *net = dev_net(hard_iface->net_dev);
310 struct batadv_debuginfo **bat_debug;
311 struct dentry *file;
312
313 if (!batadv_debugfs)
314 goto out;
315
316 if (net != &init_net)
317 return 0;
318
319 hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
320 batadv_debugfs);
321 if (!hard_iface->debug_dir)
322 goto out;
323
324 for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
325 file = debugfs_create_file(((*bat_debug)->attr).name,
326 S_IFREG | ((*bat_debug)->attr).mode,
327 hard_iface->debug_dir,
328 hard_iface->net_dev,
329 &(*bat_debug)->fops);
330 if (!file)
331 goto rem_attr;
332 }
333
334 return 0;
335 rem_attr:
336 debugfs_remove_recursive(hard_iface->debug_dir);
337 hard_iface->debug_dir = NULL;
338 out:
339 return -ENOMEM;
340 }
341
342 /**
343 * batadv_debugfs_del_hardif - delete the base directory for a hard interface
344 * in debugfs.
345 * @hard_iface: hard interface which is deleted.
346 */
batadv_debugfs_del_hardif(struct batadv_hard_iface * hard_iface)347 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
348 {
349 struct net *net = dev_net(hard_iface->net_dev);
350
351 if (net != &init_net)
352 return;
353
354 if (batadv_debugfs) {
355 debugfs_remove_recursive(hard_iface->debug_dir);
356 hard_iface->debug_dir = NULL;
357 }
358 }
359
batadv_debugfs_add_meshif(struct net_device * dev)360 int batadv_debugfs_add_meshif(struct net_device *dev)
361 {
362 struct batadv_priv *bat_priv = netdev_priv(dev);
363 struct batadv_debuginfo **bat_debug;
364 struct net *net = dev_net(dev);
365 struct dentry *file;
366
367 if (!batadv_debugfs)
368 goto out;
369
370 if (net != &init_net)
371 return 0;
372
373 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
374 if (!bat_priv->debug_dir)
375 goto out;
376
377 if (batadv_socket_setup(bat_priv) < 0)
378 goto rem_attr;
379
380 if (batadv_debug_log_setup(bat_priv) < 0)
381 goto rem_attr;
382
383 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
384 file = debugfs_create_file(((*bat_debug)->attr).name,
385 S_IFREG | ((*bat_debug)->attr).mode,
386 bat_priv->debug_dir,
387 dev, &(*bat_debug)->fops);
388 if (!file) {
389 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
390 dev->name, ((*bat_debug)->attr).name);
391 goto rem_attr;
392 }
393 }
394
395 if (batadv_nc_init_debugfs(bat_priv) < 0)
396 goto rem_attr;
397
398 return 0;
399 rem_attr:
400 debugfs_remove_recursive(bat_priv->debug_dir);
401 bat_priv->debug_dir = NULL;
402 out:
403 return -ENOMEM;
404 }
405
batadv_debugfs_del_meshif(struct net_device * dev)406 void batadv_debugfs_del_meshif(struct net_device *dev)
407 {
408 struct batadv_priv *bat_priv = netdev_priv(dev);
409 struct net *net = dev_net(dev);
410
411 if (net != &init_net)
412 return;
413
414 batadv_debug_log_cleanup(bat_priv);
415
416 if (batadv_debugfs) {
417 debugfs_remove_recursive(bat_priv->debug_dir);
418 bat_priv->debug_dir = NULL;
419 }
420 }
421