1 // SPDX-License-Identifier: (GPL-2.0 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_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"
66 static int user_reset;
68 static const char rx_list_name[][8] = {
76 * af_can statistics stuff
79 static void can_init_stats(struct net *net)
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;
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).
88 memset(pkg_stats, 0, sizeof(struct can_pkg_stats));
89 pkg_stats->jiffies_init = jiffies;
91 rcv_lists_stats->stats_reset++;
95 rcv_lists_stats->user_reset++;
99 static unsigned long calc_rate(unsigned long oldjif, unsigned long newjif,
104 if (oldjif == newjif)
107 /* see can_stat_update() - this should NEVER happen! */
108 if (count > (ULONG_MAX / HZ)) {
109 printk(KERN_ERR "can: calc_rate: count exceeded! %ld\n",
114 rate = (count * HZ) / (newjif - oldjif);
119 void can_stat_update(struct timer_list *t)
121 struct net *net = from_timer(net, t, can.stattimer);
122 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
123 unsigned long j = jiffies; /* snapshot */
125 /* restart counting in timer context on user request */
129 /* restart counting on jiffies overflow */
130 if (j < pkg_stats->jiffies_init)
133 /* prevent overflow in calc_rate() */
134 if (pkg_stats->rx_frames > (ULONG_MAX / HZ))
137 /* prevent overflow in calc_rate() */
138 if (pkg_stats->tx_frames > (ULONG_MAX / HZ))
141 /* matches overflow - very improbable */
142 if (pkg_stats->matches > (ULONG_MAX / 100))
145 /* calc total values */
146 if (pkg_stats->rx_frames)
147 pkg_stats->total_rx_match_ratio = (pkg_stats->matches * 100) /
148 pkg_stats->rx_frames;
150 pkg_stats->total_tx_rate = calc_rate(pkg_stats->jiffies_init, j,
151 pkg_stats->tx_frames);
152 pkg_stats->total_rx_rate = calc_rate(pkg_stats->jiffies_init, j,
153 pkg_stats->rx_frames);
155 /* calc current values */
156 if (pkg_stats->rx_frames_delta)
157 pkg_stats->current_rx_match_ratio =
158 (pkg_stats->matches_delta * 100) /
159 pkg_stats->rx_frames_delta;
161 pkg_stats->current_tx_rate = calc_rate(0, HZ, pkg_stats->tx_frames_delta);
162 pkg_stats->current_rx_rate = calc_rate(0, HZ, pkg_stats->rx_frames_delta);
164 /* check / update maximum values */
165 if (pkg_stats->max_tx_rate < pkg_stats->current_tx_rate)
166 pkg_stats->max_tx_rate = pkg_stats->current_tx_rate;
168 if (pkg_stats->max_rx_rate < pkg_stats->current_rx_rate)
169 pkg_stats->max_rx_rate = pkg_stats->current_rx_rate;
171 if (pkg_stats->max_rx_match_ratio < pkg_stats->current_rx_match_ratio)
172 pkg_stats->max_rx_match_ratio = pkg_stats->current_rx_match_ratio;
174 /* clear values for 'current rate' calculation */
175 pkg_stats->tx_frames_delta = 0;
176 pkg_stats->rx_frames_delta = 0;
177 pkg_stats->matches_delta = 0;
179 /* restart timer (one second) */
180 mod_timer(&net->can.stattimer, round_jiffies(jiffies + HZ));
184 * proc read functions
187 static void can_print_rcvlist(struct seq_file *m, struct hlist_head *rx_list,
188 struct net_device *dev)
192 hlist_for_each_entry_rcu(r, rx_list, list) {
193 char *fmt = (r->can_id & CAN_EFF_FLAG)?
194 " %-5s %08x %08x %pK %pK %8ld %s\n" :
195 " %-5s %03x %08x %pK %pK %8ld %s\n";
197 seq_printf(m, fmt, DNAME(dev), r->can_id, r->mask,
198 r->func, r->data, r->matches, r->ident);
202 static void can_print_recv_banner(struct seq_file *m)
205 * can1. 00000000 00000000 00000000
208 if (IS_ENABLED(CONFIG_64BIT))
209 seq_puts(m, " device can_id can_mask function userdata matches ident\n");
211 seq_puts(m, " device can_id can_mask function userdata matches ident\n");
214 static int can_stats_proc_show(struct seq_file *m, void *v)
216 struct net *net = m->private;
217 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
218 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
221 seq_printf(m, " %8ld transmitted frames (TXF)\n", pkg_stats->tx_frames);
222 seq_printf(m, " %8ld received frames (RXF)\n", pkg_stats->rx_frames);
223 seq_printf(m, " %8ld matched frames (RXMF)\n", pkg_stats->matches);
227 if (net->can.stattimer.function == can_stat_update) {
228 seq_printf(m, " %8ld %% total match ratio (RXMR)\n",
229 pkg_stats->total_rx_match_ratio);
231 seq_printf(m, " %8ld frames/s total tx rate (TXR)\n",
232 pkg_stats->total_tx_rate);
233 seq_printf(m, " %8ld frames/s total rx rate (RXR)\n",
234 pkg_stats->total_rx_rate);
238 seq_printf(m, " %8ld %% current match ratio (CRXMR)\n",
239 pkg_stats->current_rx_match_ratio);
241 seq_printf(m, " %8ld frames/s current tx rate (CTXR)\n",
242 pkg_stats->current_tx_rate);
243 seq_printf(m, " %8ld frames/s current rx rate (CRXR)\n",
244 pkg_stats->current_rx_rate);
248 seq_printf(m, " %8ld %% max match ratio (MRXMR)\n",
249 pkg_stats->max_rx_match_ratio);
251 seq_printf(m, " %8ld frames/s max tx rate (MTXR)\n",
252 pkg_stats->max_tx_rate);
253 seq_printf(m, " %8ld frames/s max rx rate (MRXR)\n",
254 pkg_stats->max_rx_rate);
259 seq_printf(m, " %8ld current receive list entries (CRCV)\n",
260 rcv_lists_stats->rcv_entries);
261 seq_printf(m, " %8ld maximum receive list entries (MRCV)\n",
262 rcv_lists_stats->rcv_entries_max);
264 if (rcv_lists_stats->stats_reset)
265 seq_printf(m, "\n %8ld statistic resets (STR)\n",
266 rcv_lists_stats->stats_reset);
268 if (rcv_lists_stats->user_reset)
269 seq_printf(m, " %8ld user statistic resets (USTR)\n",
270 rcv_lists_stats->user_reset);
276 static int can_reset_stats_proc_show(struct seq_file *m, void *v)
278 struct net *net = m->private;
279 struct can_rcv_lists_stats *rcv_lists_stats = net->can.rcv_lists_stats;
280 struct can_pkg_stats *pkg_stats = net->can.pkg_stats;
284 if (net->can.stattimer.function == can_stat_update) {
285 seq_printf(m, "Scheduled statistic reset #%ld.\n",
286 rcv_lists_stats->stats_reset + 1);
288 if (pkg_stats->jiffies_init != jiffies)
291 seq_printf(m, "Performed statistic reset #%ld.\n",
292 rcv_lists_stats->stats_reset);
297 static inline void can_rcvlist_proc_show_one(struct seq_file *m, int idx,
298 struct net_device *dev,
299 struct can_dev_rcv_lists *dev_rcv_lists)
301 if (!hlist_empty(&dev_rcv_lists->rx[idx])) {
302 can_print_recv_banner(m);
303 can_print_rcvlist(m, &dev_rcv_lists->rx[idx], dev);
305 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
309 static int can_rcvlist_proc_show(struct seq_file *m, void *v)
311 /* double cast to prevent GCC warning */
312 int idx = (int)(long)PDE_DATA(m->file->f_inode);
313 struct net_device *dev;
314 struct can_dev_rcv_lists *dev_rcv_lists;
315 struct net *net = m->private;
317 seq_printf(m, "\nreceive list '%s':\n", rx_list_name[idx]);
321 /* receive list for 'all' CAN devices (dev == NULL) */
322 dev_rcv_lists = net->can.rx_alldev_list;
323 can_rcvlist_proc_show_one(m, idx, NULL, dev_rcv_lists);
325 /* receive list for registered CAN devices */
326 for_each_netdev_rcu(net, dev) {
327 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
330 can_rcvlist_proc_show_one(m, idx, dev,
331 &can_ml->dev_rcv_lists);
340 static inline void can_rcvlist_proc_show_array(struct seq_file *m,
341 struct net_device *dev,
342 struct hlist_head *rcv_array,
343 unsigned int rcv_array_sz)
348 /* check whether at least one list is non-empty */
349 for (i = 0; i < rcv_array_sz; i++)
350 if (!hlist_empty(&rcv_array[i])) {
356 can_print_recv_banner(m);
357 for (i = 0; i < rcv_array_sz; i++) {
358 if (!hlist_empty(&rcv_array[i]))
359 can_print_rcvlist(m, &rcv_array[i], dev);
362 seq_printf(m, " (%s: no entry)\n", DNAME(dev));
365 static int can_rcvlist_sff_proc_show(struct seq_file *m, void *v)
367 struct net_device *dev;
368 struct can_dev_rcv_lists *dev_rcv_lists;
369 struct net *net = m->private;
372 seq_puts(m, "\nreceive list 'rx_sff':\n");
376 /* sff receive list for 'all' CAN devices (dev == NULL) */
377 dev_rcv_lists = net->can.rx_alldev_list;
378 can_rcvlist_proc_show_array(m, NULL, dev_rcv_lists->rx_sff,
379 ARRAY_SIZE(dev_rcv_lists->rx_sff));
381 /* sff receive list for registered CAN devices */
382 for_each_netdev_rcu(net, dev) {
383 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
386 dev_rcv_lists = &can_ml->dev_rcv_lists;
387 can_rcvlist_proc_show_array(m, dev, dev_rcv_lists->rx_sff,
388 ARRAY_SIZE(dev_rcv_lists->rx_sff));
398 static int can_rcvlist_eff_proc_show(struct seq_file *m, void *v)
400 struct net_device *dev;
401 struct can_dev_rcv_lists *dev_rcv_lists;
402 struct net *net = m->private;
405 seq_puts(m, "\nreceive list 'rx_eff':\n");
409 /* eff receive list for 'all' CAN devices (dev == NULL) */
410 dev_rcv_lists = net->can.rx_alldev_list;
411 can_rcvlist_proc_show_array(m, NULL, dev_rcv_lists->rx_eff,
412 ARRAY_SIZE(dev_rcv_lists->rx_eff));
414 /* eff receive list for registered CAN devices */
415 for_each_netdev_rcu(net, dev) {
416 struct can_ml_priv *can_ml = can_get_ml_priv(dev);
419 dev_rcv_lists = &can_ml->dev_rcv_lists;
420 can_rcvlist_proc_show_array(m, dev, dev_rcv_lists->rx_eff,
421 ARRAY_SIZE(dev_rcv_lists->rx_eff));
432 * can_init_proc - create main CAN proc directory and procfs entries
434 void can_init_proc(struct net *net)
436 /* create /proc/net/can directory */
437 net->can.proc_dir = proc_net_mkdir(net, "can", net->proc_net);
439 if (!net->can.proc_dir) {
440 printk(KERN_INFO "can: failed to create /proc/net/can . "
441 "CONFIG_PROC_FS missing?\n");
445 /* own procfs entries from the AF_CAN core */
446 net->can.pde_stats = proc_create_net_single(CAN_PROC_STATS, 0644,
447 net->can.proc_dir, can_stats_proc_show, NULL);
448 net->can.pde_reset_stats = proc_create_net_single(CAN_PROC_RESET_STATS,
449 0644, net->can.proc_dir, can_reset_stats_proc_show,
451 net->can.pde_rcvlist_err = proc_create_net_single(CAN_PROC_RCVLIST_ERR,
452 0644, net->can.proc_dir, can_rcvlist_proc_show,
454 net->can.pde_rcvlist_all = proc_create_net_single(CAN_PROC_RCVLIST_ALL,
455 0644, net->can.proc_dir, can_rcvlist_proc_show,
457 net->can.pde_rcvlist_fil = proc_create_net_single(CAN_PROC_RCVLIST_FIL,
458 0644, net->can.proc_dir, can_rcvlist_proc_show,
460 net->can.pde_rcvlist_inv = proc_create_net_single(CAN_PROC_RCVLIST_INV,
461 0644, net->can.proc_dir, can_rcvlist_proc_show,
463 net->can.pde_rcvlist_eff = proc_create_net_single(CAN_PROC_RCVLIST_EFF,
464 0644, net->can.proc_dir, can_rcvlist_eff_proc_show, NULL);
465 net->can.pde_rcvlist_sff = proc_create_net_single(CAN_PROC_RCVLIST_SFF,
466 0644, net->can.proc_dir, can_rcvlist_sff_proc_show, NULL);
470 * can_remove_proc - remove procfs entries and main CAN proc directory
472 void can_remove_proc(struct net *net)
474 if (!net->can.proc_dir)
477 if (net->can.pde_stats)
478 remove_proc_entry(CAN_PROC_STATS, net->can.proc_dir);
480 if (net->can.pde_reset_stats)
481 remove_proc_entry(CAN_PROC_RESET_STATS, net->can.proc_dir);
483 if (net->can.pde_rcvlist_err)
484 remove_proc_entry(CAN_PROC_RCVLIST_ERR, net->can.proc_dir);
486 if (net->can.pde_rcvlist_all)
487 remove_proc_entry(CAN_PROC_RCVLIST_ALL, net->can.proc_dir);
489 if (net->can.pde_rcvlist_fil)
490 remove_proc_entry(CAN_PROC_RCVLIST_FIL, net->can.proc_dir);
492 if (net->can.pde_rcvlist_inv)
493 remove_proc_entry(CAN_PROC_RCVLIST_INV, net->can.proc_dir);
495 if (net->can.pde_rcvlist_eff)
496 remove_proc_entry(CAN_PROC_RCVLIST_EFF, net->can.proc_dir);
498 if (net->can.pde_rcvlist_sff)
499 remove_proc_entry(CAN_PROC_RCVLIST_SFF, net->can.proc_dir);
501 remove_proc_entry("can", net->proc_net);