]>
Commit | Line | Data |
---|---|---|
7db7d9f3 | 1 | // SPDX-License-Identifier: GPL-2.0 |
ac79cbb9 | 2 | /* Copyright (C) 2010-2017 B.A.T.M.A.N. contributors: |
c6c8fea2 SE |
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 | |
ebf38fb7 | 16 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
c6c8fea2 SE |
17 | */ |
18 | ||
1e2c2a4f | 19 | #include "debugfs.h" |
c6c8fea2 SE |
20 | #include "main.h" |
21 | ||
22 | #include <linux/debugfs.h> | |
3e7514af | 23 | #include <linux/err.h> |
1e2c2a4f SE |
24 | #include <linux/errno.h> |
25 | #include <linux/export.h> | |
1e2c2a4f | 26 | #include <linux/fs.h> |
1e2c2a4f | 27 | #include <linux/netdevice.h> |
1e2c2a4f | 28 | #include <linux/printk.h> |
1e2c2a4f | 29 | #include <linux/seq_file.h> |
1e2c2a4f SE |
30 | #include <linux/stat.h> |
31 | #include <linux/stddef.h> | |
32 | #include <linux/stringify.h> | |
33 | #include <linux/sysfs.h> | |
94969208 | 34 | #include <net/net_namespace.h> |
c6c8fea2 | 35 | |
01d350d1 | 36 | #include "bat_algo.h" |
9bf8e4d4 | 37 | #include "bridge_loop_avoidance.h" |
2f1dfbe1 | 38 | #include "distributed-arp-table.h" |
1e2c2a4f SE |
39 | #include "gateway_client.h" |
40 | #include "icmp_socket.h" | |
ba412080 | 41 | #include "log.h" |
4e3e823b | 42 | #include "multicast.h" |
d56b1705 | 43 | #include "network-coding.h" |
1e2c2a4f SE |
44 | #include "originator.h" |
45 | #include "translation-table.h" | |
c6c8fea2 | 46 | |
9e466250 | 47 | static struct dentry *batadv_debugfs; |
c6c8fea2 | 48 | |
9e466250 | 49 | static int batadv_algorithms_open(struct inode *inode, struct file *file) |
1c280471 | 50 | { |
3193e8fd | 51 | return single_open(file, batadv_algo_seq_print_text, NULL); |
1c280471 ML |
52 | } |
53 | ||
7587405a ML |
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 | ||
9e466250 | 61 | static int batadv_originators_open(struct inode *inode, struct file *file) |
c6c8fea2 SE |
62 | { |
63 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
f138694b | 64 | |
7d211efc | 65 | return single_open(file, batadv_orig_seq_print_text, net_dev); |
c6c8fea2 SE |
66 | } |
67 | ||
cb1c92ec | 68 | /** |
7e9a8c2c SE |
69 | * batadv_originators_hardif_open() - handles debugfs output for the originator |
70 | * table of an hard interface | |
cb1c92ec SW |
71 | * @inode: inode pointer to debugfs file |
72 | * @file: pointer to the seq_file | |
7afcbbef SE |
73 | * |
74 | * Return: 0 on success or negative error number in case of failure | |
cb1c92ec SW |
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; | |
f138694b | 80 | |
cb1c92ec SW |
81 | return single_open(file, batadv_orig_hardif_seq_print_text, net_dev); |
82 | } | |
83 | ||
9e466250 | 84 | static int batadv_gateways_open(struct inode *inode, struct file *file) |
c6c8fea2 SE |
85 | { |
86 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
f138694b | 87 | |
7cf06bc6 | 88 | return single_open(file, batadv_gw_client_seq_print_text, net_dev); |
c6c8fea2 SE |
89 | } |
90 | ||
9e466250 | 91 | static int batadv_transtable_global_open(struct inode *inode, struct file *file) |
c6c8fea2 SE |
92 | { |
93 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
f138694b | 94 | |
08c36d3e | 95 | return single_open(file, batadv_tt_global_seq_print_text, net_dev); |
c6c8fea2 SE |
96 | } |
97 | ||
7a5cc242 | 98 | #ifdef CONFIG_BATMAN_ADV_BLA |
9e466250 | 99 | static int batadv_bla_claim_table_open(struct inode *inode, struct file *file) |
9bf8e4d4 SW |
100 | { |
101 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
f138694b | 102 | |
08adf151 SE |
103 | return single_open(file, batadv_bla_claim_table_seq_print_text, |
104 | net_dev); | |
9bf8e4d4 | 105 | } |
536a23f1 SW |
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; | |
f138694b | 111 | |
536a23f1 SW |
112 | return single_open(file, batadv_bla_backbone_table_seq_print_text, |
113 | net_dev); | |
114 | } | |
115 | ||
7a5cc242 | 116 | #endif |
9bf8e4d4 | 117 | |
17224474 | 118 | #ifdef CONFIG_BATMAN_ADV_DAT |
2f1dfbe1 | 119 | /** |
7e9a8c2c | 120 | * batadv_dat_cache_open() - Prepare file handler for reads from dat_chache |
2f1dfbe1 AQ |
121 | * @inode: inode which was opened |
122 | * @file: file handle to be initialized | |
7afcbbef SE |
123 | * |
124 | * Return: 0 on success or negative error number in case of failure | |
2f1dfbe1 AQ |
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; | |
f138694b | 129 | |
2f1dfbe1 AQ |
130 | return single_open(file, batadv_dat_cache_seq_print_text, net_dev); |
131 | } | |
17224474 | 132 | #endif |
2f1dfbe1 | 133 | |
9e466250 | 134 | static int batadv_transtable_local_open(struct inode *inode, struct file *file) |
c6c8fea2 SE |
135 | { |
136 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
f138694b | 137 | |
08c36d3e | 138 | return single_open(file, batadv_tt_local_seq_print_text, net_dev); |
c6c8fea2 SE |
139 | } |
140 | ||
7f223c0c | 141 | struct batadv_debuginfo { |
c6c8fea2 SE |
142 | struct attribute attr; |
143 | const struct file_operations fops; | |
144 | }; | |
145 | ||
d56b1705 MH |
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; | |
f138694b | 150 | |
d56b1705 MH |
151 | return single_open(file, batadv_nc_nodes_seq_print_text, net_dev); |
152 | } | |
153 | #endif | |
154 | ||
4e3e823b LL |
155 | #ifdef CONFIG_BATMAN_ADV_MCAST |
156 | /** | |
7e9a8c2c | 157 | * batadv_mcast_flags_open() - prepare file handler for reads from mcast_flags |
4e3e823b LL |
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 | ||
347c80f0 | 171 | #define BATADV_DEBUGINFO(_name, _mode, _open) \ |
7f223c0c | 172 | struct batadv_debuginfo batadv_debuginfo_##_name = { \ |
121bdca0 SW |
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 | }, \ | |
2b64df20 | 184 | } |
c6c8fea2 | 185 | |
637fbd12 AQ |
186 | /* the following attributes are general and therefore they will be directly |
187 | * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs | |
188 | */ | |
507b37cf | 189 | static BATADV_DEBUGINFO(routing_algos, 0444, batadv_algorithms_open); |
637fbd12 AQ |
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 */ | |
507b37cf SE |
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); | |
7a5cc242 | 201 | #ifdef CONFIG_BATMAN_ADV_BLA |
507b37cf SE |
202 | static BATADV_DEBUGINFO(bla_claim_table, 0444, batadv_bla_claim_table_open); |
203 | static BATADV_DEBUGINFO(bla_backbone_table, 0444, | |
536a23f1 | 204 | batadv_bla_backbone_table_open); |
7a5cc242 | 205 | #endif |
17224474 | 206 | #ifdef CONFIG_BATMAN_ADV_DAT |
507b37cf | 207 | static BATADV_DEBUGINFO(dat_cache, 0444, batadv_dat_cache_open); |
17224474 | 208 | #endif |
507b37cf | 209 | static BATADV_DEBUGINFO(transtable_local, 0444, batadv_transtable_local_open); |
d56b1705 | 210 | #ifdef CONFIG_BATMAN_ADV_NC |
507b37cf | 211 | static BATADV_DEBUGINFO(nc_nodes, 0444, batadv_nc_nodes_open); |
d56b1705 | 212 | #endif |
4e3e823b | 213 | #ifdef CONFIG_BATMAN_ADV_MCAST |
507b37cf | 214 | static BATADV_DEBUGINFO(mcast_flags, 0444, batadv_mcast_flags_open); |
4e3e823b | 215 | #endif |
c6c8fea2 | 216 | |
7f223c0c | 217 | static struct batadv_debuginfo *batadv_mesh_debuginfos[] = { |
7587405a | 218 | &batadv_debuginfo_neighbors, |
9e466250 SE |
219 | &batadv_debuginfo_originators, |
220 | &batadv_debuginfo_gateways, | |
221 | &batadv_debuginfo_transtable_global, | |
7a5cc242 | 222 | #ifdef CONFIG_BATMAN_ADV_BLA |
9e466250 | 223 | &batadv_debuginfo_bla_claim_table, |
536a23f1 | 224 | &batadv_debuginfo_bla_backbone_table, |
7a5cc242 | 225 | #endif |
17224474 | 226 | #ifdef CONFIG_BATMAN_ADV_DAT |
2f1dfbe1 | 227 | &batadv_debuginfo_dat_cache, |
17224474 | 228 | #endif |
9e466250 | 229 | &batadv_debuginfo_transtable_local, |
d56b1705 MH |
230 | #ifdef CONFIG_BATMAN_ADV_NC |
231 | &batadv_debuginfo_nc_nodes, | |
4e3e823b LL |
232 | #endif |
233 | #ifdef CONFIG_BATMAN_ADV_MCAST | |
234 | &batadv_debuginfo_mcast_flags, | |
d56b1705 | 235 | #endif |
c6c8fea2 SE |
236 | NULL, |
237 | }; | |
238 | ||
5bc7c1eb SW |
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 | }, \ | |
2b64df20 | 252 | } |
aa143d28 | 253 | |
507b37cf | 254 | static BATADV_HARDIF_DEBUGINFO(originators, 0444, |
cb1c92ec | 255 | batadv_originators_hardif_open); |
5bc7c1eb SW |
256 | |
257 | static struct batadv_debuginfo *batadv_hardif_debuginfos[] = { | |
cb1c92ec | 258 | &batadv_hardif_debuginfo_originators, |
5bc7c1eb SW |
259 | NULL, |
260 | }; | |
261 | ||
ff15c27c SE |
262 | /** |
263 | * batadv_debugfs_init() - Initialize soft interface independent debugfs entries | |
264 | */ | |
40a072d7 | 265 | void batadv_debugfs_init(void) |
c6c8fea2 | 266 | { |
637fbd12 | 267 | struct batadv_debuginfo **bat_debug; |
1c280471 ML |
268 | struct dentry *file; |
269 | ||
54590e4d | 270 | batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL); |
9e466250 SE |
271 | if (batadv_debugfs == ERR_PTR(-ENODEV)) |
272 | batadv_debugfs = NULL; | |
1c280471 | 273 | |
9e466250 | 274 | if (!batadv_debugfs) |
637fbd12 | 275 | goto err; |
1c280471 | 276 | |
637fbd12 AQ |
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 | } | |
1c280471 | 288 | |
1c280471 | 289 | return; |
637fbd12 AQ |
290 | err: |
291 | debugfs_remove_recursive(batadv_debugfs); | |
5bc7c1eb | 292 | batadv_debugfs = NULL; |
c6c8fea2 SE |
293 | } |
294 | ||
ff15c27c SE |
295 | /** |
296 | * batadv_debugfs_destroy() - Remove all debugfs entries | |
297 | */ | |
40a072d7 | 298 | void batadv_debugfs_destroy(void) |
c6c8fea2 | 299 | { |
3f87c423 AQ |
300 | debugfs_remove_recursive(batadv_debugfs); |
301 | batadv_debugfs = NULL; | |
c6c8fea2 SE |
302 | } |
303 | ||
5bc7c1eb | 304 | /** |
7e9a8c2c | 305 | * batadv_debugfs_add_hardif() - creates the base directory for a hard interface |
5bc7c1eb SW |
306 | * in debugfs. |
307 | * @hard_iface: hard interface which should be added. | |
7afcbbef SE |
308 | * |
309 | * Return: 0 on success or negative error number in case of failure | |
5bc7c1eb SW |
310 | */ |
311 | int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface) | |
312 | { | |
94969208 | 313 | struct net *net = dev_net(hard_iface->net_dev); |
5bc7c1eb SW |
314 | struct batadv_debuginfo **bat_debug; |
315 | struct dentry *file; | |
316 | ||
317 | if (!batadv_debugfs) | |
318 | goto out; | |
319 | ||
94969208 AL |
320 | if (net != &init_net) |
321 | return 0; | |
322 | ||
5bc7c1eb SW |
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: | |
5bc7c1eb | 343 | return -ENOMEM; |
5bc7c1eb SW |
344 | } |
345 | ||
346 | /** | |
7e9a8c2c | 347 | * batadv_debugfs_del_hardif() - delete the base directory for a hard interface |
5bc7c1eb SW |
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 | { | |
94969208 AL |
353 | struct net *net = dev_net(hard_iface->net_dev); |
354 | ||
355 | if (net != &init_net) | |
356 | return; | |
357 | ||
5bc7c1eb SW |
358 | if (batadv_debugfs) { |
359 | debugfs_remove_recursive(hard_iface->debug_dir); | |
360 | hard_iface->debug_dir = NULL; | |
361 | } | |
362 | } | |
363 | ||
ff15c27c SE |
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 | */ | |
40a072d7 | 370 | int batadv_debugfs_add_meshif(struct net_device *dev) |
c6c8fea2 | 371 | { |
56303d34 | 372 | struct batadv_priv *bat_priv = netdev_priv(dev); |
7f223c0c | 373 | struct batadv_debuginfo **bat_debug; |
94969208 | 374 | struct net *net = dev_net(dev); |
c6c8fea2 SE |
375 | struct dentry *file; |
376 | ||
9e466250 | 377 | if (!batadv_debugfs) |
c6c8fea2 SE |
378 | goto out; |
379 | ||
94969208 AL |
380 | if (net != &init_net) |
381 | return 0; | |
382 | ||
9e466250 | 383 | bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs); |
c6c8fea2 SE |
384 | if (!bat_priv->debug_dir) |
385 | goto out; | |
386 | ||
9039dc7e | 387 | if (batadv_socket_setup(bat_priv) < 0) |
5346c35e SE |
388 | goto rem_attr; |
389 | ||
9e466250 | 390 | if (batadv_debug_log_setup(bat_priv) < 0) |
5346c35e | 391 | goto rem_attr; |
c6c8fea2 | 392 | |
9e466250 | 393 | for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) { |
c6c8fea2 | 394 | file = debugfs_create_file(((*bat_debug)->attr).name, |
0aca2369 SE |
395 | S_IFREG | ((*bat_debug)->attr).mode, |
396 | bat_priv->debug_dir, | |
397 | dev, &(*bat_debug)->fops); | |
c6c8fea2 | 398 | if (!file) { |
3e34819e SE |
399 | batadv_err(dev, "Can't add debugfs file: %s/%s\n", |
400 | dev->name, ((*bat_debug)->attr).name); | |
c6c8fea2 SE |
401 | goto rem_attr; |
402 | } | |
403 | } | |
404 | ||
d56b1705 MH |
405 | if (batadv_nc_init_debugfs(bat_priv) < 0) |
406 | goto rem_attr; | |
407 | ||
c6c8fea2 SE |
408 | return 0; |
409 | rem_attr: | |
410 | debugfs_remove_recursive(bat_priv->debug_dir); | |
411 | bat_priv->debug_dir = NULL; | |
412 | out: | |
c6c8fea2 | 413 | return -ENOMEM; |
c6c8fea2 SE |
414 | } |
415 | ||
ff15c27c SE |
416 | /** |
417 | * batadv_debugfs_del_meshif() - Remove interface dependent debugfs entries | |
418 | * @dev: netdev struct of the soft interface | |
419 | */ | |
40a072d7 | 420 | void batadv_debugfs_del_meshif(struct net_device *dev) |
c6c8fea2 | 421 | { |
56303d34 | 422 | struct batadv_priv *bat_priv = netdev_priv(dev); |
94969208 AL |
423 | struct net *net = dev_net(dev); |
424 | ||
425 | if (net != &init_net) | |
426 | return; | |
c6c8fea2 | 427 | |
9e466250 | 428 | batadv_debug_log_cleanup(bat_priv); |
c6c8fea2 | 429 | |
9e466250 | 430 | if (batadv_debugfs) { |
c6c8fea2 SE |
431 | debugfs_remove_recursive(bat_priv->debug_dir); |
432 | bat_priv->debug_dir = NULL; | |
433 | } | |
434 | } |