1 // SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
3 * proc.c - procfs support for Protocol family CAN core module
5 * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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.
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.
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
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>
54 * proc filenames for the PF_CAN core
57 #define CAN_PROC_VERSION "version"
58 #define CAN_PROC_STATS "stats"
59 #define CAN_PROC_RESET_STATS "reset_stats"
60 #define CAN_PROC_RCVLIST_ALL "rcvlist_all"
61 #define CAN_PROC_RCVLIST_FIL "rcvlist_fil"
62 #define CAN_PROC_RCVLIST_INV "rcvlist_inv"
63 #define CAN_PROC_RCVLIST_SFF "rcvlist_sff"
64 #define CAN_PROC_RCVLIST_EFF "rcvlist_eff"
65 #define CAN_PROC_RCVLIST_ERR "rcvlist_err"
67 static int user_reset;
69 static const char rx_list_name[][8] = {
77 * af_can statistics stuff
80 static void can_init_stats(struct net *net)
82 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
83 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
85 * This memset function is called from a timer context (when
86 * can_stattimer is active which is the default) OR in a process
87 * context (reading the proc_fs when can_stattimer is disabled).
89 memset(pkg_stats, 0, sizeof(struct can_pkg_stats));
90 pkg_stats->jiffies_init = jiffies;
92 rcv_lists_stats->stats_reset++;
96 rcv_lists_stats->user_reset++;
100 static unsigned long calc_rate(unsigned long oldjif, unsigned long newjif,
105 if (oldjif == newjif)
108 /* see can_stat_update() - this should NEVER happen! */
109 if (count > (ULONG_MAX / HZ)) {
110 printk(KERN_ERR "can: calc_rate: count exceeded! %ld\n",
115 rate = (count * HZ) / (newjif - oldjif);
120 void can_stat_update(struct timer_list *t)
122 struct net *net = from_timer(net, t, can.stattimer);
123 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
124 unsigned long j = jiffies; /* snapshot */
126 /* restart counting in timer context on user request */
130 /* restart counting on jiffies overflow */
131 if (j < pkg_stats->jiffies_init)
134 /* prevent overflow in calc_rate() */
135 if (pkg_stats->rx_frames > (ULONG_MAX / HZ))
138 /* prevent overflow in calc_rate() */
139 if (pkg_stats->tx_frames > (ULONG_MAX / HZ))
142 /* matches overflow - very improbable */
143 if (pkg_stats->matches > (ULONG_MAX / 100))
146 /* calc total values */
147 if (pkg_stats->rx_frames)
148 pkg_stats->total_rx_match_ratio = (pkg_stats->matches * 100) /
149 pkg_stats->rx_frames;
151 pkg_stats->total_tx_rate = calc_rate(pkg_stats->jiffies_init, j,
152 pkg_stats->tx_frames);
153 pkg_stats->total_rx_rate = calc_rate(pkg_stats->jiffies_init, j,
154 pkg_stats->rx_frames);
156 /* calc current values */
157 if (pkg_stats->rx_frames_delta)
158 pkg_stats->current_rx_match_ratio =
159 (pkg_stats->matches_delta * 100) /
160 pkg_stats->rx_frames_delta;
162 pkg_stats->current_tx_rate = calc_rate(0, HZ, pkg_stats->tx_frames_delta);
163 pkg_stats->current_rx_rate = calc_rate(0, HZ, pkg_stats->rx_frames_delta);
165 /* check / update maximum values */
166 if (pkg_stats->max_tx_rate < pkg_stats->current_tx_rate)
167 pkg_stats->max_tx_rate = pkg_stats->current_tx_rate;
169 if (pkg_stats->max_rx_rate < pkg_stats->current_rx_rate)
170 pkg_stats->max_rx_rate = pkg_stats->current_rx_rate;
172 if (pkg_stats->max_rx_match_ratio < pkg_stats->current_rx_match_ratio)
173 pkg_stats->max_rx_match_ratio = pkg_stats->current_rx_match_ratio;
175 /* clear values for 'current rate' calculation */
176 pkg_stats->tx_frames_delta = 0;
177 pkg_stats->rx_frames_delta = 0;
178 pkg_stats->matches_delta = 0;
180 /* restart timer (one second) */
181 mod_timer(&net->can.stattimer, round_jiffies(jiffies + HZ));
185 * proc read functions
188 static void can_print_rcvlist(struct seq_file *m, struct hlist_head *rx_list,
189 struct net_device *dev)
193 hlist_for_each_entry_rcu(r, rx_list, list) {
194 char *fmt = (r->can_id & CAN_EFF_FLAG)?
195 " %-5s %08x %08x %pK %pK %8ld %s\n" :
196 " %-5s %03x %08x %pK %pK %8ld %s\n";
198 seq_printf(m, fmt, DNAME(dev), r->can_id, r->mask,
199 r->func, r->data, r->matches, r->ident);
203 static void can_print_recv_banner(struct seq_file *m)
206 * can1. 00000000 00000000 00000000
209 seq_puts(m, " device can_id can_mask function"
210 " userdata matches ident\n");
213 static int can_stats_proc_show(struct seq_file *m, void *v)
215 struct net *net = m->private;
216 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
217 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
220 seq_printf(m, " %8ld transmitted frames (TXF)\n", pkg_stats->tx_frames);
221 seq_printf(m, " %8ld received frames (RXF)\n", pkg_stats->rx_frames);
222 seq_printf(m, " %8ld matched frames (RXMF)\n", pkg_stats->matches);
226 if (net->can.stattimer.function == can_stat_update) {
227 seq_printf(m, " %8ld %% total match ratio (RXMR)\n",
228 pkg_stats->total_rx_match_ratio);
230 seq_printf(m, " %8ld frames/s total tx rate (TXR)\n",
231 pkg_stats->total_tx_rate);
232 seq_printf(m, " %8ld frames/s total rx rate (RXR)\n",
233 pkg_stats->total_rx_rate);
237 seq_printf(m, " %8ld %% current match ratio (CRXMR)\n",
238 pkg_stats->current_rx_match_ratio);
240 seq_printf(m, " %8ld frames/s current tx rate (CTXR)\n",
241 pkg_stats->current_tx_rate);
242 seq_printf(m, " %8ld frames/s current rx rate (CRXR)\n",
243 pkg_stats->current_rx_rate);
247 seq_printf(m, " %8ld %% max match ratio (MRXMR)\n",
248 pkg_stats->max_rx_match_ratio);
250 seq_printf(m, " %8ld frames/s max tx rate (MTXR)\n",
251 pkg_stats->max_tx_rate);
252 seq_printf(m, " %8ld frames/s max rx rate (MRXR)\n",
253 pkg_stats->max_rx_rate);
258 seq_printf(m, " %8ld current receive list entries (CRCV)\n",
259 rcv_lists_stats->rcv_entries);
260 seq_printf(m, " %8ld maximum receive list entries (MRCV)\n",
261 rcv_lists_stats->rcv_entries_max);
263 if (rcv_lists_stats->stats_reset)
264 seq_printf(m, "\n %8ld statistic resets (STR)\n",
265 rcv_lists_stats->stats_reset);
267 if (rcv_lists_stats->user_reset)
268 seq_printf(m, " %8ld user statistic resets (USTR)\n",
269 rcv_lists_stats->user_reset);
275 static int can_reset_stats_proc_show(struct seq_file *m, void *v)
277 struct net *net = m->private;
278 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
279 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
283 if (net->can.stattimer.function == can_stat_update) {
284 seq_printf(m, "Scheduled statistic reset #%ld.\n",
285 rcv_lists_stats->stats_reset + 1);
287 if (pkg_stats->jiffies_init != jiffies)
290 seq_printf(m, "Performed statistic reset #%ld.\n",
291 rcv_lists_stats->stats_reset);
296 static int can_version_proc_show(struct seq_file *m, void *v)
298 seq_printf(m, "%s\n", CAN_VERSION_STRING);
302 static inline void can_rcvlist_proc_show_one(struct seq_file *m, int idx,
303 struct net_device *dev,
304 struct can_dev_rcv_lists *dev_rcv_lists)
306 if (!hlist_empty(&dev_rcv_lists->rx[idx])) {
307 can_print_recv_banner(m);
308 can_print_rcvlist(m, &dev_rcv_lists->rx[idx], dev);
310 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
314 static int can_rcvlist_proc_show(struct seq_file *m, void *v)
316 /* double cast to prevent GCC warning */
317 int idx = (int)(long)PDE_DATA(m->file->f_inode);
318 struct net_device *dev;
319 struct can_dev_rcv_lists *dev_rcv_lists;
320 struct net *net = m->private;
322 seq_printf(m, "\nreceive list '%s':\n", rx_list_name[idx]);
326 /* receive list for 'all' CAN devices (dev == NULL) */
327 dev_rcv_lists = net->can.rx_alldev_list;
328 can_rcvlist_proc_show_one(m, idx, NULL, dev_rcv_lists);
330 /* receive list for registered CAN devices */
331 for_each_netdev_rcu(net, dev) {
332 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
335 can_rcvlist_proc_show_one(m, idx, dev,
336 &can_ml->dev_rcv_lists);
345 static inline void can_rcvlist_proc_show_array(struct seq_file *m,
346 struct net_device *dev,
347 struct hlist_head *rcv_array,
348 unsigned int rcv_array_sz)
353 /* check whether at least one list is non-empty */
354 for (i = 0; i < rcv_array_sz; i++)
355 if (!hlist_empty(&rcv_array[i])) {
361 can_print_recv_banner(m);
362 for (i = 0; i < rcv_array_sz; i++) {
363 if (!hlist_empty(&rcv_array[i]))
364 can_print_rcvlist(m, &rcv_array[i], dev);
367 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
370 static int can_rcvlist_sff_proc_show(struct seq_file *m, void *v)
372 struct net_device *dev;
373 struct can_dev_rcv_lists *dev_rcv_lists;
374 struct net *net = m->private;
377 seq_puts(m, "\nreceive list 'rx_sff':\n");
381 /* sff receive list for 'all' CAN devices (dev == NULL) */
382 dev_rcv_lists = net->can.rx_alldev_list;
383 can_rcvlist_proc_show_array(m, NULL, dev_rcv_lists->rx_sff,
384 ARRAY_SIZE(dev_rcv_lists->rx_sff));
386 /* sff receive list for registered CAN devices */
387 for_each_netdev_rcu(net, dev) {
388 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
391 dev_rcv_lists = &can_ml->dev_rcv_lists;
392 can_rcvlist_proc_show_array(m, dev, dev_rcv_lists->rx_sff,
393 ARRAY_SIZE(dev_rcv_lists->rx_sff));
403 static int can_rcvlist_eff_proc_show(struct seq_file *m, void *v)
405 struct net_device *dev;
406 struct can_dev_rcv_lists *dev_rcv_lists;
407 struct net *net = m->private;
410 seq_puts(m, "\nreceive list 'rx_eff':\n");
414 /* eff receive list for 'all' CAN devices (dev == NULL) */
415 dev_rcv_lists = net->can.rx_alldev_list;
416 can_rcvlist_proc_show_array(m, NULL, dev_rcv_lists->rx_eff,
417 ARRAY_SIZE(dev_rcv_lists->rx_eff));
419 /* eff receive list for registered CAN devices */
420 for_each_netdev_rcu(net, dev) {
421 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
424 dev_rcv_lists = &can_ml->dev_rcv_lists;
425 can_rcvlist_proc_show_array(m, dev, dev_rcv_lists->rx_eff,
426 ARRAY_SIZE(dev_rcv_lists->rx_eff));
437 * can_init_proc - create main CAN proc directory and procfs entries
439 void can_init_proc(struct net *net)
441 /* create /proc/net/can directory */
442 net->can.proc_dir = proc_net_mkdir(net, "can", net->proc_net);
444 if (!net->can.proc_dir) {
445 printk(KERN_INFO "can: failed to create /proc/net/can . "
446 "CONFIG_PROC_FS missing?\n");
450 /* own procfs entries from the AF_CAN core */
451 net->can.pde_version = proc_create_net_single(CAN_PROC_VERSION, 0644,
452 net->can.proc_dir, can_version_proc_show, NULL);
453 net->can.pde_stats = proc_create_net_single(CAN_PROC_STATS, 0644,
454 net->can.proc_dir, can_stats_proc_show, NULL);
455 net->can.pde_reset_stats = proc_create_net_single(CAN_PROC_RESET_STATS,
456 0644, net->can.proc_dir, can_reset_stats_proc_show,
458 net->can.pde_rcvlist_err = proc_create_net_single(CAN_PROC_RCVLIST_ERR,
459 0644, net->can.proc_dir, can_rcvlist_proc_show,
461 net->can.pde_rcvlist_all = proc_create_net_single(CAN_PROC_RCVLIST_ALL,
462 0644, net->can.proc_dir, can_rcvlist_proc_show,
464 net->can.pde_rcvlist_fil = proc_create_net_single(CAN_PROC_RCVLIST_FIL,
465 0644, net->can.proc_dir, can_rcvlist_proc_show,
467 net->can.pde_rcvlist_inv = proc_create_net_single(CAN_PROC_RCVLIST_INV,
468 0644, net->can.proc_dir, can_rcvlist_proc_show,
470 net->can.pde_rcvlist_eff = proc_create_net_single(CAN_PROC_RCVLIST_EFF,
471 0644, net->can.proc_dir, can_rcvlist_eff_proc_show, NULL);
472 net->can.pde_rcvlist_sff = proc_create_net_single(CAN_PROC_RCVLIST_SFF,
473 0644, net->can.proc_dir, can_rcvlist_sff_proc_show, NULL);
477 * can_remove_proc - remove procfs entries and main CAN proc directory
479 void can_remove_proc(struct net *net)
481 if (!net->can.proc_dir)
484 if (net->can.pde_version)
485 remove_proc_entry(CAN_PROC_VERSION, net->can.proc_dir);
487 if (net->can.pde_stats)
488 remove_proc_entry(CAN_PROC_STATS, net->can.proc_dir);
490 if (net->can.pde_reset_stats)
491 remove_proc_entry(CAN_PROC_RESET_STATS, net->can.proc_dir);
493 if (net->can.pde_rcvlist_err)
494 remove_proc_entry(CAN_PROC_RCVLIST_ERR, net->can.proc_dir);
496 if (net->can.pde_rcvlist_all)
497 remove_proc_entry(CAN_PROC_RCVLIST_ALL, net->can.proc_dir);
499 if (net->can.pde_rcvlist_fil)
500 remove_proc_entry(CAN_PROC_RCVLIST_FIL, net->can.proc_dir);
502 if (net->can.pde_rcvlist_inv)
503 remove_proc_entry(CAN_PROC_RCVLIST_INV, net->can.proc_dir);
505 if (net->can.pde_rcvlist_eff)
506 remove_proc_entry(CAN_PROC_RCVLIST_EFF, net->can.proc_dir);
508 if (net->can.pde_rcvlist_sff)
509 remove_proc_entry(CAN_PROC_RCVLIST_SFF, net->can.proc_dir);
511 remove_proc_entry("can", net->proc_net);