canbusload.c

   1 /*
   2  * canbusload.c
   3  *
   4  * Copyright (c) 2002-2008 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 <linux-can@vger.kernel.org>
  41  *
  42  */
  43
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <unistd.h>
  47 #include <string.h>
  48 #include <signal.h>
  49 #include <ctype.h>
  50 #include <libgen.h>
  51 #include <time.h>
  52
  53 #include <sys/time.h>
  54 #include <sys/types.h>
  55 #include <sys/socket.h>
  56 #include <sys/ioctl.h>
  57 #include <sys/uio.h>
  58 #include <net/if.h>
  59
  60 #include <linux/can.h>
  61 #include <linux/can/raw.h>
  62
  63 #include "terminal.h"
  64 #include "canframelen.h"
  65
  66 #define MAXSOCK 16    /* max. number of CAN interfaces given on the cmdline */
  67
  68 #define PERCENTRES 5 /* resolution in percent for bargraph */
  69 #define NUMBAR (100/PERCENTRES) /* number of bargraph elements */
  70
  71 extern int optind, opterr, optopt;
  72
  73 static struct {
  74         char devname[IFNAMSIZ+1];
  75         unsigned int bitrate;
  76         unsigned int recv_frames;
  77         unsigned int recv_bits_total;
  78         unsigned int recv_bits_payload;
  79 } stat[MAXSOCK+1];
  80
  81 static int  max_devname_len; /* to prevent frazzled device name output */
  82 static int  max_bitrate_len;
  83 static int  currmax;
  84 static unsigned char redraw;
  85 static unsigned char timestamp;
  86 static unsigned char color;
  87 static unsigned char bargraph;
  88 static enum cfl_mode mode = CFL_WORSTCASE;
  89 static char *prg;
  90
  91 void print_usage(char *prg)
  92 {
  93         fprintf(stderr, "\nUsage: %s [options] <CAN interface>+\n", prg);
  94         fprintf(stderr, "  (use CTRL-C to terminate %s)\n\n", prg);
  95         fprintf(stderr, "Options: -t (show current time on the first line)\n");
  96         fprintf(stderr, "         -c (colorize lines)\n");
  97         fprintf(stderr, "         -b (show bargraph in %d%% resolution)\n", PERCENTRES);
  98         fprintf(stderr, "         -r (redraw the terminal - similar to top)\n");
  99         fprintf(stderr, "         -i (ignore bitstuffing in bandwidth calculation)\n");
 100         fprintf(stderr, "         -e (exact calculation of stuffed bits)\n");
 101         fprintf(stderr, "\n");
 102         fprintf(stderr, "Up to %d CAN interfaces with mandatory bitrate can be specified on the \n", MAXSOCK);
 103         fprintf(stderr, "commandline in the form: <ifname>@<bitrate>\n\n");
 104         fprintf(stderr, "The bitrate is mandatory as it is needed to know the CAN bus bitrate to\n");
 105         fprintf(stderr, "calcultate the bus load percentage based on the received CAN frames.\n");
 106         fprintf(stderr, "Due to the bitstuffing estimation the calculated busload may exceed 100%%.\n");
 107         fprintf(stderr, "For each given interface the data is presented in one line which contains:\n\n");
 108         fprintf(stderr, "(interface) (received CAN frames) (used bits total) (used bits for payload)\n");
 109         fprintf(stderr, "\nExample:\n");
 110         fprintf(stderr, "\nuser$> canbusload can0@100000 can1@500000 can2@500000 can3@500000 -r -t -b -c\n\n");
 111         fprintf(stderr, "%s 2014-02-01 21:13:16 (worst case bitstuffing)\n", prg);
 112         fprintf(stderr, " can0@100000   805   74491  36656  74%% |XXXXXXXXXXXXXX......|\n");
 113         fprintf(stderr, " can1@500000   796   75140  37728  15%% |XXX.................|\n");
 114         fprintf(stderr, " can2@500000     0       0      0   0%% |....................|\n");
 115         fprintf(stderr, " can3@500000    47    4633   2424   0%% |....................|\n");
 116         fprintf(stderr, "\n");
 117 }
 118
 119 void sigterm(int signo)
 120 {
 121         exit(0);
 122 }
 123
 124 void printstats(int signo)
 125 {
 126         int i, j, percent;
 127
 128         if (redraw)
 129                 printf("%s", CSR_HOME);
 130
 131         if (timestamp) {
 132                 time_t currtime;
 133                 struct tm now;
 134
 135                 if (time(&currtime) == (time_t)-1) {
 136                         perror("time");
 137                         exit(1);
 138                 }
 139
 140                 localtime_r(&currtime, &now);
 141
 142                 printf("%s %04d-%02d-%02d %02d:%02d:%02d ",
 143                        prg,
 144                        now.tm_year + 1900,
 145                        now.tm_mon + 1,
 146                        now.tm_mday,
 147                        now.tm_hour,
 148                        now.tm_min,
 149                        now.tm_sec);
 150
 151                 switch (mode) {
 152
 153                 case CFL_NO_BITSTUFFING:
 154                         /* plain bit calculation without bitstuffing */
 155                         printf("(ignore bitstuffing)\n");
 156                         break;
 157
 158                 case CFL_WORSTCASE:
 159                         /* worst case estimation - see above */
 160                         printf("(worst case bitstuffing)\n");
 161                         break;
 162
 163                 case CFL_EXACT:
 164                         /* exact calculation of stuffed bits based on frame content and CRC */
 165                         printf("(exact bitstuffing)\n");
 166                         break;
 167
 168                 default:
 169                         printf("(unknown bitstuffing)\n");
 170                         break;
 171                 }
 172         }
 173
 174         for (i=0; i<currmax; i++) {
 175
 176                 if (color) {
 177                         if (i%2)
 178                                 printf("%s", FGRED);
 179                         else
 180                                 printf("%s", FGBLUE);
 181                 }
 182
 183                 if (stat[i].bitrate)
 184                         percent = (stat[i].recv_bits_total*100)/stat[i].bitrate;
 185                 else
 186                         percent = 0;
 187
 188                 printf(" %*s@%-*d %5d %7d %6d %3d%%",
 189                        max_devname_len, stat[i].devname,
 190                        max_bitrate_len, stat[i].bitrate,
 191                        stat[i].recv_frames,
 192                        stat[i].recv_bits_total,
 193                        stat[i].recv_bits_payload,
 194                        percent);
 195
 196                 if (bargraph) {
 197
 198                         printf(" |");
 199
 200                         if (percent > 100)
 201                                 percent = 100;
 202
 203                         for (j=0; j < NUMBAR; j++){
 204                                 if (j < percent/PERCENTRES)
 205                                         printf("X");
 206                                 else
 207                                         printf(".");
 208                         }
 209
 210                         printf("|");
 211                 }
 212
 213                 if (color)
 214                         printf("%s", ATTRESET);
 215
 216                 printf("\n");
 217
 218                 stat[i].recv_frames = 0;
 219                 stat[i].recv_bits_total = 0;
 220                 stat[i].recv_bits_payload = 0;
 221         }
 222
 223         printf("\n");
 224         fflush(stdout);
 225
 226         alarm(1);
 227 }
 228
 229 int main(int argc, char **argv)
 230 {
 231         fd_set rdfs;
 232         int s[MAXSOCK];
 233
 234         int opt;
 235         char *ptr, *nptr;
 236         struct sockaddr_can addr;
 237         struct can_frame frame;
 238         int nbytes, i;
 239         struct ifreq ifr;
 240         sigset_t sigmask, savesigmask;
 241
 242         signal(SIGTERM, sigterm);
 243         signal(SIGHUP, sigterm);
 244         signal(SIGINT, sigterm);
 245
 246         signal(SIGALRM, printstats);
 247
 248         prg = basename(argv[0]);
 249
 250         while ((opt = getopt(argc, argv, "rtbcieh?")) != -1) {
 251                 switch (opt) {
 252                 case 'r':
 253                         redraw = 1;
 254                         break;
 255
 256                 case 't':
 257                         timestamp = 1;
 258                         break;
 259
 260                 case 'b':
 261                         bargraph = 1;
 262                         break;
 263
 264                 case 'c':
 265                         color = 1;
 266                         break;
 267
 268                 case 'i':
 269                         mode = CFL_NO_BITSTUFFING;
 270                         break;
 271
 272                 case 'e':
 273                         mode = CFL_EXACT;
 274                         break;
 275
 276                 default:
 277                         print_usage(prg);
 278                         exit(1);
 279                         break;
 280                 }
 281         }
 282
 283         if (optind == argc) {
 284                 print_usage(prg);
 285                 exit(0);
 286         }
 287
 288         currmax = argc - optind; /* find real number of CAN devices */
 289
 290         if (currmax > MAXSOCK) {
 291                 printf("More than %d CAN devices given on commandline!\n", MAXSOCK);
 292                 return 1;
 293         }
 294
 295         for (i=0; i < currmax; i++) {
 296
 297                 ptr = argv[optind+i];
 298
 299                 nbytes = strlen(ptr);
 300                 if (nbytes >= IFNAMSIZ+sizeof("@1000000")+1) {
 301                         printf("name of CAN device '%s' is too long!\n", ptr);
 302                         return 1;
 303                 }
 304
 305 #ifdef DEBUG
 306                 printf("open %d '%s'.\n", i, ptr);
 307 #endif
 308
 309                 s[i] = socket(PF_CAN, SOCK_RAW, CAN_RAW);
 310                 if (s[i] < 0) {
 311                         perror("socket");
 312                         return 1;
 313                 }
 314
 315                 nptr = strchr(ptr, '@');
 316
 317                 if (!nptr) {
 318                         print_usage(prg);
 319                         return 1;
 320                 }
 321
 322                 nbytes = nptr - ptr;  /* interface name is up the first '@' */
 323
 324                 if (nbytes >= IFNAMSIZ) {
 325                         printf("name of CAN device '%s' is too long!\n", ptr);
 326                         return 1;
 327                 }
 328
 329                 strncpy(stat[i].devname, ptr, nbytes);
 330                 memset(&ifr.ifr_name, 0, sizeof(ifr.ifr_name));
 331                 strncpy(ifr.ifr_name, ptr, nbytes);
 332
 333                 if (nbytes > max_devname_len)
 334                         max_devname_len = nbytes; /* for nice printing */
 335
 336                 stat[i].bitrate = atoi(nptr+1); /* bitrate is placed behind the '@' */
 337
 338                 if (!stat[i].bitrate || stat[i].bitrate > 1000000) {
 339                         printf("invalid bitrate for CAN device '%s'!\n", ptr);
 340                         return 1;
 341                 }
 342
 343                 nbytes = strlen(nptr+1);
 344                 if (nbytes > max_bitrate_len)
 345                         max_bitrate_len = nbytes; /* for nice printing */
 346
 347
 348 #ifdef DEBUG
 349                 printf("using interface name '%s'.\n", ifr.ifr_name);
 350 #endif
 351
 352                 if (ioctl(s[i], SIOCGIFINDEX, &ifr) < 0) {
 353                         perror("SIOCGIFINDEX");
 354                         exit(1);
 355                 }
 356
 357                 addr.can_family = AF_CAN;
 358                 addr.can_ifindex = ifr.ifr_ifindex;
 359
 360                 if (bind(s[i], (struct sockaddr *)&addr, sizeof(addr)) < 0) {
 361                         perror("bind");
 362                         return 1;
 363                 }
 364         }
 365
 366         alarm(1);
 367
 368         if (redraw)
 369                 printf("%s", CLR_SCREEN);
 370
 371         while (1) {
 372
 373                 FD_ZERO(&rdfs);
 374                 for (i=0; i<currmax; i++)
 375                         FD_SET(s[i], &rdfs);
 376
 377                 savesigmask = sigmask;
 378
 379                 if (pselect(s[currmax-1]+1, &rdfs, NULL, NULL, NULL, &sigmask) < 0) {
 380                         //perror("pselect");
 381                         sigmask = savesigmask;
 382                         continue;
 383                 }
 384
 385                 for (i=0; i<currmax; i++) {  /* check all CAN RAW sockets */
 386
 387                         if (FD_ISSET(s[i], &rdfs)) {
 388
 389                                 nbytes = read(s[i], &frame, sizeof(struct can_frame));
 390
 391                                 if (nbytes < 0) {
 392                                         perror("read");
 393                                         return 1;
 394                                 }
 395
 396                                 if (nbytes < sizeof(struct can_frame)) {
 397                                         fprintf(stderr, "read: incomplete CAN frame\n");
 398                                         return 1;
 399                                 }
 400
 401                                 stat[i].recv_frames++;
 402                                 stat[i].recv_bits_payload += frame.can_dlc*8;
 403                                 stat[i].recv_bits_total += can_frame_length((struct canfd_frame*)&frame,
 404                                                                             mode, sizeof(frame));
 405                         }
 406                 }
 407         }
 408
 409         for (i=0; i<currmax; i++)
 410                 close(s[i]);
 411
 412         return 0;
 413 }