1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright(c) 2017 - 2018 Intel Corporation. */
9 #include <linux/if_link.h>
10 #include <linux/if_xdp.h>
11 #include <linux/if_ether.h>
18 #include <net/ethernet.h>
19 #include <sys/resource.h>
20 #include <sys/socket.h>
26 #include <sys/types.h>
29 #include "bpf/libbpf.h"
47 #define NUM_FRAMES 131072
48 #define FRAME_HEADROOM 0
49 #define FRAME_SHIFT 11
50 #define FRAME_SIZE 2048
51 #define NUM_DESCS 1024
54 #define FQ_NUM_DESCS 1024
55 #define CQ_NUM_DESCS 1024
57 #define DEBUG_HEXDUMP 0
62 static unsigned long prev_time;
70 static enum benchmark_type opt_bench = BENCH_RXDROP;
71 static u32 opt_xdp_flags;
72 static const char *opt_if = "";
73 static int opt_ifindex;
76 static int opt_shared_packet_buffer;
77 static int opt_interval = 1;
78 static u32 opt_xdp_bind_flags;
80 struct xdp_umem_uqueue {
93 struct xdp_umem_uqueue fq;
94 struct xdp_umem_uqueue cq;
105 struct xdp_desc *ring;
110 struct xdp_uqueue rx;
111 struct xdp_uqueue tx;
113 struct xdp_umem *umem;
115 unsigned long rx_npkts;
116 unsigned long tx_npkts;
117 unsigned long prev_rx_npkts;
118 unsigned long prev_tx_npkts;
121 static int num_socks;
122 struct xdpsock *xsks[MAX_SOCKS];
124 static unsigned long get_nsecs(void)
128 clock_gettime(CLOCK_MONOTONIC, &ts);
129 return ts.tv_sec * 1000000000UL + ts.tv_nsec;
132 static void dump_stats(void);
134 #define lassert(expr) \
137 fprintf(stderr, "%s:%s:%i: Assertion failed: " \
138 #expr ": errno: %d/\"%s\"\n", \
139 __FILE__, __func__, __LINE__, \
140 errno, strerror(errno)); \
142 exit(EXIT_FAILURE); \
146 #define barrier() __asm__ __volatile__("": : :"memory")
148 #define u_smp_rmb() __asm__ __volatile__("dmb ishld": : :"memory")
149 #define u_smp_wmb() __asm__ __volatile__("dmb ishst": : :"memory")
151 #define u_smp_rmb() barrier()
152 #define u_smp_wmb() barrier()
154 #define likely(x) __builtin_expect(!!(x), 1)
155 #define unlikely(x) __builtin_expect(!!(x), 0)
157 static const char pkt_data[] =
158 "\x3c\xfd\xfe\x9e\x7f\x71\xec\xb1\xd7\x98\x3a\xc0\x08\x00\x45\x00"
159 "\x00\x2e\x00\x00\x00\x00\x40\x11\x88\x97\x05\x08\x07\x08\xc8\x14"
160 "\x1e\x04\x10\x92\x10\x92\x00\x1a\x6d\xa3\x34\x33\x1f\x69\x40\x6b"
161 "\x54\x59\xb6\x14\x2d\x11\x44\xbf\xaf\xd9\xbe\xaa";
163 static inline u32 umem_nb_free(struct xdp_umem_uqueue *q, u32 nb)
165 u32 free_entries = q->cached_cons - q->cached_prod;
167 if (free_entries >= nb)
170 /* Refresh the local tail pointer */
171 q->cached_cons = *q->consumer + q->size;
173 return q->cached_cons - q->cached_prod;
176 static inline u32 xq_nb_free(struct xdp_uqueue *q, u32 ndescs)
178 u32 free_entries = q->cached_cons - q->cached_prod;
180 if (free_entries >= ndescs)
183 /* Refresh the local tail pointer */
184 q->cached_cons = *q->consumer + q->size;
185 return q->cached_cons - q->cached_prod;
188 static inline u32 umem_nb_avail(struct xdp_umem_uqueue *q, u32 nb)
190 u32 entries = q->cached_prod - q->cached_cons;
193 q->cached_prod = *q->producer;
194 entries = q->cached_prod - q->cached_cons;
197 return (entries > nb) ? nb : entries;
200 static inline u32 xq_nb_avail(struct xdp_uqueue *q, u32 ndescs)
202 u32 entries = q->cached_prod - q->cached_cons;
205 q->cached_prod = *q->producer;
206 entries = q->cached_prod - q->cached_cons;
209 return (entries > ndescs) ? ndescs : entries;
212 static inline int umem_fill_to_kernel_ex(struct xdp_umem_uqueue *fq,
218 if (umem_nb_free(fq, nb) < nb)
221 for (i = 0; i < nb; i++) {
222 u32 idx = fq->cached_prod++ & fq->mask;
224 fq->ring[idx] = d[i].addr;
229 *fq->producer = fq->cached_prod;
234 static inline int umem_fill_to_kernel(struct xdp_umem_uqueue *fq, u64 *d,
239 if (umem_nb_free(fq, nb) < nb)
242 for (i = 0; i < nb; i++) {
243 u32 idx = fq->cached_prod++ & fq->mask;
245 fq->ring[idx] = d[i];
250 *fq->producer = fq->cached_prod;
255 static inline size_t umem_complete_from_kernel(struct xdp_umem_uqueue *cq,
258 u32 idx, i, entries = umem_nb_avail(cq, nb);
262 for (i = 0; i < entries; i++) {
263 idx = cq->cached_cons++ & cq->mask;
264 d[i] = cq->ring[idx];
270 *cq->consumer = cq->cached_cons;
276 static inline void *xq_get_data(struct xdpsock *xsk, u64 addr)
278 return &xsk->umem->frames[addr];
281 static inline int xq_enq(struct xdp_uqueue *uq,
282 const struct xdp_desc *descs,
285 struct xdp_desc *r = uq->ring;
288 if (xq_nb_free(uq, ndescs) < ndescs)
291 for (i = 0; i < ndescs; i++) {
292 u32 idx = uq->cached_prod++ & uq->mask;
294 r[idx].addr = descs[i].addr;
295 r[idx].len = descs[i].len;
300 *uq->producer = uq->cached_prod;
304 static inline int xq_enq_tx_only(struct xdp_uqueue *uq,
305 unsigned int id, unsigned int ndescs)
307 struct xdp_desc *r = uq->ring;
310 if (xq_nb_free(uq, ndescs) < ndescs)
313 for (i = 0; i < ndescs; i++) {
314 u32 idx = uq->cached_prod++ & uq->mask;
316 r[idx].addr = (id + i) << FRAME_SHIFT;
317 r[idx].len = sizeof(pkt_data) - 1;
322 *uq->producer = uq->cached_prod;
326 static inline int xq_deq(struct xdp_uqueue *uq,
327 struct xdp_desc *descs,
330 struct xdp_desc *r = uq->ring;
334 entries = xq_nb_avail(uq, ndescs);
338 for (i = 0; i < entries; i++) {
339 idx = uq->cached_cons++ & uq->mask;
346 *uq->consumer = uq->cached_cons;
352 static void swap_mac_addresses(void *data)
354 struct ether_header *eth = (struct ether_header *)data;
355 struct ether_addr *src_addr = (struct ether_addr *)ð->ether_shost;
356 struct ether_addr *dst_addr = (struct ether_addr *)ð->ether_dhost;
357 struct ether_addr tmp;
360 *src_addr = *dst_addr;
364 static void hex_dump(void *pkt, size_t length, u64 addr)
366 const unsigned char *address = (unsigned char *)pkt;
367 const unsigned char *line = address;
368 size_t line_size = 32;
376 sprintf(buf, "addr=%llu", addr);
377 printf("length = %zu\n", length);
378 printf("%s | ", buf);
379 while (length-- > 0) {
380 printf("%02X ", *address++);
381 if (!(++i % line_size) || (length == 0 && i % line_size)) {
383 while (i++ % line_size)
386 printf(" | "); /* right close */
387 while (line < address) {
389 printf("%c", (c < 33 || c == 255) ? 0x2E : c);
393 printf("%s | ", buf);
399 static size_t gen_eth_frame(char *frame)
401 memcpy(frame, pkt_data, sizeof(pkt_data) - 1);
402 return sizeof(pkt_data) - 1;
405 static struct xdp_umem *xdp_umem_configure(int sfd)
407 int fq_size = FQ_NUM_DESCS, cq_size = CQ_NUM_DESCS;
408 struct xdp_mmap_offsets off;
409 struct xdp_umem_reg mr;
410 struct xdp_umem *umem;
414 umem = calloc(1, sizeof(*umem));
417 lassert(posix_memalign(&bufs, getpagesize(), /* PAGE_SIZE aligned */
418 NUM_FRAMES * FRAME_SIZE) == 0);
420 mr.addr = (__u64)bufs;
421 mr.len = NUM_FRAMES * FRAME_SIZE;
422 mr.chunk_size = FRAME_SIZE;
423 mr.headroom = FRAME_HEADROOM;
425 lassert(setsockopt(sfd, SOL_XDP, XDP_UMEM_REG, &mr, sizeof(mr)) == 0);
426 lassert(setsockopt(sfd, SOL_XDP, XDP_UMEM_FILL_RING, &fq_size,
428 lassert(setsockopt(sfd, SOL_XDP, XDP_UMEM_COMPLETION_RING, &cq_size,
431 optlen = sizeof(off);
432 lassert(getsockopt(sfd, SOL_XDP, XDP_MMAP_OFFSETS, &off,
435 umem->fq.map = mmap(0, off.fr.desc +
436 FQ_NUM_DESCS * sizeof(u64),
437 PROT_READ | PROT_WRITE,
438 MAP_SHARED | MAP_POPULATE, sfd,
439 XDP_UMEM_PGOFF_FILL_RING);
440 lassert(umem->fq.map != MAP_FAILED);
442 umem->fq.mask = FQ_NUM_DESCS - 1;
443 umem->fq.size = FQ_NUM_DESCS;
444 umem->fq.producer = umem->fq.map + off.fr.producer;
445 umem->fq.consumer = umem->fq.map + off.fr.consumer;
446 umem->fq.ring = umem->fq.map + off.fr.desc;
447 umem->fq.cached_cons = FQ_NUM_DESCS;
449 umem->cq.map = mmap(0, off.cr.desc +
450 CQ_NUM_DESCS * sizeof(u64),
451 PROT_READ | PROT_WRITE,
452 MAP_SHARED | MAP_POPULATE, sfd,
453 XDP_UMEM_PGOFF_COMPLETION_RING);
454 lassert(umem->cq.map != MAP_FAILED);
456 umem->cq.mask = CQ_NUM_DESCS - 1;
457 umem->cq.size = CQ_NUM_DESCS;
458 umem->cq.producer = umem->cq.map + off.cr.producer;
459 umem->cq.consumer = umem->cq.map + off.cr.consumer;
460 umem->cq.ring = umem->cq.map + off.cr.desc;
465 if (opt_bench == BENCH_TXONLY) {
468 for (i = 0; i < NUM_FRAMES * FRAME_SIZE; i += FRAME_SIZE)
469 (void)gen_eth_frame(&umem->frames[i]);
475 static struct xdpsock *xsk_configure(struct xdp_umem *umem)
477 struct sockaddr_xdp sxdp = {};
478 struct xdp_mmap_offsets off;
479 int sfd, ndescs = NUM_DESCS;
485 sfd = socket(PF_XDP, SOCK_RAW, 0);
488 xsk = calloc(1, sizeof(*xsk));
492 xsk->outstanding_tx = 0;
496 xsk->umem = xdp_umem_configure(sfd);
501 lassert(setsockopt(sfd, SOL_XDP, XDP_RX_RING,
502 &ndescs, sizeof(int)) == 0);
503 lassert(setsockopt(sfd, SOL_XDP, XDP_TX_RING,
504 &ndescs, sizeof(int)) == 0);
505 optlen = sizeof(off);
506 lassert(getsockopt(sfd, SOL_XDP, XDP_MMAP_OFFSETS, &off,
510 xsk->rx.map = mmap(NULL,
512 NUM_DESCS * sizeof(struct xdp_desc),
513 PROT_READ | PROT_WRITE,
514 MAP_SHARED | MAP_POPULATE, sfd,
516 lassert(xsk->rx.map != MAP_FAILED);
519 for (i = 0; i < NUM_DESCS * FRAME_SIZE; i += FRAME_SIZE)
520 lassert(umem_fill_to_kernel(&xsk->umem->fq, &i, 1)
525 xsk->tx.map = mmap(NULL,
527 NUM_DESCS * sizeof(struct xdp_desc),
528 PROT_READ | PROT_WRITE,
529 MAP_SHARED | MAP_POPULATE, sfd,
531 lassert(xsk->tx.map != MAP_FAILED);
533 xsk->rx.mask = NUM_DESCS - 1;
534 xsk->rx.size = NUM_DESCS;
535 xsk->rx.producer = xsk->rx.map + off.rx.producer;
536 xsk->rx.consumer = xsk->rx.map + off.rx.consumer;
537 xsk->rx.ring = xsk->rx.map + off.rx.desc;
539 xsk->tx.mask = NUM_DESCS - 1;
540 xsk->tx.size = NUM_DESCS;
541 xsk->tx.producer = xsk->tx.map + off.tx.producer;
542 xsk->tx.consumer = xsk->tx.map + off.tx.consumer;
543 xsk->tx.ring = xsk->tx.map + off.tx.desc;
544 xsk->tx.cached_cons = NUM_DESCS;
546 sxdp.sxdp_family = PF_XDP;
547 sxdp.sxdp_ifindex = opt_ifindex;
548 sxdp.sxdp_queue_id = opt_queue;
551 sxdp.sxdp_flags = XDP_SHARED_UMEM;
552 sxdp.sxdp_shared_umem_fd = umem->fd;
554 sxdp.sxdp_flags = opt_xdp_bind_flags;
557 lassert(bind(sfd, (struct sockaddr *)&sxdp, sizeof(sxdp)) == 0);
562 static void print_benchmark(bool running)
564 const char *bench_str = "INVALID";
566 if (opt_bench == BENCH_RXDROP)
567 bench_str = "rxdrop";
568 else if (opt_bench == BENCH_TXONLY)
569 bench_str = "txonly";
570 else if (opt_bench == BENCH_L2FWD)
573 printf("%s:%d %s ", opt_if, opt_queue, bench_str);
574 if (opt_xdp_flags & XDP_FLAGS_SKB_MODE)
576 else if (opt_xdp_flags & XDP_FLAGS_DRV_MODE)
585 printf("running...");
590 static void dump_stats(void)
592 unsigned long now = get_nsecs();
593 long dt = now - prev_time;
598 for (i = 0; i < num_socks && xsks[i]; i++) {
599 char *fmt = "%-15s %'-11.0f %'-11lu\n";
600 double rx_pps, tx_pps;
602 rx_pps = (xsks[i]->rx_npkts - xsks[i]->prev_rx_npkts) *
604 tx_pps = (xsks[i]->tx_npkts - xsks[i]->prev_tx_npkts) *
607 printf("\n sock%d@", i);
608 print_benchmark(false);
611 printf("%-15s %-11s %-11s %-11.2f\n", "", "pps", "pkts",
613 printf(fmt, "rx", rx_pps, xsks[i]->rx_npkts);
614 printf(fmt, "tx", tx_pps, xsks[i]->tx_npkts);
616 xsks[i]->prev_rx_npkts = xsks[i]->rx_npkts;
617 xsks[i]->prev_tx_npkts = xsks[i]->tx_npkts;
621 static void *poller(void *arg)
632 static void int_exit(int sig)
636 bpf_set_link_xdp_fd(opt_ifindex, -1, opt_xdp_flags);
640 static struct option long_options[] = {
641 {"rxdrop", no_argument, 0, 'r'},
642 {"txonly", no_argument, 0, 't'},
643 {"l2fwd", no_argument, 0, 'l'},
644 {"interface", required_argument, 0, 'i'},
645 {"queue", required_argument, 0, 'q'},
646 {"poll", no_argument, 0, 'p'},
647 {"shared-buffer", no_argument, 0, 's'},
648 {"xdp-skb", no_argument, 0, 'S'},
649 {"xdp-native", no_argument, 0, 'N'},
650 {"interval", required_argument, 0, 'n'},
651 {"zero-copy", no_argument, 0, 'z'},
652 {"copy", no_argument, 0, 'c'},
656 static void usage(const char *prog)
659 " Usage: %s [OPTIONS]\n"
661 " -r, --rxdrop Discard all incoming packets (default)\n"
662 " -t, --txonly Only send packets\n"
663 " -l, --l2fwd MAC swap L2 forwarding\n"
664 " -i, --interface=n Run on interface n\n"
665 " -q, --queue=n Use queue n (default 0)\n"
666 " -p, --poll Use poll syscall\n"
667 " -s, --shared-buffer Use shared packet buffer\n"
668 " -S, --xdp-skb=n Use XDP skb-mod\n"
669 " -N, --xdp-native=n Enfore XDP native mode\n"
670 " -n, --interval=n Specify statistics update interval (default 1 sec).\n"
671 " -z, --zero-copy Force zero-copy mode.\n"
672 " -c, --copy Force copy mode.\n"
674 fprintf(stderr, str, prog);
678 static void parse_command_line(int argc, char **argv)
685 c = getopt_long(argc, argv, "rtli:q:psSNn:cz", long_options,
692 opt_bench = BENCH_RXDROP;
695 opt_bench = BENCH_TXONLY;
698 opt_bench = BENCH_L2FWD;
704 opt_queue = atoi(optarg);
707 opt_shared_packet_buffer = 1;
713 opt_xdp_flags |= XDP_FLAGS_SKB_MODE;
714 opt_xdp_bind_flags |= XDP_COPY;
717 opt_xdp_flags |= XDP_FLAGS_DRV_MODE;
720 opt_interval = atoi(optarg);
723 opt_xdp_bind_flags |= XDP_ZEROCOPY;
726 opt_xdp_bind_flags |= XDP_COPY;
729 usage(basename(argv[0]));
733 opt_ifindex = if_nametoindex(opt_if);
735 fprintf(stderr, "ERROR: interface \"%s\" does not exist\n",
737 usage(basename(argv[0]));
741 static void kick_tx(int fd)
745 ret = sendto(fd, NULL, 0, MSG_DONTWAIT, NULL, 0);
746 if (ret >= 0 || errno == ENOBUFS || errno == EAGAIN || errno == EBUSY)
751 static inline void complete_tx_l2fwd(struct xdpsock *xsk)
753 u64 descs[BATCH_SIZE];
757 if (!xsk->outstanding_tx)
761 ndescs = (xsk->outstanding_tx > BATCH_SIZE) ? BATCH_SIZE :
764 /* re-add completed Tx buffers */
765 rcvd = umem_complete_from_kernel(&xsk->umem->cq, descs, ndescs);
767 umem_fill_to_kernel(&xsk->umem->fq, descs, rcvd);
768 xsk->outstanding_tx -= rcvd;
769 xsk->tx_npkts += rcvd;
773 static inline void complete_tx_only(struct xdpsock *xsk)
775 u64 descs[BATCH_SIZE];
778 if (!xsk->outstanding_tx)
783 rcvd = umem_complete_from_kernel(&xsk->umem->cq, descs, BATCH_SIZE);
785 xsk->outstanding_tx -= rcvd;
786 xsk->tx_npkts += rcvd;
790 static void rx_drop(struct xdpsock *xsk)
792 struct xdp_desc descs[BATCH_SIZE];
793 unsigned int rcvd, i;
795 rcvd = xq_deq(&xsk->rx, descs, BATCH_SIZE);
799 for (i = 0; i < rcvd; i++) {
800 char *pkt = xq_get_data(xsk, descs[i].addr);
802 hex_dump(pkt, descs[i].len, descs[i].addr);
805 xsk->rx_npkts += rcvd;
807 umem_fill_to_kernel_ex(&xsk->umem->fq, descs, rcvd);
810 static void rx_drop_all(void)
812 struct pollfd fds[MAX_SOCKS + 1];
813 int i, ret, timeout, nfds = 1;
815 memset(fds, 0, sizeof(fds));
817 for (i = 0; i < num_socks; i++) {
818 fds[i].fd = xsks[i]->sfd;
819 fds[i].events = POLLIN;
820 timeout = 1000; /* 1sn */
825 ret = poll(fds, nfds, timeout);
830 for (i = 0; i < num_socks; i++)
835 static void tx_only(struct xdpsock *xsk)
837 int timeout, ret, nfds = 1;
838 struct pollfd fds[nfds + 1];
839 unsigned int idx = 0;
841 memset(fds, 0, sizeof(fds));
842 fds[0].fd = xsk->sfd;
843 fds[0].events = POLLOUT;
844 timeout = 1000; /* 1sn */
848 ret = poll(fds, nfds, timeout);
852 if (fds[0].fd != xsk->sfd ||
853 !(fds[0].revents & POLLOUT))
857 if (xq_nb_free(&xsk->tx, BATCH_SIZE) >= BATCH_SIZE) {
858 lassert(xq_enq_tx_only(&xsk->tx, idx, BATCH_SIZE) == 0);
860 xsk->outstanding_tx += BATCH_SIZE;
865 complete_tx_only(xsk);
869 static void l2fwd(struct xdpsock *xsk)
872 struct xdp_desc descs[BATCH_SIZE];
873 unsigned int rcvd, i;
877 complete_tx_l2fwd(xsk);
879 rcvd = xq_deq(&xsk->rx, descs, BATCH_SIZE);
884 for (i = 0; i < rcvd; i++) {
885 char *pkt = xq_get_data(xsk, descs[i].addr);
887 swap_mac_addresses(pkt);
889 hex_dump(pkt, descs[i].len, descs[i].addr);
892 xsk->rx_npkts += rcvd;
894 ret = xq_enq(&xsk->tx, descs, rcvd);
896 xsk->outstanding_tx += rcvd;
900 int main(int argc, char **argv)
902 struct rlimit r = {RLIM_INFINITY, RLIM_INFINITY};
903 struct bpf_prog_load_attr prog_load_attr = {
904 .prog_type = BPF_PROG_TYPE_XDP,
906 int prog_fd, qidconf_map, xsks_map;
907 struct bpf_object *obj;
908 char xdp_filename[256];
913 parse_command_line(argc, argv);
915 if (setrlimit(RLIMIT_MEMLOCK, &r)) {
916 fprintf(stderr, "ERROR: setrlimit(RLIMIT_MEMLOCK) \"%s\"\n",
921 snprintf(xdp_filename, sizeof(xdp_filename), "%s_kern.o", argv[0]);
922 prog_load_attr.file = xdp_filename;
924 if (bpf_prog_load_xattr(&prog_load_attr, &obj, &prog_fd))
927 fprintf(stderr, "ERROR: no program found: %s\n",
932 map = bpf_object__find_map_by_name(obj, "qidconf_map");
933 qidconf_map = bpf_map__fd(map);
934 if (qidconf_map < 0) {
935 fprintf(stderr, "ERROR: no qidconf map found: %s\n",
936 strerror(qidconf_map));
940 map = bpf_object__find_map_by_name(obj, "xsks_map");
941 xsks_map = bpf_map__fd(map);
943 fprintf(stderr, "ERROR: no xsks map found: %s\n",
948 if (bpf_set_link_xdp_fd(opt_ifindex, prog_fd, opt_xdp_flags) < 0) {
949 fprintf(stderr, "ERROR: link set xdp fd failed\n");
953 ret = bpf_map_update_elem(qidconf_map, &key, &opt_queue, 0);
955 fprintf(stderr, "ERROR: bpf_map_update_elem qidconf\n");
959 /* Create sockets... */
960 xsks[num_socks++] = xsk_configure(NULL);
963 for (i = 0; i < MAX_SOCKS - 1; i++)
964 xsks[num_socks++] = xsk_configure(xsks[0]->umem);
967 /* ...and insert them into the map. */
968 for (i = 0; i < num_socks; i++) {
970 ret = bpf_map_update_elem(xsks_map, &key, &xsks[i]->sfd, 0);
972 fprintf(stderr, "ERROR: bpf_map_update_elem %d\n", i);
977 signal(SIGINT, int_exit);
978 signal(SIGTERM, int_exit);
979 signal(SIGABRT, int_exit);
981 setlocale(LC_ALL, "");
983 ret = pthread_create(&pt, NULL, poller, NULL);
986 prev_time = get_nsecs();
988 if (opt_bench == BENCH_RXDROP)
990 else if (opt_bench == BENCH_TXONLY)