kernel/2.6/net/can/proc.c

   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  * Send feedback to <socketcan-users@lists.berlios.de>
  41  *
  42  */
  43
  44 #include <linux/module.h>
  45 #include <linux/version.h>
  46 #include <linux/proc_fs.h>
  47 #include <linux/list.h>
  48 #include <linux/rcupdate.h>
  49 #include <linux/can/core.h>
  50
  51 #include "af_can.h"
  52 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,25)
  53 #include "compat.h"
  54 #endif
  55
  56 #include <linux/can/version.h> /* for RCSID. Removed by mkpatch script */
  57 RCSID("$Id$");
  58
  59 /*
  60  * proc filenames for the PF_CAN core
  61  */
  62
  63 #define CAN_PROC_VERSION     "version"
  64 #define CAN_PROC_STATS       "stats"
  65 #define CAN_PROC_RESET_STATS "reset_stats"
  66 #define CAN_PROC_RCVLIST_ALL "rcvlist_all"
  67 #define CAN_PROC_RCVLIST_FIL "rcvlist_fil"
  68 #define CAN_PROC_RCVLIST_INV "rcvlist_inv"
  69 #define CAN_PROC_RCVLIST_SFF "rcvlist_sff"
  70 #define CAN_PROC_RCVLIST_EFF "rcvlist_eff"
  71 #define CAN_PROC_RCVLIST_ERR "rcvlist_err"
  72
  73 static struct proc_dir_entry *can_dir;
  74 static struct proc_dir_entry *pde_version;
  75 static struct proc_dir_entry *pde_stats;
  76 static struct proc_dir_entry *pde_reset_stats;
  77 static struct proc_dir_entry *pde_rcvlist_all;
  78 static struct proc_dir_entry *pde_rcvlist_fil;
  79 static struct proc_dir_entry *pde_rcvlist_inv;
  80 static struct proc_dir_entry *pde_rcvlist_sff;
  81 static struct proc_dir_entry *pde_rcvlist_eff;
  82 static struct proc_dir_entry *pde_rcvlist_err;
  83
  84 static int user_reset;
  85
  86 static const char rx_list_name[][8] = {
  87         [RX_ERR] = "rx_err",
  88         [RX_ALL] = "rx_all",
  89         [RX_FIL] = "rx_fil",
  90         [RX_INV] = "rx_inv",
  91         [RX_EFF] = "rx_eff",
  92 };
  93
  94 /*
  95  * af_can statistics stuff
  96  */
  97
  98 static void can_init_stats(void)
  99 {
 100         /*
 101          * This memset function is called from a timer context (when
 102          * can_stattimer is active which is the default) OR in a process
 103          * context (reading the proc_fs when can_stattimer is disabled).
 104          */
 105         memset(&can_stats, 0, sizeof(can_stats));
 106         can_stats.jiffies_init = jiffies;
 107
 108         can_pstats.stats_reset++;
 109
 110         if (user_reset) {
 111                 user_reset = 0;
 112                 can_pstats.user_reset++;
 113         }
 114 }
 115
 116 static unsigned long calc_rate(unsigned long oldjif, unsigned long newjif,
 117                                unsigned long count)
 118 {
 119         unsigned long rate;
 120
 121         if (oldjif == newjif)
 122                 return 0;
 123
 124         /* see can_stat_update() - this should NEVER happen! */
 125         if (count > (ULONG_MAX / HZ)) {
 126                 printk(KERN_ERR "can: calc_rate: count exceeded! %ld\n",
 127                        count);
 128                 return 99999999;
 129         }
 130
 131         rate = (count * HZ) / (newjif - oldjif);
 132
 133         return rate;
 134 }
 135
 136 void can_stat_update(unsigned long data)
 137 {
 138         unsigned long j = jiffies; /* snapshot */
 139
 140         /* restart counting in timer context on user request */
 141         if (user_reset)
 142                 can_init_stats();
 143
 144         /* restart counting on jiffies overflow */
 145         if (j < can_stats.jiffies_init)
 146                 can_init_stats();
 147
 148         /* prevent overflow in calc_rate() */
 149         if (can_stats.rx_frames > (ULONG_MAX / HZ))
 150                 can_init_stats();
 151
 152         /* prevent overflow in calc_rate() */
 153         if (can_stats.tx_frames > (ULONG_MAX / HZ))
 154                 can_init_stats();
 155
 156         /* matches overflow - very improbable */
 157         if (can_stats.matches > (ULONG_MAX / 100))
 158                 can_init_stats();
 159
 160         /* calc total values */
 161         if (can_stats.rx_frames)
 162                 can_stats.total_rx_match_ratio = (can_stats.matches * 100) /
 163                         can_stats.rx_frames;
 164
 165         can_stats.total_tx_rate = calc_rate(can_stats.jiffies_init, j,
 166                                             can_stats.tx_frames);
 167         can_stats.total_rx_rate = calc_rate(can_stats.jiffies_init, j,
 168                                             can_stats.rx_frames);
 169
 170         /* calc current values */
 171         if (can_stats.rx_frames_delta)
 172                 can_stats.current_rx_match_ratio =
 173                         (can_stats.matches_delta * 100) /
 174                         can_stats.rx_frames_delta;
 175
 176         can_stats.current_tx_rate = calc_rate(0, HZ, can_stats.tx_frames_delta);
 177         can_stats.current_rx_rate = calc_rate(0, HZ, can_stats.rx_frames_delta);
 178
 179         /* check / update maximum values */
 180         if (can_stats.max_tx_rate < can_stats.current_tx_rate)
 181                 can_stats.max_tx_rate = can_stats.current_tx_rate;
 182
 183         if (can_stats.max_rx_rate < can_stats.current_rx_rate)
 184                 can_stats.max_rx_rate = can_stats.current_rx_rate;
 185
 186         if (can_stats.max_rx_match_ratio < can_stats.current_rx_match_ratio)
 187                 can_stats.max_rx_match_ratio = can_stats.current_rx_match_ratio;
 188
 189         /* clear values for 'current rate' calculation */
 190         can_stats.tx_frames_delta = 0;
 191         can_stats.rx_frames_delta = 0;
 192         can_stats.matches_delta   = 0;
 193
 194         /* restart timer (one second) */
 195         mod_timer(&can_stattimer, round_jiffies(jiffies + HZ));
 196 }
 197
 198 /*
 199  * proc read functions
 200  *
 201  * From known use-cases we expect about 10 entries in a receive list to be
 202  * printed in the proc_fs. So PAGE_SIZE is definitely enough space here.
 203  *
 204  */
 205
 206 static int can_print_rcvlist(char *page, int len, struct hlist_head *rx_list,
 207                              struct net_device *dev)
 208 {
 209         struct receiver *r;
 210         struct hlist_node *n;
 211
 212         rcu_read_lock();
 213         hlist_for_each_entry_rcu(r, n, rx_list, list) {
 214                 char *fmt = (r->can_id & CAN_EFF_FLAG)?
 215                         "   %-5s  %08X  %08x  %08x  %08x  %8ld  %s\n" :
 216                         "   %-5s     %03X    %08x  %08lx  %08lx  %8ld  %s\n";
 217
 218                 len += snprintf(page + len, PAGE_SIZE - len, fmt,
 219                                 DNAME(dev), r->can_id, r->mask,
 220                                 (unsigned long)r->func, (unsigned long)r->data,
 221                                 r->matches, r->ident);
 222
 223                 /* does a typical line fit into the current buffer? */
 224
 225                 /* 100 Bytes before end of buffer */
 226                 if (len > PAGE_SIZE - 100) {
 227                         /* mark output cut off */
 228                         len += snprintf(page + len, PAGE_SIZE - len,
 229                                         "   (..)\n");
 230                         break;
 231                 }
 232         }
 233         rcu_read_unlock();
 234
 235         return len;
 236 }
 237
 238 static int can_print_recv_banner(char *page, int len)
 239 {
 240         /*
 241          *                  can1.  00000000  00000000  00000000
 242          *                 .......          0  tp20
 243          */
 244         len += snprintf(page + len, PAGE_SIZE - len,
 245                         "  device   can_id   can_mask  function"
 246                         "  userdata   matches  ident\n");
 247
 248         return len;
 249 }
 250
 251 static int can_proc_read_stats(char *page, char **start, off_t off,
 252                                int count, int *eof, void *data)
 253 {
 254         int len = 0;
 255
 256         len += snprintf(page + len, PAGE_SIZE - len, "\n");
 257         len += snprintf(page + len, PAGE_SIZE - len,
 258                         " %8ld transmitted frames (TXF)\n",
 259                         can_stats.tx_frames);
 260         len += snprintf(page + len, PAGE_SIZE - len,
 261                         " %8ld received frames (RXF)\n", can_stats.rx_frames);
 262         len += snprintf(page + len, PAGE_SIZE - len,
 263                         " %8ld matched frames (RXMF)\n", can_stats.matches);
 264
 265         len += snprintf(page + len, PAGE_SIZE - len, "\n");
 266
 267         if (can_stattimer.function == can_stat_update) {
 268                 len += snprintf(page + len, PAGE_SIZE - len,
 269                                 " %8ld %% total match ratio (RXMR)\n",
 270                                 can_stats.total_rx_match_ratio);
 271
 272                 len += snprintf(page + len, PAGE_SIZE - len,
 273                                 " %8ld frames/s total tx rate (TXR)\n",
 274                                 can_stats.total_tx_rate);
 275                 len += snprintf(page + len, PAGE_SIZE - len,
 276                                 " %8ld frames/s total rx rate (RXR)\n",
 277                                 can_stats.total_rx_rate);
 278
 279                 len += snprintf(page + len, PAGE_SIZE - len, "\n");
 280
 281                 len += snprintf(page + len, PAGE_SIZE - len,
 282                                 " %8ld %% current match ratio (CRXMR)\n",
 283                                 can_stats.current_rx_match_ratio);
 284
 285                 len += snprintf(page + len, PAGE_SIZE - len,
 286                                 " %8ld frames/s current tx rate (CTXR)\n",
 287                                 can_stats.current_tx_rate);
 288                 len += snprintf(page + len, PAGE_SIZE - len,
 289                                 " %8ld frames/s current rx rate (CRXR)\n",
 290                                 can_stats.current_rx_rate);
 291
 292                 len += snprintf(page + len, PAGE_SIZE - len, "\n");
 293
 294                 len += snprintf(page + len, PAGE_SIZE - len,
 295                                 " %8ld %% max match ratio (MRXMR)\n",
 296                                 can_stats.max_rx_match_ratio);
 297
 298                 len += snprintf(page + len, PAGE_SIZE - len,
 299                                 " %8ld frames/s max tx rate (MTXR)\n",
 300                                 can_stats.max_tx_rate);
 301                 len += snprintf(page + len, PAGE_SIZE - len,
 302                                 " %8ld frames/s max rx rate (MRXR)\n",
 303                                 can_stats.max_rx_rate);
 304
 305                 len += snprintf(page + len, PAGE_SIZE - len, "\n");
 306         }
 307
 308         len += snprintf(page + len, PAGE_SIZE - len,
 309                         " %8ld current receive list entries (CRCV)\n",
 310                         can_pstats.rcv_entries);
 311         len += snprintf(page + len, PAGE_SIZE - len,
 312                         " %8ld maximum receive list entries (MRCV)\n",
 313                         can_pstats.rcv_entries_max);
 314
 315         if (can_pstats.stats_reset)
 316                 len += snprintf(page + len, PAGE_SIZE - len,
 317                                 "\n %8ld statistic resets (STR)\n",
 318                                 can_pstats.stats_reset);
 319
 320         if (can_pstats.user_reset)
 321                 len += snprintf(page + len, PAGE_SIZE - len,
 322                                 " %8ld user statistic resets (USTR)\n",
 323                                 can_pstats.user_reset);
 324
 325         len += snprintf(page + len, PAGE_SIZE - len, "\n");
 326
 327         *eof = 1;
 328         return len;
 329 }
 330
 331 static int can_proc_read_reset_stats(char *page, char **start, off_t off,
 332                                      int count, int *eof, void *data)
 333 {
 334         int len = 0;
 335
 336         user_reset = 1;
 337
 338         if (can_stattimer.function == can_stat_update) {
 339                 len += snprintf(page + len, PAGE_SIZE - len,
 340                                 "Scheduled statistic reset #%ld.\n",
 341                                 can_pstats.stats_reset + 1);
 342
 343         } else {
 344                 if (can_stats.jiffies_init != jiffies)
 345                         can_init_stats();
 346
 347                 len += snprintf(page + len, PAGE_SIZE - len,
 348                                 "Performed statistic reset #%ld.\n",
 349                                 can_pstats.stats_reset);
 350         }
 351
 352         *eof = 1;
 353         return len;
 354 }
 355
 356 static int can_proc_read_version(char *page, char **start, off_t off,
 357                                  int count, int *eof, void *data)
 358 {
 359         int len = 0;
 360
 361         len += snprintf(page + len, PAGE_SIZE - len, "%s\n",
 362                         CAN_VERSION_STRING);
 363         *eof = 1;
 364         return len;
 365 }
 366
 367 static int can_proc_read_rcvlist(char *page, char **start, off_t off,
 368                                  int count, int *eof, void *data)
 369 {
 370         /* double cast to prevent GCC warning */
 371         int idx = (int)(long)data;
 372         int len = 0;
 373         struct dev_rcv_lists *d;
 374         struct hlist_node *n;
 375
 376         len += snprintf(page + len, PAGE_SIZE - len,
 377                         "\nreceive list '%s':\n", rx_list_name[idx]);
 378
 379         rcu_read_lock();
 380         hlist_for_each_entry_rcu(d, n, &can_rx_dev_list, list) {
 381
 382                 if (!hlist_empty(&d->rx[idx])) {
 383                         len = can_print_recv_banner(page, len);
 384                         len = can_print_rcvlist(page, len, &d->rx[idx], d->dev);
 385                 } else
 386                         len += snprintf(page + len, PAGE_SIZE - len,
 387                                         "  (%s: no entry)\n", DNAME(d->dev));
 388
 389                 /* exit on end of buffer? */
 390                 if (len > PAGE_SIZE - 100)
 391                         break;
 392         }
 393         rcu_read_unlock();
 394
 395         len += snprintf(page + len, PAGE_SIZE - len, "\n");
 396
 397         *eof = 1;
 398         return len;
 399 }
 400
 401 static int can_proc_read_rcvlist_sff(char *page, char **start, off_t off,
 402                                      int count, int *eof, void *data)
 403 {
 404         int len = 0;
 405         struct dev_rcv_lists *d;
 406         struct hlist_node *n;
 407
 408         /* RX_SFF */
 409         len += snprintf(page + len, PAGE_SIZE - len,
 410                         "\nreceive list 'rx_sff':\n");
 411
 412         rcu_read_lock();
 413         hlist_for_each_entry_rcu(d, n, &can_rx_dev_list, list) {
 414                 int i, all_empty = 1;
 415                 /* check wether at least one list is non-empty */
 416                 for (i = 0; i < 0x800; i++)
 417                         if (!hlist_empty(&d->rx_sff[i])) {
 418                                 all_empty = 0;
 419                                 break;
 420                         }
 421
 422                 if (!all_empty) {
 423                         len = can_print_recv_banner(page, len);
 424                         for (i = 0; i < 0x800; i++) {
 425                                 if (!hlist_empty(&d->rx_sff[i]) &&
 426                                     len < PAGE_SIZE - 100)
 427                                         len = can_print_rcvlist(page, len,
 428                                                                 &d->rx_sff[i],
 429                                                                 d->dev);
 430                         }
 431                 } else
 432                         len += snprintf(page + len, PAGE_SIZE - len,
 433                                         "  (%s: no entry)\n", DNAME(d->dev));
 434
 435                 /* exit on end of buffer? */
 436                 if (len > PAGE_SIZE - 100)
 437                         break;
 438         }
 439         rcu_read_unlock();
 440
 441         len += snprintf(page + len, PAGE_SIZE - len, "\n");
 442
 443         *eof = 1;
 444         return len;
 445 }
 446
 447 /*
 448  * proc utility functions
 449  */
 450
 451 static struct proc_dir_entry *can_create_proc_readentry(const char *name,
 452                                                         mode_t mode,
 453                                                         read_proc_t *read_proc,
 454                                                         void *data)
 455 {
 456         if (can_dir)
 457                 return create_proc_read_entry(name, mode, can_dir, read_proc,
 458                                               data);
 459         else
 460                 return NULL;
 461 }
 462
 463 static void can_remove_proc_readentry(const char *name)
 464 {
 465         if (can_dir)
 466                 remove_proc_entry(name, can_dir);
 467 }
 468
 469 /*
 470  * can_init_proc - create main CAN proc directory and procfs entries
 471  */
 472 void can_init_proc(void)
 473 {
 474         /* create /proc/net/can directory */
 475 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 476         can_dir = proc_mkdir("can", init_net.proc_net);
 477 #else
 478         can_dir = proc_mkdir("can", proc_net);
 479 #endif
 480
 481         if (!can_dir) {
 482                 printk(KERN_INFO "can: failed to create /proc/net/can . "
 483                        "CONFIG_PROC_FS missing?\n");
 484                 return;
 485         }
 486
 487         can_dir->owner = THIS_MODULE;
 488
 489         /* own procfs entries from the AF_CAN core */
 490         pde_version     = can_create_proc_readentry(CAN_PROC_VERSION, 0644,
 491                                         can_proc_read_version, NULL);
 492         pde_stats       = can_create_proc_readentry(CAN_PROC_STATS, 0644,
 493                                         can_proc_read_stats, NULL);
 494         pde_reset_stats = can_create_proc_readentry(CAN_PROC_RESET_STATS, 0644,
 495                                         can_proc_read_reset_stats, NULL);
 496         pde_rcvlist_err = can_create_proc_readentry(CAN_PROC_RCVLIST_ERR, 0644,
 497                                         can_proc_read_rcvlist, (void *)RX_ERR);
 498         pde_rcvlist_all = can_create_proc_readentry(CAN_PROC_RCVLIST_ALL, 0644,
 499                                         can_proc_read_rcvlist, (void *)RX_ALL);
 500         pde_rcvlist_fil = can_create_proc_readentry(CAN_PROC_RCVLIST_FIL, 0644,
 501                                         can_proc_read_rcvlist, (void *)RX_FIL);
 502         pde_rcvlist_inv = can_create_proc_readentry(CAN_PROC_RCVLIST_INV, 0644,
 503                                         can_proc_read_rcvlist, (void *)RX_INV);
 504         pde_rcvlist_eff = can_create_proc_readentry(CAN_PROC_RCVLIST_EFF, 0644,
 505                                         can_proc_read_rcvlist, (void *)RX_EFF);
 506         pde_rcvlist_sff = can_create_proc_readentry(CAN_PROC_RCVLIST_SFF, 0644,
 507                                         can_proc_read_rcvlist_sff, NULL);
 508 }
 509
 510 /*
 511  * can_remove_proc - remove procfs entries and main CAN proc directory
 512  */
 513 void can_remove_proc(void)
 514 {
 515         if (pde_version)
 516                 can_remove_proc_readentry(CAN_PROC_VERSION);
 517
 518         if (pde_stats)
 519                 can_remove_proc_readentry(CAN_PROC_STATS);
 520
 521         if (pde_reset_stats)
 522                 can_remove_proc_readentry(CAN_PROC_RESET_STATS);
 523
 524         if (pde_rcvlist_err)
 525                 can_remove_proc_readentry(CAN_PROC_RCVLIST_ERR);
 526
 527         if (pde_rcvlist_all)
 528                 can_remove_proc_readentry(CAN_PROC_RCVLIST_ALL);
 529
 530         if (pde_rcvlist_fil)
 531                 can_remove_proc_readentry(CAN_PROC_RCVLIST_FIL);
 532
 533         if (pde_rcvlist_inv)
 534                 can_remove_proc_readentry(CAN_PROC_RCVLIST_INV);
 535
 536         if (pde_rcvlist_eff)
 537                 can_remove_proc_readentry(CAN_PROC_RCVLIST_EFF);
 538
 539         if (pde_rcvlist_sff)
 540                 can_remove_proc_readentry(CAN_PROC_RCVLIST_SFF);
 541
 542         if (can_dir)
 543 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,24)
 544                 proc_net_remove(&init_net, "can");
 545 #else
 546                 proc_net_remove("can");
 547 #endif
 548 }