]> rtime.felk.cvut.cz Git - sojka/can-utils.git/blobdiff - candump.c
can-utils: AOSP build clean up
[sojka/can-utils.git] / candump.c
index ae203747fd126d024dcceb11cc6b865ec462eb85..b489cd9c657d1e72f8bfec5e39faae322cc3da7d 100644 (file)
--- a/candump.c
+++ b/candump.c
@@ -1,7 +1,3 @@
-/*
- *  $Id$
- */
-
 /*
  * candump.c
  *
@@ -41,7 +37,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>
  *
  */
 
@@ -53,6 +49,7 @@
 #include <ctype.h>
 #include <libgen.h>
 #include <time.h>
+#include <errno.h>
 
 #include <sys/time.h>
 #include <sys/types.h>
 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 */ 
+const int canfd_on = 1;
 
 #define MAXANI 4
 const char anichar[MAXANI] = {'|', '/', '-', '\\'};
+const char extra_m_info[4][4] = {"- -", "B -", "- E", "B E"};
 
 extern int optind, opterr, optopt;
 
@@ -112,10 +114,15 @@ 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, "         -x          (print extra message infos, rx/tx brs esi)\n");
+       fprintf(stderr, "         -T <msecs>  (terminate after <msecs> without any reception)\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");
@@ -196,7 +203,10 @@ 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 extra_msg_info = 0;
        unsigned char silent = SILENT_INI;
        unsigned char silentani = 0;
        unsigned char color = 0;
@@ -209,12 +219,17 @@ int main(int argc, char **argv)
        int currmax, numfilter;
        char *ptr, *nptr;
        struct sockaddr_can addr;
+       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;
+       struct canfd_frame frame;
+       int nbytes, i, maxdlen;
        struct ifreq ifr;
        struct timeval tv, last_tv;
+       struct timeval timeout, timeout_config = { 0, 0 }, *timeout_current = NULL;
        FILE *logfile = NULL;
 
        signal(SIGTERM, sigterm);
@@ -224,7 +239,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:r:h?")) != -1) {
+       while ((opt = getopt(argc, argv, "t:ciaSs:b:B:u:ldxLn:r:heT:?")) != -1) {
                switch (opt) {
                case 't':
                        timestamp = optarg[0];
@@ -252,6 +267,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) {
@@ -286,7 +305,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));
@@ -299,10 +318,22 @@ 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 'x':
+                       extra_msg_info = 1;
+                       break;
+
                case 'L':
                        logfrmt = 1;
                        break;
@@ -323,6 +354,17 @@ int main(int argc, char **argv)
                        }
                        break;
 
+               case 'T':
+                       errno = 0;
+                       timeout_config.tv_usec = strtol(optarg, NULL, 0);
+                       if (errno != 0) {
+                               print_usage(basename(argv[0]));
+                               exit(1);
+                       }
+                       timeout_config.tv_sec = timeout_config.tv_usec / 1000;
+                       timeout_config.tv_usec = (timeout_config.tv_usec % 1000) * 1000;
+                       timeout_current = &timeout;
+                       break;
                default:
                        print_usage(basename(argv[0]));
                        exit(1);
@@ -342,7 +384,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 */
@@ -370,6 +412,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
@@ -428,25 +472,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);
+                                       return 1;
                                }
                        }
 
@@ -462,28 +501,60 @@ int main(int argc, char **argv)
 
                } /* if (nptr) */
 
