xref: /freebsd/sys/netinet/tcp_syncache.h (revision 3157ba21)
1 /*-
2  * Copyright (c) 1982, 1986, 1993, 1994, 1995
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)tcp_var.h	8.4 (Berkeley) 5/24/95
30  * $FreeBSD$
31  */
32 
33 #ifndef _NETINET_TCP_SYNCACHE_H_
34 #define _NETINET_TCP_SYNCACHE_H_
35 #ifdef _KERNEL
36 
37 struct toeopt;
38 
39 void	 syncache_init(void);
40 #ifdef VIMAGE
41 void	syncache_destroy(void);
42 #endif
43 void	 syncache_unreach(struct in_conninfo *, struct tcphdr *);
44 int	 syncache_expand(struct in_conninfo *, struct tcpopt *,
45 	     struct tcphdr *, struct socket **, struct mbuf *);
46 int	 tcp_offload_syncache_expand(struct in_conninfo *inc, struct toeopt *toeo,
47              struct tcphdr *th, struct socket **lsop, struct mbuf *m);
48 void	 syncache_add(struct in_conninfo *, struct tcpopt *,
49 	     struct tcphdr *, struct inpcb *, struct socket **, struct mbuf *);
50 void	 tcp_offload_syncache_add(struct in_conninfo *, struct toeopt *,
51              struct tcphdr *, struct inpcb *, struct socket **,
52              struct toe_usrreqs *tu, void *toepcb);
53 
54 void	 syncache_chkrst(struct in_conninfo *, struct tcphdr *);
55 void	 syncache_badack(struct in_conninfo *);
56 int	 syncache_pcbcount(void);
57 int	 syncache_pcblist(struct sysctl_req *req, int max_pcbs, int *pcbs_exported);
58 
59 struct syncache {
60 	TAILQ_ENTRY(syncache)	sc_hash;
61 	struct		in_conninfo sc_inc;	/* addresses */
62 	int		sc_rxttime;		/* retransmit time */
63 	u_int16_t	sc_rxmits;		/* retransmit counter */
64 	u_int32_t	sc_tsreflect;		/* timestamp to reflect */
65 	u_int32_t	sc_ts;			/* our timestamp to send */
66 	u_int32_t	sc_tsoff;		/* ts offset w/ syncookies */
67 	u_int32_t	sc_flowlabel;		/* IPv6 flowlabel */
68 	tcp_seq		sc_irs;			/* seq from peer */
69 	tcp_seq		sc_iss;			/* our ISS */
70 	struct		mbuf *sc_ipopts;	/* source route */
71 	u_int16_t	sc_peer_mss;		/* peer's MSS */
72 	u_int16_t	sc_wnd;			/* advertised window */
73 	u_int8_t	sc_ip_ttl;		/* IPv4 TTL */
74 	u_int8_t	sc_ip_tos;		/* IPv4 TOS */
75 	u_int8_t	sc_requested_s_scale:4,
76 			sc_requested_r_scale:4;
77 	u_int16_t	sc_flags;
78 #ifndef TCP_OFFLOAD_DISABLE
79 	struct toe_usrreqs *sc_tu;		/* TOE operations */
80 	void 		*sc_toepcb;		/* TOE protocol block */
81 #endif
82 	struct label	*sc_label;		/* MAC label reference */
83 	struct ucred	*sc_cred;		/* cred cache for jail checks */
84 };
85 
86 /*
87  * Flags for the sc_flags field.
88  */
89 #define SCF_NOOPT	0x01			/* no TCP options */
90 #define SCF_WINSCALE	0x02			/* negotiated window scaling */
91 #define SCF_TIMESTAMP	0x04			/* negotiated timestamps */
92 						/* MSS is implicit */
93 #define SCF_UNREACH	0x10			/* icmp unreachable received */
94 #define SCF_SIGNATURE	0x20			/* send MD5 digests */
95 #define SCF_SACK	0x80			/* send SACK option */
96 #define SCF_ECN		0x100			/* send ECN setup packet */
97 
98 #define	SYNCOOKIE_SECRET_SIZE	8	/* dwords */
99 #define	SYNCOOKIE_LIFETIME	16	/* seconds */
100 
101 struct syncache_head {
102 	struct vnet	*sch_vnet;
103 	struct mtx	sch_mtx;
104 	TAILQ_HEAD(sch_head, syncache)	sch_bucket;
105 	struct callout	sch_timer;
106 	int		sch_nextc;
107 	u_int		sch_length;
108 	u_int		sch_oddeven;
109 	u_int32_t	sch_secbits_odd[SYNCOOKIE_SECRET_SIZE];
110 	u_int32_t	sch_secbits_even[SYNCOOKIE_SECRET_SIZE];
111 	u_int		sch_reseed;		/* time_uptime, seconds */
112 };
113 
114 struct tcp_syncache {
115 	struct	syncache_head *hashbase;
116 	uma_zone_t zone;
117 	u_int	hashsize;
118 	u_int	hashmask;
119 	u_int	bucket_limit;
120 	u_int	cache_count;		/* XXX: unprotected */
121 	u_int	cache_limit;
122 	u_int	rexmt_limit;
123 	u_int	hash_secret;
124 };
125 
126 #endif /* _KERNEL */
127 #endif /* !_NETINET_TCP_SYNCACHE_H_ */
128