Commit | Line | Data |
---|---|---|
c6c8fea2 | 1 | /* |
567db7b0 | 2 | * Copyright (C) 2010-2012 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 | |
16 | * along with this program; if not, write to the Free Software | |
17 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA | |
18 | * 02110-1301, USA | |
19 | * | |
20 | */ | |
21 | ||
22 | #include "main.h" | |
23 | ||
24 | #include <linux/debugfs.h> | |
25 | ||
26 | #include "bat_debugfs.h" | |
27 | #include "translation-table.h" | |
28 | #include "originator.h" | |
29 | #include "hard-interface.h" | |
30 | #include "gateway_common.h" | |
31 | #include "gateway_client.h" | |
32 | #include "soft-interface.h" | |
33 | #include "vis.h" | |
34 | #include "icmp_socket.h" | |
9bf8e4d4 | 35 | #include "bridge_loop_avoidance.h" |
c6c8fea2 SE |
36 | |
37 | static struct dentry *bat_debugfs; | |
38 | ||
39 | #ifdef CONFIG_BATMAN_ADV_DEBUG | |
40 | #define LOG_BUFF_MASK (log_buff_len-1) | |
41 | #define LOG_BUFF(idx) (debug_log->log_buff[(idx) & LOG_BUFF_MASK]) | |
42 | ||
43 | static int log_buff_len = LOG_BUF_LEN; | |
44 | ||
45 | static void emit_log_char(struct debug_log *debug_log, char c) | |
46 | { | |
47 | LOG_BUFF(debug_log->log_end) = c; | |
48 | debug_log->log_end++; | |
49 | ||
50 | if (debug_log->log_end - debug_log->log_start > log_buff_len) | |
51 | debug_log->log_start = debug_log->log_end - log_buff_len; | |
52 | } | |
53 | ||
d3a547be | 54 | __printf(2, 3) |
747e4221 | 55 | static int fdebug_log(struct debug_log *debug_log, const char *fmt, ...) |
c6c8fea2 | 56 | { |
c6c8fea2 SE |
57 | va_list args; |
58 | static char debug_log_buf[256]; | |
59 | char *p; | |
60 | ||
61 | if (!debug_log) | |
62 | return 0; | |
63 | ||
64 | spin_lock_bh(&debug_log->lock); | |
65 | va_start(args, fmt); | |
1299bdaa | 66 | vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args); |
c6c8fea2 SE |
67 | va_end(args); |
68 | ||
69 | for (p = debug_log_buf; *p != 0; p++) | |
70 | emit_log_char(debug_log, *p); | |
71 | ||
72 | spin_unlock_bh(&debug_log->lock); | |
73 | ||
74 | wake_up(&debug_log->queue_wait); | |
75 | ||
76 | return 0; | |
77 | } | |
78 | ||
40a072d7 | 79 | int batadv_debug_log(struct bat_priv *bat_priv, const char *fmt, ...) |
c6c8fea2 SE |
80 | { |
81 | va_list args; | |
82 | char tmp_log_buf[256]; | |
83 | ||
84 | va_start(args, fmt); | |
85 | vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args); | |
0b0094e0 ML |
86 | fdebug_log(bat_priv->debug_log, "[%10u] %s", |
87 | jiffies_to_msecs(jiffies), tmp_log_buf); | |
c6c8fea2 SE |
88 | va_end(args); |
89 | ||
90 | return 0; | |
91 | } | |
92 | ||
93 | static int log_open(struct inode *inode, struct file *file) | |
94 | { | |
95 | nonseekable_open(inode, file); | |
96 | file->private_data = inode->i_private; | |
3193e8fd | 97 | batadv_inc_module_count(); |
c6c8fea2 SE |
98 | return 0; |
99 | } | |
100 | ||
101 | static int log_release(struct inode *inode, struct file *file) | |
102 | { | |
3193e8fd | 103 | batadv_dec_module_count(); |
c6c8fea2 SE |
104 | return 0; |
105 | } | |
106 | ||
107 | static ssize_t log_read(struct file *file, char __user *buf, | |
108 | size_t count, loff_t *ppos) | |
109 | { | |
110 | struct bat_priv *bat_priv = file->private_data; | |
111 | struct debug_log *debug_log = bat_priv->debug_log; | |
112 | int error, i = 0; | |
113 | char c; | |
114 | ||
115 | if ((file->f_flags & O_NONBLOCK) && | |
116 | !(debug_log->log_end - debug_log->log_start)) | |
117 | return -EAGAIN; | |
118 | ||
16f14b45 | 119 | if (!buf) |
c6c8fea2 SE |
120 | return -EINVAL; |
121 | ||
122 | if (count == 0) | |
123 | return 0; | |
124 | ||
125 | if (!access_ok(VERIFY_WRITE, buf, count)) | |
126 | return -EFAULT; | |
127 | ||
128 | error = wait_event_interruptible(debug_log->queue_wait, | |
129 | (debug_log->log_start - debug_log->log_end)); | |
130 | ||
131 | if (error) | |
132 | return error; | |
133 | ||
134 | spin_lock_bh(&debug_log->lock); | |
135 | ||
136 | while ((!error) && (i < count) && | |
137 | (debug_log->log_start != debug_log->log_end)) { | |
138 | c = LOG_BUFF(debug_log->log_start); | |
139 | ||
140 | debug_log->log_start++; | |
141 | ||
142 | spin_unlock_bh(&debug_log->lock); | |
143 | ||
144 | error = __put_user(c, buf); | |
145 | ||
146 | spin_lock_bh(&debug_log->lock); | |
147 | ||
148 | buf++; | |
149 | i++; | |
150 | ||
151 | } | |
152 | ||
153 | spin_unlock_bh(&debug_log->lock); | |
154 | ||
155 | if (!error) | |
156 | return i; | |
157 | ||
158 | return error; | |
159 | } | |
160 | ||
161 | static unsigned int log_poll(struct file *file, poll_table *wait) | |
162 | { | |
163 | struct bat_priv *bat_priv = file->private_data; | |
164 | struct debug_log *debug_log = bat_priv->debug_log; | |
165 | ||
166 | poll_wait(file, &debug_log->queue_wait, wait); | |
167 | ||
168 | if (debug_log->log_end - debug_log->log_start) | |
169 | return POLLIN | POLLRDNORM; | |
170 | ||
171 | return 0; | |
172 | } | |
173 | ||
174 | static const struct file_operations log_fops = { | |
175 | .open = log_open, | |
176 | .release = log_release, | |
177 | .read = log_read, | |
178 | .poll = log_poll, | |
179 | .llseek = no_llseek, | |
180 | }; | |
181 | ||
182 | static int debug_log_setup(struct bat_priv *bat_priv) | |
183 | { | |
184 | struct dentry *d; | |
185 | ||
186 | if (!bat_priv->debug_dir) | |
187 | goto err; | |
188 | ||
704509b8 | 189 | bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC); |
c6c8fea2 SE |
190 | if (!bat_priv->debug_log) |
191 | goto err; | |
192 | ||
193 | spin_lock_init(&bat_priv->debug_log->lock); | |
194 | init_waitqueue_head(&bat_priv->debug_log->queue_wait); | |
195 | ||
196 | d = debugfs_create_file("log", S_IFREG | S_IRUSR, | |
197 | bat_priv->debug_dir, bat_priv, &log_fops); | |
5346c35e | 198 | if (!d) |
c6c8fea2 SE |
199 | goto err; |
200 | ||
201 | return 0; | |
202 | ||
203 | err: | |
5346c35e | 204 | return -ENOMEM; |
c6c8fea2 SE |
205 | } |
206 | ||
207 | static void debug_log_cleanup(struct bat_priv *bat_priv) | |
208 | { | |
209 | kfree(bat_priv->debug_log); | |
210 | bat_priv->debug_log = NULL; | |
211 | } | |
212 | #else /* CONFIG_BATMAN_ADV_DEBUG */ | |
213 | static int debug_log_setup(struct bat_priv *bat_priv) | |
214 | { | |
215 | bat_priv->debug_log = NULL; | |
216 | return 0; | |
217 | } | |
218 | ||
219 | static void debug_log_cleanup(struct bat_priv *bat_priv) | |
220 | { | |
221 | return; | |
222 | } | |
223 | #endif | |
224 | ||
1c280471 ML |
225 | static int bat_algorithms_open(struct inode *inode, struct file *file) |
226 | { | |
3193e8fd | 227 | return single_open(file, batadv_algo_seq_print_text, NULL); |
1c280471 ML |
228 | } |
229 | ||
c6c8fea2 SE |
230 | static int originators_open(struct inode *inode, struct file *file) |
231 | { | |
232 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
7d211efc | 233 | return single_open(file, batadv_orig_seq_print_text, net_dev); |
c6c8fea2 SE |
234 | } |
235 | ||
236 | static int gateways_open(struct inode *inode, struct file *file) | |
237 | { | |
238 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
7cf06bc6 | 239 | return single_open(file, batadv_gw_client_seq_print_text, net_dev); |
c6c8fea2 SE |
240 | } |
241 | ||
c6c8fea2 SE |
242 | static int transtable_global_open(struct inode *inode, struct file *file) |
243 | { | |
244 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
08c36d3e | 245 | return single_open(file, batadv_tt_global_seq_print_text, net_dev); |
c6c8fea2 SE |
246 | } |
247 | ||
7a5cc242 | 248 | #ifdef CONFIG_BATMAN_ADV_BLA |
9bf8e4d4 SW |
249 | static int bla_claim_table_open(struct inode *inode, struct file *file) |
250 | { | |
251 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
08adf151 SE |
252 | return single_open(file, batadv_bla_claim_table_seq_print_text, |
253 | net_dev); | |
9bf8e4d4 | 254 | } |
7a5cc242 | 255 | #endif |
9bf8e4d4 | 256 | |
c6c8fea2 SE |
257 | static int transtable_local_open(struct inode *inode, struct file *file) |
258 | { | |
259 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
08c36d3e | 260 | return single_open(file, batadv_tt_local_seq_print_text, net_dev); |
c6c8fea2 SE |
261 | } |
262 | ||
263 | static int vis_data_open(struct inode *inode, struct file *file) | |
264 | { | |
265 | struct net_device *net_dev = (struct net_device *)inode->i_private; | |
d0f714f4 | 266 | return single_open(file, batadv_vis_seq_print_text, net_dev); |
c6c8fea2 SE |
267 | } |
268 | ||
269 | struct bat_debuginfo { | |
270 | struct attribute attr; | |
271 | const struct file_operations fops; | |
272 | }; | |
273 | ||
274 | #define BAT_DEBUGINFO(_name, _mode, _open) \ | |
275 | struct bat_debuginfo bat_debuginfo_##_name = { \ | |
276 | .attr = { .name = __stringify(_name), \ | |
277 | .mode = _mode, }, \ | |
278 | .fops = { .owner = THIS_MODULE, \ | |
279 | .open = _open, \ | |
280 | .read = seq_read, \ | |
281 | .llseek = seq_lseek, \ | |
282 | .release = single_release, \ | |
283 | } \ | |
284 | }; | |
285 | ||
1c280471 | 286 | static BAT_DEBUGINFO(routing_algos, S_IRUGO, bat_algorithms_open); |
c6c8fea2 SE |
287 | static BAT_DEBUGINFO(originators, S_IRUGO, originators_open); |
288 | static BAT_DEBUGINFO(gateways, S_IRUGO, gateways_open); | |
c6c8fea2 | 289 | static BAT_DEBUGINFO(transtable_global, S_IRUGO, transtable_global_open); |
7a5cc242 | 290 | #ifdef CONFIG_BATMAN_ADV_BLA |
9bf8e4d4 | 291 | static BAT_DEBUGINFO(bla_claim_table, S_IRUGO, bla_claim_table_open); |
7a5cc242 | 292 | #endif |
c6c8fea2 SE |
293 | static BAT_DEBUGINFO(transtable_local, S_IRUGO, transtable_local_open); |
294 | static BAT_DEBUGINFO(vis_data, S_IRUGO, vis_data_open); | |
295 | ||
296 | static struct bat_debuginfo *mesh_debuginfos[] = { | |
297 | &bat_debuginfo_originators, | |
298 | &bat_debuginfo_gateways, | |
c6c8fea2 | 299 | &bat_debuginfo_transtable_global, |
7a5cc242 | 300 | #ifdef CONFIG_BATMAN_ADV_BLA |
9bf8e4d4 | 301 | &bat_debuginfo_bla_claim_table, |
7a5cc242 | 302 | #endif |
c6c8fea2 SE |
303 | &bat_debuginfo_transtable_local, |
304 | &bat_debuginfo_vis_data, | |
305 | NULL, | |
306 | }; | |
307 | ||
40a072d7 | 308 | void batadv_debugfs_init(void) |
c6c8fea2 | 309 | { |
1c280471 ML |
310 | struct bat_debuginfo *bat_debug; |
311 | struct dentry *file; | |
312 | ||
c6c8fea2 SE |
313 | bat_debugfs = debugfs_create_dir(DEBUGFS_BAT_SUBDIR, NULL); |
314 | if (bat_debugfs == ERR_PTR(-ENODEV)) | |
315 | bat_debugfs = NULL; | |
1c280471 ML |
316 | |
317 | if (!bat_debugfs) | |
318 | goto out; | |
319 | ||
320 | bat_debug = &bat_debuginfo_routing_algos; | |
321 | file = debugfs_create_file(bat_debug->attr.name, | |
322 | S_IFREG | bat_debug->attr.mode, | |
323 | bat_debugfs, NULL, &bat_debug->fops); | |
324 | if (!file) | |
325 | pr_err("Can't add debugfs file: %s\n", bat_debug->attr.name); | |
326 | ||
327 | out: | |
328 | return; | |
c6c8fea2 SE |
329 | } |
330 | ||
40a072d7 | 331 | void batadv_debugfs_destroy(void) |
c6c8fea2 SE |
332 | { |
333 | if (bat_debugfs) { | |
334 | debugfs_remove_recursive(bat_debugfs); | |
335 | bat_debugfs = NULL; | |
336 | } | |
337 | } | |
338 | ||
40a072d7 | 339 | int batadv_debugfs_add_meshif(struct net_device *dev) |
c6c8fea2 SE |
340 | { |
341 | struct bat_priv *bat_priv = netdev_priv(dev); | |
342 | struct bat_debuginfo **bat_debug; | |
343 | struct dentry *file; | |
344 | ||
345 | if (!bat_debugfs) | |
346 | goto out; | |
347 | ||
348 | bat_priv->debug_dir = debugfs_create_dir(dev->name, bat_debugfs); | |
349 | if (!bat_priv->debug_dir) | |
350 | goto out; | |
351 | ||
9039dc7e | 352 | if (batadv_socket_setup(bat_priv) < 0) |
5346c35e SE |
353 | goto rem_attr; |
354 | ||
355 | if (debug_log_setup(bat_priv) < 0) | |
356 | goto rem_attr; | |
c6c8fea2 SE |
357 | |
358 | for (bat_debug = mesh_debuginfos; *bat_debug; ++bat_debug) { | |
359 | file = debugfs_create_file(((*bat_debug)->attr).name, | |
360 | S_IFREG | ((*bat_debug)->attr).mode, | |
361 | bat_priv->debug_dir, | |
362 | dev, &(*bat_debug)->fops); | |
363 | if (!file) { | |
364 | bat_err(dev, "Can't add debugfs file: %s/%s\n", | |
365 | dev->name, ((*bat_debug)->attr).name); | |
366 | goto rem_attr; | |
367 | } | |
368 | } | |
369 | ||
370 | return 0; | |
371 | rem_attr: | |
372 | debugfs_remove_recursive(bat_priv->debug_dir); | |
373 | bat_priv->debug_dir = NULL; | |
374 | out: | |
375 | #ifdef CONFIG_DEBUG_FS | |
376 | return -ENOMEM; | |
377 | #else | |
378 | return 0; | |
379 | #endif /* CONFIG_DEBUG_FS */ | |
380 | } | |
381 | ||
40a072d7 | 382 | void batadv_debugfs_del_meshif(struct net_device *dev) |
c6c8fea2 SE |
383 | { |
384 | struct bat_priv *bat_priv = netdev_priv(dev); | |
385 | ||
386 | debug_log_cleanup(bat_priv); | |
387 | ||
388 | if (bat_debugfs) { | |
389 | debugfs_remove_recursive(bat_priv->debug_dir); | |
390 | bat_priv->debug_dir = NULL; | |
391 | } | |
392 | } |