tools/testing/selftests/networking/timestamping/rxtimestamp.c

   1 #include <errno.h>
   2 #include <error.h>
   3 #include <getopt.h>
   4 #include <stdbool.h>
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <string.h>
   8
   9 #include <sys/time.h>
  10 #include <sys/socket.h>
  11 #include <sys/select.h>
  12 #include <sys/ioctl.h>
  13 #include <arpa/inet.h>
  14 #include <net/if.h>
  15
  16 #include <asm/types.h>
  17 #include <linux/net_tstamp.h>
  18 #include <linux/errqueue.h>
  19
  20 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
  21
  22 struct options {
  23         int so_timestamp;
  24         int so_timestampns;
  25         int so_timestamping;
  26 };
  27
  28 struct tstamps {
  29         bool tstamp;
  30         bool tstampns;
  31         bool swtstamp;
  32         bool hwtstamp;
  33 };
  34
  35 struct socket_type {
  36         char *friendly_name;
  37         int type;
  38         int protocol;
  39         bool enabled;
  40 };
  41
  42 struct test_case {
  43         struct options sockopt;
  44         struct tstamps expected;
  45         bool enabled;
  46 };
  47
  48 struct sof_flag {
  49         int mask;
  50         char *name;
  51 };
  52
  53 static struct sof_flag sof_flags[] = {
  54 #define SOF_FLAG(f) { f, #f }
  55         SOF_FLAG(SOF_TIMESTAMPING_SOFTWARE),
  56         SOF_FLAG(SOF_TIMESTAMPING_RX_SOFTWARE),
  57         SOF_FLAG(SOF_TIMESTAMPING_RX_HARDWARE),
  58 };
  59
  60 static struct socket_type socket_types[] = {
  61         { "ip",         SOCK_RAW,       IPPROTO_EGP },
  62         { "udp",        SOCK_DGRAM,     IPPROTO_UDP },
  63         { "tcp",        SOCK_STREAM,    IPPROTO_TCP },
  64 };
  65
  66 static struct test_case test_cases[] = {
  67         { {}, {} },
  68         {
  69                 { so_timestamp: 1 },
  70                 { tstamp: true }
  71         },
  72         {
  73                 { so_timestampns: 1 },
  74                 { tstampns: true }
  75         },
  76         {
  77                 { so_timestamp: 1, so_timestampns: 1 },
  78                 { tstampns: true }
  79         },
  80         {
  81                 { so_timestamping: SOF_TIMESTAMPING_RX_SOFTWARE },
  82                 {}
  83         },
  84         {
  85                 /* Loopback device does not support hw timestamps. */
  86                 { so_timestamping: SOF_TIMESTAMPING_RX_HARDWARE },
  87                 {}
  88         },
  89         {
  90                 { so_timestamping: SOF_TIMESTAMPING_SOFTWARE },
  91                 {}
  92         },
  93         {
  94                 { so_timestamping: SOF_TIMESTAMPING_RX_SOFTWARE
  95                         | SOF_TIMESTAMPING_RX_HARDWARE },
  96                 {}
  97         },
  98         {
  99                 { so_timestamping: SOF_TIMESTAMPING_SOFTWARE
 100                         | SOF_TIMESTAMPING_RX_SOFTWARE },
 101                 { swtstamp: true }
 102         },
 103         {
 104                 { so_timestamp: 1, so_timestamping: SOF_TIMESTAMPING_SOFTWARE
 105                         | SOF_TIMESTAMPING_RX_SOFTWARE },
 106                 { tstamp: true, swtstamp: true }
 107         },
 108 };
 109
 110 static struct option long_options[] = {
 111         { "list_tests", no_argument, 0, 'l' },
 112         { "test_num", required_argument, 0, 'n' },
 113         { "op_size", required_argument, 0, 's' },
 114         { "tcp", no_argument, 0, 't' },
 115         { "udp", no_argument, 0, 'u' },
 116         { "ip", no_argument, 0, 'i' },
 117         { NULL, 0, NULL, 0 },
 118 };
 119
 120 static int next_port = 19999;
 121 static int op_size = 10 * 1024;
 122
 123 void print_test_case(struct test_case *t)
 124 {
 125         int f = 0;
 126
 127         printf("sockopts {");
 128         if (t->sockopt.so_timestamp)
 129                 printf(" SO_TIMESTAMP ");
 130         if (t->sockopt.so_timestampns)
 131                 printf(" SO_TIMESTAMPNS ");
 132         if (t->sockopt.so_timestamping) {
 133                 printf(" SO_TIMESTAMPING: {");
 134                 for (f = 0; f < ARRAY_SIZE(sof_flags); f++)
 135                         if (t->sockopt.so_timestamping & sof_flags[f].mask)
 136                                 printf(" %s |", sof_flags[f].name);
 137                 printf("}");
 138         }
 139         printf("} expected cmsgs: {");
 140         if (t->expected.tstamp)
 141                 printf(" SCM_TIMESTAMP ");
 142         if (t->expected.tstampns)
 143                 printf(" SCM_TIMESTAMPNS ");
 144         if (t->expected.swtstamp || t->expected.hwtstamp) {
 145                 printf(" SCM_TIMESTAMPING {");
 146                 if (t->expected.swtstamp)
 147                         printf("0");
 148                 if (t->expected.swtstamp && t->expected.hwtstamp)
 149                         printf(",");
 150                 if (t->expected.hwtstamp)
 151                         printf("2");
 152                 printf("}");
 153         }
 154         printf("}\n");
 155 }
 156
 157 void do_send(int src)
 158 {
 159         int r;
 160         char *buf = malloc(op_size);
 161
 162         memset(buf, 'z', op_size);
 163         r = write(src, buf, op_size);
 164         if (r < 0)
 165                 error(1, errno, "Failed to sendmsg");
 166
 167         free(buf);
 168 }
 169
 170 bool do_recv(int rcv, int read_size, struct tstamps expected)
 171 {
 172         const int CMSG_SIZE = 1024;
 173
 174         struct scm_timestamping *ts;
 175         struct tstamps actual = {};
 176         char cmsg_buf[CMSG_SIZE];
 177         struct iovec recv_iov;
 178         struct cmsghdr *cmsg;
 179         bool failed = false;
 180         struct msghdr hdr;
 181         int flags = 0;
 182         int r;
 183
 184         memset(&hdr, 0, sizeof(hdr));
 185         hdr.msg_iov = &recv_iov;
 186         hdr.msg_iovlen = 1;
 187         recv_iov.iov_base = malloc(read_size);
 188         recv_iov.iov_len = read_size;
 189
 190         hdr.msg_control = cmsg_buf;
 191         hdr.msg_controllen = sizeof(cmsg_buf);
 192
 193         r = recvmsg(rcv, &hdr, flags);
 194         if (r < 0)
 195                 error(1, errno, "Failed to recvmsg");
 196         if (r != read_size)
 197                 error(1, 0, "Only received %d bytes of payload.", r);
 198
 199         if (hdr.msg_flags & (MSG_TRUNC | MSG_CTRUNC))
 200                 error(1, 0, "Message was truncated.");
 201
 202         for (cmsg = CMSG_FIRSTHDR(&hdr); cmsg != NULL;
 203              cmsg = CMSG_NXTHDR(&hdr, cmsg)) {
 204                 if (cmsg->cmsg_level != SOL_SOCKET)
 205                         error(1, 0, "Unexpected cmsg_level %d",
 206                               cmsg->cmsg_level);
 207                 switch (cmsg->cmsg_type) {
 208                 case SCM_TIMESTAMP:
 209                         actual.tstamp = true;
 210                         break;
 211                 case SCM_TIMESTAMPNS:
 212                         actual.tstampns = true;
 213                         break;
 214                 case SCM_TIMESTAMPING:
 215                         ts = (struct scm_timestamping *)CMSG_DATA(cmsg);
 216                         actual.swtstamp = !!ts->ts[0].tv_sec;
 217                         if (ts->ts[1].tv_sec != 0)
 218                                 error(0, 0, "ts[1] should not be set.");
 219                         actual.hwtstamp = !!ts->ts[2].tv_sec;
 220                         break;
 221                 default:
 222                         error(1, 0, "Unexpected cmsg_type %d", cmsg->cmsg_type);
 223                 }
 224         }
 225
 226 #define VALIDATE(field) \
 227         do { \
 228                 if (expected.field != actual.field) { \
 229                         if (expected.field) \
 230                                 error(0, 0, "Expected " #field " to be set."); \
 231                         else \
 232                                 error(0, 0, \
 233                                       "Expected " #field " to not be set."); \
 234                         failed = true; \
 235                 } \
 236         } while (0)
 237
 238         VALIDATE(tstamp);
 239         VALIDATE(tstampns);
 240         VALIDATE(swtstamp);
 241         VALIDATE(hwtstamp);
 242 #undef VALIDATE
 243
 244         free(recv_iov.iov_base);
 245
 246         return failed;
 247 }
 248
 249 void config_so_flags(int rcv, struct options o)
 250 {
 251         int on = 1;
 252
 253         if (setsockopt(rcv, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) < 0)
 254                 error(1, errno, "Failed to enable SO_REUSEADDR");
 255
 256         if (o.so_timestamp &&
 257             setsockopt(rcv, SOL_SOCKET, SO_TIMESTAMP,
 258                        &o.so_timestamp, sizeof(o.so_timestamp)) < 0)
 259                 error(1, errno, "Failed to enable SO_TIMESTAMP");
 260
 261         if (o.so_timestampns &&
 262             setsockopt(rcv, SOL_SOCKET, SO_TIMESTAMPNS,
 263                        &o.so_timestampns, sizeof(o.so_timestampns)) < 0)
 264                 error(1, errno, "Failed to enable SO_TIMESTAMPNS");
 265
 266         if (o.so_timestamping &&
 267             setsockopt(rcv, SOL_SOCKET, SO_TIMESTAMPING,
 268                        &o.so_timestamping, sizeof(o.so_timestamping)) < 0)
 269                 error(1, errno, "Failed to set SO_TIMESTAMPING");
 270 }
 271
 272 bool run_test_case(struct socket_type s, struct test_case t)
 273 {
 274         int port = (s.type == SOCK_RAW) ? 0 : next_port++;
 275         int read_size = op_size;
 276         struct sockaddr_in addr;
 277         bool failed = false;
 278         int src, dst, rcv;
 279
 280         src = socket(AF_INET, s.type, s.protocol);
 281         if (src < 0)
 282                 error(1, errno, "Failed to open src socket");
 283
 284         dst = socket(AF_INET, s.type, s.protocol);
 285         if (dst < 0)
 286                 error(1, errno, "Failed to open dst socket");
 287
 288         memset(&addr, 0, sizeof(addr));
 289         addr.sin_family = AF_INET;
 290         addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 291         addr.sin_port = htons(port);
 292
 293         if (bind(dst, (struct sockaddr *)&addr, sizeof(addr)) < 0)
 294                 error(1, errno, "Failed to bind to port %d", port);
 295
 296         if (s.type == SOCK_STREAM && (listen(dst, 1) < 0))
 297                 error(1, errno, "Failed to listen");
 298
 299         if (connect(src, (struct sockaddr *)&addr, sizeof(addr)) < 0)
 300                 error(1, errno, "Failed to connect");
 301
 302         if (s.type == SOCK_STREAM) {
 303                 rcv = accept(dst, NULL, NULL);
 304                 if (rcv < 0)
 305                         error(1, errno, "Failed to accept");
 306                 close(dst);
 307         } else {
 308                 rcv = dst;
 309         }
 310
 311         config_so_flags(rcv, t.sockopt);
 312         usleep(20000); /* setsockopt for SO_TIMESTAMPING is asynchronous */
 313         do_send(src);
 314
 315         if (s.type == SOCK_RAW)
 316                 read_size += 20;  /* for IP header */
 317         failed = do_recv(rcv, read_size, t.expected);
 318
 319         close(rcv);
 320         close(src);
 321
 322         return failed;
 323 }
 324
 325 int main(int argc, char **argv)
 326 {
 327         bool all_protocols = true;
 328         bool all_tests = true;
 329         int arg_index = 0;
 330         int failures = 0;
 331         int s, t, opt;
 332
 333         while ((opt = getopt_long(argc, argv, "", long_options,
 334                                   &arg_index)) != -1) {
 335                 switch (opt) {
 336                 case 'l':
 337                         for (t = 0; t < ARRAY_SIZE(test_cases); t++) {
 338                                 printf("%d\t", t);
 339                                 print_test_case(&test_cases[t]);
 340                         }
 341                         return 0;
 342                 case 'n':
 343                         t = atoi(optarg);
 344                         if (t >= ARRAY_SIZE(test_cases))
 345                                 error(1, 0, "Invalid test case: %d", t);
 346                         all_tests = false;
 347                         test_cases[t].enabled = true;
 348                         break;
 349                 case 's':
 350                         op_size = atoi(optarg);
 351                         break;
 352                 case 't':
 353                         all_protocols = false;
 354                         socket_types[2].enabled = true;
 355                         break;
 356                 case 'u':
 357                         all_protocols = false;
 358                         socket_types[1].enabled = true;
 359                         break;
 360                 case 'i':
 361                         all_protocols = false;
 362                         socket_types[0].enabled = true;
 363                         break;
 364                 default:
 365                         error(1, 0, "Failed to parse parameters.");
 366                 }
 367         }
 368
 369         for (s = 0; s < ARRAY_SIZE(socket_types); s++) {
 370                 if (!all_protocols && !socket_types[s].enabled)
 371                         continue;
 372
 373                 printf("Testing %s...\n", socket_types[s].friendly_name);
 374                 for (t = 0; t < ARRAY_SIZE(test_cases); t++) {
 375                         if (!all_tests && !test_cases[t].enabled)
 376                                 continue;
 377
 378                         printf("Starting testcase %d...\n", t);
 379                         if (run_test_case(socket_types[s], test_cases[t])) {
 380                                 failures++;
 381                                 printf("FAILURE in test case ");
 382                                 print_test_case(&test_cases[t]);
 383                         }
 384                 }
 385         }
 386         if (!failures)
 387                 printf("PASSED.\n");
 388         return failures;
 389 }