1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Test the SO_TXTIME API 4 * 5 * Takes a stream of { payload, delivery time }[], to be sent across two 6 * processes. Start this program on two separate network namespaces or 7 * connected hosts, one instance in transmit mode and the other in receive 8 * mode using the '-r' option. Receiver will compare arrival timestamps to 9 * the expected stream. Sender will read transmit timestamps from the error 10 * queue. The streams can differ due to out-of-order delivery and drops. 11 */ 12 13 #define _GNU_SOURCE 14 15 #include <arpa/inet.h> 16 #include <error.h> 17 #include <errno.h> 18 #include <inttypes.h> 19 #include <linux/net_tstamp.h> 20 #include <linux/errqueue.h> 21 #include <linux/if_ether.h> 22 #include <linux/ipv6.h> 23 #include <linux/udp.h> 24 #include <stdbool.h> 25 #include <stdlib.h> 26 #include <stdio.h> 27 #include <string.h> 28 #include <sys/socket.h> 29 #include <sys/stat.h> 30 #include <sys/time.h> 31 #include <sys/types.h> 32 #include <time.h> 33 #include <unistd.h> 34 #include <poll.h> 35 36 #include "kselftest.h" 37 38 static int cfg_clockid = CLOCK_TAI; 39 static uint16_t cfg_port = 8000; 40 static int cfg_variance_us = 4000; 41 static bool cfg_machine_slow; 42 static uint64_t cfg_start_time_ns; 43 static int cfg_mark; 44 static bool cfg_rx; 45 46 static uint64_t glob_tstart; 47 static uint64_t tdeliver_max; 48 49 static int errors; 50 51 /* encode one timed transmission (of a 1B payload) */ 52 struct timed_send { 53 char data; 54 int64_t delay_us; 55 }; 56 57 #define MAX_NUM_PKT 8 58 static struct timed_send cfg_buf[MAX_NUM_PKT]; 59 static int cfg_num_pkt; 60 61 static int cfg_errq_level; 62 static int cfg_errq_type; 63 64 static struct sockaddr_storage cfg_dst_addr; 65 static struct sockaddr_storage cfg_src_addr; 66 static socklen_t cfg_alen; 67 68 static uint64_t gettime_ns(clockid_t clock) 69 { 70 struct timespec ts; 71 72 if (clock_gettime(clock, &ts)) 73 error(1, errno, "gettime"); 74 75 return ts.tv_sec * (1000ULL * 1000 * 1000) + ts.tv_nsec; 76 } 77 78 static void do_send_one(int fdt, struct timed_send *ts) 79 { 80 char control[CMSG_SPACE(sizeof(uint64_t))]; 81 struct msghdr msg = {0}; 82 struct iovec iov = {0}; 83 struct cmsghdr *cm; 84 uint64_t tdeliver; 85 int ret; 86 87 iov.iov_base = &ts->data; 88 iov.iov_len = 1; 89 90 msg.msg_iov = &iov; 91 msg.msg_iovlen = 1; 92 msg.msg_name = (struct sockaddr *)&cfg_dst_addr; 93 msg.msg_namelen = cfg_alen; 94 95 if (ts->delay_us >= 0) { 96 memset(control, 0, sizeof(control)); 97 msg.msg_control = &control; 98 msg.msg_controllen = sizeof(control); 99 100 tdeliver = glob_tstart + ts->delay_us * 1000; 101 tdeliver_max = tdeliver_max > tdeliver ? 102 tdeliver_max : tdeliver; 103 104 cm = CMSG_FIRSTHDR(&msg); 105 cm->cmsg_level = SOL_SOCKET; 106 cm->cmsg_type = SCM_TXTIME; 107 cm->cmsg_len = CMSG_LEN(sizeof(tdeliver)); 108 memcpy(CMSG_DATA(cm), &tdeliver, sizeof(tdeliver)); 109 } 110 111 ret = sendmsg(fdt, &msg, 0); 112 if (ret == -1) 113 error(1, errno, "write"); 114 if (ret == 0) 115 error(1, 0, "write: 0B"); 116 117 } 118 119 static void do_recv_one(int fdr, struct timed_send *ts) 120 { 121 int64_t tstop, texpect; 122 char rbuf[2]; 123 int ret; 124 125 ret = recv(fdr, rbuf, sizeof(rbuf), 0); 126 if (ret == -1 && errno == EAGAIN) 127 error(1, EAGAIN, "recv: timeout"); 128 if (ret == -1) 129 error(1, errno, "read"); 130 if (ret != 1) 131 error(1, 0, "read: %dB", ret); 132 133 tstop = (gettime_ns(cfg_clockid) - glob_tstart) / 1000; 134 texpect = ts->delay_us >= 0 ? ts->delay_us : 0; 135 136 fprintf(stderr, "payload:%c delay:%lld expected:%lld (us)\n", 137 rbuf[0], (long long)tstop, (long long)texpect); 138 139 if (rbuf[0] != ts->data) { 140 fprintf(stderr, "payload mismatch. expected %c\n", ts->data); 141 errors++; 142 } 143 144 if (llabs(tstop - texpect) > cfg_variance_us) { 145 fprintf(stderr, "exceeds variance (%d us)\n", cfg_variance_us); 146 if (!cfg_machine_slow) 147 errors++; 148 } 149 } 150 151 static void do_recv_verify_empty(int fdr) 152 { 153 char rbuf[1]; 154 int ret; 155 156 ret = recv(fdr, rbuf, sizeof(rbuf), 0); 157 if (ret != -1 || errno != EAGAIN) 158 error(1, 0, "recv: not empty as expected (%d, %d)", ret, errno); 159 } 160 161 static int do_recv_errqueue_timeout(int fdt) 162 { 163 char control[CMSG_SPACE(sizeof(struct sock_extended_err)) + 164 CMSG_SPACE(sizeof(struct sockaddr_in6))] = {0}; 165 char data[sizeof(struct ethhdr) + sizeof(struct ipv6hdr) + 166 sizeof(struct udphdr) + 1]; 167 struct sock_extended_err *err; 168 int ret, num_tstamp = 0; 169 struct msghdr msg = {0}; 170 struct iovec iov = {0}; 171 struct cmsghdr *cm; 172 int64_t tstamp = 0; 173 174 iov.iov_base = data; 175 iov.iov_len = sizeof(data); 176 177 msg.msg_iov = &iov; 178 msg.msg_iovlen = 1; 179 180 msg.msg_control = control; 181 msg.msg_controllen = sizeof(control); 182 183 while (1) { 184 const char *reason = NULL; 185 186 ret = recvmsg(fdt, &msg, MSG_ERRQUEUE); 187 if (ret == -1 && errno == EAGAIN) 188 break; 189 if (ret == -1) 190 error(1, errno, "errqueue"); 191 if (msg.msg_flags != MSG_ERRQUEUE) 192 error(1, 0, "errqueue: flags 0x%x\n", msg.msg_flags); 193 194 cm = CMSG_FIRSTHDR(&msg); 195 if (cm->cmsg_level != cfg_errq_level || 196 cm->cmsg_type != cfg_errq_type) 197 error(1, 0, "errqueue: type 0x%x.0x%x\n", 198 cm->cmsg_level, cm->cmsg_type); 199 200 err = (struct sock_extended_err *)CMSG_DATA(cm); 201 if (err->ee_origin != SO_EE_ORIGIN_TXTIME) 202 error(1, 0, "errqueue: origin 0x%x\n", err->ee_origin); 203 204 switch (err->ee_errno) { 205 case ECANCELED: 206 if (err->ee_code != SO_EE_CODE_TXTIME_MISSED) 207 error(1, 0, "errqueue: unknown ECANCELED %u\n", 208 err->ee_code); 209 reason = "missed txtime"; 210 break; 211 case EINVAL: 212 if (err->ee_code != SO_EE_CODE_TXTIME_INVALID_PARAM) 213 error(1, 0, "errqueue: unknown EINVAL %u\n", 214 err->ee_code); 215 reason = "invalid txtime"; 216 break; 217 default: 218 error(1, 0, "errqueue: errno %u code %u\n", 219 err->ee_errno, err->ee_code); 220 } 221 222 tstamp = ((int64_t) err->ee_data) << 32 | err->ee_info; 223 tstamp -= (int64_t) glob_tstart; 224 tstamp /= 1000 * 1000; 225 fprintf(stderr, "send: pkt %c at %" PRId64 "ms dropped: %s\n", 226 data[ret - 1], tstamp, reason); 227 228 msg.msg_flags = 0; 229 msg.msg_controllen = sizeof(control); 230 num_tstamp++; 231 } 232 233 return num_tstamp; 234 } 235 236 static void recv_errqueue_msgs(int fdt) 237 { 238 struct pollfd pfd = { .fd = fdt, .events = POLLERR }; 239 const int timeout_ms = 10; 240 int ret, num_tstamp = 0; 241 242 do { 243 ret = poll(&pfd, 1, timeout_ms); 244 if (ret == -1) 245 error(1, errno, "poll"); 246 247 if (ret && (pfd.revents & POLLERR)) 248 num_tstamp += do_recv_errqueue_timeout(fdt); 249 250 if (num_tstamp == cfg_num_pkt) 251 break; 252 253 } while (gettime_ns(cfg_clockid) < tdeliver_max); 254 } 255 256 static void start_time_wait(void) 257 { 258 uint64_t now; 259 int err; 260 261 if (!cfg_start_time_ns) 262 return; 263 264 now = gettime_ns(CLOCK_REALTIME); 265 if (cfg_start_time_ns < now) { 266 fprintf(stderr, "FAIL: start time already passed\n"); 267 if (!cfg_machine_slow) 268 errors++; 269 return; 270 } 271 272 err = usleep((cfg_start_time_ns - now) / 1000); 273 if (err) 274 error(1, errno, "usleep"); 275 } 276 277 static void setsockopt_txtime(int fd) 278 { 279 struct sock_txtime so_txtime_val = { .clockid = cfg_clockid }; 280 struct sock_txtime so_txtime_val_read = { 0 }; 281 socklen_t vallen = sizeof(so_txtime_val); 282 283 so_txtime_val.flags = SOF_TXTIME_REPORT_ERRORS; 284 285 if (setsockopt(fd, SOL_SOCKET, SO_TXTIME, 286 &so_txtime_val, sizeof(so_txtime_val))) 287 error(1, errno, "setsockopt txtime"); 288 289 if (getsockopt(fd, SOL_SOCKET, SO_TXTIME, 290 &so_txtime_val_read, &vallen)) 291 error(1, errno, "getsockopt txtime"); 292 293 if (vallen != sizeof(so_txtime_val) || 294 memcmp(&so_txtime_val, &so_txtime_val_read, vallen)) 295 error(1, 0, "getsockopt txtime: mismatch"); 296 } 297 298 static int setup_tx(struct sockaddr *addr, socklen_t alen) 299 { 300 int fd; 301 302 fd = socket(addr->sa_family, SOCK_DGRAM, 0); 303 if (fd == -1) 304 error(1, errno, "socket t"); 305 306 if (connect(fd, addr, alen)) 307 error(1, errno, "connect"); 308 309 setsockopt_txtime(fd); 310 311 if (cfg_mark && 312 setsockopt(fd, SOL_SOCKET, SO_MARK, &cfg_mark, sizeof(cfg_mark))) 313 error(1, errno, "setsockopt mark"); 314 315 return fd; 316 } 317 318 static int setup_rx(struct sockaddr *addr, socklen_t alen) 319 { 320 struct timeval tv = { .tv_usec = 100 * 1000 }; 321 int fd; 322 323 fd = socket(addr->sa_family, SOCK_DGRAM, 0); 324 if (fd == -1) 325 error(1, errno, "socket r"); 326 327 if (bind(fd, addr, alen)) 328 error(1, errno, "bind"); 329 330 if (cfg_machine_slow) 331 tv.tv_sec = 2; 332 333 if (setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv))) 334 error(1, errno, "setsockopt rcv timeout"); 335 336 return fd; 337 } 338 339 static void do_test_tx(struct sockaddr *addr, socklen_t alen) 340 { 341 int fdt, i; 342 343 fprintf(stderr, "\nSO_TXTIME ipv%c clock %s\n", 344 addr->sa_family == PF_INET ? '4' : '6', 345 cfg_clockid == CLOCK_TAI ? "tai" : "monotonic"); 346 347 fdt = setup_tx(addr, alen); 348 349 start_time_wait(); 350 glob_tstart = gettime_ns(cfg_clockid); 351 352 for (i = 0; i < cfg_num_pkt; i++) 353 do_send_one(fdt, &cfg_buf[i]); 354 355 recv_errqueue_msgs(fdt); 356 357 if (close(fdt)) 358 error(1, errno, "close t"); 359 } 360 361 static void do_test_rx(struct sockaddr *addr, socklen_t alen) 362 { 363 int fdr, i; 364 365 fdr = setup_rx(addr, alen); 366 367 start_time_wait(); 368 glob_tstart = gettime_ns(cfg_clockid); 369 370 for (i = 0; i < cfg_num_pkt; i++) 371 do_recv_one(fdr, &cfg_buf[i]); 372 373 do_recv_verify_empty(fdr); 374 375 if (close(fdr)) 376 error(1, errno, "close r"); 377 } 378 379 static void setup_sockaddr(int domain, const char *str_addr, 380 struct sockaddr_storage *sockaddr) 381 { 382 struct sockaddr_in6 *addr6 = (void *) sockaddr; 383 struct sockaddr_in *addr4 = (void *) sockaddr; 384 385 switch (domain) { 386 case PF_INET: 387 memset(addr4, 0, sizeof(*addr4)); 388 addr4->sin_family = AF_INET; 389 addr4->sin_port = htons(cfg_port); 390 if (str_addr && 391 inet_pton(AF_INET, str_addr, &(addr4->sin_addr)) != 1) 392 error(1, 0, "ipv4 parse error: %s", str_addr); 393 break; 394 case PF_INET6: 395 memset(addr6, 0, sizeof(*addr6)); 396 addr6->sin6_family = AF_INET6; 397 addr6->sin6_port = htons(cfg_port); 398 if (str_addr && 399 inet_pton(AF_INET6, str_addr, &(addr6->sin6_addr)) != 1) 400 error(1, 0, "ipv6 parse error: %s", str_addr); 401 break; 402 } 403 } 404 405 static int parse_io(const char *optarg, struct timed_send *array) 406 { 407 char *arg, *tok; 408 int aoff = 0; 409 410 arg = strdup(optarg); 411 if (!arg) 412 error(1, errno, "strdup"); 413 414 while ((tok = strtok(arg, ","))) { 415 arg = NULL; /* only pass non-zero on first call */ 416 417 if (aoff / 2 == MAX_NUM_PKT) 418 error(1, 0, "exceeds max pkt count (%d)", MAX_NUM_PKT); 419 420 if (aoff & 1) { /* parse delay */ 421 array->delay_us = strtol(tok, NULL, 0) * 1000; 422 array++; 423 } else { /* parse character */ 424 array->data = tok[0]; 425 } 426 427 aoff++; 428 } 429 430 free(arg); 431 432 return aoff / 2; 433 } 434 435 static void usage(const char *progname) 436 { 437 fprintf(stderr, "\nUsage: %s [options] <payload>\n" 438 "Options:\n" 439 " -4 only IPv4\n" 440 " -6 only IPv6\n" 441 " -c <clock> monotonic or tai (default)\n" 442 " -D <addr> destination IP address (server)\n" 443 " -S <addr> source IP address (client)\n" 444 " -r run rx mode\n" 445 " -t <nsec> start time (UTC nanoseconds)\n" 446 " -m <mark> socket mark\n" 447 "\n", 448 progname); 449 exit(1); 450 } 451 452 static void parse_opts(int argc, char **argv) 453 { 454 char *daddr = NULL, *saddr = NULL; 455 int domain = PF_UNSPEC; 456 int c; 457 458 while ((c = getopt(argc, argv, "46c:S:D:rt:m:")) != -1) { 459 switch (c) { 460 case '4': 461 if (domain != PF_UNSPEC) 462 error(1, 0, "Pass one of -4 or -6"); 463 domain = PF_INET; 464 cfg_alen = sizeof(struct sockaddr_in); 465 cfg_errq_level = SOL_IP; 466 cfg_errq_type = IP_RECVERR; 467 break; 468 case '6': 469 if (domain != PF_UNSPEC) 470 error(1, 0, "Pass one of -4 or -6"); 471 domain = PF_INET6; 472 cfg_alen = sizeof(struct sockaddr_in6); 473 cfg_errq_level = SOL_IPV6; 474 cfg_errq_type = IPV6_RECVERR; 475 break; 476 case 'c': 477 if (!strcmp(optarg, "tai")) 478 cfg_clockid = CLOCK_TAI; 479 else if (!strcmp(optarg, "monotonic") || 480 !strcmp(optarg, "mono")) 481 cfg_clockid = CLOCK_MONOTONIC; 482 else 483 error(1, 0, "unknown clock id %s", optarg); 484 break; 485 case 'S': 486 saddr = optarg; 487 break; 488 case 'D': 489 daddr = optarg; 490 break; 491 case 'r': 492 cfg_rx = true; 493 break; 494 case 't': 495 cfg_start_time_ns = strtoll(optarg, NULL, 0); 496 break; 497 case 'm': 498 cfg_mark = strtol(optarg, NULL, 0); 499 break; 500 default: 501 usage(argv[0]); 502 } 503 } 504 505 if (argc - optind != 1) 506 usage(argv[0]); 507 508 if (domain == PF_UNSPEC) 509 error(1, 0, "Pass one of -4 or -6"); 510 if (!daddr) 511 error(1, 0, "-D <server addr> required\n"); 512 if (!cfg_rx && !saddr) 513 error(1, 0, "-S <client addr> required\n"); 514 515 setup_sockaddr(domain, daddr, &cfg_dst_addr); 516 setup_sockaddr(domain, saddr, &cfg_src_addr); 517 518 cfg_num_pkt = parse_io(argv[optind], cfg_buf); 519 520 cfg_machine_slow = getenv("KSFT_MACHINE_SLOW"); 521 } 522 523 int main(int argc, char **argv) 524 { 525 parse_opts(argc, argv); 526 527 if (cfg_rx) 528 do_test_rx((void *)&cfg_dst_addr, cfg_alen); 529 else 530 do_test_tx((void *)&cfg_src_addr, cfg_alen); 531 532 if (errors) { 533 fprintf(stderr, "FAIL: %d errors\n", errors); 534 return KSFT_FAIL; 535 } 536 537 return KSFT_PASS; 538 } 539