xref: /freebsd/sys/netinet/tcp_lro.h (revision 6829dae12bb055451fa467da4589c43bd03b1e64)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2006, Myricom Inc.
5  * Copyright (c) 2008, Intel Corporation.
6  * Copyright (c) 2016 Mellanox Technologies.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _TCP_LRO_H_
34 #define _TCP_LRO_H_
35 
36 #include <sys/time.h>
37 
38 #ifndef TCP_LRO_ENTRIES
39 /* Define default number of LRO entries per RX queue */
40 #define	TCP_LRO_ENTRIES	8
41 #endif
42 
43 struct lro_entry {
44 	LIST_ENTRY(lro_entry)	next;
45 	LIST_ENTRY(lro_entry)	hash_next;
46 	struct mbuf		*m_head;
47 	struct mbuf		*m_tail;
48 	union {
49 		struct ip	*ip4;
50 		struct ip6_hdr	*ip6;
51 	} leip;
52 	union {
53 		in_addr_t	s_ip4;
54 		struct in6_addr	s_ip6;
55 	} lesource;
56 	union {
57 		in_addr_t	d_ip4;
58 		struct in6_addr	d_ip6;
59 	} ledest;
60 	uint16_t		source_port;
61 	uint16_t		dest_port;
62 	uint16_t		eh_type;	/* EthernetHeader type. */
63 	uint16_t		append_cnt;
64 	uint32_t		p_len;		/* IP header payload length. */
65 	uint32_t		ulp_csum;	/* TCP, etc. checksum. */
66 	uint32_t		next_seq;	/* tcp_seq */
67 	uint32_t		ack_seq;	/* tcp_seq */
68 	uint32_t		tsval;
69 	uint32_t		tsecr;
70 	uint16_t		window;
71 	uint16_t		timestamp;	/* flag, not a TCP hdr field. */
72 	struct timeval		mtime;
73 };
74 LIST_HEAD(lro_head, lro_entry);
75 
76 #define	le_ip4			leip.ip4
77 #define	le_ip6			leip.ip6
78 #define	source_ip4		lesource.s_ip4
79 #define	dest_ip4		ledest.d_ip4
80 #define	source_ip6		lesource.s_ip6
81 #define	dest_ip6		ledest.d_ip6
82 
83 struct lro_mbuf_sort {
84 	uint64_t seq;
85 	struct mbuf *mb;
86 };
87 
88 /* NB: This is part of driver structs. */
89 struct lro_ctrl {
90 	struct ifnet	*ifp;
91 	struct lro_mbuf_sort *lro_mbuf_data;
92 	uint64_t	lro_queued;
93 	uint64_t	lro_flushed;
94 	uint64_t	lro_bad_csum;
95 	unsigned	lro_cnt;
96 	unsigned	lro_mbuf_count;
97 	unsigned	lro_mbuf_max;
98 	unsigned short	lro_ackcnt_lim;		/* max # of aggregated ACKs */
99 	unsigned 	lro_length_lim;		/* max len of aggregated data */
100 
101 	u_long		lro_hashsz;
102 	struct lro_head	*lro_hash;
103 	struct lro_head	lro_active;
104 	struct lro_head	lro_free;
105 };
106 
107 #define	TCP_LRO_LENGTH_MAX	65535
108 #define	TCP_LRO_ACKCNT_MAX	65535		/* unlimited */
109 
110 int tcp_lro_init(struct lro_ctrl *);
111 int tcp_lro_init_args(struct lro_ctrl *, struct ifnet *, unsigned, unsigned);
112 void tcp_lro_free(struct lro_ctrl *);
113 void tcp_lro_flush_inactive(struct lro_ctrl *, const struct timeval *);
114 void tcp_lro_flush(struct lro_ctrl *, struct lro_entry *);
115 void tcp_lro_flush_all(struct lro_ctrl *);
116 int tcp_lro_rx(struct lro_ctrl *, struct mbuf *, uint32_t);
117 void tcp_lro_queue_mbuf(struct lro_ctrl *, struct mbuf *);
118 
119 #define	TCP_LRO_NO_ENTRIES	-2
120 #define	TCP_LRO_CANNOT		-1
121 #define	TCP_LRO_NOT_SUPPORTED	1
122 
123 #endif /* _TCP_LRO_H_ */
124