]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - net/batman-adv/debugfs.c
Merge branch 'cdc_ncm-coalesce'
[mirror_ubuntu-zesty-kernel.git] / net / batman-adv / debugfs.c
CommitLineData
e19f9759 1/* Copyright (C) 2010-2014 B.A.T.M.A.N. contributors:
c6c8fea2
SE
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
ebf38fb7 15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea2
SE
16 */
17
18#include "main.h"
19
20#include <linux/debugfs.h>
21
b706b13b 22#include "debugfs.h"
c6c8fea2
SE
23#include "translation-table.h"
24#include "originator.h"
25#include "hard-interface.h"
26#include "gateway_common.h"
27#include "gateway_client.h"
28#include "soft-interface.h"
c6c8fea2 29#include "icmp_socket.h"
9bf8e4d4 30#include "bridge_loop_avoidance.h"
2f1dfbe1 31#include "distributed-arp-table.h"
d56b1705 32#include "network-coding.h"
c6c8fea2 33
9e466250 34static struct dentry *batadv_debugfs;
c6c8fea2
SE
35
36#ifdef CONFIG_BATMAN_ADV_DEBUG
347c80f0 37#define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
c6c8fea2 38
a8a0a62d
SE
39static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
40
0abf5d81 41static char *batadv_log_char_addr(struct batadv_priv_debug_log *debug_log,
a8a0a62d
SE
42 size_t idx)
43{
44 return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
45}
c6c8fea2 46
0abf5d81
ML
47static void batadv_emit_log_char(struct batadv_priv_debug_log *debug_log,
48 char c)
c6c8fea2 49{
a8a0a62d
SE
50 char *char_addr;
51
52 char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
53 *char_addr = c;
c6c8fea2
SE
54 debug_log->log_end++;
55
9e466250
SE
56 if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
57 debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
c6c8fea2
SE
58}
59
d3a547be 60__printf(2, 3)
0abf5d81 61static int batadv_fdebug_log(struct batadv_priv_debug_log *debug_log,
56303d34 62 const char *fmt, ...)
c6c8fea2 63{
c6c8fea2
SE
64 va_list args;
65 static char debug_log_buf[256];
66 char *p;
67
68 if (!debug_log)
69 return 0;
70
71 spin_lock_bh(&debug_log->lock);
72 va_start(args, fmt);
1299bdaa 73 vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
c6c8fea2
SE
74 va_end(args);
75
76 for (p = debug_log_buf; *p != 0; p++)
9e466250 77 batadv_emit_log_char(debug_log, *p);
c6c8fea2
SE
78
79 spin_unlock_bh(&debug_log->lock);
80
81 wake_up(&debug_log->queue_wait);
82
83 return 0;
84}
85
56303d34 86int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
c6c8fea2
SE
87{
88 va_list args;
89 char tmp_log_buf[256];
90
91 va_start(args, fmt);
92 vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
9e466250
SE
93 batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
94 jiffies_to_msecs(jiffies), tmp_log_buf);
c6c8fea2
SE
95 va_end(args);
96
97 return 0;
98}
99
9e466250 100static int batadv_log_open(struct inode *inode, struct file *file)
c6c8fea2 101{
bd5b80d5
SE
102 if (!try_module_get(THIS_MODULE))
103 return -EBUSY;
104
c6c8fea2
SE
105 nonseekable_open(inode, file);
106 file->private_data = inode->i_private;
c6c8fea2
SE
107 return 0;
108}
109
9e466250 110static int batadv_log_release(struct inode *inode, struct file *file)
c6c8fea2 111{
bd5b80d5 112 module_put(THIS_MODULE);
c6c8fea2
SE
113 return 0;
114}
115
0abf5d81 116static int batadv_log_empty(struct batadv_priv_debug_log *debug_log)
0aca2369
SE
117{
118 return !(debug_log->log_start - debug_log->log_end);
119}
120
9e466250
SE
121static ssize_t batadv_log_read(struct file *file, char __user *buf,
122 size_t count, loff_t *ppos)
c6c8fea2 123{
56303d34 124 struct batadv_priv *bat_priv = file->private_data;
0abf5d81 125 struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
c6c8fea2 126 int error, i = 0;
a8a0a62d 127 char *char_addr;
c6c8fea2
SE
128 char c;
129
0aca2369 130 if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
c6c8fea2
SE
131 return -EAGAIN;
132
16f14b45 133 if (!buf)
c6c8fea2
SE
134 return -EINVAL;
135
136 if (count == 0)
137 return 0;
138
139 if (!access_ok(VERIFY_WRITE, buf, count))
140 return -EFAULT;
141
142 error = wait_event_interruptible(debug_log->queue_wait,
0aca2369 143 (!batadv_log_empty(debug_log)));
c6c8fea2
SE
144
145 if (error)
146 return error;
147
148 spin_lock_bh(&debug_log->lock);
149
150 while ((!error) && (i < count) &&
151 (debug_log->log_start != debug_log->log_end)) {
a8a0a62d
SE
152 char_addr = batadv_log_char_addr(debug_log,
153 debug_log->log_start);
154 c = *char_addr;
c6c8fea2
SE
155
156 debug_log->log_start++;
157
158 spin_unlock_bh(&debug_log->lock);
159
160 error = __put_user(c, buf);
161
162 spin_lock_bh(&debug_log->lock);
163
164 buf++;
165 i++;
c6c8fea2
SE
166 }
167
168 spin_unlock_bh(&debug_log->lock);
169
170 if (!error)
171 return i;
172
173 return error;
174}
175
9e466250 176static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
c6c8fea2 177{
56303d34 178 struct batadv_priv *bat_priv = file->private_data;
0abf5d81 179 struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
c6c8fea2
SE
180
181 poll_wait(file, &debug_log->queue_wait, wait);
182
0aca2369 183 if (!batadv_log_empty(debug_log))
c6c8fea2
SE
184 return POLLIN | POLLRDNORM;
185
186 return 0;
187}
188
9e466250
SE
189static const struct file_operations batadv_log_fops = {
190 .open = batadv_log_open,
191 .release = batadv_log_release,
192 .read = batadv_log_read,
193 .poll = batadv_log_poll,
c6c8fea2
SE
194 .llseek = no_llseek,
195};
196
56303d34 197static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
c6c8fea2
SE
198{
199 struct dentry *d;
200
201 if (!bat_priv->debug_dir)
202 goto err;
203
704509b8 204 bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
c6c8fea2
SE
205 if (!bat_priv->debug_log)
206 goto err;
207
208 spin_lock_init(&bat_priv->debug_log->lock);
209 init_waitqueue_head(&bat_priv->debug_log->queue_wait);
210
211 d = debugfs_create_file("log", S_IFREG | S_IRUSR,
9e466250
SE
212 bat_priv->debug_dir, bat_priv,
213 &batadv_log_fops);
5346c35e 214 if (!d)
c6c8fea2
SE
215 goto err;
216
217 return 0;
218
219err:
5346c35e 220 return -ENOMEM;
c6c8fea2
SE
221}
222
56303d34 223static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
c6c8fea2
SE
224{
225 kfree(bat_priv->debug_log);
226 bat_priv->debug_log = NULL;
227}
228#else /* CONFIG_BATMAN_ADV_DEBUG */
56303d34 229static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
c6c8fea2 230{
c6c8fea2
SE
231 return 0;
232}
233
56303d34 234static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
c6c8fea2
SE
235{
236 return;
237}
238#endif
239
9e466250 240static int batadv_algorithms_open(struct inode *inode, struct file *file)
1c280471 241{
3193e8fd 242 return single_open(file, batadv_algo_seq_print_text, NULL);
1c280471
ML
243}
244
9e466250 245static int batadv_originators_open(struct inode *inode, struct file *file)
c6c8fea2
SE
246{
247 struct net_device *net_dev = (struct net_device *)inode->i_private;
7d211efc 248 return single_open(file, batadv_orig_seq_print_text, net_dev);
c6c8fea2
SE
249}
250
cb1c92ec
SW
251/**
252 * batadv_originators_hardif_open - handles debugfs output for the
253 * originator table of an hard interface
254 * @inode: inode pointer to debugfs file
255 * @file: pointer to the seq_file
256 */
257static int batadv_originators_hardif_open(struct inode *inode,
258 struct file *file)
259{
260 struct net_device *net_dev = (struct net_device *)inode->i_private;
261 return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
262}
263
9e466250 264static int batadv_gateways_open(struct inode *inode, struct file *file)
c6c8fea2
SE
265{
266 struct net_device *net_dev = (struct net_device *)inode->i_private;
7cf06bc6 267 return single_open(file, batadv_gw_client_seq_print_text, net_dev);
c6c8fea2
SE
268}
269
9e466250 270static int batadv_transtable_global_open(struct inode *inode, struct file *file)
c6c8fea2
SE
271{
272 struct net_device *net_dev = (struct net_device *)inode->i_private;
08c36d3e 273 return single_open(file, batadv_tt_global_seq_print_text, net_dev);
c6c8fea2
SE
274}
275
7a5cc242 276#ifdef CONFIG_BATMAN_ADV_BLA
9e466250 277static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
9bf8e4d4
SW
278{
279 struct net_device *net_dev = (struct net_device *)inode->i_private;
08adf151
SE
280 return single_open(file, batadv_bla_claim_table_seq_print_text,
281 net_dev);
9bf8e4d4 282}
536a23f1
SW
283
284static int batadv_bla_backbone_table_open(struct inode *inode,
285 struct file *file)
286{
287 struct net_device *net_dev = (struct net_device *)inode->i_private;
288 return single_open(file, batadv_bla_backbone_table_seq_print_text,
289 net_dev);
290}
291
7a5cc242 292#endif
9bf8e4d4 293
17224474 294#ifdef CONFIG_BATMAN_ADV_DAT
2f1dfbe1
AQ
295/**
296 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
297 * @inode: inode which was opened
298 * @file: file handle to be initialized
299 */
300static int batadv_dat_cache_open(struct inode *inode, struct file *file)
301{
302 struct net_device *net_dev = (struct net_device *)inode->i_private;
303 return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
304}
17224474 305#endif
2f1dfbe1 306
9e466250 307static int batadv_transtable_local_open(struct inode *inode, struct file *file)
c6c8fea2
SE
308{
309 struct net_device *net_dev = (struct net_device *)inode->i_private;
08c36d3e 310 return single_open(file, batadv_tt_local_seq_print_text, net_dev);
c6c8fea2
SE
311}
312
7f223c0c 313struct batadv_debuginfo {
c6c8fea2
SE
314 struct attribute attr;
315 const struct file_operations fops;
316};
317
d56b1705
MH
318#ifdef CONFIG_BATMAN_ADV_NC
319static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
320{
321 struct net_device *net_dev = (struct net_device *)inode->i_private;
322 return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
323}
324#endif
325
347c80f0 326#define BATADV_DEBUGINFO(_name, _mode, _open) \
7f223c0c 327struct batadv_debuginfo batadv_debuginfo_##_name = { \
9e466250
SE
328 .attr = { .name = __stringify(_name), \
329 .mode = _mode, }, \
330 .fops = { .owner = THIS_MODULE, \
331 .open = _open, \
332 .read = seq_read, \
333 .llseek = seq_lseek, \
334 .release = single_release, \
335 } \
c6c8fea2
SE
336};
337
637fbd12
AQ
338/* the following attributes are general and therefore they will be directly
339 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
340 */
347c80f0 341static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
637fbd12
AQ
342
343static struct batadv_debuginfo *batadv_general_debuginfos[] = {
344 &batadv_debuginfo_routing_algos,
345 NULL,
346};
347
348/* The following attributes are per soft interface */
347c80f0
SE
349static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
350static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
351static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
352 batadv_transtable_global_open);
7a5cc242 353#ifdef CONFIG_BATMAN_ADV_BLA
347c80f0 354static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
536a23f1
SW
355static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
356 batadv_bla_backbone_table_open);
7a5cc242 357#endif
17224474 358#ifdef CONFIG_BATMAN_ADV_DAT
2f1dfbe1 359static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
17224474 360#endif
347c80f0
SE
361static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
362 batadv_transtable_local_open);
d56b1705
MH
363#ifdef CONFIG_BATMAN_ADV_NC
364static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
365#endif
c6c8fea2 366
7f223c0c 367static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
9e466250
SE
368 &batadv_debuginfo_originators,
369 &batadv_debuginfo_gateways,
370 &batadv_debuginfo_transtable_global,
7a5cc242 371#ifdef CONFIG_BATMAN_ADV_BLA
9e466250 372 &batadv_debuginfo_bla_claim_table,
536a23f1 373 &batadv_debuginfo_bla_backbone_table,
7a5cc242 374#endif
17224474 375#ifdef CONFIG_BATMAN_ADV_DAT
2f1dfbe1 376 &batadv_debuginfo_dat_cache,
17224474 377#endif
9e466250 378 &batadv_debuginfo_transtable_local,
d56b1705
MH
379#ifdef CONFIG_BATMAN_ADV_NC
380 &batadv_debuginfo_nc_nodes,
381#endif
c6c8fea2
SE
382 NULL,
383};
384
5bc7c1eb
SW
385#define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
386struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
387 .attr = { \
388 .name = __stringify(_name), \
389 .mode = _mode, \
390 }, \
391 .fops = { \
392 .owner = THIS_MODULE, \
393 .open = _open, \
394 .read = seq_read, \
395 .llseek = seq_lseek, \
396 .release = single_release, \
397 }, \
398};
cb1c92ec
SW
399static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
400 batadv_originators_hardif_open);
5bc7c1eb
SW
401
402static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
cb1c92ec 403 &batadv_hardif_debuginfo_originators,
5bc7c1eb
SW
404 NULL,
405};
406
40a072d7 407void batadv_debugfs_init(void)
c6c8fea2 408{
637fbd12 409 struct batadv_debuginfo **bat_debug;
1c280471
ML
410 struct dentry *file;
411
54590e4d 412 batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
9e466250
SE
413 if (batadv_debugfs == ERR_PTR(-ENODEV))
414 batadv_debugfs = NULL;
1c280471 415
9e466250 416 if (!batadv_debugfs)
637fbd12 417 goto err;
1c280471 418
637fbd12
AQ
419 for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
420 file = debugfs_create_file(((*bat_debug)->attr).name,
421 S_IFREG | ((*bat_debug)->attr).mode,
422 batadv_debugfs, NULL,
423 &(*bat_debug)->fops);
424 if (!file) {
425 pr_err("Can't add general debugfs file: %s\n",
426 ((*bat_debug)->attr).name);
427 goto err;
428 }
429 }
1c280471 430
1c280471 431 return;
637fbd12
AQ
432err:
433 debugfs_remove_recursive(batadv_debugfs);
5bc7c1eb 434 batadv_debugfs = NULL;
c6c8fea2
SE
435}
436
40a072d7 437void batadv_debugfs_destroy(void)
c6c8fea2 438{
3f87c423
AQ
439 debugfs_remove_recursive(batadv_debugfs);
440 batadv_debugfs = NULL;
c6c8fea2
SE
441}
442
5bc7c1eb
SW
443/**
444 * batadv_debugfs_add_hardif - creates the base directory for a hard interface
445 * in debugfs.
446 * @hard_iface: hard interface which should be added.
447 */
448int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
449{
450 struct batadv_debuginfo **bat_debug;
451 struct dentry *file;
452
453 if (!batadv_debugfs)
454 goto out;
455
456 hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
457 batadv_debugfs);
458 if (!hard_iface->debug_dir)
459 goto out;
460
461 for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
462 file = debugfs_create_file(((*bat_debug)->attr).name,
463 S_IFREG | ((*bat_debug)->attr).mode,
464 hard_iface->debug_dir,
465 hard_iface->net_dev,
466 &(*bat_debug)->fops);
467 if (!file)
468 goto rem_attr;
469 }
470
471 return 0;
472rem_attr:
473 debugfs_remove_recursive(hard_iface->debug_dir);
474 hard_iface->debug_dir = NULL;
475out:
476#ifdef CONFIG_DEBUG_FS
477 return -ENOMEM;
478#else
479 return 0;
480#endif /* CONFIG_DEBUG_FS */
481}
482
483/**
484 * batadv_debugfs_del_hardif - delete the base directory for a hard interface
485 * in debugfs.
486 * @hard_iface: hard interface which is deleted.
487 */
488void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
489{
490 if (batadv_debugfs) {
491 debugfs_remove_recursive(hard_iface->debug_dir);
492 hard_iface->debug_dir = NULL;
493 }
494}
495
40a072d7 496int batadv_debugfs_add_meshif(struct net_device *dev)
c6c8fea2 497{
56303d34 498 struct batadv_priv *bat_priv = netdev_priv(dev);
7f223c0c 499 struct batadv_debuginfo **bat_debug;
c6c8fea2
SE
500 struct dentry *file;
501
9e466250 502 if (!batadv_debugfs)
c6c8fea2
SE
503 goto out;
504
9e466250 505 bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
c6c8fea2
SE
506 if (!bat_priv->debug_dir)
507 goto out;
508
9039dc7e 509 if (batadv_socket_setup(bat_priv) < 0)
5346c35e
SE
510 goto rem_attr;
511
9e466250 512 if (batadv_debug_log_setup(bat_priv) < 0)
5346c35e 513 goto rem_attr;
c6c8fea2 514
9e466250 515 for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
c6c8fea2 516 file = debugfs_create_file(((*bat_debug)->attr).name,
0aca2369
SE
517 S_IFREG | ((*bat_debug)->attr).mode,
518 bat_priv->debug_dir,
519 dev, &(*bat_debug)->fops);
c6c8fea2 520 if (!file) {
3e34819e
SE
521 batadv_err(dev, "Can't add debugfs file: %s/%s\n",
522 dev->name, ((*bat_debug)->attr).name);
c6c8fea2
SE
523 goto rem_attr;
524 }
525 }
526
d56b1705
MH
527 if (batadv_nc_init_debugfs(bat_priv) < 0)
528 goto rem_attr;
529
c6c8fea2
SE
530 return 0;
531rem_attr:
532 debugfs_remove_recursive(bat_priv->debug_dir);
533 bat_priv->debug_dir = NULL;
534out:
535#ifdef CONFIG_DEBUG_FS
536 return -ENOMEM;
537#else
538 return 0;
539#endif /* CONFIG_DEBUG_FS */
540}
541
40a072d7 542void batadv_debugfs_del_meshif(struct net_device *dev)
c6c8fea2 543{
56303d34 544 struct batadv_priv *bat_priv = netdev_priv(dev);
c6c8fea2 545
9e466250 546 batadv_debug_log_cleanup(bat_priv);
c6c8fea2 547
9e466250 548 if (batadv_debugfs) {
c6c8fea2
SE
549 debugfs_remove_recursive(bat_priv->debug_dir);
550 bat_priv->debug_dir = NULL;
551 }
552}