2 * Copyright 2013 Red Hat, Inc.
3 * Author: Daniel Borkmann <dborkman@redhat.com>
4 * Chetan Loke <loke.chetan@gmail.com> (TPACKET_V3 usage example)
6 * A basic test of packet socket's TPACKET_V1/TPACKET_V2/TPACKET_V3 behavior.
9 * Test the setup of the TPACKET socket with different patterns that are
10 * known to fail (TODO) resp. succeed (OK).
13 * Open a pair of packet sockets and send resp. receive an a priori known
14 * packet pattern accross the sockets and check if it was received resp.
15 * sent correctly. Fanout in combination with RX_RING is currently not
18 * The test currently runs for
19 * - TPACKET_V1: RX_RING, TX_RING
20 * - TPACKET_V2: RX_RING, TX_RING
21 * - TPACKET_V3: RX_RING
25 * This program is free software; you can redistribute it and/or modify it
26 * under the terms and conditions of the GNU General Public License,
27 * version 2, as published by the Free Software Foundation.
29 * This program is distributed in the hope it will be useful, but WITHOUT
30 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
31 * FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for
34 * You should have received a copy of the GNU General Public License along with
35 * this program; if not, write to the Free Software Foundation, Inc.,
36 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
41 #include <sys/types.h>
43 #include <sys/socket.h>
45 #include <linux/if_packet.h>
46 #include <linux/filter.h>
50 #include <bits/wordsize.h>
51 #include <net/ethernet.h>
52 #include <netinet/ip.h>
53 #include <arpa/inet.h>
61 #include "psock_lib.h"
64 # define bug_on(cond) assert(!(cond))
67 #ifndef __aligned_tpacket
68 # define __aligned_tpacket __attribute__((aligned(TPACKET_ALIGNMENT)))
71 #ifndef __align_tpacket
72 # define __align_tpacket(x) __attribute__((aligned(TPACKET_ALIGN(x))))
75 #define NUM_PACKETS 100
76 #define ALIGN_8(x) (((x) + 8 - 1) & ~(8 - 1))
81 size_t mm_len, rd_len;
82 struct sockaddr_ll ll;
83 void (*walk)(int sock, struct ring *ring);
84 int type, rd_num, flen, version;
86 struct tpacket_req req;
87 struct tpacket_req3 req3;
93 uint32_t offset_to_priv;
94 struct tpacket_hdr_v1 h1;
99 struct tpacket_hdr tp_h __aligned_tpacket;
100 struct sockaddr_ll s_ll __align_tpacket(sizeof(struct tpacket_hdr));
103 struct tpacket2_hdr tp_h __aligned_tpacket;
104 struct sockaddr_ll s_ll __align_tpacket(sizeof(struct tpacket2_hdr));
109 static unsigned int total_packets, total_bytes;
111 static int pfsocket(int ver)
113 int ret, sock = socket(PF_PACKET, SOCK_RAW, 0);
119 ret = setsockopt(sock, SOL_PACKET, PACKET_VERSION, &ver, sizeof(ver));
121 perror("setsockopt");
128 static void status_bar_update(void)
130 if (total_packets % 10 == 0) {
131 fprintf(stderr, ".");
136 static void test_payload(void *pay, size_t len)
138 struct ethhdr *eth = pay;
140 if (len < sizeof(struct ethhdr)) {
141 fprintf(stderr, "test_payload: packet too "
142 "small: %zu bytes!\n", len);
146 if (eth->h_proto != htons(ETH_P_IP)) {
147 fprintf(stderr, "test_payload: wrong ethernet "
148 "type: 0x%x!\n", ntohs(eth->h_proto));
153 static void create_payload(void *pay, size_t *len)
156 struct ethhdr *eth = pay;
157 struct iphdr *ip = pay + sizeof(*eth);
159 /* Lets create some broken crap, that still passes
163 *len = DATA_LEN + 42;
165 memset(pay, 0xff, ETH_ALEN * 2);
166 eth->h_proto = htons(ETH_P_IP);
168 for (i = 0; i < sizeof(*ip); ++i)
169 ((uint8_t *) pay)[i + sizeof(*eth)] = (uint8_t) rand();
176 ip->tot_len = htons((uint16_t) *len - sizeof(*eth));
178 ip->saddr = htonl(INADDR_LOOPBACK);
179 ip->daddr = htonl(INADDR_LOOPBACK);
181 memset(pay + sizeof(*eth) + sizeof(*ip),
182 DATA_CHAR, DATA_LEN);
185 static inline int __v1_rx_kernel_ready(struct tpacket_hdr *hdr)
187 return ((hdr->tp_status & TP_STATUS_USER) == TP_STATUS_USER);
190 static inline void __v1_rx_user_ready(struct tpacket_hdr *hdr)
192 hdr->tp_status = TP_STATUS_KERNEL;
193 __sync_synchronize();
196 static inline int __v2_rx_kernel_ready(struct tpacket2_hdr *hdr)
198 return ((hdr->tp_status & TP_STATUS_USER) == TP_STATUS_USER);
201 static inline void __v2_rx_user_ready(struct tpacket2_hdr *hdr)
203 hdr->tp_status = TP_STATUS_KERNEL;
204 __sync_synchronize();
207 static inline int __v1_v2_rx_kernel_ready(void *base, int version)
211 return __v1_rx_kernel_ready(base);
213 return __v2_rx_kernel_ready(base);
220 static inline void __v1_v2_rx_user_ready(void *base, int version)
224 __v1_rx_user_ready(base);
227 __v2_rx_user_ready(base);
232 static void walk_v1_v2_rx(int sock, struct ring *ring)
237 unsigned int frame_num = 0;
239 bug_on(ring->type != PACKET_RX_RING);
241 pair_udp_open(udp_sock, PORT_BASE);
243 memset(&pfd, 0, sizeof(pfd));
245 pfd.events = POLLIN | POLLERR;
248 pair_udp_send(udp_sock, NUM_PACKETS);
250 while (total_packets < NUM_PACKETS * 2) {
251 while (__v1_v2_rx_kernel_ready(ring->rd[frame_num].iov_base,
253 ppd.raw = ring->rd[frame_num].iov_base;
255 switch (ring->version) {
257 test_payload((uint8_t *) ppd.raw + ppd.v1->tp_h.tp_mac,
258 ppd.v1->tp_h.tp_snaplen);
259 total_bytes += ppd.v1->tp_h.tp_snaplen;
263 test_payload((uint8_t *) ppd.raw + ppd.v2->tp_h.tp_mac,
264 ppd.v2->tp_h.tp_snaplen);
265 total_bytes += ppd.v2->tp_h.tp_snaplen;
272 __v1_v2_rx_user_ready(ppd.raw, ring->version);
274 frame_num = (frame_num + 1) % ring->rd_num;
280 pair_udp_close(udp_sock);
282 if (total_packets != 2 * NUM_PACKETS) {
283 fprintf(stderr, "walk_v%d_rx: received %u out of %u pkts\n",
284 ring->version, total_packets, NUM_PACKETS);
288 fprintf(stderr, " %u pkts (%u bytes)", NUM_PACKETS, total_bytes >> 1);
291 static inline int __v1_tx_kernel_ready(struct tpacket_hdr *hdr)
293 return !(hdr->tp_status & (TP_STATUS_SEND_REQUEST | TP_STATUS_SENDING));
296 static inline void __v1_tx_user_ready(struct tpacket_hdr *hdr)
298 hdr->tp_status = TP_STATUS_SEND_REQUEST;
299 __sync_synchronize();
302 static inline int __v2_tx_kernel_ready(struct tpacket2_hdr *hdr)
304 return !(hdr->tp_status & (TP_STATUS_SEND_REQUEST | TP_STATUS_SENDING));
307 static inline void __v2_tx_user_ready(struct tpacket2_hdr *hdr)
309 hdr->tp_status = TP_STATUS_SEND_REQUEST;
310 __sync_synchronize();
313 static inline int __v3_tx_kernel_ready(struct tpacket3_hdr *hdr)
315 return !(hdr->tp_status & (TP_STATUS_SEND_REQUEST | TP_STATUS_SENDING));
318 static inline void __v3_tx_user_ready(struct tpacket3_hdr *hdr)
320 hdr->tp_status = TP_STATUS_SEND_REQUEST;
321 __sync_synchronize();
324 static inline int __tx_kernel_ready(void *base, int version)
328 return __v1_tx_kernel_ready(base);
330 return __v2_tx_kernel_ready(base);
332 return __v3_tx_kernel_ready(base);
339 static inline void __tx_user_ready(void *base, int version)
343 __v1_tx_user_ready(base);
346 __v2_tx_user_ready(base);
349 __v3_tx_user_ready(base);
354 static void __v1_v2_set_packet_loss_discard(int sock)
356 int ret, discard = 1;
358 ret = setsockopt(sock, SOL_PACKET, PACKET_LOSS, (void *) &discard,
361 perror("setsockopt");
366 static inline void *get_next_frame(struct ring *ring, int n)
368 uint8_t *f0 = ring->rd[0].iov_base;
370 switch (ring->version) {
373 return ring->rd[n].iov_base;
375 return f0 + (n * ring->req3.tp_frame_size);
381 static void walk_tx(int sock, struct ring *ring)
388 unsigned int frame_num = 0, got = 0;
389 struct sockaddr_ll ll = {
390 .sll_family = PF_PACKET,
391 .sll_halen = ETH_ALEN,
395 /* TPACKET_V{1,2} sets up the ring->rd* related variables based
396 * on frames (e.g., rd_num is tp_frame_nr) whereas V3 sets these
397 * up based on blocks (e.g, rd_num is tp_block_nr)
399 if (ring->version <= TPACKET_V2)
400 nframes = ring->rd_num;
402 nframes = ring->req3.tp_frame_nr;
404 bug_on(ring->type != PACKET_TX_RING);
405 bug_on(nframes < NUM_PACKETS);
407 rcv_sock = socket(PF_PACKET, SOCK_RAW, htons(ETH_P_ALL));
408 if (rcv_sock == -1) {
413 pair_udp_setfilter(rcv_sock);
415 ll.sll_ifindex = if_nametoindex("lo");
416 ret = bind(rcv_sock, (struct sockaddr *) &ll, sizeof(ll));
422 memset(&pfd, 0, sizeof(pfd));
424 pfd.events = POLLOUT | POLLERR;
427 total_packets = NUM_PACKETS;
428 create_payload(packet, &packet_len);
430 while (total_packets > 0) {
431 void *next = get_next_frame(ring, frame_num);
433 while (__tx_kernel_ready(next, ring->version) &&
437 switch (ring->version) {
439 ppd.v1->tp_h.tp_snaplen = packet_len;
440 ppd.v1->tp_h.tp_len = packet_len;
442 memcpy((uint8_t *) ppd.raw + TPACKET_HDRLEN -
443 sizeof(struct sockaddr_ll), packet,
445 total_bytes += ppd.v1->tp_h.tp_snaplen;
449 ppd.v2->tp_h.tp_snaplen = packet_len;
450 ppd.v2->tp_h.tp_len = packet_len;
452 memcpy((uint8_t *) ppd.raw + TPACKET2_HDRLEN -
453 sizeof(struct sockaddr_ll), packet,
455 total_bytes += ppd.v2->tp_h.tp_snaplen;
458 struct tpacket3_hdr *tx = next;
460 tx->tp_snaplen = packet_len;
461 tx->tp_len = packet_len;
462 tx->tp_next_offset = 0;
464 memcpy((uint8_t *)tx + TPACKET3_HDRLEN -
465 sizeof(struct sockaddr_ll), packet,
467 total_bytes += tx->tp_snaplen;
475 __tx_user_ready(next, ring->version);
477 frame_num = (frame_num + 1) % nframes;
483 bug_on(total_packets != 0);
485 ret = sendto(sock, NULL, 0, 0, NULL, 0);
491 while ((ret = recvfrom(rcv_sock, packet, sizeof(packet),
492 0, NULL, NULL)) > 0 &&
493 total_packets < NUM_PACKETS) {
495 test_payload(packet, ret);
503 if (total_packets != NUM_PACKETS) {
504 fprintf(stderr, "walk_v%d_rx: received %u out of %u pkts\n",
505 ring->version, total_packets, NUM_PACKETS);
509 fprintf(stderr, " %u pkts (%u bytes)", NUM_PACKETS, got);
512 static void walk_v1_v2(int sock, struct ring *ring)
514 if (ring->type == PACKET_RX_RING)
515 walk_v1_v2_rx(sock, ring);
520 static uint64_t __v3_prev_block_seq_num = 0;
522 void __v3_test_block_seq_num(struct block_desc *pbd)
524 if (__v3_prev_block_seq_num + 1 != pbd->h1.seq_num) {
525 fprintf(stderr, "\nprev_block_seq_num:%"PRIu64", expected "
526 "seq:%"PRIu64" != actual seq:%"PRIu64"\n",
527 __v3_prev_block_seq_num, __v3_prev_block_seq_num + 1,
528 (uint64_t) pbd->h1.seq_num);
532 __v3_prev_block_seq_num = pbd->h1.seq_num;
535 static void __v3_test_block_len(struct block_desc *pbd, uint32_t bytes, int block_num)
537 if (pbd->h1.num_pkts && bytes != pbd->h1.blk_len) {
538 fprintf(stderr, "\nblock:%u with %upackets, expected "
539 "len:%u != actual len:%u\n", block_num,
540 pbd->h1.num_pkts, bytes, pbd->h1.blk_len);
545 static void __v3_test_block_header(struct block_desc *pbd, const int block_num)
547 if ((pbd->h1.block_status & TP_STATUS_USER) == 0) {
548 fprintf(stderr, "\nblock %u: not in TP_STATUS_USER\n", block_num);
552 __v3_test_block_seq_num(pbd);
555 static void __v3_walk_block(struct block_desc *pbd, const int block_num)
557 int num_pkts = pbd->h1.num_pkts, i;
558 unsigned long bytes = 0, bytes_with_padding = ALIGN_8(sizeof(*pbd));
559 struct tpacket3_hdr *ppd;
561 __v3_test_block_header(pbd, block_num);
563 ppd = (struct tpacket3_hdr *) ((uint8_t *) pbd +
564 pbd->h1.offset_to_first_pkt);
566 for (i = 0; i < num_pkts; ++i) {
567 bytes += ppd->tp_snaplen;
569 if (ppd->tp_next_offset)
570 bytes_with_padding += ppd->tp_next_offset;
572 bytes_with_padding += ALIGN_8(ppd->tp_snaplen + ppd->tp_mac);
574 test_payload((uint8_t *) ppd + ppd->tp_mac, ppd->tp_snaplen);
579 ppd = (struct tpacket3_hdr *) ((uint8_t *) ppd + ppd->tp_next_offset);
580 __sync_synchronize();
583 __v3_test_block_len(pbd, bytes_with_padding, block_num);
584 total_bytes += bytes;
587 void __v3_flush_block(struct block_desc *pbd)
589 pbd->h1.block_status = TP_STATUS_KERNEL;
590 __sync_synchronize();
593 static void walk_v3_rx(int sock, struct ring *ring)
595 unsigned int block_num = 0;
597 struct block_desc *pbd;
600 bug_on(ring->type != PACKET_RX_RING);
602 pair_udp_open(udp_sock, PORT_BASE);
604 memset(&pfd, 0, sizeof(pfd));
606 pfd.events = POLLIN | POLLERR;
609 pair_udp_send(udp_sock, NUM_PACKETS);
611 while (total_packets < NUM_PACKETS * 2) {
612 pbd = (struct block_desc *) ring->rd[block_num].iov_base;
614 while ((pbd->h1.block_status & TP_STATUS_USER) == 0)
617 __v3_walk_block(pbd, block_num);
618 __v3_flush_block(pbd);
620 block_num = (block_num + 1) % ring->rd_num;
623 pair_udp_close(udp_sock);
625 if (total_packets != 2 * NUM_PACKETS) {
626 fprintf(stderr, "walk_v3_rx: received %u out of %u pkts\n",
627 total_packets, NUM_PACKETS);
631 fprintf(stderr, " %u pkts (%u bytes)", NUM_PACKETS, total_bytes >> 1);
634 static void walk_v3(int sock, struct ring *ring)
636 if (ring->type == PACKET_RX_RING)
637 walk_v3_rx(sock, ring);
642 static void __v1_v2_fill(struct ring *ring, unsigned int blocks)
644 ring->req.tp_block_size = getpagesize() << 2;
645 ring->req.tp_frame_size = TPACKET_ALIGNMENT << 7;
646 ring->req.tp_block_nr = blocks;
648 ring->req.tp_frame_nr = ring->req.tp_block_size /
649 ring->req.tp_frame_size *
650 ring->req.tp_block_nr;
652 ring->mm_len = ring->req.tp_block_size * ring->req.tp_block_nr;
653 ring->walk = walk_v1_v2;
654 ring->rd_num = ring->req.tp_frame_nr;
655 ring->flen = ring->req.tp_frame_size;
658 static void __v3_fill(struct ring *ring, unsigned int blocks, int type)
660 if (type == PACKET_RX_RING) {
661 ring->req3.tp_retire_blk_tov = 64;
662 ring->req3.tp_sizeof_priv = 0;
663 ring->req3.tp_feature_req_word = TP_FT_REQ_FILL_RXHASH;
665 ring->req3.tp_block_size = getpagesize() << 2;
666 ring->req3.tp_frame_size = TPACKET_ALIGNMENT << 7;
667 ring->req3.tp_block_nr = blocks;
669 ring->req3.tp_frame_nr = ring->req3.tp_block_size /
670 ring->req3.tp_frame_size *
671 ring->req3.tp_block_nr;
673 ring->mm_len = ring->req3.tp_block_size * ring->req3.tp_block_nr;
674 ring->walk = walk_v3;
675 ring->rd_num = ring->req3.tp_block_nr;
676 ring->flen = ring->req3.tp_block_size;
679 static void setup_ring(int sock, struct ring *ring, int version, int type)
682 unsigned int blocks = 256;
685 ring->version = version;
690 if (type == PACKET_TX_RING)
691 __v1_v2_set_packet_loss_discard(sock);
692 __v1_v2_fill(ring, blocks);
693 ret = setsockopt(sock, SOL_PACKET, type, &ring->req,
698 __v3_fill(ring, blocks, type);
699 ret = setsockopt(sock, SOL_PACKET, type, &ring->req3,
705 perror("setsockopt");
709 ring->rd_len = ring->rd_num * sizeof(*ring->rd);
710 ring->rd = malloc(ring->rd_len);
711 if (ring->rd == NULL) {
720 static void mmap_ring(int sock, struct ring *ring)
724 ring->mm_space = mmap(0, ring->mm_len, PROT_READ | PROT_WRITE,
725 MAP_SHARED | MAP_LOCKED | MAP_POPULATE, sock, 0);
726 if (ring->mm_space == MAP_FAILED) {
731 memset(ring->rd, 0, ring->rd_len);
732 for (i = 0; i < ring->rd_num; ++i) {
733 ring->rd[i].iov_base = ring->mm_space + (i * ring->flen);
734 ring->rd[i].iov_len = ring->flen;
738 static void bind_ring(int sock, struct ring *ring)
742 pair_udp_setfilter(sock);
744 ring->ll.sll_family = PF_PACKET;
745 ring->ll.sll_protocol = htons(ETH_P_ALL);
746 ring->ll.sll_ifindex = if_nametoindex("lo");
747 ring->ll.sll_hatype = 0;
748 ring->ll.sll_pkttype = 0;
749 ring->ll.sll_halen = 0;
751 ret = bind(sock, (struct sockaddr *) &ring->ll, sizeof(ring->ll));
758 static void walk_ring(int sock, struct ring *ring)
760 ring->walk(sock, ring);
763 static void unmap_ring(int sock, struct ring *ring)
765 munmap(ring->mm_space, ring->mm_len);
769 static int test_kernel_bit_width(void)
775 fd = open("/proc/kallsyms", O_RDONLY);
781 ret = read(fd, in, sizeof(in));
790 while(!isspace(*ptr)) {
798 static int test_user_bit_width(void)
803 static const char *tpacket_str[] = {
804 [TPACKET_V1] = "TPACKET_V1",
805 [TPACKET_V2] = "TPACKET_V2",
806 [TPACKET_V3] = "TPACKET_V3",
809 static const char *type_str[] = {
810 [PACKET_RX_RING] = "PACKET_RX_RING",
811 [PACKET_TX_RING] = "PACKET_TX_RING",
814 static int test_tpacket(int version, int type)
819 fprintf(stderr, "test: %s with %s ", tpacket_str[version],
823 if (version == TPACKET_V1 &&
824 test_kernel_bit_width() != test_user_bit_width()) {
825 fprintf(stderr, "test: skip %s %s since user and kernel "
826 "space have different bit width\n",
827 tpacket_str[version], type_str[type]);
831 sock = pfsocket(version);
832 memset(&ring, 0, sizeof(ring));
833 setup_ring(sock, &ring, version, type);
834 mmap_ring(sock, &ring);
835 bind_ring(sock, &ring);
836 walk_ring(sock, &ring);
837 unmap_ring(sock, &ring);
840 fprintf(stderr, "\n");
848 ret |= test_tpacket(TPACKET_V1, PACKET_RX_RING);
849 ret |= test_tpacket(TPACKET_V1, PACKET_TX_RING);
851 ret |= test_tpacket(TPACKET_V2, PACKET_RX_RING);
852 ret |= test_tpacket(TPACKET_V2, PACKET_TX_RING);
854 ret |= test_tpacket(TPACKET_V3, PACKET_RX_RING);
855 ret |= test_tpacket(TPACKET_V3, PACKET_TX_RING);
860 printf("OK. All tests passed\n");