xref: /freebsd-13-stable/sys/netinet/tcp_hostcache.h (revision f8167e0404dab9ffeaca95853dd237ab7c587f82)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2002 Andre Oppermann, Internet Business Solutions AG
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote
16  *    products derived from this software without specific prior written
17  *    permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 /*
33  * Many thanks to jlemon for basic structure of tcp_syncache which is being
34  * followed here.
35  */
36 
37 #ifndef _NETINET_TCP_HOSTCACHE_H_
38 #define _NETINET_TCP_HOSTCACHE_H_
39 
40 TAILQ_HEAD(hc_qhead, hc_metrics);
41 
42 struct hc_head {
43 	struct hc_qhead	hch_bucket;
44 	u_int		hch_length;
45 	struct mtx	hch_mtx;
46 };
47 
48 struct hc_metrics {
49 	/* housekeeping */
50 	TAILQ_ENTRY(hc_metrics) rmx_q;
51 	struct		hc_head *rmx_head; /* head of bucket tail queue */
52 	struct		in_addr ip4;	/* IP address */
53 	struct		in6_addr ip6;	/* IP6 address */
54 	uint32_t	ip6_zoneid;	/* IPv6 scope zone id */
55 	/* endpoint specific values for tcp */
56 	uint32_t	rmx_mtu;	/* MTU for this path */
57 	uint32_t	rmx_ssthresh;	/* outbound gateway buffer limit */
58 	uint32_t	rmx_rtt;	/* estimated round trip time */
59 	uint32_t	rmx_rttvar;	/* estimated rtt variance */
60 	uint32_t	rmx_cwnd;	/* congestion window */
61 	uint32_t	rmx_sendpipe;	/* outbound delay-bandwidth product */
62 	uint32_t	rmx_recvpipe;	/* inbound delay-bandwidth product */
63 	/* TCP hostcache internal data */
64 	int		rmx_expire;	/* lifetime for object */
65 	u_long		rmx_hits;	/* number of hits */
66 	u_long		rmx_updates;	/* number of updates */
67 };
68 
69 struct tcp_hostcache {
70 	struct hc_head	*hashbase;
71 	uma_zone_t	zone;
72 	u_int		hashsize;
73 	u_int		hashmask;
74 	u_int		hashsalt;
75 	u_int		bucket_limit;
76 	u_int		cache_count;
77 	u_int		cache_limit;
78 	int		expire;
79 	int		prune;
80 	int		purgeall;
81 };
82 
83 #endif /* !_NETINET_TCP_HOSTCACHE_H_*/
84