]> rtime.felk.cvut.cz Git - sojka/can-utils.git/blobdiff - candump.c
Update includes to Linux 3.6 with CAN FD support.
[sojka/can-utils.git] / candump.c
index a106bfd577d563832079ec121090f2ccd38045d5..ac51192354b06d76a91d4b4fcbd08ed5e80f9401 100644 (file)
--- a/candump.c
+++ b/candump.c
@@ -5,7 +5,7 @@
 /*
  * candump.c
  *
- * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
+ * Copyright (c) 2002-2009 Volkswagen Group Electronic Research
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -41,7 +41,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  * DAMAGE.
  *
- * Send feedback to <socketcan-users@lists.berlios.de>
+ * Send feedback to <linux-can@vger.kernel.org>
  *
  */
 
@@ -68,7 +68,6 @@
 #include "lib.h"
 
 #define MAXSOCK 16    /* max. number of CAN interfaces given on the cmdline */
-#define MAXFILTER 30  /* max. number of possible filters for each socket */
 #define MAXIFNAMES 30 /* size of receive name index to omit ioctls */
 #define MAXCOL 6      /* number of different colors for colorized output */
 #define ANYDEV "any"  /* name of interface to receive from any CAN interface */
@@ -90,6 +89,9 @@
 const char col_on [MAXCOL][19] = {BLUE, RED, GREEN, BOLD, MAGENTA, CYAN};
 const char col_off [] = ATTRESET;
 
+static char *cmdlinename[MAXSOCK];
+static __u32 dropcnt[MAXSOCK];
+static __u32 last_dropcnt[MAXSOCK];
 static char devname[MAXIFNAMES][IFNAMSIZ+1];
 static int  dindex[MAXIFNAMES];
 static int  max_devname_len; /* to prevent frazzled device name output */ 
@@ -113,13 +115,17 @@ void print_usage(char *prg)
        fprintf(stderr, "         -s <level>  (silent mode - %d: off (default) %d: animation %d: silent)\n", SILENT_OFF, SILENT_ANI, SILENT_ON);
        fprintf(stderr, "         -b <can>    (bridge mode - send received frames to <can>)\n");
        fprintf(stderr, "         -B <can>    (bridge mode - like '-b' with disabled loopback)\n");
+       fprintf(stderr, "         -u <usecs>  (delay bridge forwarding by <usecs> microseconds)\n");
        fprintf(stderr, "         -l          (log CAN-frames into file. Sets '-s %d' by default)\n", SILENT_ON);
        fprintf(stderr, "         -L          (use log file format on stdout)\n");
        fprintf(stderr, "         -n <count>  (terminate after receiption of <count> CAN frames)\n");
+       fprintf(stderr, "         -r <size>   (set socket receive buffer to <size>)\n");
+       fprintf(stderr, "         -d          (monitor dropped CAN frames)\n");
+       fprintf(stderr, "         -e          (dump CAN error frames in human-readable format)\n");
        fprintf(stderr, "\n");
        fprintf(stderr, "Up to %d CAN interfaces with optional filter sets can be specified\n", MAXSOCK);
        fprintf(stderr, "on the commandline in the form: <ifname>[,filter]*\n");
-       fprintf(stderr, "\nUp to %d comma separated filters can be specified for each given CAN interface:\n", MAXFILTER);
+       fprintf(stderr, "\nComma separated filters can be specified for each given CAN interface:\n");
        fprintf(stderr, " <can_id>:<can_mask> (matches when <received_can_id> & mask == can_id & mask)\n");
        fprintf(stderr, " <can_id>~<can_mask> (matches when <received_can_id> & mask != can_id & mask)\n");
        fprintf(stderr, " #<error_mask>       (set error frame filter, see include/linux/can/error.h)\n");
@@ -196,7 +202,9 @@ int main(int argc, char **argv)
        fd_set rdfs;
        int s[MAXSOCK];
        int bridge = 0;
+       useconds_t bridge_delay = 0;
        unsigned char timestamp = 0;
+       unsigned char dropmonitor = 0;
        unsigned char silent = SILENT_INI;
        unsigned char silentani = 0;
        unsigned char color = 0;
@@ -204,11 +212,16 @@ int main(int argc, char **argv)
        unsigned char log = 0;
        unsigned char logfrmt = 0;
        int count = 0;
