]> rtime.felk.cvut.cz Git - sojka/can-utils.git/blob - candump.c
Fix sloppy CAN_(EFF|RTR)_FLAG handling in can_filter.can_mask .
[sojka/can-utils.git] / candump.c
1 /*
2  *  $Id$
3  */
4
5 /*
6  * candump.c
7  *
8  * Copyright (c) 2002-2007 Volkswagen Group Electronic Research
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
22  *
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.
27  *
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.
30  *
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
42  * DAMAGE.
43  *
44  * Send feedback to <socketcan-users@lists.berlios.de>
45  *
46  */
47
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <unistd.h>
51 #include <string.h>
52 #include <signal.h>
53 #include <ctype.h>
54 #include <libgen.h>
55 #include <time.h>
56
57 #include <sys/time.h>
58 #include <sys/types.h>
59 #include <sys/socket.h>
60 #include <sys/ioctl.h>
61 #include <sys/uio.h>
62 #include <net/if.h>
63
64 #include <linux/can.h>
65 #include <linux/can/raw.h>
66
67 #include "terminal.h"
68 #include "lib.h"
69
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 */
76
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) */
81
82 #define BOLD    ATTBOLD
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
89
90 const char col_on [MAXCOL][19] = {BLUE, RED, GREEN, BOLD, MAGENTA, CYAN};
91 const char col_off [] = ATTRESET;
92
93 static char devname[MAXIFNAMES][IFNAMSIZ+1];
94 static int  dindex[MAXIFNAMES];
95 static int  max_devname_len; /* to prevent frazzled device name output */ 
96
97 #define MAXANI 4
98 const char anichar[MAXANI] = {'|', '/', '-', '\\'};
99
100 extern int optind, opterr, optopt;
101
102 static volatile int running = 1;
103
104 void print_usage(char *prg)
105 {
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:DFFFFFFF (match only for extended CAN ID 12345678)\n", prg);
134         fprintf(stderr, "%s vcan2,123:7FF (matches CAN ID 123 - including EFF and RTR frames)\n", prg);
135         fprintf(stderr, "%s vcan2,123:C00007FF (matches CAN ID 123 - only SFF and non-RTR frames)\n", prg);
136         fprintf(stderr, "\n");
137 }
138
139 void sigterm(int signo)
140 {
141         running = 0;
142 }
143
144 int idx2dindex(int ifidx, int socket) {
145
146         int i;
147         struct ifreq ifr;
148
149         for (i=0; i < MAXIFNAMES; i++) {
150                 if (dindex[i] == ifidx)
151                         return i;
152         }
153
154         /* create new interface index cache entry */
155
156         /* remove index cache zombies first */
157         for (i=0; i < MAXIFNAMES; i++) {
158                 if (dindex[i]) {
159                         ifr.ifr_ifindex = dindex[i];
160                         if (ioctl(socket, SIOCGIFNAME, &ifr) < 0)
161                                 dindex[i] = 0;
162                 }
163         }
164
165         for (i=0; i < MAXIFNAMES; i++)
166                 if (!dindex[i]) /* free entry */
167                         break;
168
169         if (i == MAXIFNAMES) {
170                 fprintf(stderr, "Interface index cache only supports %d interfaces.\n",
171                        MAXIFNAMES);
172                 exit(1);
173         }
174
175         dindex[i] = ifidx;
176
177         ifr.ifr_ifindex = ifidx;
178         if (ioctl(socket, SIOCGIFNAME, &ifr) < 0)
179                 perror("SIOCGIFNAME");
180
181         if (max_devname_len < strlen(ifr.ifr_name))
182                 max_devname_len = strlen(ifr.ifr_name);
183
184         strcpy(devname[i], ifr.ifr_name);
185
186 #ifdef DEBUG
187         printf("new index %d (%s)\n", i, devname[i]);
188 #endif
189
190         return i;
191 }
192
193 int main(int argc, char **argv)
194 {
195         fd_set rdfs;
196         int s[MAXSOCK];
197         int bridge = 0;
198         unsigned char timestamp = 0;
199         unsigned char silent = SILENT_INI;
200         unsigned char silentani = 0;
201         unsigned char color = 0;
202         unsigned char view = 0;
203         unsigned char log = 0;
204         unsigned char logfrmt = 0;
205         int opt, ret;
206         int currmax, numfilter;
207         char *ptr, *nptr;
208         struct sockaddr_can addr;
209         struct can_filter rfilter[MAXFILTER];
210         can_err_mask_t err_mask;
211         struct can_frame frame;
212         int nbytes, i;
213         struct ifreq ifr;
214         struct timeval tv, last_tv;
215         FILE *logfile = NULL;
216
217         signal(SIGTERM, sigterm);
218         signal(SIGHUP, sigterm);
219         signal(SIGINT, sigterm);
220
221         last_tv.tv_sec  = 0;
222         last_tv.tv_usec = 0;
223
224         while ((opt = getopt(argc, argv, "t:ciaSs:b:B:lLh?")) != -1) {
225                 switch (opt) {
226                 case 't':
227                         timestamp = optarg[0];
228                         if ((timestamp != 'a') && (timestamp != 'A') &&
229                             (timestamp != 'd') && (timestamp != 'z')) {
230                                 fprintf(stderr, "%s: unknown timestamp mode '%c' - ignored\n",
231                                        basename(argv[0]), optarg[0]);
232                                 timestamp = 0;
233                         }
234                         break;
235
236                 case 'c':
237                         color++;
238                         break;
239
240                 case 'i':
241                         view |= CANLIB_VIEW_BINARY;
242                         break;
243
244                 case 'a':
245                         view |= CANLIB_VIEW_ASCII;
246                         break;
247
248                 case 'S':
249                         view |= CANLIB_VIEW_SWAP;
250                         break;
251
252                 case 's':
253                         silent = atoi(optarg);
254                         if (silent > SILENT_ON) {
255                                 print_usage(basename(argv[0]));
256                                 exit(1);
257                         }
258                         break;
259
260                 case 'b':
261                 case 'B':
262                         if (strlen(optarg) >= IFNAMSIZ) {
263                                 fprintf(stderr, "Name of CAN device '%s' is too long!\n\n", optarg);
264                                 return 1;
265                         } else {
266                                 bridge = socket(PF_CAN, SOCK_RAW, CAN_RAW);
267                                 if (bridge < 0) {
268                                         perror("bridge socket");
269                                         return 1;
270                                 }
271                                 addr.can_family = AF_CAN;
272                                 strcpy(ifr.ifr_name, optarg);
273                                 if (ioctl(bridge, SIOCGIFINDEX, &ifr) < 0)
274                                         perror("SIOCGIFINDEX");
275                                 addr.can_ifindex = ifr.ifr_ifindex;
276                 
277                                 if (!addr.can_ifindex) {
278                                         perror("invalid bridge interface");
279                                         return 1;
280                                 }
281
282                                 if (opt == 'B') {
283                                         int loopback = 0;
284
285                                         setsockopt(bridge, SOL_CAN_RAW, CAN_RAW_LOOPBACK,
286                                                    &loopback, sizeof(loopback));
287                                 }
288
289                                 if (bind(bridge, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
290                                         perror("bridge bind");
291                                         return 1;
292                                 }
293                         }
294                         break;
295             
296                 case 'l':
297                         log = 1;
298                         break;
299
300                 case 'L':
301                         logfrmt = 1;
302                         break;
303
304                 default:
305                         print_usage(basename(argv[0]));
306                         exit(1);
307                         break;
308                 }
309         }
310
311         if (optind == argc) {
312                 print_usage(basename(argv[0]));
313                 exit(0);
314         }
315         
316         if (logfrmt && view) {
317                 fprintf(stderr, "Log file format selected: Please disable ASCII/BINARY/SWAP options!\n");
318                 exit(0);
319         }
320
321         if (silent == SILENT_INI) {
322                 if (log) {
323                         fprintf(stderr, "\nDisabled standard output while logging.");
324                         silent = SILENT_ON; /* disable output on stdout */
325                 } else
326                         silent = SILENT_OFF; /* default output */
327         }
328
329         currmax = argc - optind; /* find real number of CAN devices */
330
331         if (currmax > MAXSOCK) {
332                 fprintf(stderr, "More than %d CAN devices given on commandline!\n", MAXSOCK);
333                 return 1;
334         }
335
336         for (i=0; i < currmax; i++) {
337
338                 ptr = argv[optind+i];
339                 nptr = strchr(ptr, ',');
340
341 #ifdef DEBUG
342                 printf("open %d '%s'.\n", i, ptr);
343 #endif
344
345                 s[i] = socket(PF_CAN, SOCK_RAW, CAN_RAW);
346                 if (s[i] < 0) {
347                         perror("socket");
348                         return 1;
349                 }
350
351                 if (nptr)
352                         nbytes = nptr - ptr;  /* interface name is up the first ',' */
353                 else
354                         nbytes = strlen(ptr); /* no ',' found => no filter definitions */
355
356                 if (nbytes >= IFNAMSIZ) {
357                         fprintf(stderr, "name of CAN device '%s' is too long!\n", ptr);
358                         return 1;
359                 }
360
361                 if (nbytes > max_devname_len)
362                         max_devname_len = nbytes; /* for nice printing */
363
364                 addr.can_family = AF_CAN;
365
366                 memset(&ifr.ifr_name, 0, sizeof(ifr.ifr_name));
367                 strncpy(ifr.ifr_name, ptr, nbytes);
368
369 #ifdef DEBUG
370                 printf("using interface name '%s'.\n", ifr.ifr_name);
371 #endif
372
373                 if (strcmp(ANYDEV, ifr.ifr_name)) {
374                         if (ioctl(s[i], SIOCGIFINDEX, &ifr) < 0) {
375                                 perror("SIOCGIFINDEX");
376                                 exit(1);
377                         }
378                         addr.can_ifindex = ifr.ifr_ifindex;
379                 } else
380                         addr.can_ifindex = 0; /* any can interface */
381
382                 if (nptr) {
383
384                         /* found a ',' after the interface name => check for filters */
385
386                         numfilter = 0;
387                         err_mask = 0;
388
389                         while (nptr) {
390
391                                 ptr = nptr+1; /* hop behind the ',' */
392                                 nptr = strchr(ptr, ','); /* update exit condition */
393
394                                 if (sscanf(ptr, "%lx:%lx",
395                                            (long unsigned int *)
396                                            &rfilter[numfilter].can_id, 
397                                            (long unsigned int *)
398                                            &rfilter[numfilter].can_mask) == 2) {
399                                         rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
400                                         numfilter++;
401                                 } else if (sscanf(ptr, "%lx~%lx",
402                                                   (long unsigned int *)
403                                                   &rfilter[numfilter].can_id, 
404                                                   (long unsigned int *)
405                                                   &rfilter[numfilter].can_mask) == 2) {
406                                         rfilter[numfilter].can_id |= CAN_INV_FILTER;
407                                         rfilter[numfilter].can_mask &= ~CAN_ERR_FLAG;
408                                         numfilter++;
409                                 } else if (sscanf(ptr, "#%lx",
410                                                   (long unsigned int *)&err_mask) != 1) { 
411                                         fprintf(stderr, "Error in filter option parsing: '%s'\n", ptr);
412                                         exit(1);
413                                 }
414
415                                 if (numfilter > MAXFILTER) {
416                                         fprintf(stderr, "Too many filters specified for '%s'.\n",
417                                                ifr.ifr_name);
418                                         exit(1);
419                                 }
420                         }
421
422                         if (err_mask)
423                                 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_ERR_FILTER,
424                                            &err_mask, sizeof(err_mask));
425
426                         if (numfilter)
427                                 setsockopt(s[i], SOL_CAN_RAW, CAN_RAW_FILTER,
428                                            &rfilter, numfilter * sizeof(struct can_filter));
429                 } /* if (nptr) */
430
431                 if (bind(s[i], (struct sockaddr *)&addr, sizeof(addr)) < 0) {
432                         perror("bind");
433                         return 1;
434                 }
435         }
436
437         if (log) {
438                 time_t currtime;
439                 struct tm now;
440                 char fname[sizeof("candump-2006-11-20_202026.log")+1];
441
442                 if (time(&currtime) == (time_t)-1) {
443                         perror("time");
444                         return 1;
445                 }
446
447                 localtime_r(&currtime, &now);
448
449                 sprintf(fname, "candump-%04d-%02d-%02d_%02d%02d%02d.log",
450                         now.tm_year + 1900,
451                         now.tm_mon + 1,
452                         now.tm_mday,
453                         now.tm_hour,
454                         now.tm_min,
455                         now.tm_sec);
456
457                 if (silent != SILENT_ON)
458                         printf("\nWarning: console output active while logging!");
459
460                 fprintf(stderr, "\nEnabling Logfile '%s'\n\n", fname);
461
462                 logfile = fopen(fname, "w");
463                 if (!logfile) {
464                         perror("logfile");
465                         return 1;
466                 }
467         }
468
469         while (running) {
470
471                 FD_ZERO(&rdfs);
472                 for (i=0; i<currmax; i++)
473                         FD_SET(s[i], &rdfs);
474
475                 if ((ret = select(s[currmax-1]+1, &rdfs, NULL, NULL, NULL)) < 0) {
476                         //perror("select");
477                         running = 0;
478                         continue;
479                 }
480
481                 for (i=0; i<currmax; i++) {  /* check all CAN RAW sockets */
482
483                         if (FD_ISSET(s[i], &rdfs)) {
484
485                                 socklen_t len = sizeof(addr);
486                                 int idx;
487
488                                 nbytes = recvfrom(s[i], &frame, sizeof(struct can_frame), 0,
489                                                   (struct sockaddr*)&addr, &len);
490                                 if (nbytes < 0) {
491                                         perror("read");
492                                         return 1;
493                                 }
494
495                                 if (nbytes < sizeof(struct can_frame)) {
496                                         fprintf(stderr, "read: incomplete CAN frame\n");
497                                         return 1;
498                                 }
499
500                                 if (bridge) {
501                                         nbytes = write(bridge, &frame, sizeof(struct can_frame));
502                                         if (nbytes < 0) {
503                                                 perror("bridge write");
504                                                 return 1;
505                                         } else if (nbytes < sizeof(struct can_frame)) {
506                                                 fprintf(stderr,"bridge write: incomplete CAN frame\n");
507                                                 return 1;
508                                         }
509                                 }
510                     
511                                 if (timestamp || log || logfrmt)
512                                         if (ioctl(s[i], SIOCGSTAMP, &tv) < 0)
513                                                 perror("SIOCGSTAMP");
514
515
516                                 idx = idx2dindex(addr.can_ifindex, s[i]);
517
518                                 if (log) {
519                                         /* log CAN frame with absolute timestamp & device */
520                                         fprintf(logfile, "(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
521                                         fprintf(logfile, "%*s ", max_devname_len, devname[idx]);
522                                         /* without seperator as logfile use-case is parsing */
523                                         fprint_canframe(logfile, &frame, "\n", 0);
524                                 }
525
526                                 if (logfrmt) {
527                                         /* print CAN frame in log file style to stdout */
528                                         printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
529                                         printf("%*s ", max_devname_len, devname[idx]);
530                                         fprint_canframe(stdout, &frame, "\n", 0);
531                                         goto out_fflush; /* no other output to stdout */
532                                 }
533
534                                 if (silent != SILENT_OFF){
535                                         if (silent == SILENT_ANI) {
536                                                 printf("%c\b", anichar[silentani%=MAXANI]);
537                                                 silentani++;
538                                         }
539                                         goto out_fflush; /* no other output to stdout */
540                                 }
541                       
542                                 printf(" %s", (color>2)?col_on[idx%MAXCOL]:"");
543
544                                 switch (timestamp) {
545
546                                 case 'a': /* absolute with timestamp */
547                                         printf("(%ld.%06ld) ", tv.tv_sec, tv.tv_usec);
548                                         break;
549
550                                 case 'A': /* absolute with date */
551                                 {
552                                         struct tm tm;
553                                         char timestring[25];
554
555                                         tm = *localtime(&tv.tv_sec);
556                                         strftime(timestring, 24, "%Y-%m-%d %H:%M:%S", &tm);
557                                         printf("(%s.%06ld) ", timestring, tv.tv_usec);
558                                 }
559                                 break;
560
561                                 case 'd': /* delta */
562                                 case 'z': /* starting with zero */
563                                 {
564                                         struct timeval diff;
565
566                                         if (last_tv.tv_sec == 0)   /* first init */
567                                                 last_tv = tv;
568                                         diff.tv_sec  = tv.tv_sec  - last_tv.tv_sec;
569                                         diff.tv_usec = tv.tv_usec - last_tv.tv_usec;
570                                         if (diff.tv_usec < 0)
571                                                 diff.tv_sec--, diff.tv_usec += 1000000;
572                                         if (diff.tv_sec < 0)
573                                                 diff.tv_sec = diff.tv_usec = 0;
574                                         printf("(%ld.%06ld) ", diff.tv_sec, diff.tv_usec);
575                                 
576                                         if (timestamp == 'd')
577                                                 last_tv = tv; /* update for delta calculation */
578                                 }
579                                 break;
580
581                                 default: /* no timestamp output */
582                                         break;
583                                 }
584
585                                 printf(" %s", (color && (color<3))?col_on[idx%MAXCOL]:"");
586                                 printf("%*s", max_devname_len, devname[idx]);
587                                 printf("%s  ", (color==1)?col_off:"");
588
589                                 fprint_long_canframe(stdout, &frame, NULL, view);
590
591                                 printf("%s", (color>1)?col_off:"");
592                                 printf("\n");
593                         }
594
595                 out_fflush:
596                         fflush(stdout);
597                 }
598         }
599
600         for (i=0; i<currmax; i++)
601                 close(s[i]);
602
603         if (bridge)
604                 close(bridge);
605
606         if (log)
607                 fclose(logfile);
608
609         return 0;
610 }