Loading...
1// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2/*
3 * proc.c - procfs support for Protocol family CAN core module
4 *
5 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of Volkswagen nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * Alternatively, provided that this notice is retained in full, this
21 * software may be distributed under the terms of the GNU General
22 * Public License ("GPL") version 2, in which case the provisions of the
23 * GPL apply INSTEAD OF those given above.
24 *
25 * The provided data structures and external interfaces from this code
26 * are not restricted to be used by modules with a GPL compatible license.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
39 * DAMAGE.
40 *
41 */
42
43#include <linux/module.h>
44#include <linux/proc_fs.h>
45#include <linux/list.h>
46#include <linux/rcupdate.h>
47#include <linux/if_arp.h>
48#include <linux/can/can-ml.h>
49#include <linux/can/core.h>
50
51#include "af_can.h"
52
53/*
54 * proc filenames for the PF_CAN core
55 */
56
57#define CAN_PROC_STATS "stats"
58#define CAN_PROC_RESET_STATS "reset_stats"
59#define CAN_PROC_RCVLIST_ALL "rcvlist_all"
60#define CAN_PROC_RCVLIST_FIL "rcvlist_fil"
61#define CAN_PROC_RCVLIST_INV "rcvlist_inv"
62#define CAN_PROC_RCVLIST_SFF "rcvlist_sff"
63#define CAN_PROC_RCVLIST_EFF "rcvlist_eff"
64#define CAN_PROC_RCVLIST_ERR "rcvlist_err"
65
66static int user_reset;
67
68static const char rx_list_name[][8] = {
69 [RX_ERR] = "rx_err",
70 [RX_ALL] = "rx_all",
71 [RX_FIL] = "rx_fil",
72 [RX_INV] = "rx_inv",
73};
74
75/*
76 * af_can statistics stuff
77 */
78
79static void can_init_stats(struct net *net)
80{
81 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
82 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
83 /*
84 * This memset function is called from a timer context (when
85 * can_stattimer is active which is the default) OR in a process
86 * context (reading the proc_fs when can_stattimer is disabled).
87 */
88 memset(pkg_stats, 0, sizeof(struct can_pkg_stats));
89 pkg_stats->jiffies_init = jiffies;
90
91 rcv_lists_stats->stats_reset++;
92
93 if (user_reset) {
94 user_reset = 0;
95 rcv_lists_stats->user_reset++;
96 }
97}
98
99static unsigned long calc_rate(unsigned long oldjif, unsigned long newjif,
100 unsigned long count)
101{
102 if (oldjif == newjif)
103 return 0;
104
105 /* see can_stat_update() - this should NEVER happen! */
106 if (count > (ULONG_MAX / HZ)) {
107 printk(KERN_ERR "can: calc_rate: count exceeded! %ld\n",
108 count);
109 return 99999999;
110 }
111
112 return (count * HZ) / (newjif - oldjif);
113}
114
115void can_stat_update(struct timer_list *t)
116{
117 struct net *net = from_timer(net, t, can.stattimer);
118 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
119 unsigned long j = jiffies; /* snapshot */
120
121 /* restart counting in timer context on user request */
122 if (user_reset)
123 can_init_stats(net);
124
125 /* restart counting on jiffies overflow */
126 if (j < pkg_stats->jiffies_init)
127 can_init_stats(net);
128
129 /* prevent overflow in calc_rate() */
130 if (pkg_stats->rx_frames > (ULONG_MAX / HZ))
131 can_init_stats(net);
132
133 /* prevent overflow in calc_rate() */
134 if (pkg_stats->tx_frames > (ULONG_MAX / HZ))
135 can_init_stats(net);
136
137 /* matches overflow - very improbable */
138 if (pkg_stats->matches > (ULONG_MAX / 100))
139 can_init_stats(net);
140
141 /* calc total values */
142 if (pkg_stats->rx_frames)
143 pkg_stats->total_rx_match_ratio = (pkg_stats->matches * 100) /
144 pkg_stats->rx_frames;
145
146 pkg_stats->total_tx_rate = calc_rate(pkg_stats->jiffies_init, j,
147 pkg_stats->tx_frames);
148 pkg_stats->total_rx_rate = calc_rate(pkg_stats->jiffies_init, j,
149 pkg_stats->rx_frames);
150
151 /* calc current values */
152 if (pkg_stats->rx_frames_delta)
153 pkg_stats->current_rx_match_ratio =
154 (pkg_stats->matches_delta * 100) /
155 pkg_stats->rx_frames_delta;
156
157 pkg_stats->current_tx_rate = calc_rate(0, HZ, pkg_stats->tx_frames_delta);
158 pkg_stats->current_rx_rate = calc_rate(0, HZ, pkg_stats->rx_frames_delta);
159
160 /* check / update maximum values */
161 if (pkg_stats->max_tx_rate < pkg_stats->current_tx_rate)
162 pkg_stats->max_tx_rate = pkg_stats->current_tx_rate;
163
164 if (pkg_stats->max_rx_rate < pkg_stats->current_rx_rate)
165 pkg_stats->max_rx_rate = pkg_stats->current_rx_rate;
166
167 if (pkg_stats->max_rx_match_ratio < pkg_stats->current_rx_match_ratio)
168 pkg_stats->max_rx_match_ratio = pkg_stats->current_rx_match_ratio;
169
170 /* clear values for 'current rate' calculation */
171 pkg_stats->tx_frames_delta = 0;
172 pkg_stats->rx_frames_delta = 0;
173 pkg_stats->matches_delta = 0;
174
175 /* restart timer (one second) */
176 mod_timer(&net->can.stattimer, round_jiffies(jiffies + HZ));
177}
178
179/*
180 * proc read functions
181 */
182
183static void can_print_rcvlist(struct seq_file *m, struct hlist_head *rx_list,
184 struct net_device *dev)
185{
186 struct receiver *r;
187
188 hlist_for_each_entry_rcu(r, rx_list, list) {
189 char *fmt = (r->can_id & CAN_EFF_FLAG)?
190 " %-5s %08x %08x %pK %pK %8ld %s\n" :
191 " %-5s %03x %08x %pK %pK %8ld %s\n";
192
193 seq_printf(m, fmt, DNAME(dev), r->can_id, r->mask,
194 r->func, r->data, r->matches, r->ident);
195 }
196}
197
198static void can_print_recv_banner(struct seq_file *m)
199{
200 /*
201 * can1. 00000000 00000000 00000000
202 * ....... 0 tp20
203 */
204 if (IS_ENABLED(CONFIG_64BIT))
205 seq_puts(m, " device can_id can_mask function userdata matches ident\n");
206 else
207 seq_puts(m, " device can_id can_mask function userdata matches ident\n");
208}
209
210static int can_stats_proc_show(struct seq_file *m, void *v)
211{
212 struct net *net = m->private;
213 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
214 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
215
216 seq_putc(m, '\n');
217 seq_printf(m, " %8ld transmitted frames (TXF)\n", pkg_stats->tx_frames);
218 seq_printf(m, " %8ld received frames (RXF)\n", pkg_stats->rx_frames);
219 seq_printf(m, " %8ld matched frames (RXMF)\n", pkg_stats->matches);
220
221 seq_putc(m, '\n');
222
223 if (net->can.stattimer.function == can_stat_update) {
224 seq_printf(m, " %8ld %% total match ratio (RXMR)\n",
225 pkg_stats->total_rx_match_ratio);
226
227 seq_printf(m, " %8ld frames/s total tx rate (TXR)\n",
228 pkg_stats->total_tx_rate);
229 seq_printf(m, " %8ld frames/s total rx rate (RXR)\n",
230 pkg_stats->total_rx_rate);
231
232 seq_putc(m, '\n');
233
234 seq_printf(m, " %8ld %% current match ratio (CRXMR)\n",
235 pkg_stats->current_rx_match_ratio);
236
237 seq_printf(m, " %8ld frames/s current tx rate (CTXR)\n",
238 pkg_stats->current_tx_rate);
239 seq_printf(m, " %8ld frames/s current rx rate (CRXR)\n",
240 pkg_stats->current_rx_rate);
241
242 seq_putc(m, '\n');
243
244 seq_printf(m, " %8ld %% max match ratio (MRXMR)\n",
245 pkg_stats->max_rx_match_ratio);
246
247 seq_printf(m, " %8ld frames/s max tx rate (MTXR)\n",
248 pkg_stats->max_tx_rate);
249 seq_printf(m, " %8ld frames/s max rx rate (MRXR)\n",
250 pkg_stats->max_rx_rate);
251
252 seq_putc(m, '\n');
253 }
254
255 seq_printf(m, " %8ld current receive list entries (CRCV)\n",
256 rcv_lists_stats->rcv_entries);
257 seq_printf(m, " %8ld maximum receive list entries (MRCV)\n",
258 rcv_lists_stats->rcv_entries_max);
259
260 if (rcv_lists_stats->stats_reset)
261 seq_printf(m, "\n %8ld statistic resets (STR)\n",
262 rcv_lists_stats->stats_reset);
263
264 if (rcv_lists_stats->user_reset)
265 seq_printf(m, " %8ld user statistic resets (USTR)\n",
266 rcv_lists_stats->user_reset);
267
268 seq_putc(m, '\n');
269 return 0;
270}
271
272static int can_reset_stats_proc_show(struct seq_file *m, void *v)
273{
274 struct net *net = m->private;
275 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
276 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
277
278 user_reset = 1;
279
280 if (net->can.stattimer.function == can_stat_update) {
281 seq_printf(m, "Scheduled statistic reset #%ld.\n",
282 rcv_lists_stats->stats_reset + 1);
283 } else {
284 if (pkg_stats->jiffies_init != jiffies)
285 can_init_stats(net);
286
287 seq_printf(m, "Performed statistic reset #%ld.\n",
288 rcv_lists_stats->stats_reset);
289 }
290 return 0;
291}
292
293static inline void can_rcvlist_proc_show_one(struct seq_file *m, int idx,
294 struct net_device *dev,
295 struct can_dev_rcv_lists *dev_rcv_lists)
296{
297 if (!hlist_empty(&dev_rcv_lists->rx[idx])) {
298 can_print_recv_banner(m);
299 can_print_rcvlist(m, &dev_rcv_lists->rx[idx], dev);
300 } else
301 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
302
303}
304
305static int can_rcvlist_proc_show(struct seq_file *m, void *v)
306{
307 /* double cast to prevent GCC warning */
308 int idx = (int)(long)pde_data(m->file->f_inode);
309 struct net_device *dev;
310 struct can_dev_rcv_lists *dev_rcv_lists;
311 struct net *net = m->private;
312
313 seq_printf(m, "\nreceive list '%s':\n", rx_list_name[idx]);
314
315 rcu_read_lock();
316
317 /* receive list for 'all' CAN devices (dev == NULL) */
318 dev_rcv_lists = net->can.rx_alldev_list;
319 can_rcvlist_proc_show_one(m, idx, NULL, dev_rcv_lists);
320
321 /* receive list for registered CAN devices */
322 for_each_netdev_rcu(net, dev) {
323 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
324
325 if (can_ml)
326 can_rcvlist_proc_show_one(m, idx, dev,
327 &can_ml->dev_rcv_lists);
328 }
329
330 rcu_read_unlock();
331
332 seq_putc(m, '\n');
333 return 0;
334}
335
336static inline void can_rcvlist_proc_show_array(struct seq_file *m,
337 struct net_device *dev,
338 struct hlist_head *rcv_array,
339 unsigned int rcv_array_sz)
340{
341 unsigned int i;
342 int all_empty = 1;
343
344 /* check whether at least one list is non-empty */
345 for (i = 0; i < rcv_array_sz; i++)
346 if (!hlist_empty(&rcv_array[i])) {
347 all_empty = 0;
348 break;
349 }
350
351 if (!all_empty) {
352 can_print_recv_banner(m);
353 for (i = 0; i < rcv_array_sz; i++) {
354 if (!hlist_empty(&rcv_array[i]))
355 can_print_rcvlist(m, &rcv_array[i], dev);
356 }
357 } else
358 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
359}
360
361static int can_rcvlist_sff_proc_show(struct seq_file *m, void *v)
362{
363 struct net_device *dev;
364 struct can_dev_rcv_lists *dev_rcv_lists;
365 struct net *net = m->private;
366
367 /* RX_SFF */
368 seq_puts(m, "\nreceive list 'rx_sff':\n");
369
370 rcu_read_lock();
371
372 /* sff receive list for 'all' CAN devices (dev == NULL) */
373 dev_rcv_lists = net->can.rx_alldev_list;
374 can_rcvlist_proc_show_array(m, NULL, dev_rcv_lists->rx_sff,
375 ARRAY_SIZE(dev_rcv_lists->rx_sff));
376
377 /* sff receive list for registered CAN devices */
378 for_each_netdev_rcu(net, dev) {
379 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
380
381 if (can_ml) {
382 dev_rcv_lists = &can_ml->dev_rcv_lists;
383 can_rcvlist_proc_show_array(m, dev, dev_rcv_lists->rx_sff,
384 ARRAY_SIZE(dev_rcv_lists->rx_sff));
385 }
386 }
387
388 rcu_read_unlock();
389
390 seq_putc(m, '\n');
391 return 0;
392}
393
394static int can_rcvlist_eff_proc_show(struct seq_file *m, void *v)
395{
396 struct net_device *dev;
397 struct can_dev_rcv_lists *dev_rcv_lists;
398 struct net *net = m->private;
399
400 /* RX_EFF */
401 seq_puts(m, "\nreceive list 'rx_eff':\n");
402
403 rcu_read_lock();
404
405 /* eff receive list for 'all' CAN devices (dev == NULL) */
406 dev_rcv_lists = net->can.rx_alldev_list;
407 can_rcvlist_proc_show_array(m, NULL, dev_rcv_lists->rx_eff,
408 ARRAY_SIZE(dev_rcv_lists->rx_eff));
409
410 /* eff receive list for registered CAN devices */
411 for_each_netdev_rcu(net, dev) {
412 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
413
414 if (can_ml) {
415 dev_rcv_lists = &can_ml->dev_rcv_lists;
416 can_rcvlist_proc_show_array(m, dev, dev_rcv_lists->rx_eff,
417 ARRAY_SIZE(dev_rcv_lists->rx_eff));
418 }
419 }
420
421 rcu_read_unlock();
422
423 seq_putc(m, '\n');
424 return 0;
425}
426
427/*
428 * can_init_proc - create main CAN proc directory and procfs entries
429 */
430void can_init_proc(struct net *net)
431{
432 /* create /proc/net/can directory */
433 net->can.proc_dir = proc_net_mkdir(net, "can", net->proc_net);
434
435 if (!net->can.proc_dir) {
436 printk(KERN_INFO "can: failed to create /proc/net/can . "
437 "CONFIG_PROC_FS missing?\n");
438 return;
439 }
440
441 /* own procfs entries from the AF_CAN core */
442 net->can.pde_stats = proc_create_net_single(CAN_PROC_STATS, 0644,
443 net->can.proc_dir, can_stats_proc_show, NULL);
444 net->can.pde_reset_stats = proc_create_net_single(CAN_PROC_RESET_STATS,
445 0644, net->can.proc_dir, can_reset_stats_proc_show,
446 NULL);
447 net->can.pde_rcvlist_err = proc_create_net_single(CAN_PROC_RCVLIST_ERR,
448 0644, net->can.proc_dir, can_rcvlist_proc_show,
449 (void *)RX_ERR);
450 net->can.pde_rcvlist_all = proc_create_net_single(CAN_PROC_RCVLIST_ALL,
451 0644, net->can.proc_dir, can_rcvlist_proc_show,
452 (void *)RX_ALL);
453 net->can.pde_rcvlist_fil = proc_create_net_single(CAN_PROC_RCVLIST_FIL,
454 0644, net->can.proc_dir, can_rcvlist_proc_show,
455 (void *)RX_FIL);
456 net->can.pde_rcvlist_inv = proc_create_net_single(CAN_PROC_RCVLIST_INV,
457 0644, net->can.proc_dir, can_rcvlist_proc_show,
458 (void *)RX_INV);
459 net->can.pde_rcvlist_eff = proc_create_net_single(CAN_PROC_RCVLIST_EFF,
460 0644, net->can.proc_dir, can_rcvlist_eff_proc_show, NULL);
461 net->can.pde_rcvlist_sff = proc_create_net_single(CAN_PROC_RCVLIST_SFF,
462 0644, net->can.proc_dir, can_rcvlist_sff_proc_show, NULL);
463}
464
465/*
466 * can_remove_proc - remove procfs entries and main CAN proc directory
467 */
468void can_remove_proc(struct net *net)
469{
470 if (!net->can.proc_dir)
471 return;
472
473 if (net->can.pde_stats)
474 remove_proc_entry(CAN_PROC_STATS, net->can.proc_dir);
475
476 if (net->can.pde_reset_stats)
477 remove_proc_entry(CAN_PROC_RESET_STATS, net->can.proc_dir);
478
479 if (net->can.pde_rcvlist_err)
480 remove_proc_entry(CAN_PROC_RCVLIST_ERR, net->can.proc_dir);
481
482 if (net->can.pde_rcvlist_all)
483 remove_proc_entry(CAN_PROC_RCVLIST_ALL, net->can.proc_dir);
484
485 if (net->can.pde_rcvlist_fil)
486 remove_proc_entry(CAN_PROC_RCVLIST_FIL, net->can.proc_dir);
487
488 if (net->can.pde_rcvlist_inv)
489 remove_proc_entry(CAN_PROC_RCVLIST_INV, net->can.proc_dir);
490
491 if (net->can.pde_rcvlist_eff)
492 remove_proc_entry(CAN_PROC_RCVLIST_EFF, net->can.proc_dir);
493
494 if (net->can.pde_rcvlist_sff)
495 remove_proc_entry(CAN_PROC_RCVLIST_SFF, net->can.proc_dir);
496
497 remove_proc_entry("can", net->proc_net);
498}
1/*
2 * proc.c - procfs support for Protocol family CAN core module
3 *
4 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of Volkswagen nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * Alternatively, provided that this notice is retained in full, this
20 * software may be distributed under the terms of the GNU General
21 * Public License ("GPL") version 2, in which case the provisions of the
22 * GPL apply INSTEAD OF those given above.
23 *
24 * The provided data structures and external interfaces from this code
25 * are not restricted to be used by modules with a GPL compatible license.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
38 * DAMAGE.
39 *
40 */
41
42#include <linux/module.h>
43#include <linux/proc_fs.h>
44#include <linux/list.h>
45#include <linux/rcupdate.h>
46#include <linux/if_arp.h>
47#include <linux/can/core.h>
48
49#include "af_can.h"
50
51/*
52 * proc filenames for the PF_CAN core
53 */
54
55#define CAN_PROC_VERSION "version"
56#define CAN_PROC_STATS "stats"
57#define CAN_PROC_RESET_STATS "reset_stats"
58#define CAN_PROC_RCVLIST_ALL "rcvlist_all"
59#define CAN_PROC_RCVLIST_FIL "rcvlist_fil"
60#define CAN_PROC_RCVLIST_INV "rcvlist_inv"
61#define CAN_PROC_RCVLIST_SFF "rcvlist_sff"
62#define CAN_PROC_RCVLIST_EFF "rcvlist_eff"
63#define CAN_PROC_RCVLIST_ERR "rcvlist_err"
64
65static struct proc_dir_entry *can_dir;
66static struct proc_dir_entry *pde_version;
67static struct proc_dir_entry *pde_stats;
68static struct proc_dir_entry *pde_reset_stats;
69static struct proc_dir_entry *pde_rcvlist_all;
70static struct proc_dir_entry *pde_rcvlist_fil;
71static struct proc_dir_entry *pde_rcvlist_inv;
72static struct proc_dir_entry *pde_rcvlist_sff;
73static struct proc_dir_entry *pde_rcvlist_eff;
74static struct proc_dir_entry *pde_rcvlist_err;
75
76static int user_reset;
77
78static const char rx_list_name[][8] = {
79 [RX_ERR] = "rx_err",
80 [RX_ALL] = "rx_all",
81 [RX_FIL] = "rx_fil",
82 [RX_INV] = "rx_inv",
83};
84
85/*
86 * af_can statistics stuff
87 */
88
89static void can_init_stats(void)
90{
91 /*
92 * This memset function is called from a timer context (when
93 * can_stattimer is active which is the default) OR in a process
94 * context (reading the proc_fs when can_stattimer is disabled).
95 */
96 memset(&can_stats, 0, sizeof(can_stats));
97 can_stats.jiffies_init = jiffies;
98
99 can_pstats.stats_reset++;
100
101 if (user_reset) {
102 user_reset = 0;
103 can_pstats.user_reset++;
104 }
105}
106
107static unsigned long calc_rate(unsigned long oldjif, unsigned long newjif,
108 unsigned long count)
109{
110 unsigned long rate;
111
112 if (oldjif == newjif)
113 return 0;
114
115 /* see can_stat_update() - this should NEVER happen! */
116 if (count > (ULONG_MAX / HZ)) {
117 printk(KERN_ERR "can: calc_rate: count exceeded! %ld\n",
118 count);
119 return 99999999;
120 }
121
122 rate = (count * HZ) / (newjif - oldjif);
123
124 return rate;
125}
126
127void can_stat_update(unsigned long data)
128{
129 unsigned long j = jiffies; /* snapshot */
130
131 /* restart counting in timer context on user request */
132 if (user_reset)
133 can_init_stats();
134
135 /* restart counting on jiffies overflow */
136 if (j < can_stats.jiffies_init)
137 can_init_stats();
138
139 /* prevent overflow in calc_rate() */
140 if (can_stats.rx_frames > (ULONG_MAX / HZ))
141 can_init_stats();
142
143 /* prevent overflow in calc_rate() */
144 if (can_stats.tx_frames > (ULONG_MAX / HZ))
145 can_init_stats();
146
147 /* matches overflow - very improbable */
148 if (can_stats.matches > (ULONG_MAX / 100))
149 can_init_stats();
150
151 /* calc total values */
152 if (can_stats.rx_frames)
153 can_stats.total_rx_match_ratio = (can_stats.matches * 100) /
154 can_stats.rx_frames;
155
156 can_stats.total_tx_rate = calc_rate(can_stats.jiffies_init, j,
157 can_stats.tx_frames);
158 can_stats.total_rx_rate = calc_rate(can_stats.jiffies_init, j,
159 can_stats.rx_frames);
160
161 /* calc current values */
162 if (can_stats.rx_frames_delta)
163 can_stats.current_rx_match_ratio =
164 (can_stats.matches_delta * 100) /
165 can_stats.rx_frames_delta;
166
167 can_stats.current_tx_rate = calc_rate(0, HZ, can_stats.tx_frames_delta);
168 can_stats.current_rx_rate = calc_rate(0, HZ, can_stats.rx_frames_delta);
169
170 /* check / update maximum values */
171 if (can_stats.max_tx_rate < can_stats.current_tx_rate)
172 can_stats.max_tx_rate = can_stats.current_tx_rate;
173
174 if (can_stats.max_rx_rate < can_stats.current_rx_rate)
175 can_stats.max_rx_rate = can_stats.current_rx_rate;
176
177 if (can_stats.max_rx_match_ratio < can_stats.current_rx_match_ratio)
178 can_stats.max_rx_match_ratio = can_stats.current_rx_match_ratio;
179
180 /* clear values for 'current rate' calculation */
181 can_stats.tx_frames_delta = 0;
182 can_stats.rx_frames_delta = 0;
183 can_stats.matches_delta = 0;
184
185 /* restart timer (one second) */
186 mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
187}
188
189/*
190 * proc read functions
191 */
192
193static void can_print_rcvlist(struct seq_file *m, struct hlist_head *rx_list,
194 struct net_device *dev)
195{
196 struct receiver *r;
197
198 hlist_for_each_entry_rcu(r, rx_list, list) {
199 char *fmt = (r->can_id & CAN_EFF_FLAG)?
200 " %-5s %08x %08x %pK %pK %8ld %s\n" :
201 " %-5s %03x %08x %pK %pK %8ld %s\n";
202
203 seq_printf(m, fmt, DNAME(dev), r->can_id, r->mask,
204 r->func, r->data, r->matches, r->ident);
205 }
206}
207
208static void can_print_recv_banner(struct seq_file *m)
209{
210 /*
211 * can1. 00000000 00000000 00000000
212 * ....... 0 tp20
213 */
214 seq_puts(m, " device can_id can_mask function"
215 " userdata matches ident\n");
216}
217
218static int can_stats_proc_show(struct seq_file *m, void *v)
219{
220 seq_putc(m, '\n');
221 seq_printf(m, " %8ld transmitted frames (TXF)\n", can_stats.tx_frames);
222 seq_printf(m, " %8ld received frames (RXF)\n", can_stats.rx_frames);
223 seq_printf(m, " %8ld matched frames (RXMF)\n", can_stats.matches);
224
225 seq_putc(m, '\n');
226
227 if (can_stattimer.function == can_stat_update) {
228 seq_printf(m, " %8ld %% total match ratio (RXMR)\n",
229 can_stats.total_rx_match_ratio);
230
231 seq_printf(m, " %8ld frames/s total tx rate (TXR)\n",
232 can_stats.total_tx_rate);
233 seq_printf(m, " %8ld frames/s total rx rate (RXR)\n",
234 can_stats.total_rx_rate);
235
236 seq_putc(m, '\n');
237
238 seq_printf(m, " %8ld %% current match ratio (CRXMR)\n",
239 can_stats.current_rx_match_ratio);
240
241 seq_printf(m, " %8ld frames/s current tx rate (CTXR)\n",
242 can_stats.current_tx_rate);
243 seq_printf(m, " %8ld frames/s current rx rate (CRXR)\n",
244 can_stats.current_rx_rate);
245
246 seq_putc(m, '\n');
247
248 seq_printf(m, " %8ld %% max match ratio (MRXMR)\n",
249 can_stats.max_rx_match_ratio);
250
251 seq_printf(m, " %8ld frames/s max tx rate (MTXR)\n",
252 can_stats.max_tx_rate);
253 seq_printf(m, " %8ld frames/s max rx rate (MRXR)\n",
254 can_stats.max_rx_rate);
255
256 seq_putc(m, '\n');
257 }
258
259 seq_printf(m, " %8ld current receive list entries (CRCV)\n",
260 can_pstats.rcv_entries);
261 seq_printf(m, " %8ld maximum receive list entries (MRCV)\n",
262 can_pstats.rcv_entries_max);
263
264 if (can_pstats.stats_reset)
265 seq_printf(m, "\n %8ld statistic resets (STR)\n",
266 can_pstats.stats_reset);
267
268 if (can_pstats.user_reset)
269 seq_printf(m, " %8ld user statistic resets (USTR)\n",
270 can_pstats.user_reset);
271
272 seq_putc(m, '\n');
273 return 0;
274}
275
276static int can_stats_proc_open(struct inode *inode, struct file *file)
277{
278 return single_open(file, can_stats_proc_show, NULL);
279}
280
281static const struct file_operations can_stats_proc_fops = {
282 .owner = THIS_MODULE,
283 .open = can_stats_proc_open,
284 .read = seq_read,
285 .llseek = seq_lseek,
286 .release = single_release,
287};
288
289static int can_reset_stats_proc_show(struct seq_file *m, void *v)
290{
291 user_reset = 1;
292
293 if (can_stattimer.function == can_stat_update) {
294 seq_printf(m, "Scheduled statistic reset #%ld.\n",
295 can_pstats.stats_reset + 1);
296
297 } else {
298 if (can_stats.jiffies_init != jiffies)
299 can_init_stats();
300
301 seq_printf(m, "Performed statistic reset #%ld.\n",
302 can_pstats.stats_reset);
303 }
304 return 0;
305}
306
307static int can_reset_stats_proc_open(struct inode *inode, struct file *file)
308{
309 return single_open(file, can_reset_stats_proc_show, NULL);
310}
311
312static const struct file_operations can_reset_stats_proc_fops = {
313 .owner = THIS_MODULE,
314 .open = can_reset_stats_proc_open,
315 .read = seq_read,
316 .llseek = seq_lseek,
317 .release = single_release,
318};
319
320static int can_version_proc_show(struct seq_file *m, void *v)
321{
322 seq_printf(m, "%s\n", CAN_VERSION_STRING);
323 return 0;
324}
325
326static int can_version_proc_open(struct inode *inode, struct file *file)
327{
328 return single_open(file, can_version_proc_show, NULL);
329}
330
331static const struct file_operations can_version_proc_fops = {
332 .owner = THIS_MODULE,
333 .open = can_version_proc_open,
334 .read = seq_read,
335 .llseek = seq_lseek,
336 .release = single_release,
337};
338
339static inline void can_rcvlist_proc_show_one(struct seq_file *m, int idx,
340 struct net_device *dev,
341 struct dev_rcv_lists *d)
342{
343 if (!hlist_empty(&d->rx[idx])) {
344 can_print_recv_banner(m);
345 can_print_rcvlist(m, &d->rx[idx], dev);
346 } else
347 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
348
349}
350
351static int can_rcvlist_proc_show(struct seq_file *m, void *v)
352{
353 /* double cast to prevent GCC warning */
354 int idx = (int)(long)m->private;
355 struct net_device *dev;
356 struct dev_rcv_lists *d;
357
358 seq_printf(m, "\nreceive list '%s':\n", rx_list_name[idx]);
359
360 rcu_read_lock();
361
362 /* receive list for 'all' CAN devices (dev == NULL) */
363 d = &can_rx_alldev_list;
364 can_rcvlist_proc_show_one(m, idx, NULL, d);
365
366 /* receive list for registered CAN devices */
367 for_each_netdev_rcu(&init_net, dev) {
368 if (dev->type == ARPHRD_CAN && dev->ml_priv)
369 can_rcvlist_proc_show_one(m, idx, dev, dev->ml_priv);
370 }
371
372 rcu_read_unlock();
373
374 seq_putc(m, '\n');
375 return 0;
376}
377
378static int can_rcvlist_proc_open(struct inode *inode, struct file *file)
379{
380 return single_open(file, can_rcvlist_proc_show, PDE_DATA(inode));
381}
382
383static const struct file_operations can_rcvlist_proc_fops = {
384 .owner = THIS_MODULE,
385 .open = can_rcvlist_proc_open,
386 .read = seq_read,
387 .llseek = seq_lseek,
388 .release = single_release,
389};
390
391static inline void can_rcvlist_proc_show_array(struct seq_file *m,
392 struct net_device *dev,
393 struct hlist_head *rcv_array,
394 unsigned int rcv_array_sz)
395{
396 unsigned int i;
397 int all_empty = 1;
398
399 /* check whether at least one list is non-empty */
400 for (i = 0; i < rcv_array_sz; i++)
401 if (!hlist_empty(&rcv_array[i])) {
402 all_empty = 0;
403 break;
404 }
405
406 if (!all_empty) {
407 can_print_recv_banner(m);
408 for (i = 0; i < rcv_array_sz; i++) {
409 if (!hlist_empty(&rcv_array[i]))
410 can_print_rcvlist(m, &rcv_array[i], dev);
411 }
412 } else
413 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
414}
415
416static int can_rcvlist_sff_proc_show(struct seq_file *m, void *v)
417{
418 struct net_device *dev;
419 struct dev_rcv_lists *d;
420
421 /* RX_SFF */
422 seq_puts(m, "\nreceive list 'rx_sff':\n");
423
424 rcu_read_lock();
425
426 /* sff receive list for 'all' CAN devices (dev == NULL) */
427 d = &can_rx_alldev_list;
428 can_rcvlist_proc_show_array(m, NULL, d->rx_sff, ARRAY_SIZE(d->rx_sff));
429
430 /* sff receive list for registered CAN devices */
431 for_each_netdev_rcu(&init_net, dev) {
432 if (dev->type == ARPHRD_CAN && dev->ml_priv) {
433 d = dev->ml_priv;
434 can_rcvlist_proc_show_array(m, dev, d->rx_sff,
435 ARRAY_SIZE(d->rx_sff));
436 }
437 }
438
439 rcu_read_unlock();
440
441 seq_putc(m, '\n');
442 return 0;
443}
444
445static int can_rcvlist_sff_proc_open(struct inode *inode, struct file *file)
446{
447 return single_open(file, can_rcvlist_sff_proc_show, NULL);
448}
449
450static const struct file_operations can_rcvlist_sff_proc_fops = {
451 .owner = THIS_MODULE,
452 .open = can_rcvlist_sff_proc_open,
453 .read = seq_read,
454 .llseek = seq_lseek,
455 .release = single_release,
456};
457
458
459static int can_rcvlist_eff_proc_show(struct seq_file *m, void *v)
460{
461 struct net_device *dev;
462 struct dev_rcv_lists *d;
463
464 /* RX_EFF */
465 seq_puts(m, "\nreceive list 'rx_eff':\n");
466
467 rcu_read_lock();
468
469 /* eff receive list for 'all' CAN devices (dev == NULL) */
470 d = &can_rx_alldev_list;
471 can_rcvlist_proc_show_array(m, NULL, d->rx_eff, ARRAY_SIZE(d->rx_eff));
472
473 /* eff receive list for registered CAN devices */
474 for_each_netdev_rcu(&init_net, dev) {
475 if (dev->type == ARPHRD_CAN && dev->ml_priv) {
476 d = dev->ml_priv;
477 can_rcvlist_proc_show_array(m, dev, d->rx_eff,
478 ARRAY_SIZE(d->rx_eff));
479 }
480 }
481
482 rcu_read_unlock();
483
484 seq_putc(m, '\n');
485 return 0;
486}
487
488static int can_rcvlist_eff_proc_open(struct inode *inode, struct file *file)
489{
490 return single_open(file, can_rcvlist_eff_proc_show, NULL);
491}
492
493static const struct file_operations can_rcvlist_eff_proc_fops = {
494 .owner = THIS_MODULE,
495 .open = can_rcvlist_eff_proc_open,
496 .read = seq_read,
497 .llseek = seq_lseek,
498 .release = single_release,
499};
500
501/*
502 * proc utility functions
503 */
504
505static void can_remove_proc_readentry(const char *name)
506{
507 if (can_dir)
508 remove_proc_entry(name, can_dir);
509}
510
511/*
512 * can_init_proc - create main CAN proc directory and procfs entries
513 */
514void can_init_proc(void)
515{
516 /* create /proc/net/can directory */
517 can_dir = proc_mkdir("can", init_net.proc_net);
518
519 if (!can_dir) {
520 pr_info("can: failed to create /proc/net/can.\n");
521 return;
522 }
523
524 /* own procfs entries from the AF_CAN core */
525 pde_version = proc_create(CAN_PROC_VERSION, 0644, can_dir,
526 &can_version_proc_fops);
527 pde_stats = proc_create(CAN_PROC_STATS, 0644, can_dir,
528 &can_stats_proc_fops);
529 pde_reset_stats = proc_create(CAN_PROC_RESET_STATS, 0644, can_dir,
530 &can_reset_stats_proc_fops);
531 pde_rcvlist_err = proc_create_data(CAN_PROC_RCVLIST_ERR, 0644, can_dir,
532 &can_rcvlist_proc_fops, (void *)RX_ERR);
533 pde_rcvlist_all = proc_create_data(CAN_PROC_RCVLIST_ALL, 0644, can_dir,
534 &can_rcvlist_proc_fops, (void *)RX_ALL);
535 pde_rcvlist_fil = proc_create_data(CAN_PROC_RCVLIST_FIL, 0644, can_dir,
536 &can_rcvlist_proc_fops, (void *)RX_FIL);
537 pde_rcvlist_inv = proc_create_data(CAN_PROC_RCVLIST_INV, 0644, can_dir,
538 &can_rcvlist_proc_fops, (void *)RX_INV);
539 pde_rcvlist_eff = proc_create(CAN_PROC_RCVLIST_EFF, 0644, can_dir,
540 &can_rcvlist_eff_proc_fops);
541 pde_rcvlist_sff = proc_create(CAN_PROC_RCVLIST_SFF, 0644, can_dir,
542 &can_rcvlist_sff_proc_fops);
543}
544
545/*
546 * can_remove_proc - remove procfs entries and main CAN proc directory
547 */
548void can_remove_proc(void)
549{
550 if (pde_version)
551 can_remove_proc_readentry(CAN_PROC_VERSION);
552
553 if (pde_stats)
554 can_remove_proc_readentry(CAN_PROC_STATS);
555
556 if (pde_reset_stats)
557 can_remove_proc_readentry(CAN_PROC_RESET_STATS);
558
559 if (pde_rcvlist_err)
560 can_remove_proc_readentry(CAN_PROC_RCVLIST_ERR);
561
562 if (pde_rcvlist_all)
563 can_remove_proc_readentry(CAN_PROC_RCVLIST_ALL);
564
565 if (pde_rcvlist_fil)
566 can_remove_proc_readentry(CAN_PROC_RCVLIST_FIL);
567
568 if (pde_rcvlist_inv)
569 can_remove_proc_readentry(CAN_PROC_RCVLIST_INV);
570
571 if (pde_rcvlist_eff)
572 can_remove_proc_readentry(CAN_PROC_RCVLIST_EFF);
573
574 if (pde_rcvlist_sff)
575 can_remove_proc_readentry(CAN_PROC_RCVLIST_SFF);
576
577 if (can_dir)
578 remove_proc_entry("can", init_net.proc_net);
579}