+       int rcvbuf_size = 0;
        int opt, ret;
        int currmax, numfilter;
        char *ptr, *nptr;
        struct sockaddr_can addr;
-       struct can_filter rfilter[MAXFILTER];
+       char ctrlmsg[CMSG_SPACE(sizeof(struct timeval)) + CMSG_SPACE(sizeof(__u32))];
+       struct iovec iov;
+       struct msghdr msg;
+       struct cmsghdr *cmsg;
+       struct can_filter *rfilter;
        can_err_mask_t err_mask;
        struct can_frame frame;
        int nbytes, i;
@@ -223,7 +236,7 @@ int main(int argc, char **argv)
        last_tv.tv_sec  = 0;
        last_tv.tv_usec = 0;
 
-       while ((opt = getopt(argc, argv, "t:ciaSs:b:B:lLn:h?")) != -1) {
+       while ((opt = getopt(argc, argv, "t:ciaSs:b:B:u:ldLn:r:he?")) != -1) {
                switch (opt) {
                case 't':
                        timestamp = optarg[0];
@@ -251,6 +264,10 @@ int main(int argc, char **argv)
                        view |= CANLIB_VIEW_SWAP;
                        break;
 
+               case 'e':
+                       view |= CANLIB_VIEW_ERROR;
+                       break;
+
                case 's':
                        silent = atoi(optarg);
                        if (silent > SILENT_ON) {
@@ -285,7 +302,7 @@ int main(int argc, char **argv)
                                setsockopt(bridge, SOL_CAN_RAW, CAN_RAW_FILTER, NULL, 0);
 
                                if (opt == 'B') {
-                                       int loopback = 0;
+                                       const int loopback = 0;
 
                                        setsockopt(bridge, SOL_CAN_RAW, CAN_RAW_LOOPBACK,
                                                   &loopback, sizeof(loopback));
@@ -298,10 +315,18 @@ int main(int argc, char **argv)
                        }
                        break;
            
+               case 'u':
+                       bridge_delay = (useconds_t)strtoul(optarg, (char **)NULL, 10);
+                       break;
+
                case 'l':
                        log = 1;
                        break;
 
+               case 'd':
+                       dropmonitor = 1;
+                       break;
+
                case 'L':
                        logfrmt = 1;
                        break;
@@ -314,6 +339,14 @@ int main(int argc, char **argv)
                        }
                        break;
 
+               case 'r':
+                       rcvbuf_size = atoi(optarg);
+                       if (rcvbuf_size < 1) {
+                               print_usage(basename(argv[0]));
+                               exit(1);
+                       }
+                       break;
+
                default:
                        print_usage(basename(argv[0]));
                        exit(1);
@@ -333,7 +366,7 @@ int main(int argc, char **argv)
 
        if (silent == SILENT_INI) {
                if (log) {
-                       fprintf(stderr, "\nDisabled standard output while logging.");
+                       fprintf(stderr, "Disabled standard output while logging.\n");
                        silent = SILENT_ON; /* disable output on stdout */
                } else
                        silent = SILENT_OFF; /* default output */
@@ -361,6 +394,8 @@ int main(int argc, char **argv)
                        return 1;
                }
 
+               cmdlinename[i] = ptr; /* save pointer to cmdline name of this socket */
+
                if (nptr)
                        nbytes = nptr - ptr;  /* interface name is up the first ',' */
                else
@@ -396,6 +431,21 @@ int main(int argc, char **argv)
 
                        /* found a ',' after the interface name => check for filters */
 
+                       /* determine number of filters to alloc the filter space */
+                       numfilter = 0;
+                       ptr = nptr;
+                       while (ptr) {
+                               numfilter++;
+                               ptr++; /* hop behind the ',' */
+                               ptr = strchr(ptr, ','); /* exit condition */
+                       }
+
+                       rfilter = malloc(sizeof(struct can_filter) * numfilter);
+                       if (!rfilter) {
+                               fprintf(stderr, "Failed to create filter space!\n");
+                               return 1;
+                       }
+
                        numfilter = 0;
                        err_mask = 0;
 
@@ -404,31 +454,20 @@ int main(int argc, char **argv)
                                ptr = nptr+1; /* hop behind the ',' */
                                nptr = strchr(ptr, ','); /* update exit condition */
 
-                               if (sscanf(ptr, "%lx:%lx",
-                                          (long unsigned int *)
+                               if (sscanf(ptr, "%x:%x",
                                           &rfilter[numfilter].can_id, 
-                                          (long unsigned int *)
                                           &rfilter[numfilter].can_mask) == 2) {
                                        rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
                                        numfilter++;
-                               } else if (sscanf(ptr, "%lx~%lx",
-                                                 (long unsigned int *)
+                               } else if (sscanf(ptr, "%x~%x",
                                                  &rfilter[numfilter].can_id, 
-                                                 (long unsigned int *)
                                                  &rfilter[numfilter].can_mask) == 2) {
                                        rfilter[numfilter].can_id |= CAN_INV_FILTER;
                                        rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
                                        numfilter++;
-                               } else if (sscanf(ptr, "#%lx",
-                                                 (long unsigned int *)&err_mask) != 1) { 
+                               } else if (sscanf(ptr, "#%x", &err_mask) != 1) { 
                                        fprintf(stderr, "Error in filter option parsing: '%s'\n", ptr);
-                                       exit(1);
-                               }
-
-                               if (numfilter > MAXFILTER) {
-                                       fprintf(stderr, "Too many filters specified for '%s'.\n",
-                                              ifr.ifr_name);
-                                       exit(1);
+                                       return 1;
                                }
                        }
 
@@ -438,9 +477,65 @@ int main(int argc, char **argv)
 
                        if (numfilter)
                                setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_FILTER,
-                                          &rfilter, numfilter * sizeof(struct can_filter));
+                                          rfilter, numfilter * sizeof(struct can_filter));
+
+                       free(rfilter);
+
                } /* if (nptr) */
 
+               if (rcvbuf_size) {
+
+                       int curr_rcvbuf_size;
+                       socklen_t curr_rcvbuf_size_len = sizeof(curr_rcvbuf_size);
+
+                       /* try SO_RCVBUFFORCE first, if we run with CAP_NET_ADMIN */
+                       if (setsockopt(s[i], SOL_SOCKET, SO_RCVBUFFORCE,
+                                      &rcvbuf_size, sizeof(rcvbuf_size)) < 0) {
+#ifdef DEBUG
+                               printf("SO_RCVBUFFORCE failed so try SO_RCVBUF ...\n");
+#endif
+                               if (setsockopt(s[i], SOL_SOCKET, SO_RCVBUF,
+                                              &rcvbuf_size, sizeof(rcvbuf_size)) < 0) {
+                                       perror("setsockopt SO_RCVBUF");
+                                       return 1;
+                               }
+
+                               if (getsockopt(s[i], SOL_SOCKET, SO_RCVBUF,
+                                              &curr_rcvbuf_size, &curr_rcvbuf_size_len) < 0) {
+                                       perror("getsockopt SO_RCVBUF");
+                                       return 1;
+                               }
+
+                               /* Only print a warning the first time we detect the adjustment */
+                               /* n.b.: The wanted size is doubled in Linux in net/sore/sock.c */
+                               if (!i && curr_rcvbuf_size < rcvbuf_size*2)
+                                       fprintf(stderr, "The socket receive buffer size was "
+                                               "adjusted due to /proc/sys/net/core/rmem_max.\n");
+                       }
+               }
+
+               if (timestamp || log || logfrmt) {
+
+                       const int timestamp_on = 1;
+
+                       if (setsockopt(s[i], SOL_SOCKET, SO_TIMESTAMP,
+                                      &timestamp_on, sizeof(timestamp_on)) < 0) {
+                               perror("setsockopt SO_TIMESTAMP");
+                               return 1;
+                       }
+               }
+
+               if (dropmonitor) {
+
+                       const int dropmonitor_on = 1;
+
+                       if (setsockopt(s[i], SOL_SOCKET, SO_RXQ_OVFL,
+                                      &dropmonitor_on, sizeof(dropmonitor_on)) < 0) {
+                               perror("setsockopt SO_RXQ_OVFL not supported by your Linux Kernel");
+                               return 1;
+                       }
+               }
+
                if (bind(s[i], (struct sockaddr *)&addr, sizeof(addr)) < 0) {
                        perror("bind");
                        return 1;
@@ -479,6 +574,13 @@ int main(int argc, char **argv)
                }
        }
 
+       /* these settings are static and can be held out of the hot path */
+       iov.iov_base = &frame;
+       msg.msg_name = &addr;
+       msg.msg_iov = &iov;
+       msg.msg_iovlen = 1;
+       msg.msg_control = &ctrlmsg;
+
        while (running) {
 
                FD_ZERO(&rdfs);
@@ -495,17 +597,21 @@ int main(int argc, char **argv)
 
                        if (FD_ISSET(s[i], &rdfs)) {
 
-                               socklen_t len = sizeof(addr);
                                int idx;
 
-                               nbytes = recvfrom(s[i], &frame, sizeof(struct can_frame), 0,
-                                                 (struct sockaddr*)&addr, &len);
+                               /* these settings may be modified by recvmsg() */
+                               iov.iov_len = sizeof(frame);
+                               msg.msg_namelen = sizeof(addr);
+                               msg.msg_controllen = sizeof(ctrlmsg);  
+                               msg.msg_flags = 0;
+
+                               nbytes = recvmsg(s[i], &msg, 0);
                                if (nbytes < 0) {
                                        perror("read");
                                        return 1;
                                }
 
-                               if (nbytes < sizeof(struct can_frame)) {
+                               if ((size_t)nbytes < sizeof(struct can_frame)) {
                                        fprintf(stderr, "read: incomplete CAN frame\n");
                                        return 1;
                                }
@@ -514,20 +620,48 @@ int main(int argc, char **argv)
                                        running = 0;
 
                                if (bridge) {
+                                       if (bridge_delay)
+                                               usleep(bridge_delay);
+
                                        nbytes = write(bridge, &frame, sizeof(struct can_frame));
                                        if (nbytes < 0) {
                                                perror("bridge write");
                                                return 1;
-                                       } else if (nbytes < sizeof(struct can_frame)) {
+                                       } else if ((size_t)nbytes < sizeof(struct can_frame)) {
                                                fprintf(stderr,"bridge write: incomplete CAN frame\n");
                                                return 1;
                                        }
                                }
                    
-                               if (timestamp || log || logfrmt)
-                                       if (ioctl(s[i], SIOCGSTAMP, &tv) < 0)
-                                               perror("SIOCGSTAMP");
+                               for (cmsg = CMSG_FIRSTHDR(&msg);
+                                    cmsg && (cmsg->cmsg_level == SOL_SOCKET);
+                                    cmsg = CMSG_NXTHDR(&msg,cmsg)) {
+                                       if (cmsg->cmsg_type == SO_TIMESTAMP)
+                                               tv = *(struct timeval *)CMSG_DATA(cmsg);
+                                       else if (cmsg->cmsg_type == SO_RXQ_OVFL)
+                                               dropcnt[i] = *(__u32 *)CMSG_DATA(cmsg);
+                               }
+
+                               /* check for (unlikely) dropped frames on this specific socket */
+                               if (dropcnt[i] != last_dropcnt[i]) {
+
+                                       __u32 frames;
+
+                                       if (dropcnt[i] > last_dropcnt[i])
+                                               frames = dropcnt[i] - last_dropcnt[i];
+                                       else
+                                               frames = 4294967295U - last_dropcnt[i] + dropcnt[i]; /* 4294967295U == UINT32_MAX */
 
+                                       if (silent != SILENT_ON)
+                                               printf("DROPCOUNT: dropped %d CAN frame%s on '%s' socket (total drops %d)\n",
+                                                      frames, (frames > 1)?"s":"", cmdlinename[i], dropcnt[i]);
+
+                                       if (log)
+                                               fprintf(logfile, "DROPCOUNT: dropped %d CAN frame%s on '%s' socket (total drops %d)\n",
+                                                       frames, (frames > 1)?"s":"", cmdlinename[i], dropcnt[i]);
+
+                                       last_dropcnt[i] = dropcnt[i];
+                               }
 
                                idx = idx2dindex(addr.can_ifindex, s[i]);
 
@@ -587,7 +721,7 @@ int main(int argc, char **argv)
                                                diff.tv_sec--, diff.tv_usec += 1000000;
                                        if (diff.tv_sec < 0)
                                                diff.tv_sec = diff.tv_usec = 0;
-                                       printf("(%ld.%06ld) ", diff.tv_sec, diff.tv_usec);
+                                       printf("(%03ld.%06ld) ", diff.tv_sec, diff.tv_usec);
                                
                                        if (timestamp == 'd')
                                                last_tv = tv; /* update for delta calculation */