8 * Copyright (c) 2002-2009 Volkswagen Group Electronic Research
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of Volkswagen nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * Alternatively, provided that this notice is retained in full, this
24 * software may be distributed under the terms of the GNU General
25 * Public License ("GPL") version 2, in which case the provisions of the
26 * GPL apply INSTEAD OF those given above.
28 * The provided data structures and external interfaces from this code
29 * are not restricted to be used by modules with a GPL compatible license.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
44 * Send feedback to <linux-can@vger.kernel.org>
58 #include <sys/types.h>
59 #include <sys/socket.h>
60 #include <sys/ioctl.h>
64 #include <linux/can.h>
65 #include <linux/can/raw.h>
70 #define MAXSOCK 16 /* max. number of CAN interfaces given on the cmdline */
71 #define MAXIFNAMES 30 /* size of receive name index to omit ioctls */
72 #define MAXCOL 6 /* number of different colors for colorized output */
73 #define ANYDEV "any" /* name of interface to receive from any CAN interface */
74 #define ANL "\r\n" /* newline in ASC mode */
76 #define SILENT_INI 42 /* detect user setting on commandline */
77 #define SILENT_OFF 0 /* no silent mode */
78 #define SILENT_ANI 1 /* silent mode with animation */
79 #define SILENT_ON 2 /* silent mode (completely silent) */
82 #define RED ATTBOLD FGRED
83 #define GREEN ATTBOLD FGGREEN
84 #define YELLOW ATTBOLD FGYELLOW
85 #define BLUE ATTBOLD FGBLUE
86 #define MAGENTA ATTBOLD FGMAGENTA
87 #define CYAN ATTBOLD FGCYAN
89 const char col_on [MAXCOL][19] = {BLUE, RED, GREEN, BOLD, MAGENTA, CYAN};
90 const char col_off [] = ATTRESET;
92 static char *cmdlinename[MAXSOCK];
93 static __u32 dropcnt[MAXSOCK];
94 static __u32 last_dropcnt[MAXSOCK];
95 static char devname[MAXIFNAMES][IFNAMSIZ+1];
96 static int dindex[MAXIFNAMES];
97 static int max_devname_len; /* to prevent frazzled device name output */
98 const int canfd_on = 1;
101 const char anichar[MAXANI] = {'|', '/', '-', '\\'};
102 const char extra_m_info[4][4] = {"- -", "B -", "- E", "B E"};
104 extern int optind, opterr, optopt;
106 static volatile int running = 1;
108 void print_usage(char *prg)
110 fprintf(stderr, "\nUsage: %s [options] <CAN interface>+\n", prg);
111 fprintf(stderr, " (use CTRL-C to terminate %s)\n\n", prg);
112 fprintf(stderr, "Options: -t <type> (timestamp: (a)bsolute/(d)elta/(z)ero/(A)bsolute w date)\n");
113 fprintf(stderr, " -c (increment color mode level)\n");
114 fprintf(stderr, " -i (binary output - may exceed 80 chars/line)\n");
115 fprintf(stderr, " -a (enable additional ASCII output)\n");
116 fprintf(stderr, " -S (swap byte order in printed CAN data[] - marked with '%c' )\n", SWAP_DELIMITER);
117 fprintf(stderr, " -s <level> (silent mode - %d: off (default) %d: animation %d: silent)\n", SILENT_OFF, SILENT_ANI, SILENT_ON);
118 fprintf(stderr, " -b <can> (bridge mode - send received frames to <can>)\n");
119 fprintf(stderr, " -B <can> (bridge mode - like '-b' with disabled loopback)\n");
120 fprintf(stderr, " -u <usecs> (delay bridge forwarding by <usecs> microseconds)\n");
121 fprintf(stderr, " -l (log CAN-frames into file. Sets '-s %d' by default)\n", SILENT_ON);
122 fprintf(stderr, " -L (use log file format on stdout)\n");
123 fprintf(stderr, " -n <count> (terminate after receiption of <count> CAN frames)\n");
124 fprintf(stderr, " -r <size> (set socket receive buffer to <size>)\n");
125 fprintf(stderr, " -d (monitor dropped CAN frames)\n");
126 fprintf(stderr, " -e (dump CAN error frames in human-readable format)\n");
127 fprintf(stderr, " -x (print extra message infos, rx/tx brs esi)\n");
128 fprintf(stderr, "\n");
129 fprintf(stderr, "Up to %d CAN interfaces with optional filter sets can be specified\n", MAXSOCK);
130 fprintf(stderr, "on the commandline in the form: <ifname>[,filter]*\n");
131 fprintf(stderr, "\nComma separated filters can be specified for each given CAN interface:\n");
132 fprintf(stderr, " <can_id>:<can_mask> (matches when <received_can_id> & mask == can_id & mask)\n");
133 fprintf(stderr, " <can_id>~<can_mask> (matches when <received_can_id> & mask != can_id & mask)\n");
134 fprintf(stderr, " #<error_mask> (set error frame filter, see include/linux/can/error.h)\n");
135 fprintf(stderr, "\nCAN IDs, masks and data content are given and expected in hexadecimal values.\n");
136 fprintf(stderr, "When can_id and can_mask are both 8 digits, they are assumed to be 29 bit EFF.\n");
137 fprintf(stderr, "Without any given filter all data frames are received ('0:0' default filter).\n");
138 fprintf(stderr, "\nUse interface name '%s' to receive from all CAN interfaces.\n", ANYDEV);
139 fprintf(stderr, "\nExamples:\n");
140 fprintf(stderr, "%s -c -c -ta can0,123:7FF,400:700,#000000FF can2,400~7F0 can3 can8\n", prg);
141 fprintf(stderr, "%s -l any,0~0,#FFFFFFFF (log only error frames but no(!) data frames)\n", prg);
142 fprintf(stderr, "%s -l any,0:0,#FFFFFFFF (log error frames and also all data frames)\n", prg);
143 fprintf(stderr, "%s vcan2,92345678:DFFFFFFF (match only for extended CAN ID 12345678)\n", prg);
144 fprintf(stderr, "%s vcan2,123:7FF (matches CAN ID 123 - including EFF and RTR frames)\n", prg);
145 fprintf(stderr, "%s vcan2,123:C00007FF (matches CAN ID 123 - only SFF and non-RTR frames)\n", prg);
146 fprintf(stderr, "\n");
149 void sigterm(int signo)
154 int idx2dindex(int ifidx, int socket) {
159 for (i=0; i < MAXIFNAMES; i++) {
160 if (dindex[i] == ifidx)
164 /* create new interface index cache entry */
166 /* remove index cache zombies first */
167 for (i=0; i < MAXIFNAMES; i++) {
169 ifr.ifr_ifindex = dindex[i];
170 if (ioctl(socket, SIOCGIFNAME, &ifr) < 0)
175 for (i=0; i < MAXIFNAMES; i++)
176 if (!dindex[i]) /* free entry */
179 if (i == MAXIFNAMES) {
180 fprintf(stderr, "Interface index cache only supports %d interfaces.\n",
187 ifr.ifr_ifindex = ifidx;
188 if (ioctl(socket, SIOCGIFNAME, &ifr) < 0)
189 perror("SIOCGIFNAME");
191 if (max_devname_len < strlen(ifr.ifr_name))
192 max_devname_len = strlen(ifr.ifr_name);
194 strcpy(devname[i], ifr.ifr_name);
197 printf("new index %d (%s)\n", i, devname[i]);
203 int main(int argc, char **argv)
208 useconds_t bridge_delay = 0;
209 unsigned char timestamp = 0;
210 unsigned char dropmonitor = 0;
211 unsigned char extra_msg_info = 0;
212 unsigned char silent = SILENT_INI;
213 unsigned char silentani = 0;
214 unsigned char color = 0;
215 unsigned char view = 0;
216 unsigned char log = 0;
217 unsigned char logfrmt = 0;
221 int currmax, numfilter;
223 struct sockaddr_can addr;
224 char ctrlmsg[CMSG_SPACE(sizeof(struct timeval)) + CMSG_SPACE(sizeof(__u32))];
227 struct cmsghdr *cmsg;
228 struct can_filter *rfilter;
229 can_err_mask_t err_mask;
230 struct canfd_frame frame;
231 int nbytes, i, maxdlen;
233 struct timeval tv, last_tv;
234 FILE *logfile = NULL;
236 signal(SIGTERM, sigterm);
237 signal(SIGHUP, sigterm);
238 signal(SIGINT, sigterm);
243 while ((opt = getopt(argc, argv, "t:ciaSs:b:B:u:ldxLn:r:he?")) != -1) {
246 timestamp = optarg[0];
247 if ((timestamp != 'a') && (timestamp != 'A') &&
248 (timestamp != 'd') && (timestamp != 'z')) {
249 fprintf(stderr, "%s: unknown timestamp mode '%c' - ignored\n",
250 basename(argv[0]), optarg[0]);
260 view |= CANLIB_VIEW_BINARY;
264 view |= CANLIB_VIEW_ASCII;
268 view |= CANLIB_VIEW_SWAP;
272 view |= CANLIB_VIEW_ERROR;
276 silent = atoi(optarg);
277 if (silent > SILENT_ON) {
278 print_usage(basename(argv[0]));
285 if (strlen(optarg) >= IFNAMSIZ) {
286 fprintf(stderr, "Name of CAN device '%s' is too long!\n\n", optarg);
289 bridge = socket(PF_CAN, SOCK_RAW, CAN_RAW);
291 perror("bridge socket");
294 addr.can_family = AF_CAN;
295 strcpy(ifr.ifr_name, optarg);
296 if (ioctl(bridge, SIOCGIFINDEX, &ifr) < 0)
297 perror("SIOCGIFINDEX");
298 addr.can_ifindex = ifr.ifr_ifindex;
300 if (!addr.can_ifindex) {
301 perror("invalid bridge interface");
305 /* disable default receive filter on this write-only RAW socket */
306 setsockopt(bridge, SOL_CAN_RAW, CAN_RAW_FILTER, NULL, 0);
309 const int loopback = 0;
311 setsockopt(bridge, SOL_CAN_RAW, CAN_RAW_LOOPBACK,
312 &loopback, sizeof(loopback));
315 if (bind(bridge, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
316 perror("bridge bind");
323 bridge_delay = (useconds_t)strtoul(optarg, (char **)NULL, 10);
343 count = atoi(optarg);
345 print_usage(basename(argv[0]));
351 rcvbuf_size = atoi(optarg);
352 if (rcvbuf_size < 1) {
353 print_usage(basename(argv[0]));
359 print_usage(basename(argv[0]));
365 if (optind == argc) {
366 print_usage(basename(argv[0]));
370 if (logfrmt && view) {
371 fprintf(stderr, "Log file format selected: Please disable ASCII/BINARY/SWAP options!\n");
375 if (silent == SILENT_INI) {
377 fprintf(stderr, "Disabled standard output while logging.\n");
378 silent = SILENT_ON; /* disable output on stdout */
380 silent = SILENT_OFF; /* default output */
383 currmax = argc - optind; /* find real number of CAN devices */
385 if (currmax > MAXSOCK) {
386 fprintf(stderr, "More than %d CAN devices given on commandline!\n", MAXSOCK);
390 for (i=0; i < currmax; i++) {
392 ptr = argv[optind+i];
393 nptr = strchr(ptr, ',');
396 printf("open %d '%s'.\n", i, ptr);
399 s[i] = socket(PF_CAN, SOCK_RAW, CAN_RAW);
405 cmdlinename[i] = ptr; /* save pointer to cmdline name of this socket */
408 nbytes = nptr - ptr; /* interface name is up the first ',' */
410 nbytes = strlen(ptr); /* no ',' found => no filter definitions */
412 if (nbytes >= IFNAMSIZ) {
413 fprintf(stderr, "name of CAN device '%s' is too long!\n", ptr);
417 if (nbytes > max_devname_len)
418 max_devname_len = nbytes; /* for nice printing */
420 addr.can_family = AF_CAN;
422 memset(&ifr.ifr_name, 0, sizeof(ifr.ifr_name));
423 strncpy(ifr.ifr_name, ptr, nbytes);
426 printf("using interface name '%s'.\n", ifr.ifr_name);
429 if (strcmp(ANYDEV, ifr.ifr_name)) {
430 if (ioctl(s[i], SIOCGIFINDEX, &ifr) < 0) {
431 perror("SIOCGIFINDEX");
434 addr.can_ifindex = ifr.ifr_ifindex;
436 addr.can_ifindex = 0; /* any can interface */
440 /* found a ',' after the interface name => check for filters */
442 /* determine number of filters to alloc the filter space */
447 ptr++; /* hop behind the ',' */
448 ptr = strchr(ptr, ','); /* exit condition */
451 rfilter = malloc(sizeof(struct can_filter) * numfilter);
453 fprintf(stderr, "Failed to create filter space!\n");
462 ptr = nptr+1; /* hop behind the ',' */
463 nptr = strchr(ptr, ','); /* update exit condition */
465 if (sscanf(ptr, "%x:%x",
466 &rfilter[numfilter].can_id,
467 &rfilter[numfilter].can_mask) == 2) {
468 rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
470 } else if (sscanf(ptr, "%x~%x",
471 &rfilter[numfilter].can_id,
472 &rfilter[numfilter].can_mask) == 2) {
473 rfilter[numfilter].can_id |= CAN_INV_FILTER;
474 rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
476 } else if (sscanf(ptr, "#%x", &err_mask) != 1) {
477 fprintf(stderr, "Error in filter option parsing: '%s'\n", ptr);
483 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_ERR_FILTER,
484 &err_mask, sizeof(err_mask));
487 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_FILTER,
488 rfilter, numfilter * sizeof(struct can_filter));
494 /* try to switch the socket into CAN FD mode */
495 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_FD_FRAMES, &canfd_on, sizeof(canfd_on));
499 int curr_rcvbuf_size;
500 socklen_t curr_rcvbuf_size_len = sizeof(curr_rcvbuf_size);
502 /* try SO_RCVBUFFORCE first, if we run with CAP_NET_ADMIN */
503 if (setsockopt(s[i], SOL_SOCKET, SO_RCVBUFFORCE,
504 &rcvbuf_size, sizeof(rcvbuf_size)) < 0) {
506 printf("SO_RCVBUFFORCE failed so try SO_RCVBUF ...\n");
508 if (setsockopt(s[i], SOL_SOCKET, SO_RCVBUF,
509 &rcvbuf_size, sizeof(rcvbuf_size)) < 0) {
510 perror("setsockopt SO_RCVBUF");
514 if (getsockopt(s[i], SOL_SOCKET, SO_RCVBUF,
515 &curr_rcvbuf_size, &curr_rcvbuf_size_len) < 0) {
516 perror("getsockopt SO_RCVBUF");
520 /* Only print a warning the first time we detect the adjustment */
521 /* n.b.: The wanted size is doubled in Linux in net/sore/sock.c */
522 if (!i && curr_rcvbuf_size < rcvbuf_size*2)
523 fprintf(stderr, "The socket receive buffer size was "
524 "adjusted due to /proc/sys/net/core/rmem_max.\n");
528 if (timestamp || log || logfrmt) {
530 const int timestamp_on = 1;
532 if (setsockopt(s[i], SOL_SOCKET, SO_TIMESTAMP,
533 ×tamp_on, sizeof(timestamp_on)) < 0) {
534 perror("setsockopt SO_TIMESTAMP");
541 const int dropmonitor_on = 1;
543 if (setsockopt(s[i], SOL_SOCKET, SO_RXQ_OVFL,
544 &dropmonitor_on, sizeof(dropmonitor_on)) < 0) {
545 perror("setsockopt SO_RXQ_OVFL not supported by your Linux Kernel");
550 if (bind(s[i], (struct sockaddr *)&addr, sizeof(addr)) < 0) {
559 char fname[sizeof("candump-2006-11-20_202026.log")+1];
561 if (time(&currtime) == (time_t)-1) {
566 localtime_r(&currtime, &now);
568 sprintf(fname, "candump-%04d-%02d-%02d_%02d%02d%02d.log",
576 if (silent != SILENT_ON)
577 printf("\nWarning: console output active while logging!");
579 fprintf(stderr, "\nEnabling Logfile '%s'\n\n", fname);
581 logfile = fopen(fname, "w");
588 /* these settings are static and can be held out of the hot path */
589 iov.iov_base = &frame;
590 msg.msg_name = &addr;
593 msg.msg_control = &ctrlmsg;
598 for (i=0; i<currmax; i++)
601 if ((ret = select(s[currmax-1]+1, &rdfs, NULL, NULL, NULL)) < 0) {
607 for (i=0; i<currmax; i++) { /* check all CAN RAW sockets */
609 if (FD_ISSET(s[i], &rdfs)) {
613 /* these settings may be modified by recvmsg() */
614 iov.iov_len = sizeof(frame);
615 msg.msg_namelen = sizeof(addr);
616 msg.msg_controllen = sizeof(ctrlmsg);
619 nbytes = recvmsg(s[i], &msg, 0);
625 if ((size_t)nbytes == CAN_MTU)
626 maxdlen = CAN_MAX_DLEN;
627 else if ((size_t)nbytes == CANFD_MTU)
628 maxdlen = CANFD_MAX_DLEN;
630 fprintf(stderr, "read: incomplete CAN frame\n");
634 if (count && (--count == 0))
639 usleep(bridge_delay);
641 nbytes = write(bridge, &frame, nbytes);
643 perror("bridge write");
645 } else if ((size_t)nbytes != CAN_MTU && (size_t)nbytes != CANFD_MTU) {
646 fprintf(stderr,"bridge write: incomplete CAN frame\n");
651 for (cmsg = CMSG_FIRSTHDR(&msg);
652 cmsg && (cmsg->cmsg_level == SOL_SOCKET);
653 cmsg = CMSG_NXTHDR(&msg,cmsg)) {
654 if (cmsg->cmsg_type == SO_TIMESTAMP)
655 tv = *(struct timeval *)CMSG_DATA(cmsg);
656 else if (cmsg->cmsg_type == SO_RXQ_OVFL)
657 dropcnt[i] = *(__u32 *)CMSG_DATA(cmsg);
660 /* check for (unlikely) dropped frames on this specific socket */
661 if (dropcnt[i] != last_dropcnt[i]) {
665 if (dropcnt[i] > last_dropcnt[i])
666 frames = dropcnt[i] - last_dropcnt[i];
668 frames = 4294967295U - last_dropcnt[i] + dropcnt[i]; /* 4294967295U == UINT32_MAX */
670 if (silent != SILENT_ON)
671 printf("DROPCOUNT: dropped %d CAN frame%s on '%s' socket (total drops %d)\n",
672 frames, (frames > 1)?"s":"", cmdlinename[i], dropcnt[i]);
675 fprintf(logfile, "DROPCOUNT: dropped %d CAN frame%s on '%s' socket (total drops %d)\n",
676 frames, (frames > 1)?"s":"", cmdlinename[i], dropcnt[i]);
678 last_dropcnt[i] = dropcnt[i];
681 idx = idx2dindex(addr.can_ifindex, s[i]);
683 /* once we detected a EFF frame indent SFF frames accordingly */
684 if (frame.can_id & CAN_EFF_FLAG)
685 view |= CANLIB_VIEW_INDENT_SFF;
688 /* log CAN frame with absolute timestamp & device */
689 fprintf(logfile, "(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
690 fprintf(logfile, "%*s ", max_devname_len, devname[idx]);
691 /* without seperator as logfile use-case is parsing */
692 fprint_canframe(logfile, &frame, "\n", 0, maxdlen);
696 /* print CAN frame in log file style to stdout */
697 printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
698 printf("%*s ", max_devname_len, devname[idx]);
699 fprint_canframe(stdout, &frame, "\n", 0, maxdlen);
700 goto out_fflush; /* no other output to stdout */
703 if (silent != SILENT_OFF){
704 if (silent == SILENT_ANI) {
705 printf("%c\b", anichar[silentani%=MAXANI]);
708 goto out_fflush; /* no other output to stdout */
711 printf(" %s", (color>2)?col_on[idx%MAXCOL]:"");
715 case 'a': /* absolute with timestamp */
716 printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
719 case 'A': /* absolute with date */
724 tm = *localtime(&tv.tv_sec);
725 strftime(timestring, 24, "%Y-%m-%d %H:%M:%S", &tm);
726 printf("(%s.%06ld) ", timestring, tv.tv_usec);
730 case 'd': /* delta */
731 case 'z': /* starting with zero */
735 if (last_tv.tv_sec == 0) /* first init */
737 diff.tv_sec = tv.tv_sec - last_tv.tv_sec;
738 diff.tv_usec = tv.tv_usec - last_tv.tv_usec;
739 if (diff.tv_usec < 0)
740 diff.tv_sec--, diff.tv_usec += 1000000;
742 diff.tv_sec = diff.tv_usec = 0;
743 printf("(%03ld.%06ld) ", diff.tv_sec, diff.tv_usec);
745 if (timestamp == 'd')
746 last_tv = tv; /* update for delta calculation */
750 default: /* no timestamp output */
754 printf(" %s", (color && (color<3))?col_on[idx%MAXCOL]:"");
755 printf("%*s", max_devname_len, devname[idx]);
757 if (extra_msg_info) {
759 if (msg.msg_flags & MSG_DONTROUTE)
760 printf (" TX %s", extra_m_info[frame.flags & 3]);
762 printf (" RX %s", extra_m_info[frame.flags & 3]);
765 printf("%s ", (color==1)?col_off:"");
767 fprint_long_canframe(stdout, &frame, NULL, view, maxdlen);
769 printf("%s", (color>1)?col_off:"");
778 for (i=0; i<currmax; i++)