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