1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2014 Google Inc.
4 * Author: willemb@google.com (Willem de Bruijn)
6 * Test software tx timestamping, including
8 * - SCHED, SND and ACK timestamps
11 * - various packet sizes (to test GSO and TSO)
13 * Consult the command line arguments for help on running
14 * the various testcases.
16 * This test requires a dummy TCP server.
17 * A simple `nc6 [-u] -l -p $DESTPORT` will do
22 #include <arpa/inet.h>
23 #include <asm/types.h>
27 #include <linux/errqueue.h>
28 #include <linux/if_ether.h>
29 #include <linux/ipv6.h>
30 #include <linux/net_tstamp.h>
33 #include <netinet/in.h>
34 #include <netinet/ip.h>
35 #include <netinet/udp.h>
36 #include <netinet/tcp.h>
37 #include <netpacket/packet.h>
44 #include <sys/ioctl.h>
45 #include <sys/select.h>
46 #include <sys/socket.h>
48 #include <sys/types.h>
52 /* command line parameters */
53 static int cfg_proto = SOCK_STREAM;
54 static int cfg_ipproto = IPPROTO_TCP;
55 static int cfg_num_pkts = 4;
56 static int do_ipv4 = 1;
57 static int do_ipv6 = 1;
58 static int cfg_payload_len = 10;
59 static int cfg_poll_timeout = 100;
60 static int cfg_delay_snd;
61 static int cfg_delay_ack;
62 static bool cfg_show_payload;
63 static bool cfg_do_pktinfo;
64 static bool cfg_loop_nodata;
65 static bool cfg_no_delay;
66 static bool cfg_use_cmsg;
67 static bool cfg_use_pf_packet;
68 static bool cfg_do_listen;
69 static uint16_t dest_port = 9000;
71 static struct sockaddr_in daddr;
72 static struct sockaddr_in6 daddr6;
73 static struct timespec ts_usr;
75 static int saved_tskey = -1;
76 static int saved_tskey_type = -1;
78 static bool test_failed;
80 static int64_t timespec_to_us64(struct timespec *ts)
82 return ts->tv_sec * 1000 * 1000 + ts->tv_nsec / 1000;
85 static void validate_key(int tskey, int tstype)
89 /* compare key for each subsequent request
90 * must only test for one type, the first one requested
92 if (saved_tskey == -1)
93 saved_tskey_type = tstype;
94 else if (saved_tskey_type != tstype)
97 stepsize = cfg_proto == SOCK_STREAM ? cfg_payload_len : 1;
98 if (tskey != saved_tskey + stepsize) {
99 fprintf(stderr, "ERROR: key %d, expected %d\n",
100 tskey, saved_tskey + stepsize);
107 static void validate_timestamp(struct timespec *cur, int min_delay)
109 int max_delay = min_delay + 500 /* processing time upper bound */;
110 int64_t cur64, start64;
112 cur64 = timespec_to_us64(cur);
113 start64 = timespec_to_us64(&ts_usr);
115 if (cur64 < start64 + min_delay || cur64 > start64 + max_delay) {
116 fprintf(stderr, "ERROR: delay %lu expected between %d and %d\n",
117 cur64 - start64, min_delay, max_delay);
122 static void __print_timestamp(const char *name, struct timespec *cur,
123 uint32_t key, int payload_len)
125 if (!(cur->tv_sec | cur->tv_nsec))
128 fprintf(stderr, " %s: %lu s %lu us (seq=%u, len=%u)",
129 name, cur->tv_sec, cur->tv_nsec / 1000,
133 fprintf(stderr, " (USR %+" PRId64 " us)",
134 timespec_to_us64(cur) - timespec_to_us64(&ts_usr));
136 fprintf(stderr, "\n");
139 static void print_timestamp_usr(void)
141 if (clock_gettime(CLOCK_REALTIME, &ts_usr))
142 error(1, errno, "clock_gettime");
144 __print_timestamp(" USR", &ts_usr, 0, 0);
147 static void print_timestamp(struct scm_timestamping *tss, int tstype,
148 int tskey, int payload_len)
152 validate_key(tskey, tstype);
155 case SCM_TSTAMP_SCHED:
157 validate_timestamp(&tss->ts[0], 0);
161 validate_timestamp(&tss->ts[0], cfg_delay_snd);
165 validate_timestamp(&tss->ts[0], cfg_delay_ack);
168 error(1, 0, "unknown timestamp type: %u",
171 __print_timestamp(tsname, &tss->ts[0], tskey, payload_len);
174 /* TODO: convert to check_and_print payload once API is stable */
175 static void print_payload(char *data, int len)
185 fprintf(stderr, "payload: ");
186 for (i = 0; i < len; i++)
187 fprintf(stderr, "%02hhx ", data[i]);
188 fprintf(stderr, "\n");
191 static void print_pktinfo(int family, int ifindex, void *saddr, void *daddr)
193 char sa[INET6_ADDRSTRLEN], da[INET6_ADDRSTRLEN];
195 fprintf(stderr, " pktinfo: ifindex=%u src=%s dst=%s\n",
197 saddr ? inet_ntop(family, saddr, sa, sizeof(sa)) : "unknown",
198 daddr ? inet_ntop(family, daddr, da, sizeof(da)) : "unknown");
201 static void __poll(int fd)
203 struct pollfd pollfd;
206 memset(&pollfd, 0, sizeof(pollfd));
208 ret = poll(&pollfd, 1, cfg_poll_timeout);
210 error(1, errno, "poll");
213 static void __recv_errmsg_cmsg(struct msghdr *msg, int payload_len)
215 struct sock_extended_err *serr = NULL;
216 struct scm_timestamping *tss = NULL;
220 for (cm = CMSG_FIRSTHDR(msg);
222 cm = CMSG_NXTHDR(msg, cm)) {
223 if (cm->cmsg_level == SOL_SOCKET &&
224 cm->cmsg_type == SCM_TIMESTAMPING) {
225 tss = (void *) CMSG_DATA(cm);
226 } else if ((cm->cmsg_level == SOL_IP &&
227 cm->cmsg_type == IP_RECVERR) ||
228 (cm->cmsg_level == SOL_IPV6 &&
229 cm->cmsg_type == IPV6_RECVERR) ||
230 (cm->cmsg_level == SOL_PACKET &&
231 cm->cmsg_type == PACKET_TX_TIMESTAMP)) {
232 serr = (void *) CMSG_DATA(cm);
233 if (serr->ee_errno != ENOMSG ||
234 serr->ee_origin != SO_EE_ORIGIN_TIMESTAMPING) {
235 fprintf(stderr, "unknown ip error %d %d\n",
240 } else if (cm->cmsg_level == SOL_IP &&
241 cm->cmsg_type == IP_PKTINFO) {
242 struct in_pktinfo *info = (void *) CMSG_DATA(cm);
243 print_pktinfo(AF_INET, info->ipi_ifindex,
244 &info->ipi_spec_dst, &info->ipi_addr);
245 } else if (cm->cmsg_level == SOL_IPV6 &&
246 cm->cmsg_type == IPV6_PKTINFO) {
247 struct in6_pktinfo *info6 = (void *) CMSG_DATA(cm);
248 print_pktinfo(AF_INET6, info6->ipi6_ifindex,
249 NULL, &info6->ipi6_addr);
251 fprintf(stderr, "unknown cmsg %d,%d\n",
252 cm->cmsg_level, cm->cmsg_type);
255 print_timestamp(tss, serr->ee_info, serr->ee_data,
264 fprintf(stderr, "batched %d timestamps\n", batch);
267 static int recv_errmsg(int fd)
269 static char ctrl[1024 /* overprovision*/];
270 static struct msghdr msg;
275 data = malloc(cfg_payload_len);
277 error(1, 0, "malloc");
279 memset(&msg, 0, sizeof(msg));
280 memset(&entry, 0, sizeof(entry));
281 memset(ctrl, 0, sizeof(ctrl));
283 entry.iov_base = data;
284 entry.iov_len = cfg_payload_len;
285 msg.msg_iov = &entry;
289 msg.msg_control = ctrl;
290 msg.msg_controllen = sizeof(ctrl);
292 ret = recvmsg(fd, &msg, MSG_ERRQUEUE);
293 if (ret == -1 && errno != EAGAIN)
294 error(1, errno, "recvmsg");
297 __recv_errmsg_cmsg(&msg, ret);
298 if (cfg_show_payload)
299 print_payload(data, cfg_payload_len);
306 static uint16_t get_ip_csum(const uint16_t *start, int num_words,
311 for (i = 0; i < num_words; i++)
315 sum = (sum & 0xFFFF) + (sum >> 16);
320 static uint16_t get_udp_csum(const struct udphdr *udph, int alen)
322 unsigned long pseudo_sum, csum_len;
323 const void *csum_start = udph;
325 pseudo_sum = htons(IPPROTO_UDP);
326 pseudo_sum += udph->len;
328 /* checksum ip(v6) addresses + udp header + payload */
329 csum_start -= alen * 2;
330 csum_len = ntohs(udph->len) + alen * 2;
332 return get_ip_csum(csum_start, csum_len >> 1, pseudo_sum);
335 static int fill_header_ipv4(void *p)
337 struct iphdr *iph = p;
339 memset(iph, 0, sizeof(*iph));
344 iph->saddr = daddr.sin_addr.s_addr; /* set for udp csum calc */
345 iph->daddr = daddr.sin_addr.s_addr;
346 iph->protocol = IPPROTO_UDP;
348 /* kernel writes saddr, csum, len */
353 static int fill_header_ipv6(void *p)
355 struct ipv6hdr *ip6h = p;
357 memset(ip6h, 0, sizeof(*ip6h));
360 ip6h->payload_len = htons(sizeof(struct udphdr) + cfg_payload_len);
361 ip6h->nexthdr = IPPROTO_UDP;
362 ip6h->hop_limit = 64;
364 ip6h->saddr = daddr6.sin6_addr;
365 ip6h->daddr = daddr6.sin6_addr;
367 /* kernel does not write saddr in case of ipv6 */
369 return sizeof(*ip6h);
372 static void fill_header_udp(void *p, bool is_ipv4)
374 struct udphdr *udph = p;
376 udph->source = ntohs(dest_port + 1); /* spoof */
377 udph->dest = ntohs(dest_port);
378 udph->len = ntohs(sizeof(*udph) + cfg_payload_len);
381 udph->check = get_udp_csum(udph, is_ipv4 ? sizeof(struct in_addr) :
382 sizeof(struct in6_addr));
385 static void do_test(int family, unsigned int report_opt)
387 char control[CMSG_SPACE(sizeof(uint32_t))];
388 struct sockaddr_ll laddr;
389 unsigned int sock_opt;
390 struct cmsghdr *cmsg;
394 int fd, i, val = 1, total_len;
396 total_len = cfg_payload_len;
397 if (cfg_use_pf_packet || cfg_proto == SOCK_RAW) {
398 total_len += sizeof(struct udphdr);
399 if (cfg_use_pf_packet || cfg_ipproto == IPPROTO_RAW)
400 if (family == PF_INET)
401 total_len += sizeof(struct iphdr);
403 total_len += sizeof(struct ipv6hdr);
405 /* special case, only rawv6_sendmsg:
406 * pass proto in sin6_port if not connected
407 * also see ANK comment in net/ipv4/raw.c
409 daddr6.sin6_port = htons(cfg_ipproto);
412 buf = malloc(total_len);
414 error(1, 0, "malloc");
416 fd = socket(cfg_use_pf_packet ? PF_PACKET : family,
417 cfg_proto, cfg_ipproto);
419 error(1, errno, "socket");
421 /* reset expected key on each new socket */
424 if (cfg_proto == SOCK_STREAM) {
425 if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY,
426 (char*) &val, sizeof(val)))
427 error(1, 0, "setsockopt no nagle");
429 if (family == PF_INET) {
430 if (connect(fd, (void *) &daddr, sizeof(daddr)))
431 error(1, errno, "connect ipv4");
433 if (connect(fd, (void *) &daddr6, sizeof(daddr6)))
434 error(1, errno, "connect ipv6");
438 if (cfg_do_pktinfo) {
439 if (family == AF_INET6) {
440 if (setsockopt(fd, SOL_IPV6, IPV6_RECVPKTINFO,
442 error(1, errno, "setsockopt pktinfo ipv6");
444 if (setsockopt(fd, SOL_IP, IP_PKTINFO,
446 error(1, errno, "setsockopt pktinfo ipv4");
450 sock_opt = SOF_TIMESTAMPING_SOFTWARE |
451 SOF_TIMESTAMPING_OPT_CMSG |
452 SOF_TIMESTAMPING_OPT_ID;
455 sock_opt |= report_opt;
458 sock_opt |= SOF_TIMESTAMPING_OPT_TSONLY;
460 if (setsockopt(fd, SOL_SOCKET, SO_TIMESTAMPING,
461 (char *) &sock_opt, sizeof(sock_opt)))
462 error(1, 0, "setsockopt timestamping");
464 for (i = 0; i < cfg_num_pkts; i++) {
465 memset(&msg, 0, sizeof(msg));
466 memset(buf, 'a' + i, total_len);
468 if (cfg_use_pf_packet || cfg_proto == SOCK_RAW) {
471 if (cfg_use_pf_packet || cfg_ipproto == IPPROTO_RAW) {
472 if (family == PF_INET)
473 off = fill_header_ipv4(buf);
475 off = fill_header_ipv6(buf);
478 fill_header_udp(buf + off, family == PF_INET);
481 print_timestamp_usr();
484 iov.iov_len = total_len;
486 if (cfg_proto != SOCK_STREAM) {
487 if (cfg_use_pf_packet) {
488 memset(&laddr, 0, sizeof(laddr));
490 laddr.sll_family = AF_PACKET;
491 laddr.sll_ifindex = 1;
492 laddr.sll_protocol = htons(family == AF_INET ? ETH_P_IP : ETH_P_IPV6);
493 laddr.sll_halen = ETH_ALEN;
495 msg.msg_name = (void *)&laddr;
496 msg.msg_namelen = sizeof(laddr);
497 } else if (family == PF_INET) {
498 msg.msg_name = (void *)&daddr;
499 msg.msg_namelen = sizeof(daddr);
501 msg.msg_name = (void *)&daddr6;
502 msg.msg_namelen = sizeof(daddr6);
510 memset(control, 0, sizeof(control));
512 msg.msg_control = control;
513 msg.msg_controllen = sizeof(control);
515 cmsg = CMSG_FIRSTHDR(&msg);
516 cmsg->cmsg_level = SOL_SOCKET;
517 cmsg->cmsg_type = SO_TIMESTAMPING;
518 cmsg->cmsg_len = CMSG_LEN(sizeof(uint32_t));
520 *((uint32_t *) CMSG_DATA(cmsg)) = report_opt;
523 val = sendmsg(fd, &msg, 0);
524 if (val != total_len)
525 error(1, errno, "send");
527 /* wait for all errors to be queued, else ACKs arrive OOO */
533 while (!recv_errmsg(fd)) {}
537 error(1, errno, "close");
543 static void __attribute__((noreturn)) usage(const char *filepath)
545 fprintf(stderr, "\nUsage: %s [options] hostname\n"
546 "\nwhere options are:\n"
549 " -h: show this message\n"
550 " -c N: number of packets for each test\n"
551 " -C: use cmsg to set tstamp recording options\n"
552 " -D: no delay between packets\n"
553 " -F: poll() waits forever for an event\n"
554 " -I: request PKTINFO\n"
555 " -l N: send N bytes at a time\n"
556 " -L listen on hostname and port\n"
557 " -n: set no-payload option\n"
558 " -p N: connect to port N\n"
559 " -P: use PF_PACKET\n"
561 " -R: use raw (IP_HDRINCL)\n"
563 " -v: validate SND delay (usec)\n"
564 " -V: validate ACK delay (usec)\n"
565 " -x: show payload (up to 70 bytes)\n",
570 static void parse_opt(int argc, char **argv)
575 while ((c = getopt(argc, argv, "46c:CDFhIl:Lnp:PrRuv:V:x")) != -1) {
584 cfg_num_pkts = strtoul(optarg, NULL, 10);
593 cfg_poll_timeout = -1;
596 cfg_do_pktinfo = true;
599 cfg_payload_len = strtoul(optarg, NULL, 10);
602 cfg_do_listen = true;
605 cfg_loop_nodata = true;
608 dest_port = strtoul(optarg, NULL, 10);
612 cfg_use_pf_packet = true;
613 cfg_proto = SOCK_DGRAM;
618 cfg_proto = SOCK_RAW;
619 cfg_ipproto = IPPROTO_UDP;
623 cfg_proto = SOCK_RAW;
624 cfg_ipproto = IPPROTO_RAW;
628 cfg_proto = SOCK_DGRAM;
629 cfg_ipproto = IPPROTO_UDP;
632 cfg_delay_snd = strtoul(optarg, NULL, 10);
635 cfg_delay_ack = strtoul(optarg, NULL, 10);
638 cfg_show_payload = true;
646 if (!cfg_payload_len)
647 error(1, 0, "payload may not be nonzero");
648 if (cfg_proto != SOCK_STREAM && cfg_payload_len > 1472)
649 error(1, 0, "udp packet might exceed expected MTU");
650 if (!do_ipv4 && !do_ipv6)
651 error(1, 0, "pass -4 or -6, not both");
653 error(1, 0, "pass -P, -r, -R or -u, not multiple");
654 if (cfg_do_pktinfo && cfg_use_pf_packet)
655 error(1, 0, "cannot ask for pktinfo over pf_packet");
657 if (optind != argc - 1)
658 error(1, 0, "missing required hostname argument");
661 static void resolve_hostname(const char *hostname)
663 struct addrinfo hints = { .ai_family = do_ipv4 ? AF_INET : AF_INET6 };
664 struct addrinfo *addrs, *cur;
665 int have_ipv4 = 0, have_ipv6 = 0;
668 if (getaddrinfo(hostname, NULL, &hints, &addrs))
669 error(1, errno, "getaddrinfo");
672 while (cur && !have_ipv4 && !have_ipv6) {
673 if (!have_ipv4 && cur->ai_family == AF_INET) {
674 memcpy(&daddr, cur->ai_addr, sizeof(daddr));
675 daddr.sin_port = htons(dest_port);
678 else if (!have_ipv6 && cur->ai_family == AF_INET6) {
679 memcpy(&daddr6, cur->ai_addr, sizeof(daddr6));
680 daddr6.sin6_port = htons(dest_port);
688 if (do_ipv6 && hints.ai_family != AF_INET6) {
689 hints.ai_family = AF_INET6;
693 do_ipv4 &= have_ipv4;
694 do_ipv6 &= have_ipv6;
697 static void do_listen(int family, void *addr, int alen)
701 type = cfg_proto == SOCK_RAW ? SOCK_DGRAM : cfg_proto;
703 fd = socket(family, type, 0);
705 error(1, errno, "socket rx");
707 if (bind(fd, addr, alen))
708 error(1, errno, "bind rx");
710 if (type == SOCK_STREAM && listen(fd, 10))
711 error(1, errno, "listen rx");
713 /* leave fd open, will be closed on process exit.
714 * this enables connect() to succeed and avoids icmp replies
718 static void do_main(int family)
720 fprintf(stderr, "family: %s %s\n",
721 family == PF_INET ? "INET" : "INET6",
722 cfg_use_pf_packet ? "(PF_PACKET)" : "");
724 fprintf(stderr, "test SND\n");
725 do_test(family, SOF_TIMESTAMPING_TX_SOFTWARE);
727 fprintf(stderr, "test ENQ\n");
728 do_test(family, SOF_TIMESTAMPING_TX_SCHED);
730 fprintf(stderr, "test ENQ + SND\n");
731 do_test(family, SOF_TIMESTAMPING_TX_SCHED |
732 SOF_TIMESTAMPING_TX_SOFTWARE);
734 if (cfg_proto == SOCK_STREAM) {
735 fprintf(stderr, "\ntest ACK\n");
736 do_test(family, SOF_TIMESTAMPING_TX_ACK);
738 fprintf(stderr, "\ntest SND + ACK\n");
739 do_test(family, SOF_TIMESTAMPING_TX_SOFTWARE |
740 SOF_TIMESTAMPING_TX_ACK);
742 fprintf(stderr, "\ntest ENQ + SND + ACK\n");
743 do_test(family, SOF_TIMESTAMPING_TX_SCHED |
744 SOF_TIMESTAMPING_TX_SOFTWARE |
745 SOF_TIMESTAMPING_TX_ACK);
749 const char *sock_names[] = { NULL, "TCP", "UDP", "RAW" };
751 int main(int argc, char **argv)
756 parse_opt(argc, argv);
757 resolve_hostname(argv[argc - 1]);
759 fprintf(stderr, "protocol: %s\n", sock_names[cfg_proto]);
760 fprintf(stderr, "payload: %u\n", cfg_payload_len);
761 fprintf(stderr, "server port: %u\n", dest_port);
762 fprintf(stderr, "\n");
766 do_listen(PF_INET, &daddr, sizeof(daddr));
772 do_listen(PF_INET6, &daddr6, sizeof(daddr6));