+               /* try to switch the socket into CAN FD mode */
+               setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_FD_FRAMES, &canfd_on, sizeof(canfd_on));
+
                if (rcvbuf_size) {
 
                        int curr_rcvbuf_size;
                        socklen_t curr_rcvbuf_size_len = sizeof(curr_rcvbuf_size);
 
-                       if (setsockopt(s[i], SOL_SOCKET, SO_RCVBUF,
+                       /* 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) {
-                               perror("setsockopt SO_RCVBUF");
-                               exit(1);
+#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 (getsockopt(s[i], SOL_SOCKET, SO_RCVBUF,
-                                      &curr_rcvbuf_size, &curr_rcvbuf_size_len) < 0) {
-                               perror("getsockopt SO_RCVBUF");
-                               exit(1);
+               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) {
 
-                       /* 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");
+                       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) {
@@ -524,13 +595,23 @@ 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);
                for (i=0; i<currmax; i++)
                        FD_SET(s[i], &rdfs);
 
-               if ((ret = select(s[currmax-1]+1, &rdfs, NULL, NULL, NULL)) < 0) {
+               if (timeout_current)
+                       *timeout_current = timeout_config;
+
+               if ((ret = select(s[currmax-1]+1, &rdfs, NULL, NULL, timeout_current)) <= 0) {
                        //perror("select");
                        running = 0;
                        continue;
@@ -540,17 +621,25 @@ 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 == CAN_MTU)
+                                       maxdlen = CAN_MAX_DLEN;
+                               else if ((size_t)nbytes == CANFD_MTU)
+                                       maxdlen = CANFD_MAX_DLEN;
+                               else {
                                        fprintf(stderr, "read: incomplete CAN frame\n");
                                        return 1;
                                }
@@ -559,36 +648,68 @@ int main(int argc, char **argv)
                                        running = 0;
 
                                if (bridge) {
-                                       nbytes = write(bridge, &frame, sizeof(struct can_frame));
+                                       if (bridge_delay)
+                                               usleep(bridge_delay);
+
+                                       nbytes = write(bridge, &frame, nbytes);
                                        if (nbytes < 0) {
                                                perror("bridge write");
                                                return 1;
-                                       } else if (nbytes < sizeof(struct can_frame)) {
+                                       } else if ((size_t)nbytes != CAN_MTU && (size_t)nbytes != CANFD_MTU) {
                                                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]);
 
+                               /* once we detected a EFF frame indent SFF frames accordingly */
+                               if (frame.can_id & CAN_EFF_FLAG)
+                                       view |= CANLIB_VIEW_INDENT_SFF;
+
                                if (log) {
                                        /* log CAN frame with absolute timestamp & device */
-                                       fprintf(logfile, "(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
+                                       fprintf(logfile, "(%010ld.%06ld) ", tv.tv_sec, tv.tv_usec);
                                        fprintf(logfile, "%*s ", max_devname_len, devname[idx]);
                                        /* without seperator as logfile use-case is parsing */
-                                       fprint_canframe(logfile, &frame, "\n", 0);
+                                       fprint_canframe(logfile, &frame, "\n", 0, maxdlen);
                                }
 
                                if (logfrmt) {
                                        /* print CAN frame in log file style to stdout */
-                                       printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
+                                       printf("(%010ld.%06ld) ", tv.tv_sec, tv.tv_usec);
                                        printf("%*s ", max_devname_len, devname[idx]);
-                                       fprint_canframe(stdout, &frame, "\n", 0);
+                                       fprint_canframe(stdout, &frame, "\n", 0, maxdlen);
                                        goto out_fflush; /* no other output to stdout */
                                }
 
@@ -605,7 +726,7 @@ int main(int argc, char **argv)
                                switch (timestamp) {
 
                                case 'a': /* absolute with timestamp */
-                                       printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
+                                       printf("(%010ld.%06ld) ", tv.tv_sec, tv.tv_usec);
                                        break;
 
                                case 'A': /* absolute with date */
@@ -632,7 +753,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 */
@@ -645,9 +766,18 @@ int main(int argc, char **argv)
 
                                printf(" %s", (color && (color<3))?col_on[idx%MAXCOL]:"");
                                printf("%*s", max_devname_len, devname[idx]);
+
+                               if (extra_msg_info) {
+
+                                       if (msg.msg_flags & MSG_DONTROUTE)
+                                               printf ("  TX %s", extra_m_info[frame.flags & 3]);
+                                       else
+                                               printf ("  RX %s", extra_m_info[frame.flags & 3]);
+                               }
+
                                printf("%s  ", (color==1)?col_off:"");
 
-                               fprint_long_canframe(stdout, &frame, NULL, view);
+                               fprint_long_canframe(stdout, &frame, NULL, view, maxdlen);
 
                                printf("%s", (color>1)?col_off:"");
                                printf("\n");