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