8 * Copyright (c) 2002-2007 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 <socketcan-users@lists.berlios.de>
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 MAXFILTER 30 /* max. number of possible filters for each socket */
72 #define MAXIFNAMES 30 /* size of receive name index to omit ioctls */
73 #define MAXCOL 6 /* number of different colors for colorized output */
74 #define ANYDEV "any" /* name of interface to receive from any CAN interface */
75 #define ANL "\r\n" /* newline in ASC mode */
77 #define SILENT_INI 42 /* detect user setting on commandline */
78 #define SILENT_OFF 0 /* no silent mode */
79 #define SILENT_ANI 1 /* silent mode with animation */
80 #define SILENT_ON 2 /* silent mode (completely silent) */
83 #define RED ATTBOLD FGRED
84 #define GREEN ATTBOLD FGGREEN
85 #define YELLOW ATTBOLD FGYELLOW
86 #define BLUE ATTBOLD FGBLUE
87 #define MAGENTA ATTBOLD FGMAGENTA
88 #define CYAN ATTBOLD FGCYAN
90 const char col_on [MAXCOL][19] = {BLUE, RED, GREEN, BOLD, MAGENTA, CYAN};
91 const char col_off [] = ATTRESET;
93 static char devname[MAXIFNAMES][IFNAMSIZ+1];
94 static int dindex[MAXIFNAMES];
95 static int max_devname_len; /* to prevent frazzled device name output */
98 const char anichar[MAXANI] = {'|', '/', '-', '\\'};
100 extern int optind, opterr, optopt;
102 static volatile int running = 1;
104 void print_usage(char *prg)
106 fprintf(stderr, "\nUsage: %s [options] <CAN interface>+\n", prg);
107 fprintf(stderr, " (use CTRL-C to terminate %s)\n\n", prg);
108 fprintf(stderr, "Options: -t <type> (timestamp: (a)bsolute/(d)elta/(z)ero/(A)bsolute w date)\n");
109 fprintf(stderr, " -c (increment color mode level)\n");
110 fprintf(stderr, " -i (binary output - may exceed 80 chars/line)\n");
111 fprintf(stderr, " -a (enable additional ASCII output)\n");
112 fprintf(stderr, " -S (swap byte order in printed CAN data[] - marked with '%c' )\n", SWAP_DELIMITER);
113 fprintf(stderr, " -s <level> (silent mode - %d: off (default) %d: animation %d: silent)\n", SILENT_OFF, SILENT_ANI, SILENT_ON);
114 fprintf(stderr, " -b <can> (bridge mode - send received frames to <can>)\n");
115 fprintf(stderr, " -B <can> (bridge mode - like '-b' with disabled loopback)\n");
116 fprintf(stderr, " -l (log CAN-frames into file. Sets '-s %d' by default)\n", SILENT_ON);
117 fprintf(stderr, " -L (use log file format on stdout)\n");
118 fprintf(stderr, "\n");
119 fprintf(stderr, "Up to %d CAN interfaces with optional filter sets can be specified\n", MAXSOCK);
120 fprintf(stderr, "on the commandline in the form: <ifname>[,filter]*\n");
121 fprintf(stderr, "\nUp to %d comma separated filters can be specified for each given CAN interface:\n", MAXFILTER);
122 fprintf(stderr, " <can_id>:<can_mask> (matches when <received_can_id> & mask == can_id & mask)\n");
123 fprintf(stderr, " <can_id>~<can_mask> (matches when <received_can_id> & mask != can_id & mask)\n");
124 fprintf(stderr, " #<error_mask> (set error frame filter, see include/linux/can/error.h)\n");
125 fprintf(stderr, "\nCAN IDs, masks and data content are given and expected in hexadecimal values.\n");
126 fprintf(stderr, "When can_id and can_mask are both 8 digits, they are assumed to be 29 bit EFF.\n");
127 fprintf(stderr, "Without any given filter all data frames are received ('0:0' default filter).\n");
128 fprintf(stderr, "\nUse interface name '%s' to receive from all CAN interfaces.\n", ANYDEV);
129 fprintf(stderr, "\nExamples:\n");
130 fprintf(stderr, "%s -c -c -ta can0,123:7FF,400:700,#000000FF can2,400~7F0 can3 can8\n", prg);
131 fprintf(stderr, "%s -l any,0~0,#FFFFFFFF (log only error frames but no(!) data frames)\n", prg);
132 fprintf(stderr, "%s -l any,0:0,#FFFFFFFF (log error frames and also all data frames)\n", prg);
133 fprintf(stderr, "%s vcan2,92345678:9FFFFFFF (match only for extended CAN ID 12345678)\n", prg);
134 fprintf(stderr, "%s vcan2,12345678:1FFFFFFF (analog to above due to 8 digit value length)\n", prg);
135 fprintf(stderr, "\n");
138 void sigterm(int signo)
143 int idx2dindex(int ifidx, int socket) {
148 for (i=0; i < MAXIFNAMES; i++) {
149 if (dindex[i] == ifidx)
153 /* create new interface index cache entry */
155 /* remove index cache zombies first */
156 for (i=0; i < MAXIFNAMES; i++) {
158 ifr.ifr_ifindex = dindex[i];
159 if (ioctl(socket, SIOCGIFNAME, &ifr) < 0)
164 for (i=0; i < MAXIFNAMES; i++)
165 if (!dindex[i]) /* free entry */
168 if (i == MAXIFNAMES) {
169 printf("Interface index cache only supports %d interfaces.\n",
176 ifr.ifr_ifindex = ifidx;
177 if (ioctl(socket, SIOCGIFNAME, &ifr) < 0)
178 perror("SIOCGIFNAME");
180 if (max_devname_len < strlen(ifr.ifr_name))
181 max_devname_len = strlen(ifr.ifr_name);
183 strcpy(devname[i], ifr.ifr_name);
186 printf("new index %d (%s)\n", i, devname[i]);
192 canid_t checkeff(char *ptr, char *nptr)
201 if (len == 17 && (ptr[8] == ':' || ptr[8] == '~'))
207 int main(int argc, char **argv)
212 unsigned char timestamp = 0;
213 unsigned char silent = SILENT_INI;
214 unsigned char silentani = 0;
215 unsigned char color = 0;
216 unsigned char view = 0;
217 unsigned char log = 0;
218 unsigned char logfrmt = 0;
220 int currmax, numfilter;
223 struct sockaddr_can addr;
224 struct can_filter rfilter[MAXFILTER];
225 can_err_mask_t err_mask;
226 struct can_frame frame;
229 struct timeval tv, last_tv;
230 FILE *logfile = NULL;
232 signal(SIGTERM, sigterm);
233 signal(SIGHUP, sigterm);
234 signal(SIGINT, sigterm);
239 while ((opt = getopt(argc, argv, "t:ciaSs:b:B:lLh?")) != -1) {
242 timestamp = optarg[0];
243 if ((timestamp != 'a') && (timestamp != 'A') &&
244 (timestamp != 'd') && (timestamp != 'z')) {
245 printf("%s: unknown timestamp mode '%c' - ignored\n",
246 basename(argv[0]), optarg[0]);
256 view |= CANLIB_VIEW_BINARY;
260 view |= CANLIB_VIEW_ASCII;
264 view |= CANLIB_VIEW_SWAP;
268 silent = atoi(optarg);
269 if (silent > SILENT_ON) {
270 print_usage(basename(argv[0]));
277 if (strlen(optarg) >= IFNAMSIZ) {
278 printf("Name of CAN device '%s' is too long!\n\n", optarg);
281 bridge = socket(PF_CAN, SOCK_RAW, CAN_RAW);
283 perror("bridge socket");
286 addr.can_family = AF_CAN;
287 strcpy(ifr.ifr_name, optarg);
288 if (ioctl(bridge, SIOCGIFINDEX, &ifr) < 0)
289 perror("SIOCGIFINDEX");
290 addr.can_ifindex = ifr.ifr_ifindex;
292 if (!addr.can_ifindex) {
293 perror("invalid bridge interface");
300 setsockopt(bridge, SOL_CAN_RAW, CAN_RAW_LOOPBACK,
301 &loopback, sizeof(loopback));
304 if (bind(bridge, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
305 perror("bridge bind");
320 print_usage(basename(argv[0]));
326 if (optind == argc) {
327 print_usage(basename(argv[0]));
331 if (logfrmt && view) {
332 fprintf(stderr, "Log file format selected: Please disable ASCII/BINARY/SWAP options!\n");
336 if (silent == SILENT_INI) {
338 printf("\nDisabled standard output while logging.");
339 silent = SILENT_ON; /* disable output on stdout */
341 silent = SILENT_OFF; /* default output */
344 currmax = argc - optind; /* find real number of CAN devices */
346 if (currmax > MAXSOCK) {
347 printf("More than %d CAN devices given on commandline!\n", MAXSOCK);
351 for (i=0; i < currmax; i++) {
353 ptr = argv[optind+i];
354 nptr = strchr(ptr, ',');
357 printf("open %d '%s'.\n", i, ptr);
360 s[i] = socket(PF_CAN, SOCK_RAW, CAN_RAW);
367 nbytes = nptr - ptr; /* interface name is up the first ',' */
369 nbytes = strlen(ptr); /* no ',' found => no filter definitions */
371 if (nbytes >= IFNAMSIZ) {
372 printf("name of CAN device '%s' is too long!\n", ptr);
376 if (nbytes > max_devname_len)
377 max_devname_len = nbytes; /* for nice printing */
379 addr.can_family = AF_CAN;
381 memset(&ifr.ifr_name, 0, sizeof(ifr.ifr_name));
382 strncpy(ifr.ifr_name, ptr, nbytes);
385 printf("using interface name '%s'.\n", ifr.ifr_name);
388 if (strcmp(ANYDEV, ifr.ifr_name)) {
389 if (ioctl(s[i], SIOCGIFINDEX, &ifr) < 0) {
390 perror("SIOCGIFINDEX");
393 addr.can_ifindex = ifr.ifr_ifindex;
395 addr.can_ifindex = 0; /* any can interface */
399 /* found a ',' after the interface name => check for filters */
406 ptr = nptr+1; /* hop behind the ',' */
407 nptr = strchr(ptr, ','); /* update exit condition */
409 if (sscanf(ptr, "%lx:%lx",
410 (long unsigned int *)
411 &rfilter[numfilter].can_id,
412 (long unsigned int *)
413 &rfilter[numfilter].can_mask) == 2) {
414 eff = checkeff(ptr, nptr);
415 rfilter[numfilter].can_id |= eff;
416 rfilter[numfilter].can_mask |= eff;
417 rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
419 } else if (sscanf(ptr, "%lx~%lx",
420 (long unsigned int *)
421 &rfilter[numfilter].can_id,
422 (long unsigned int *)
423 &rfilter[numfilter].can_mask) == 2) {
424 rfilter[numfilter].can_id |= CAN_INV_FILTER;
425 eff = checkeff(ptr, nptr);
426 rfilter[numfilter].can_id |= eff;
427 rfilter[numfilter].can_mask |= eff;
428 rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
430 } else if (sscanf(ptr, "#%lx",
431 (long unsigned int *)&err_mask) != 1) {
432 printf("Error in filter option parsing: '%s'\n", ptr);
436 if (numfilter > MAXFILTER) {
437 printf("Too many filters specified for '%s'.\n",
444 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_ERR_FILTER,
445 &err_mask, sizeof(err_mask));
448 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_FILTER,
449 &rfilter, numfilter * sizeof(struct can_filter));
452 if (bind(s[i], (struct sockaddr *)&addr, sizeof(addr)) < 0) {
461 char fname[sizeof("candump-2006-11-20_202026.log")+1];
463 if (time(&currtime) == (time_t)-1) {
468 localtime_r(&currtime, &now);
470 sprintf(fname, "candump-%04d-%02d-%02d_%02d%02d%02d.log",
478 if (silent != SILENT_ON)
479 printf("\nWarning: console output active while logging!");
481 printf("\nEnabling Logfile '%s'\n\n", fname);
483 logfile = fopen(fname, "w");
493 for (i=0; i<currmax; i++)
496 if ((ret = select(s[currmax-1]+1, &rdfs, NULL, NULL, NULL)) < 0) {
502 for (i=0; i<currmax; i++) { /* check all CAN RAW sockets */
504 if (FD_ISSET(s[i], &rdfs)) {
506 socklen_t len = sizeof(addr);
509 nbytes = recvfrom(s[i], &frame, sizeof(struct can_frame), 0,
510 (struct sockaddr*)&addr, &len);
516 if (nbytes < sizeof(struct can_frame)) {
517 fprintf(stderr, "read: incomplete CAN frame\n");
522 nbytes = write(bridge, &frame, sizeof(struct can_frame));
524 perror("bridge write");
526 } else if (nbytes < sizeof(struct can_frame)) {
527 fprintf(stderr,"bridge write: incomplete CAN frame\n");
532 if (timestamp || log || logfrmt)
533 if (ioctl(s[i], SIOCGSTAMP, &tv) < 0)
534 perror("SIOCGSTAMP");
537 idx = idx2dindex(addr.can_ifindex, s[i]);
540 /* log CAN frame with absolute timestamp & device */
541 fprintf(logfile, "(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
542 fprintf(logfile, "%*s ", max_devname_len, devname[idx]);
543 /* without seperator as logfile use-case is parsing */
544 fprint_canframe(logfile, &frame, "\n", 0);
548 /* print CAN frame in log file style to stdout */
549 printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
550 printf("%*s ", max_devname_len, devname[idx]);
551 fprint_canframe(stdout, &frame, "\n", 0);
552 goto out_fflush; /* no other output to stdout */
555 if (silent != SILENT_OFF){
556 if (silent == SILENT_ANI) {
557 printf("%c\b", anichar[silentani%=MAXANI]);
560 goto out_fflush; /* no other output to stdout */
563 printf(" %s", (color>2)?col_on[idx%MAXCOL]:"");
567 case 'a': /* absolute with timestamp */
568 printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
571 case 'A': /* absolute with date */
576 tm = *localtime(&tv.tv_sec);
577 strftime(timestring, 24, "%Y-%m-%d %H:%M:%S", &tm);
578 printf("(%s.%06ld) ", timestring, tv.tv_usec);
582 case 'd': /* delta */
583 case 'z': /* starting with zero */
587 if (last_tv.tv_sec == 0) /* first init */
589 diff.tv_sec = tv.tv_sec - last_tv.tv_sec;
590 diff.tv_usec = tv.tv_usec - last_tv.tv_usec;
591 if (diff.tv_usec < 0)
592 diff.tv_sec--, diff.tv_usec += 1000000;
594 diff.tv_sec = diff.tv_usec = 0;
595 printf("(%ld.%06ld) ", diff.tv_sec, diff.tv_usec);
597 if (timestamp == 'd')
598 last_tv = tv; /* update for delta calculation */
602 default: /* no timestamp output */
606 printf(" %s", (color && (color<3))?col_on[idx%MAXCOL]:"");
607 printf("%*s", max_devname_len, devname[idx]);
608 printf("%s ", (color==1)?col_off:"");
610 fprint_long_canframe(stdout, &frame, NULL, view);
612 printf("%s", (color>1)?col_off:"");
621 for (i=0; i<currmax; i++)