drm/amdgpu/vg20:Restruct uvd to support multiple uvds
[muen/linux.git] / net / batman-adv / debugfs.c
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (C) 2010-2018  B.A.T.M.A.N. contributors:
3  *
4  * Marek Lindner
5  *
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.
9  *
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.
14  *
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/>.
17  */
18
19 #include "debugfs.h"
20 #include "main.h"
21
22 #include <linux/debugfs.h>
23 #include <linux/err.h>
24 #include <linux/errno.h>
25 #include <linux/export.h>
26 #include <linux/fs.h>
27 #include <linux/netdevice.h>
28 #include <linux/printk.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
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
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
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 originator
70  *  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  */
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
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
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
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
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  */
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
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
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  */
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, 0444, 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, 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);
205 #endif
206 #ifdef CONFIG_BATMAN_ADV_DAT
207 static BATADV_DEBUGINFO(dat_cache, 0444, batadv_dat_cache_open);
208 #endif
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);
212 #endif
213 #ifdef CONFIG_BATMAN_ADV_MCAST
214 static BATADV_DEBUGINFO(mcast_flags, 0444, batadv_mcast_flags_open);
215 #endif
216
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,
225 #endif
226 #ifdef CONFIG_BATMAN_ADV_DAT
227         &batadv_debuginfo_dat_cache,
228 #endif
229         &batadv_debuginfo_transtable_local,
230 #ifdef CONFIG_BATMAN_ADV_NC
231         &batadv_debuginfo_nc_nodes,
232 #endif
233 #ifdef CONFIG_BATMAN_ADV_MCAST
234         &batadv_debuginfo_mcast_flags,
235 #endif
236         NULL,
237 };
238
239 #define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open)            \
240 struct batadv_debuginfo batadv_hardif_debuginfo_##_name = {     \
241         .attr = {                                               \
242                 .name = __stringify(_name),                     \
243                 .mode = _mode,                                  \
244         },                                                      \
245         .fops = {                                               \
246                 .owner = THIS_MODULE,                           \
247                 .open = _open,                                  \
248                 .read   = seq_read,                             \
249                 .llseek = seq_lseek,                            \
250                 .release = single_release,                      \
251         },                                                      \
252 }
253
254 static BATADV_HARDIF_DEBUGINFO(originators, 0444,
255                                batadv_originators_hardif_open);
256
257 static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
258         &batadv_hardif_debuginfo_originators,
259         NULL,
260 };
261
262 /**
263  * batadv_debugfs_init() - Initialize soft interface independent debugfs entries
264  */
265 void batadv_debugfs_init(void)
266 {
267         struct batadv_debuginfo **bat_debug;
268         struct dentry *file;
269
270         batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
271         if (batadv_debugfs == ERR_PTR(-ENODEV))
272                 batadv_debugfs = NULL;
273
274         if (!batadv_debugfs)
275                 goto err;
276
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);
282                 if (!file) {
283                         pr_err("Can't add general debugfs file: %s\n",
284                                ((*bat_debug)->attr).name);
285                         goto err;
286                 }
287         }
288
289         return;
290 err:
291         debugfs_remove_recursive(batadv_debugfs);
292         batadv_debugfs = NULL;
293 }
294
295 /**
296  * batadv_debugfs_destroy() - Remove all debugfs entries
297  */
298 void batadv_debugfs_destroy(void)
299 {
300         debugfs_remove_recursive(batadv_debugfs);
301         batadv_debugfs = NULL;
302 }
303
304 /**
305  * batadv_debugfs_add_hardif() - creates the base directory for a hard interface
306  *  in debugfs.
307  * @hard_iface: hard interface which should be added.
308  *
309  * Return: 0 on success or negative error number in case of failure
310  */
311 int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
312 {
313         struct net *net = dev_net(hard_iface->net_dev);
314         struct batadv_debuginfo **bat_debug;
315         struct dentry *file;
316
317         if (!batadv_debugfs)
318                 goto out;
319
320         if (net != &init_net)
321                 return 0;
322
323         hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
324                                                    batadv_debugfs);
325         if (!hard_iface->debug_dir)
326                 goto out;
327
328         for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
329                 file = debugfs_create_file(((*bat_debug)->attr).name,
330                                            S_IFREG | ((*bat_debug)->attr).mode,
331                                            hard_iface->debug_dir,
332                                            hard_iface->net_dev,
333                                            &(*bat_debug)->fops);
334                 if (!file)
335                         goto rem_attr;
336         }
337
338         return 0;
339 rem_attr:
340         debugfs_remove_recursive(hard_iface->debug_dir);
341         hard_iface->debug_dir = NULL;
342 out:
343         return -ENOMEM;
344 }
345
346 /**
347  * batadv_debugfs_del_hardif() - delete the base directory for a hard interface
348  *  in debugfs.
349  * @hard_iface: hard interface which is deleted.
350  */
351 void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
352 {
353         struct net *net = dev_net(hard_iface->net_dev);
354
355         if (net != &init_net)
356                 return;
357
358         if (batadv_debugfs) {
359                 debugfs_remove_recursive(hard_iface->debug_dir);
360                 hard_iface->debug_dir = NULL;
361         }
362 }
363
364 /**
365  * batadv_debugfs_add_meshif() - Initialize interface dependent debugfs entries
366  * @dev: netdev struct of the soft interface
367  *
368  * Return: 0 on success or negative error number in case of failure
369  */
370 int batadv_debugfs_add_meshif(struct net_device *dev)
371 {
372         struct batadv_priv *bat_priv = netdev_priv(dev);
373         struct batadv_debuginfo **bat_debug;
374         struct net *net = dev_net(dev);
375         struct dentry *file;
376
377         if (!batadv_debugfs)
378                 goto out;
379
380         if (net != &init_net)
381                 return 0;
382
383         bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
384         if (!bat_priv->debug_dir)
385                 goto out;
386
387         if (batadv_socket_setup(bat_priv) < 0)
388                 goto rem_attr;
389
390         if (batadv_debug_log_setup(bat_priv) < 0)
391                 goto rem_attr;
392
393         for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
394                 file = debugfs_create_file(((*bat_debug)->attr).name,
395                                            S_IFREG | ((*bat_debug)->attr).mode,
396                                            bat_priv->debug_dir,
397                                            dev, &(*bat_debug)->fops);
398                 if (!file) {
399                         batadv_err(dev, "Can't add debugfs file: %s/%s\n",
400                                    dev->name, ((*bat_debug)->attr).name);
401                         goto rem_attr;
402                 }
403         }
404
405         if (batadv_nc_init_debugfs(bat_priv) < 0)
406                 goto rem_attr;
407
408         return 0;
409 rem_attr:
410         debugfs_remove_recursive(bat_priv->debug_dir);
411         bat_priv->debug_dir = NULL;
412 out:
413         return -ENOMEM;
414 }
415
416 /**
417  * batadv_debugfs_del_meshif() - Remove interface dependent debugfs entries
418  * @dev: netdev struct of the soft interface
419  */
420 void batadv_debugfs_del_meshif(struct net_device *dev)
421 {
422         struct batadv_priv *bat_priv = netdev_priv(dev);
423         struct net *net = dev_net(dev);
424
425         if (net != &init_net)
426                 return;
427
428         batadv_debug_log_cleanup(bat_priv);
429
430         if (batadv_debugfs) {
431                 debugfs_remove_recursive(bat_priv->debug_dir);
432                 bat_priv->debug_dir = NULL;
433         }
434 }