1 /**************************************************************************/
2 /* File: vca_canping.c - utility to test CAN functionality and throughput */
4 /* LibVCA - Versatile CAN/CANopen API library */
5 /* Copyright (C) 2005-2009 Michal Sojka, DCE FEE CTU Prague */
6 /* Copyright (C) 2006-2009 Pavel Pisa <pisa@cmp.felk.cvut.cz> */
8 /* LibVCA is free software; you can redistribute it and/or modify it */
9 /* under terms of the GNU General Public License as published by the */
10 /* Free Software Foundation; either version 2, or (at your option) any */
11 /* later version. LinCAN is distributed in the hope that it will be */
12 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty */
13 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
14 /* General Public License for more details. You should have received a */
15 /* copy of the GNU General Public License along with LinCAN; see file */
16 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave, */
17 /* Cambridge, MA 02139, USA. */
18 /**************************************************************************/
29 #include <sys/types.h>
31 #include <sys/select.h>
34 #include <semaphore.h>
38 /* TODO: Handle the case where there are more canping slaves running
51 int sched_policy = SCHED_OTHER;
58 #define dbg(level, fmt, arg...) do {} while (0)
60 #define dbg(level, fmt, arg...) do { if (level <= DEBUG) { printf("candping: " fmt, ## arg); } } while (0)
63 #define NOT_INTERRUPTED_SYSCALL (errno != EINTR && errno != ERESTART)
64 #define IS_FINISH_FLAG() (finish_flag)
68 #define EXIT_BAD_PARAM 1
69 #define EXIT_CANNOT_OPEN 2
70 #define EXIT_FILTER_ERROR 3
72 #define EXIT_READ_ERROR 5
73 #define EXIT_WRITE_ERROR 6
74 #define EXIT_SELECT_ERROR 7
75 #define EXIT_FLUSH_ERROR 8
77 /* Global variables */
78 sig_atomic_t finish_flag = 0; /* Threads should terminate. */
79 sem_t finish_sem; /* Thread signals a termination */
80 vca_handle_t global_vcah = VCA_HANDLE_INVALID;
83 int total_timeout = 0;
85 pthread_mutex_t mut_start = PTHREAD_MUTEX_INITIALIZER;
86 pthread_cond_t cond_start = PTHREAD_COND_INITIALIZER;
88 sem_t ready_sem; /* Thread is ready for execution */
91 /* Command line options */
92 char *option_device = VCA_DEV_NAME;
93 int option_masters = 0;
94 long int option_first_id = 1000;
95 int option_slaves = 0;
96 int option_verbose = 0; /* 0 - nothing, 1 - only global
97 * statistics, 2 - simple times, 3 -
99 int option_length = 8;
100 int option_count = 0;
101 int option_wait_ms = 1000;
102 int option_timeout = 4;
103 int option_open_once = 0;
104 int option_synch_start = 0;
105 bool option_background = false;
106 char *option_histogram = NULL;
107 int option_msg_to_ignore = 0;
108 char *option_save_all_times = NULL;
110 typedef struct threads {
120 typedef struct thread_data {
125 double mean; /* mean value of responses */
126 double moment2nd; /* used to compute variance of
128 int min, max; /* min/max response times */
129 int timeout; /* number of timeouts */
131 struct histogram hist;
132 unsigned *times; /* Array of all measured times */
137 UL_LIST_CUST_DEC(thread_list, threads_t, thread_data_t, head, node);
139 threads_t master_threads;
140 threads_t slave_threads;
142 int histogram_init(struct histogram *h,
147 h->allocated = max_value/resolution + 1;
148 h->resolution = resolution;
149 mem = h->allocated*sizeof(*h->data);
150 h->data = malloc(mem);
152 memset(h->data, 0, mem);
158 void histogram_add(struct histogram *h, unsigned value)
160 unsigned index = value / h->resolution;
161 if (index >= h->allocated)
162 index = h->allocated - 1;
166 void histogram_fprint(struct histogram *h, FILE *f)
168 unsigned long long sum = 0, cum;
170 for (i = 0; i < h->allocated; i++)
173 for (i = 0; i < h->allocated; i++) {
174 if (h->data[i] != 0) {
175 if (!getenv("CANPING_MS"))
176 fprintf(f, "%d %lld\n", i*h->resolution, cum);
178 fprintf(f, "%g %lld\n", 1e-3*(i*h->resolution), cum);
184 /* Subtract the `struct timeval' values X and Y, storing the result in
185 RESULT. Return 1 if the difference is negative, otherwise 0. */
187 int timeval_subtract (struct timeval *result, struct timeval *x, struct timeval *y)
189 /* Perform the carry for the later subtraction by updating Y. */
190 if (x->tv_usec < y->tv_usec) {
191 int nsec = (y->tv_usec - x->tv_usec) / 1000000 + 1;
192 y->tv_usec -= 1000000 * nsec;
195 if (x->tv_usec - y->tv_usec > 1000000) {
196 int nsec = (x->tv_usec - y->tv_usec) / 1000000;
197 y->tv_usec += 1000000 * nsec;
201 /* Compute the time remaining to wait.
202 `tv_usec' is certainly positive. */
203 result->tv_sec = x->tv_sec - y->tv_sec;
204 result->tv_usec = x->tv_usec - y->tv_usec;
206 /* Return 1 if result is negative. */
207 return x->tv_sec < y->tv_sec;
210 void dbg_print_timeval(char *msg, struct timeval *tv)
213 printf("%s sec=%ld usec=%ld\n", msg, tv->tv_sec, tv->tv_usec);
215 void kill_all_threads(int signum)
219 ul_list_for_each(thread_list, &master_threads, td) {
220 pthread_kill(td->tid, signum);
222 ul_list_for_each(thread_list, &slave_threads, td) {
223 pthread_kill(td->tid, signum);
226 void term_handler(int signum)
228 dbg(1, "Thread %p got a signal %d\n", (void *)pthread_self(), signum);
229 if (!IS_FINISH_FLAG()) {
230 dbg(1, "Terminating threads\n");
233 kill_all_threads(signum);
237 void *master_thread(void *arg)
239 thread_data_t *td = (thread_data_t *)arg;
240 int ping_id = td->canid;
241 int pong_id = ping_id + 1;
242 struct canmsg_t pingmsg, pongmsg;
245 vca_handle_t vcah = VCA_HANDLE_INVALID; /* File descriptor of CAN driver. */
247 fd_set rdset; /* read set for select syscall */
248 struct timeval timeout, pingtime, pongtime;
249 struct canfilt_t canfilt; /* filter for received messages */
251 if (!option_open_once) {
252 /* Open the CAN driver and disable (D) reception of
253 * all messages until we setup a filter below. */
254 if(vca_open_handle(&vcah, option_device, "D", 0) < 0) {
256 fprintf(stderr, "Error opening %s (for id %d)\n", option_device, ping_id);
257 exit(EXIT_CANNOT_OPEN);
263 /* setup filtering of received messages */
264 memset(&canfilt, 0, sizeof(canfilt));
265 canfilt.mask = 0xfffffff;
266 canfilt.id = pong_id; /* pong responces with increased id */
267 ret = vca_set_filt(vcah, &canfilt);
269 perror("ioctl CANQUE_FILTER");
270 exit(EXIT_FILTER_ERROR);
272 ret = vca_queue_flush(vcah, 0);
274 perror("ioctl CANQUE_QUEUE_FLUSH");
275 exit(EXIT_FLUSH_ERROR);
278 if (option_histogram)
279 histogram_init(&td->hist, 1000*1000/*max [us]*/, 5/*resolution [us]*/);
281 if (option_save_all_times) {
282 td->times = malloc(sizeof(*td->times)*option_count);
284 error(1, errno, "malloc times");
287 /* Prepare data structures for the select syscall. */
290 /* Signal that I'm ready */
291 sem_post(&ready_sem);
293 if (option_synch_start) {
294 /* Wait for other threads to initialize */
295 pthread_mutex_lock(&mut_start);
296 while (!start_flag) pthread_cond_wait(&cond_start, &mut_start);
297 pthread_mutex_unlock(&mut_start);
300 while (!IS_FINISH_FLAG() && (option_count == 0 || ping_count++ < option_count + option_msg_to_ignore)) {
301 /* Send a ping message */
304 pingmsg.length = option_length;
305 for (i=0; i < option_length; i++) pingmsg.data[i] = i;
306 gettimeofday(&pingtime, NULL);
308 ret = vca_send_msg_seq(vcah, &pingmsg, 1);
310 if (NOT_INTERRUPTED_SYSCALL) {
312 exit(EXIT_WRITE_ERROR);
317 /* Wait for a pong responce */
318 FD_SET (vca_h2fd(vcah), &rdset);
320 timeout.tv_sec = option_timeout;
323 ret = select(FD_SETSIZE, &rdset, NULL, NULL, &timeout);
325 /* Read the message */
327 ret = vca_rec_msg_seq(vcah, &pongmsg, 1);
329 if (NOT_INTERRUPTED_SYSCALL) {
331 exit(EXIT_READ_ERROR);
335 else { /* A pong message received */
337 gettimeofday(&pongtime, NULL);
339 fprintf(stderr, "read returned zero\n");
340 exit(EXIT_READ_ERROR);
342 if (pongmsg.id != pong_id) {
343 fprintf(stderr, "Filter error (expected: %d, received %ld)\n", pong_id, pongmsg.id);
344 exit(EXIT_FILTER_ERROR);
346 timeval_subtract(&pongtime, &pongtime, &pingtime);
347 time = pongtime.tv_sec*1000000 + pongtime.tv_usec;
348 switch (option_verbose) {
350 printf("%d:%ld\n", ping_id, time);
353 printf("Pong response %d for id %d received in %ld us\n", ping_count, ping_id, time);
356 /* Update statistics */
357 if (ping_count > option_msg_to_ignore) {
360 td->mean * ((double)(td->count - 1) / td->count) +
361 (double)time / td->count;
363 td->moment2nd * ((double)(td->count - 1) / td->count) +
364 (double)time*time / td->count;
365 if (time > td->max) td->max = time;
366 if (time < td->min) td->min = time;
367 if (option_histogram)
368 histogram_add(&td->hist, time);
369 if (option_save_all_times)
370 td->times[ping_count - 1 - option_msg_to_ignore] = time;
375 else if (ret == 0) { /* select */
376 if (option_verbose >= 2)
377 printf("Timeout encountered (id %d)\n", ping_id);
382 if (NOT_INTERRUPTED_SYSCALL) {
384 exit(EXIT_SELECT_ERROR);
388 usleep(option_wait_ms * 1000);
391 if (!option_open_once) {
392 /* Close the can driver */
393 vca_close_handle(vcah);
396 if (option_histogram) {
399 snprintf(buf, sizeof(buf), "%s-%d.dat", option_histogram, ping_id);
401 histogram_fprint(&td->hist, f);
405 if (option_save_all_times) {
409 snprintf(buf, sizeof(buf), "%s-%d.dat", option_save_all_times, ping_id);
411 for (i=0; i<option_count; i++) {
412 if (!getenv("CANPING_MS"))
413 fprintf(f, "%u\n", td->times[i]);
415 fprintf(f, "%g\n", 1e-3*td->times[i]);
420 sem_post(&finish_sem);
424 void start_masters(int masters, int first_id)
429 dbg(1, "Starting %d master threads\n", masters);
431 for (i = 0; i < masters; i++, id += 2) {
434 td = malloc(sizeof(*td));
436 printf("Can't allocate memory");
439 memset(td, 0, sizeof(*td));
441 td->min = 0x7fffffff;
442 /* TODO use mutexes and signal blocking */
443 thread_list_ins_tail(&master_threads, td);
444 pthread_create(&td->tid, NULL, master_thread, (void *)td);
445 dbg(2, "Master thread: %p\n", (void *)td->tid);
449 /* Wait for all threads beeing ready */
450 for (i = 0; i < masters; i++) sem_wait(&ready_sem);
453 pthread_mutex_lock(&mut_start);
455 pthread_cond_broadcast(&cond_start);
456 pthread_mutex_unlock(&mut_start);
459 void *slave_thread(void *arg)
461 thread_data_t *td = (thread_data_t *)arg;
462 int ping_id = td->canid;
463 int pong_id = ping_id + 1;
464 struct canmsg_t pingmsg, pongmsg;
466 vca_handle_t vcah = VCA_HANDLE_INVALID; /* File descriptor of CAN driver. */
468 struct canfilt_t canfilt; /* filter for received messages */
470 if (!option_open_once) {
471 /* Open the CAN driver and disable (D) reception of
472 * all messages until we setup a filter below. */
473 if(vca_open_handle(&vcah, option_device, "D", 0) < 0) {
475 printf("Error opening %s (for id %d)\n", option_device, ping_id);
476 exit(EXIT_CANNOT_OPEN);
482 /* setup filtering of received messages */
483 memset(&canfilt, 0, sizeof(canfilt));
484 canfilt.mask = 0xfffffff;
485 canfilt.id = ping_id; /* receive only our ping messages */
486 ret = vca_set_filt(vcah, &canfilt);
488 perror("ioctl CANQUE_FILTER");
489 exit(EXIT_FILTER_ERROR);
491 /* If there are some messages already, delete them. These may
492 * not processed by our filter and thus may have a wrong
494 ret = vca_queue_flush(vcah, 0);
496 perror("ioctl CANQUE_QUEUE_FLUSH");
497 exit(EXIT_FLUSH_ERROR);
500 /* Prepare a pong message */
502 pongmsg.id = pong_id;
503 pongmsg.length = option_length;
504 for (i=0; i < option_length; i++) pongmsg.data[i] = i;
506 /* Signal that I'm ready */
507 sem_post(&ready_sem);
509 while (!IS_FINISH_FLAG()) {
510 /* Receive a ping message */
512 ret = vca_rec_msg_seq(vcah, &pingmsg, 1);
514 if (NOT_INTERRUPTED_SYSCALL) {
515 printf("%d\n", errno);
517 exit(EXIT_READ_ERROR);
520 if (NOT_INTERRUPTED_SYSCALL && pingmsg.id != ping_id) {
521 fprintf(stderr, "Filter error (expected: %d, received %ld)\n", ping_id, pingmsg.id);
522 exit(EXIT_FILTER_ERROR);
524 /* Answer immendiately with a pong message */
525 if (NOT_INTERRUPTED_SYSCALL) {
526 ret = vca_send_msg_seq(vcah, &pongmsg, 1);
528 if (NOT_INTERRUPTED_SYSCALL) {
530 exit(EXIT_WRITE_ERROR);
535 if (ret >= 0) total_count++;
537 if (option_verbose >= 2)
538 /* This drasticly slows down the pong
539 * response. Why??? */
540 printf("Replying to ping id %lu\n", pingmsg.id);
544 if (!option_open_once) {
545 /* Close can driver */
546 vca_close_handle(vcah);
549 dbg(2, "Slave thread for id %d is going to finish\n", ping_id);
551 sem_post(&finish_sem);
555 void start_slaves(int slaves, int first_id)
560 dbg(1, "Starting %d slave threads\n", slaves);
562 for (i = 0; i < slaves; i++, id += 2) {
565 td = malloc(sizeof(*td));
567 printf("Can't allocate memory");
570 memset(td, 0, sizeof(*td));
572 /* TODO use mutexes and signal blocking */
573 thread_list_ins_tail(&slave_threads, td);
574 pthread_create(&td->tid, NULL, slave_thread, (void *)td);
575 dbg(2, "Slave thread: %p\n", (void *)td->tid);
578 /* Wait for all threads beeing ready */
579 for (i = 0; i < slaves; i++) sem_wait(&ready_sem);
583 int set_sched_policy_and_prio(int policy, int rtprio)
585 struct sched_param scheduling_parameters;
586 int maxprio=sched_get_priority_max(policy);
587 int minprio=sched_get_priority_min(policy);
589 if((rtprio < minprio) || (rtprio > maxprio)) {
590 fprintf(stderr, "The priority for requested policy is out of <%d, %d> range\n",
595 scheduling_parameters.sched_priority = rtprio;
597 if (0 != pthread_setschedparam(pthread_self(), policy, &scheduling_parameters)) {
598 perror("pthread_setschedparam error");
604 void print_help(void)
606 printf("Usage: canping -m <master threads> [other options]\n"
607 " canping -s <slave threads> [other options]\n\n"
609 " -b go to background (fork) after initialization, prints child PID\n"
610 " -c count how many messages each master sends\n"
611 " -d dev device (e.g. /dev/can1)\n"
612 " -e prefix save all measured times in file <prefix>-<id>.dat\n"
613 " -g prefix store cumulative histogram in file <prefix>-<id>.dat\n"
614 " -h print this help\n"
615 " -i id id of first master message\n"
616 " -l length length of the messages (0..8)\n"
617 " -n number ignore first <number> messages\n"
618 " -o open a device only once for all threads (doesn't work)\n" /* due to filters */
619 " -t timeout timeout in seconds (default 4 s)\n"
620 " -v be verbose (use more than once to increase verbosity)\n"
621 " -w ms wait ms miliseconds between sending pings\n"
622 " -y synchronize threads before start (doesn't test race conditions\n"
623 " between open and read/write)\n"
625 " -r run at realtime priority\n"
626 " -R P:prio run at realtime priority prio, policy RR or FF\n"
629 "Example: canping -m 10 -vv\n"
633 int parse_options(int argc, char *argv[])
638 while ((c = getopt (argc, argv, "bc:d:e:g:hi:l:m:n:os:t:vw:yrR:")) != -1)
642 option_background = true;
645 option_count = atoi(optarg);
648 option_device = optarg;
651 option_save_all_times = optarg;
654 option_histogram = optarg;
661 option_first_id = atoi(optarg);
664 option_length = atoi(optarg);
665 if (option_length > 8) option_length = 8;
666 if (option_length < 0) option_length = 0;
669 option_masters = atoi(optarg);
672 option_msg_to_ignore = atoi(optarg);
675 option_open_once = 1;
678 option_slaves = atoi(optarg);
681 option_timeout = atoi(optarg);
687 option_wait_ms = atoi(optarg);
690 option_synch_start = 1;
694 sched_policy = SCHED_FIFO;
695 sched_rtprio = (sched_get_priority_min(SCHED_FIFO) +
696 sched_get_priority_max(SCHED_FIFO)) / 2;
699 if(!isalpha(*optarg)) {
700 sched_policy = SCHED_FIFO;
701 } else if(!strncmp(optarg,"FF:",3)) {
702 sched_policy = SCHED_FIFO;
704 } else if(!strncmp(optarg,"RR:",3)) {
705 sched_policy = SCHED_RR;
708 fprintf (stderr, "Unknown policy %s\n", optarg);
709 exit(EXIT_BAD_PARAM);
711 sched_rtprio = atoi(optarg);
715 if (isprint (optopt))
716 fprintf (stderr, "Unknown option `-%c'.\n", optopt);
719 "Unknown option character `\\x%x'.\n",
723 exit(EXIT_BAD_PARAM);
725 if (!(option_masters || option_slaves) || (option_masters && option_slaves))
726 exit(EXIT_BAD_PARAM);
730 void print_stats(thread_data_t *td)
733 int count = td->count + td->timeout;
735 if (td->count >= 2) {
736 snprintf(std, 19, "%7.2f", sqrt((td->count/(td->count - 1)) *
737 (td->moment2nd - td->mean*td->mean)));
739 strncpy(std, "N/A", 19);
741 printf("Id %4ld: count = %5d"
742 " mean = %7.2f stddev = %s"
743 " min = %5d max = %5d [us]"
744 " loss = %d%% (%d)\n",
745 td->canid, count, td->mean,
748 (count > 0) ? 100 * td->timeout / count : 0, td->timeout
752 void wait_for_threads(void)
756 int thread_count = option_slaves + option_masters;
759 while (thread_count > 0) {
760 if (option_verbose != 1) {
761 ret = sem_wait(&finish_sem);
762 dbg(2, "Main thread sem_wait() exited with ret=%d.\n", ret);
764 /* If the sem_wait is successful i.e. not
765 * interrupted by a signal, decrease the
767 if (ret == 0) thread_count--;
769 if (!IS_FINISH_FLAG()) {
770 printf("Total count: %6d, Timeouts: %6d\r", total_count, total_timeout);
774 while (sem_trywait(&finish_sem) == 0) thread_count--;
777 if (option_verbose == 1) {
781 ul_list_for_each(thread_list, &master_threads, td) {
782 pthread_join(td->tid, &thread_ret);
783 dbg(2, "Master thread for id %ld finished; exit code %d\n", td->canid, (int)thread_ret);
786 ul_list_for_each(thread_list, &slave_threads, td) {
787 pthread_join(td->tid, &thread_ret);
788 dbg(2, "Slave thread for id %ld finished; exit code %d\n", td->canid, (int)thread_ret);
791 if (option_masters) printf("Summary statistics:\n");
793 ul_list_for_each_cut(thread_list, &master_threads, td) {
799 ul_list_for_each_cut(thread_list, &slave_threads, td)
803 int main(int argc, char *argv[])
805 parse_options(argc, argv);
808 if(sched_policy != SCHED_OTHER) {
809 if(set_sched_policy_and_prio(sched_policy, sched_rtprio) <0)
810 exit(EXIT_BAD_PARAM);
811 mlockall(MCL_CURRENT | MCL_FUTURE);
816 thread_list_init_head(&master_threads);
817 thread_list_init_head(&slave_threads);
819 sem_init(&finish_sem, 0, 0);
820 sem_init(&ready_sem, 0, 0);
822 siginterrupt(SIGINT, 1);
823 signal(SIGINT, term_handler);
824 siginterrupt(SIGTERM, 1);
825 signal(SIGTERM, term_handler);
827 dbg(2, "Main thread: %p\n", (void *)pthread_self());
829 if (option_open_once) {
830 /* Open the CAN driver */
831 if(vca_open_handle(&global_vcah, option_device, NULL, 0) < 0) {
833 printf("Error opening %s\n", option_device);
834 exit(EXIT_CANNOT_OPEN);
840 if ((child_ready = sem_open("canping", O_CREAT)) == NULL)
841 error(1, errno, "sem_open");
842 if (option_background) {
843 /* Go to background when everything is ready */
846 error(1, errno, "Cannot go to background");
848 int devnull = open("/dev/null", O_WRONLY);
855 if (option_masters) start_masters(option_masters, option_first_id);
856 if (option_slaves) start_slaves(option_slaves, option_first_id);
857 sem_post(child_ready);
860 sem_wait(child_ready);
861 printf("%d\n", fork_ret);
867 if (option_open_once) {
868 vca_close_handle(global_vcah);