latester/latester.c

   1 /**************************************************************************/
   2 /* CAN latency tester                                                     */
   3 /* Copyright (C) 2010 Michal Sojka, DCE FEE CTU Prague                    */
   4 /* License: GPLv2                                                         */
   5 /**************************************************************************/
   6
   7 #include <ctype.h>
   8 #include <errno.h>
   9 #include <error.h>
  10 #include <fcntl.h>
  11 #include <math.h>
  12 #include <net/if.h>
  13 #include <pthread.h>
  14 #include <semaphore.h>
  15 #include <signal.h>
  16 #include <stdbool.h>
  17 #include <stdint.h>
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <string.h>
  21 #include <sys/ioctl.h>
  22 #include <sys/time.h>
  23 #include <sys/types.h>
  24 //#include <ul_list.h>
  25 #include <unistd.h>
  26 #include <sched.h>
  27 #include <sys/mman.h>
  28 #include <sys/socket.h>
  29 #include <linux/can.h>
  30 #include <linux/can/raw.h>
  31 #include <poll.h>
  32 #include <talloc.h>
  33 #include <popt.h>
  34
  35 #include "histogram.h"
  36
  37 #ifndef DEBUG
  38 #define dbg(level, fmt, arg...) do {} while (0)
  39 #else
  40 #define dbg(level, fmt, arg...) do { if (level <= DEBUG) { printf("candping: " fmt, ## arg); } } while (0)
  41 #endif
  42
  43 #define INTERRUPTED_SYSCALL(errno) (errno == EINTR || errno == ERESTART)
  44
  45 #define MEMSET_ZERO(obj) memset(&(obj), 0, sizeof(obj))
  46
  47 /* Global variables */
  48 volatile sig_atomic_t finish_flag = 0;  /* Threads should terminate. */
  49 sem_t finish_sem;               /* Thread signals a termination */
  50
  51 /* Command line options */
  52 struct options {
  53         char **interface;
  54         canid_t id;
  55         unsigned period_us;
  56         unsigned timeout_ms;
  57         unsigned count;
  58         unsigned oneattime;
  59         char *file;
  60         char *histogram_fn;
  61 };
  62
  63 struct options opt = {
  64         .id = 10,
  65         .period_us = 0,
  66         .timeout_ms = 1000,
  67
  68 };
  69
  70 int num_interfaces = 0;
  71 int count = 0;                  /* Number of sent messages */
  72
  73 struct msg_info {
  74         canid_t id;
  75         uint8_t length;
  76         struct timespec ts_sent, ts_sent_kern;
  77         struct timespec ts_rx_onwire, ts_rx_onwire_kern;
  78         struct timespec ts_rx_final, ts_rx_final_kern;
  79 };
  80
  81 #define MAX_INFOS 10000
  82 struct msg_info msg_infos[MAX_INFOS];
  83
  84 struct histogram histogram;
  85
  86 static inline struct msg_info *frame2info(struct can_frame *frame)
  87 {
  88         uint16_t idx;
  89         if (frame->can_dlc == 2) {
  90                 memcpy(&idx, frame->data, sizeof(idx));
  91                 if (idx >= MAX_INFOS)
  92                         error(1, 0, "%s idx too high", __FUNCTION__);
  93         } else
  94                 error(1, 0, "%s error", __FUNCTION__);
  95         return &msg_infos[idx];
  96 }
  97
  98 static inline char *tstamp_str(const void *ctx, struct timespec *tstamp)
  99 {
 100         return talloc_asprintf(ctx, "%ld.%06ld",
 101                                tstamp->tv_sec, tstamp->tv_nsec/1000);
 102 }
 103
 104 void print_msg_info(struct msg_info *mi)
 105 {
 106         struct timespec diff;
 107         void *local = talloc_new (NULL);
 108
 109 #define S(ts) tstamp_str(local, &ts)
 110 #define DIFF(a, b) (timespec_subtract(&diff, &b, &a), S(diff))
 111
 112         if (num_interfaces == 2)
 113                 printf("%s -> %s (%s) = %s (%s)\n",
 114                        S(mi->ts_sent), S(mi->ts_rx_final_kern), S(mi->ts_rx_final),
 115                        DIFF(mi->ts_sent, mi->ts_rx_final_kern),
 116                        DIFF(mi->ts_sent, mi->ts_rx_final));
 117         else
 118                 printf("%s -> %s (%s) -> %s (%s) = %s (%s), %s (%s)\n",
 119                        S(mi->ts_sent),
 120                        S(mi->ts_rx_onwire_kern), S(mi->ts_rx_onwire),
 121                        S(mi->ts_rx_final_kern), S(mi->ts_rx_final),
 122                        DIFF(mi->ts_sent, mi->ts_rx_onwire_kern),
 123                        DIFF(mi->ts_sent, mi->ts_rx_onwire),
 124                        DIFF(mi->ts_rx_onwire_kern, mi->ts_rx_final_kern),
 125                        DIFF(mi->ts_rx_onwire, mi->ts_rx_final));
 126 #undef S
 127 #undef DIFF
 128         talloc_free (local);
 129 }
 130
 131
 132 /* Subtract the `struct timespec' values X and Y, storing the result in
 133    RESULT.  Return 1 if the difference is negative, otherwise 0.  */
 134
 135 int timespec_subtract (struct timespec *result, struct timespec *x, struct timespec *yy)
 136 {
 137         struct timespec ylocal = *yy, *y = &ylocal;
 138         /* Perform the carry for the later subtraction by updating Y. */
 139         if (x->tv_nsec < y->tv_nsec) {
 140                 int nsec = (y->tv_nsec - x->tv_nsec) / 1000000000 + 1;
 141                 y->tv_nsec -= 1000000000 * nsec;
 142                 y->tv_sec += nsec;
 143         }
 144         if (x->tv_nsec - y->tv_nsec > 1000000000) {
 145                 int nsec = (x->tv_nsec - y->tv_nsec) / 1000000000;
 146                 y->tv_nsec += 1000000000 * nsec;
 147                 y->tv_sec -= nsec;
 148         }
 149
 150         /* Compute the time remaining to wait.
 151            `tv_nsec' is certainly positive. */
 152         result->tv_sec = x->tv_sec - y->tv_sec;
 153         result->tv_nsec = x->tv_nsec - y->tv_nsec;
 154
 155         /* Return 1 if result is negative. */
 156         return x->tv_sec < y->tv_sec;
 157 }
 158
 159 void dbg_print_timespec(char *msg, struct timespec *tv)
 160 {
 161
 162         printf("%s sec=%ld nsec=%ld\n", msg, tv->tv_sec, tv->tv_nsec);
 163 }
 164
 165 static inline unsigned get_msg_latency_us(struct msg_info *mi)
 166 {
 167         struct timespec diff;
 168         if (num_interfaces == 3)
 169                 timespec_subtract(&diff, &mi->ts_rx_final_kern, &mi->ts_rx_onwire_kern);
 170         else
 171                 timespec_subtract(&diff, &mi->ts_rx_final_kern, &mi->ts_sent);
 172         return diff.tv_sec * 1000000 + diff.tv_nsec/1000;
 173 }
 174
 175 void set_sched_policy_and_prio(int policy, int rtprio)
 176 {
 177         struct sched_param scheduling_parameters;
 178         int maxprio=sched_get_priority_max(policy);
 179         int minprio=sched_get_priority_min(policy);
 180
 181         if((rtprio < minprio) || (rtprio > maxprio))
 182                 error(1, 0, "The priority for requested policy is out of <%d, %d> range\n",
 183                       minprio, maxprio);
 184
 185         scheduling_parameters.sched_priority = rtprio;
 186
 187         if (0 != pthread_setschedparam(pthread_self(), policy, &scheduling_parameters))
 188                 error(1, errno, "pthread_setschedparam error");
 189 }
 190
 191 void term_handler(int signum)
 192 {
 193         finish_flag = 1;
 194 }
 195
 196 static inline int sock_get_if_index(int s, const char *if_name)
 197 {
 198         struct ifreq ifr;
 199         MEMSET_ZERO(ifr);
 200
 201         strcpy(ifr.ifr_name, if_name);
 202         if (ioctl(s, SIOCGIFINDEX, &ifr) < 0)
 203                 error(1, errno, "SIOCGIFINDEX '%s'", if_name);
 204         return ifr.ifr_ifindex;
 205 }
 206
 207 static inline get_tstamp(struct timespec *ts)
 208 {
 209         clock_gettime(CLOCK_REALTIME, ts);
 210 }
 211
 212 int send_frame(int socket)
 213 {
 214         struct can_frame frame;
 215         struct msg_info *mi;
 216         int ret;
 217         static int curr_msg = -1;
 218         int i;
 219         uint16_t idx;
 220
 221         i = curr_msg+1;
 222         while (msg_infos[i].id != 0 && i != curr_msg) {
 223                 i++;
 224                 if (i >= MAX_INFOS)
 225                         i = 0;
 226         }
 227         if (i == curr_msg)
 228                 error(1, 0, "Msg info table is full! Probably, many packets were lost.");
 229         else
 230                 curr_msg = i;
 231
 232         frame.can_id = opt.id;
 233         frame.can_dlc = 2;
 234         idx = curr_msg;
 235         memcpy(frame.data, &idx, sizeof(idx));
 236         mi = frame2info(&frame);
 237
 238         mi->id = frame.can_id;
 239         mi->length = frame.can_dlc;
 240         get_tstamp(&mi->ts_sent);
 241         ret = write(socket, &frame, sizeof(frame));
 242         return ret;
 243 }
 244
 245 void msg_info_free(struct msg_info *mi)
 246 {
 247         mi->id = 0;
 248 }
 249
 250 static inline void get_next_timeout(struct timespec *timeout)
 251 {
 252         struct timespec now;
 253         static struct timespec last = {-1, 0 };
 254
 255         clock_gettime(CLOCK_MONOTONIC, &now);
 256
 257         if (last.tv_sec == -1)
 258                 last = now;
 259         if (opt.period_us != 0) {
 260                 last.tv_sec += opt.period_us/1000000;
 261                 last.tv_nsec += (opt.period_us%1000000)*1000;
 262                 while (last.tv_nsec >= 1000000000) {
 263                         last.tv_nsec -= 1000000000;
 264                         last.tv_sec++;
 265                 }
 266                 timespec_subtract(timeout, &last, &now);
 267         } else if (opt.timeout_ms != 0) {
 268                 timeout->tv_sec = opt.timeout_ms/1000;
 269                 timeout->tv_nsec = (opt.timeout_ms%1000)*1000000;
 270         } else
 271                 error(1, 0, "Timeout and period cannot be both zero");
 272 }
 273
 274 void receive(int s, struct can_frame *frame, struct timespec *ts_kern, struct timespec *ts_user)
 275 {
 276         char ctrlmsg[CMSG_SPACE(sizeof(struct timeval)) + CMSG_SPACE(sizeof(__u32))];
 277         struct iovec iov;
 278         struct msghdr msg;
 279         struct cmsghdr *cmsg;
 280         struct sockaddr_can addr;
 281         int nbytes;
 282         static uint64_t dropcnt = 0;
 283
 284         iov.iov_base = frame;
 285         msg.msg_name = &addr;
 286         msg.msg_iov = &iov;
 287         msg.msg_iovlen = 1;
 288         msg.msg_control = &ctrlmsg;
 289
 290         /* these settings may be modified by recvmsg() */
 291         iov.iov_len = sizeof(*frame);
 292         msg.msg_namelen = sizeof(addr);
 293         msg.msg_controllen = sizeof(ctrlmsg);
 294         msg.msg_flags = 0;
 295
 296         nbytes = recvmsg(s, &msg, 0);
 297         if (nbytes < 0)
 298                 error(1, errno, "recvmsg");
 299
 300         if (nbytes < sizeof(struct can_frame))
 301                 error(1, 0, "recvmsg: incomplete CAN frame\n");
 302
 303         get_tstamp(ts_user);
 304         MEMSET_ZERO(*ts_kern);
 305         for (cmsg = CMSG_FIRSTHDR(&msg);
 306              cmsg && (cmsg->cmsg_level == SOL_SOCKET);
 307              cmsg = CMSG_NXTHDR(&msg,cmsg)) {
 308                 if (cmsg->cmsg_type == SO_TIMESTAMPNS)
 309                         *ts_kern = *(struct timespec *)CMSG_DATA(cmsg);
 310                 else if (cmsg->cmsg_type == SO_RXQ_OVFL)
 311                         dropcnt += *(__u32 *)CMSG_DATA(cmsg);
 312         }
 313
 314 }
 315
 316 void process_tx(int s)
 317 {
 318         error(1, 0, "%s: not implemented", __FUNCTION__);
 319 }
 320
 321 void process_on_wire_rx(int s)
 322 {
 323         struct timespec ts_kern, ts_user, ts_diff;
 324         struct can_frame frame;
 325         struct msg_info *mi;
 326         receive(s, &frame, &ts_kern, &ts_user);
 327         mi = frame2info(&frame);
 328         mi->ts_rx_onwire_kern = ts_kern;
 329         mi->ts_rx_onwire = ts_user;
 330 }
 331
 332
 333 void process_final_rx(int s)
 334 {
 335         struct timespec ts_kern, ts_user, ts_diff;
 336         struct can_frame frame;
 337         struct msg_info *mi;
 338         receive(s, &frame, &ts_kern, &ts_user);
 339         mi = frame2info(&frame);
 340         mi->ts_rx_final_kern = ts_kern;
 341         mi->ts_rx_final = ts_user;
 342
 343         if (opt.histogram_fn)
 344                 histogram_add(&histogram, get_msg_latency_us(mi));
 345
 346         if (0 && !opt.file)
 347                 print_msg_info(mi);
 348         msg_info_free(mi);
 349 }
 350
 351 void *measure_thread(void *arg)
 352 {
 353         int s, i, ret;
 354         struct pollfd pfd[3];
 355         struct timespec timeout;
 356         struct sockaddr_can addr;
 357         sigset_t set;
 358         unsigned msg_in_progress = 0;
 359
 360         MEMSET_ZERO(pfd);
 361
 362         for (i=0; i<num_interfaces; i++) {
 363                 if ((s = socket(PF_CAN, SOCK_RAW, CAN_RAW)) < 0)
 364                         error(1, errno, "socket");
 365
 366                 addr.can_family = AF_CAN;
 367                 addr.can_ifindex = sock_get_if_index(s, opt.interface[i]);
 368
 369                 if (i == 0) {   /* TX socket */
 370                         /* disable default receive filter on this RAW socket */
 371                         /* This is obsolete as we do not read from the socket at all, but for */
 372                         /* this reason we can remove the receive list in the Kernel to save a */
 373                         /* little (really a very little!) CPU usage.                          */
 374                         if (setsockopt(s, SOL_CAN_RAW, CAN_RAW_FILTER, NULL, 0) == -1)
 375                                 error(1, errno, "SOL_CAN_RAW");
 376                 }
 377
 378                 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0)
 379                         error(1, errno, "bind");
 380
 381                 const int timestamp_on = 1;
 382                 if (setsockopt(s, SOL_SOCKET, SO_TIMESTAMPNS,
 383                                &timestamp_on, sizeof(timestamp_on)) < 0)
 384                         error(1, errno, "setsockopt SO_TIMESTAMP");
 385
 386                 const int dropmonitor_on = 1;
 387                 if (setsockopt(s, SOL_SOCKET, SO_RXQ_OVFL,
 388                                &dropmonitor_on, sizeof(dropmonitor_on)) < 0)
 389                         error(1, errno, "setsockopt SO_RXQ_OVFL not supported by your Linux Kernel");
 390
 391                 pfd[i].fd = s;
 392                 if (i == 0)
 393                         pfd[i].events = POLLIN | POLLERR | ((opt.period_us == 0 && !opt.oneattime) ? POLLOUT : 0);
 394                 else
 395                         pfd[i].events = POLLIN;
 396         }
 397
 398         set_sched_policy_and_prio(SCHED_FIFO, 99);
 399
 400 #define SEND()                                          \
 401         do {                                            \
 402                 ret = send_frame(pfd[0].fd);            \
 403                 if (ret != sizeof(struct can_frame))    \
 404                         error(1, errno, "send_frame (line %d)", __LINE__); \
 405                 count++;                                \
 406                 msg_in_progress++;                      \
 407         } while (0)
 408
 409         if (opt.oneattime) {
 410                 SEND();
 411                 count = 1;
 412         }
 413
 414         while (!finish_flag &&
 415                (opt.count == 0 || count < opt.count || msg_in_progress != 0)) {
 416
 417                 get_next_timeout(&timeout);
 418                 //printf("ppoll"); fflush(stdout);
 419                 ret = ppoll(pfd, num_interfaces, &timeout, NULL);
 420                 //printf("=%d\n", ret);
 421                 switch (ret) {
 422                 case -1: // Error
 423                         if (!INTERRUPTED_SYSCALL(errno))
 424                                 error(1, errno, "ppoll");
 425                         break;
 426                 case 0: // Timeout
 427                         if (opt.period_us) {
 428                                 if (opt.count == 0 || count < opt.count) {
 429                                         SEND();
 430                                 }
 431                         } else {
 432                                 error(1, 0, "poll timeout");
 433                         }
 434                         break;
 435                 default: // Event
 436                         if (pfd[0].revents & (POLLIN|POLLERR)) {
 437                                 process_tx(pfd[0].fd);
 438                         }
 439                         if (pfd[0].revents & POLLOUT) {
 440                                 if (opt.count == 0 || count < opt.count)
 441                                         SEND();
 442                         }
 443                         pfd[0].revents = 0;
 444
 445                         if (num_interfaces == 3 && pfd[1].revents != 0) {
 446                                 process_on_wire_rx(pfd[1].fd);
 447                                 pfd[1].revents = 0;
 448                         }
 449
 450                         i = (num_interfaces == 2) ? 1 : 2;
 451                         if (pfd[i].revents != 0) {
 452                                 process_final_rx(pfd[i].fd);
 453                                 msg_in_progress--;
 454                                 pfd[i].revents = 0;
 455                                 if ((opt.count == 0 || count < opt.count) &&
 456                                     opt.oneattime) {
 457                                         SEND();
 458                                 }
 459                         }
 460                 }
 461         }
 462
 463         for (i=0; i<num_interfaces; i++)
 464                 close(pfd[i].fd);
 465
 466         return NULL;
 467 }
 468
 469 struct poptOption optionsTable[] = {
 470         { "device", 'd', POPT_ARG_ARGV, &opt.interface, 'd', "Interface to use. Must be given two times (tx, rx) or three times (tx, rx1, rx2)", "interface" },
 471         { "count",  'c', POPT_ARG_INT|POPT_ARGFLAG_SHOW_DEFAULT,  &opt.count,   0,   "The count of messages to send, zero corresponds to infinity", "num"},
 472         { "id",     'i', POPT_ARG_INT|POPT_ARGFLAG_SHOW_DEFAULT,  &opt.id,      0,   "CAN ID of sent messages", "id"},
 473         { "period", 'p', POPT_ARG_INT|POPT_ARGFLAG_SHOW_DEFAULT,  &opt.period_us, 0, "Period for sending messages or zero (default) to send as fast as possible", "us"},
 474         { "timeout",'t', POPT_ARG_INT|POPT_ARGFLAG_SHOW_DEFAULT,  &opt.timeout_ms,0, "Timeout when period is zero", "ms"},
 475         { "oneattime",'o', POPT_ARG_NONE,                         &opt.oneattime,0,  "Send the next message only when the previous was finally received"},
 476         { "verbose",'v', POPT_ARG_NONE,                           NULL, 'v',         "Send the next message only when the previous was finally received"},
 477 //      { "file",   'f', POPT_ARG_STRING,                         &opt.file,    0,   "File where to store results", "filename"},
 478         { "histogram", 'h', POPT_ARG_STRING,                      &opt.histogram_fn, 0, "Store histogram in file", "filename"},
 479         POPT_AUTOHELP
 480         { NULL, 0, 0, NULL, 0 }
 481 };
 482
 483 int parse_options(int argc, const char *argv[])
 484 {
 485         int c;
 486         poptContext optCon;   /* context for parsing command-line options */
 487
 488         optCon = poptGetContext(NULL, argc, argv, optionsTable, 0);
 489         //poptSetOtherOptionHelp(optCon, "[OPTIONS]* <port>");
 490
 491         /* Now do options processing */
 492         while ((c = poptGetNextOpt(optCon)) >= 0) {
 493                 switch (c) {
 494                 case 'd':
 495                         num_interfaces++;
 496                         break;
 497                 }
 498         }
 499         if (c < -1)
 500                 error(1, 0, "%s: %s\n",
 501                       poptBadOption(optCon, POPT_BADOPTION_NOALIAS),
 502                       poptStrerror(c));
 503
 504         if (num_interfaces < 2 || num_interfaces > 3)
 505                 error(1, 0, "-d option must be given exactly 2 or 3 times");
 506
 507         if (opt.oneattime && opt.period_us)
 508                 error(1, 0, "oneattime and period cannot be specified at the same time");
 509
 510         poptFreeContext(optCon);
 511
 512         return 0;
 513 }
 514
 515
 516 int main(int argc, const char *argv[])
 517 {
 518         pthread_t thread;
 519         sigset_t set;
 520         int ret;
 521         FILE *fhist;
 522
 523         parse_options(argc, argv);
 524
 525         mlockall(MCL_CURRENT | MCL_FUTURE);
 526
 527         signal(SIGINT, term_handler);
 528         signal(SIGTERM, term_handler);
 529
 530         if (opt.histogram_fn) {
 531                 histogram_init(&histogram, 1000000, 1);
 532                 fhist = fopen(opt.histogram_fn, "w");
 533                 if (fhist == NULL)
 534                         error(1, errno, "open %s", opt.histogram_fn);
 535         }
 536
 537
 538         pthread_create(&thread, 0, measure_thread, NULL);
 539
 540         while (!finish_flag && (opt.count == 0 || count < opt.count)) {
 541                 if (1 || opt.file) {
 542                         printf("\rMessage %d", count);
 543                         fflush(stdout);
 544                 }
 545                 usleep(100000);
 546         }
 547         if (1 || opt.file)
 548                 printf("\rMessage %d\n", count);
 549
 550         pthread_join(thread, NULL);
 551
 552         if (opt.histogram_fn) {
 553                 histogram_fprint(&histogram, fhist);
 554                 fclose(fhist);
 555         }
 556
 557         return 0;
 558 }