VirtualBox

source: vbox/trunk/src/VBox/Devices/Network/slirp/tcp_var.h@ 15435

Last change on this file since 15435 was 15054, checked in by vboxsync, 16 years ago

slirp: code readability

  • Property svn:eol-style set to native
File size: 13.9 KB
Line 
1/*
2 * Copyright (c) 1982, 1986, 1993, 1994
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 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)tcp_var.h 8.3 (Berkeley) 4/10/94
34 * tcp_var.h,v 1.3 1994/08/21 05:27:39 paul Exp
35 */
36
37#ifndef _TCP_VAR_H_
38#define _TCP_VAR_H_
39
40#ifdef VBOX_WITH_BSD_REASS
41#include "queue.h"
42#endif /* VBOX_WITH_BSD_REASS */
43
44#include "tcpip.h"
45#include "tcp_timer.h"
46
47#if SIZEOF_CHAR_P == 4
48 typedef struct tcpiphdr *tcpiphdrp_32;
49# define u32ptr_done(pData, u32, ptr) do {} while (0)
50# define ptr_to_u32(pData, ptr) (ptr)
51# define u32_to_ptr(pData, u32, type) ((type)(u32))
52#else
53 typedef u_int32_t tcpiphdrp_32;
54# include <iprt/types.h>
55# include <iprt/assert.h>
56
57#if defined(VBOX_WITH_BSD_REASS)
58# define u32ptr_done(pData, u32, ptr) do {} while (0)
59# define ptr_to_u32(pData, ptr) (ptr)
60# define u32_to_ptr(pData, u32, type) ((type)(u32))
61#else /* !VBOX_WITH_BSD_REASS */
62# define u32ptr_done(pData, u32, ptr) VBoxU32PtrDone((pData), (ptr), (u32))
63# define ptr_to_u32(pData, ptr) VBoxU32PtrHash((pData), (ptr))
64# define u32_to_ptr(pData, u32, type) ((type)VBoxU32PtrLookup((pData), (u32)))
65#endif /* !VBOX_WITH_BSD_REASS */
66
67#endif
68
69#ifdef VBOX_WITH_BSD_REASS
70/* TCP segment queue entry */
71struct tseg_qent
72{
73 LIST_ENTRY(tseg_qent) tqe_q;
74 int tqe_len; /* TCP segment data length */
75 struct tcphdr *tqe_th; /* a pointer to tcp header */
76 struct mbuf *tqe_m; /* mbuf contains packet */
77};
78LIST_HEAD(tsegqe_head, tseg_qent);
79#endif
80
81/*
82 * Tcp control block, one per tcp; fields:
83 */
84struct tcpcb
85{
86#ifndef VBOX_WITH_BSD_REASS
87 tcpiphdrp_32 seg_next; /* sequencing queue */
88 tcpiphdrp_32 seg_prev;
89#else /* VBOX_WITH_BSD_REASS */
90 LIST_ENTRY(tcpcb) t_list;
91 struct tsegqe_head t_segq; /* segment reassembly queue */
92 int t_segqlen; /* segment reassembly queue length */
93#endif /* VBOX_WITH_BSD_REASS */
94 int16_t t_state; /* state of this connection */
95 int16_t t_timer[TCPT_NTIMERS]; /* tcp timers */
96 int16_t t_rxtshift; /* log(2) of rexmt exp. backoff */
97 int16_t t_rxtcur; /* current retransmit value */
98 int16_t t_dupacks; /* consecutive dup acks recd */
99 uint16_t t_maxseg; /* maximum segment size */
100 char t_force; /* 1 if forcing out a byte */
101 uint16_t t_flags;
102#define TF_ACKNOW 0x0001 /* ack peer immediately */
103#define TF_DELACK 0x0002 /* ack, but try to delay it */
104#define TF_NODELAY 0x0004 /* don't delay packets to coalesce */
105#define TF_NOOPT 0x0008 /* don't use tcp options */
106#define TF_SENTFIN 0x0010 /* have sent FIN */
107#define TF_REQ_SCALE 0x0020 /* have/will request window scaling */
108#define TF_RCVD_SCALE 0x0040 /* other side has requested scaling */
109#define TF_REQ_TSTMP 0x0080 /* have/will request timestamps */
110#define TF_RCVD_TSTMP 0x0100 /* a timestamp was received in SYN */
111#define TF_SACK_PERMIT 0x0200 /* other side said I could SACK */
112
113 /* Make it static for now */
114/* struct tcpiphdr *t_template; / * skeletal packet for transmit */
115 struct tcpiphdr t_template;
116
117 struct socket *t_socket; /* back pointer to socket */
118/*
119 * The following fields are used as in the protocol specification.
120 * See RFC783, Dec. 1981, page 21.
121 */
122 /* send sequence variables */
123 tcp_seq snd_una; /* send unacknowledged */
124 tcp_seq snd_nxt; /* send next */
125 tcp_seq snd_up; /* send urgent pointer */
126 tcp_seq snd_wl1; /* window update seg seq number */
127 tcp_seq snd_wl2; /* window update seg ack number */
128 tcp_seq iss; /* initial send sequence number */
129 uint32_t snd_wnd; /* send window */
130 /* receive sequence variables */
131 uint32_t rcv_wnd; /* receive window */
132 tcp_seq rcv_nxt; /* receive next */
133 tcp_seq rcv_up; /* receive urgent pointer */
134 tcp_seq irs; /* initial receive sequence number */
135/*
136 * Additional variables for this implementation.
137 */
138 /* receive variables */
139 tcp_seq rcv_adv; /* advertised window */
140 /* retransmit variables */
141 tcp_seq snd_max; /* highest sequence number sent;
142 * used to recognize retransmits
143 */
144 /* congestion control (for slow start, source quench, retransmit after loss) */
145 uint32_t snd_cwnd; /* congestion-controlled window */
146 uint32_t snd_ssthresh; /* snd_cwnd size threshold for
147 * for slow start exponential to
148 * linear switch
149 */
150/*
151 * transmit timing stuff. See below for scale of srtt and rttvar.
152 * "Variance" is actually smoothed difference.
153 */
154 int16_t t_idle; /* inactivity time */
155 int16_t t_rtt; /* round trip time */
156 tcp_seq t_rtseq; /* sequence number being timed */
157 int16_t t_srtt; /* smoothed round-trip time */
158 int16_t t_rttvar; /* variance in round-trip time */
159 uint16_t t_rttmin; /* minimum rtt allowed */
160 uint32_t max_sndwnd; /* largest window peer has offered */
161
162/* out-of-band data */
163 char t_oobflags; /* have some */
164 char t_iobc; /* input character */
165#define TCPOOB_HAVEDATA 0x01
166#define TCPOOB_HADDATA 0x02
167 short t_softerror; /* possible error not yet reported */
168
169/* RFC 1323 variables */
170 uint8_t snd_scale; /* window scaling for send window */
171 uint8_t rcv_scale; /* window scaling for recv window */
172 uint8_t request_r_scale; /* pending window scaling */
173 uint8_t requested_s_scale;
174 uint32_t ts_recent; /* timestamp echo data */
175 uint32_t ts_recent_age; /* when last updated */
176 tcp_seq last_ack_sent;
177};
178
179#ifdef VBOX_WITH_BSD_REASS
180LIST_HEAD(tcpcbhead, tcpcb);
181#endif /* VBOX_WITH_BSD_REASS */
182
183#define sototcpcb(so) ((so)->so_tcpcb)
184
185/*
186 * The smoothed round-trip time and estimated variance
187 * are stored as fixed point numbers scaled by the values below.
188 * For convenience, these scales are also used in smoothing the average
189 * (smoothed = (1/scale)sample + ((scale-1)/scale)smoothed).
190 * With these scales, srtt has 3 bits to the right of the binary point,
191 * and thus an "ALPHA" of 0.875. rttvar has 2 bits to the right of the
192 * binary point, and is smoothed with an ALPHA of 0.75.
193 */
194#define TCP_RTT_SCALE 8 /* multiplier for srtt; 3 bits frac. */
195#define TCP_RTT_SHIFT 3 /* shift for srtt; 3 bits frac. */
196#define TCP_RTTVAR_SCALE 4 /* multiplier for rttvar; 2 bits */
197#define TCP_RTTVAR_SHIFT 2 /* multiplier for rttvar; 2 bits */
198
199/*
200 * The initial retransmission should happen at rtt + 4 * rttvar.
201 * Because of the way we do the smoothing, srtt and rttvar
202 * will each average +1/2 tick of bias. When we compute
203 * the retransmit timer, we want 1/2 tick of rounding and
204 * 1 extra tick because of +-1/2 tick uncertainty in the
205 * firing of the timer. The bias will give us exactly the
206 * 1.5 tick we need. But, because the bias is
207 * statistical, we have to test that we don't drop below
208 * the minimum feasible timer (which is 2 ticks).
209 * This macro assumes that the value of TCP_RTTVAR_SCALE
210 * is the same as the multiplier for rttvar.
211 */
212#define TCP_REXMTVAL(tp) \
213 (((tp)->t_srtt >> TCP_RTT_SHIFT) + (tp)->t_rttvar)
214
215/* XXX
216 * We want to avoid doing m_pullup on incoming packets but that
217 * means avoiding dtom on the tcp reassembly code. That in turn means
218 * keeping an mbuf pointer in the reassembly queue (since we might
219 * have a cluster). As a quick hack, the source & destination
220 * port numbers (which are no longer needed once we've located the
221 * tcpcb) are overlayed with an mbuf pointer.
222 */
223#if SIZEOF_CHAR_P == 4
224typedef struct mbuf *mbufp_32;
225/* VBox change which is too much bother to #ifdef */
226# define REASS_MBUF_SET(ti, p) (*(mbufp_32 *)&((ti)->ti_t)) = (p)
227# define REASS_MBUF_GET(ti) ((struct mbuf *)(*(mbufp_32 *)&((ti)->ti_t)))
228#else
229typedef u_int32_t mbufp_32;
230/* VBox change which is too much bother to #ifdef */
231# define REASS_MBUF_SET(ti, p) (*(mbufp_32 *)&((ti)->ti_t)) = ptr_to_u32(pData, p)
232# define REASS_MBUF_GET(ti) u32_to_ptr(pData, (*(mbufp_32 *)&((ti)->ti_t)), struct mbuf *)
233#endif
234
235/*
236 * TCP statistics.
237 * Many of these should be kept per connection,
238 * but that's inconvenient at the moment.
239 */
240struct tcpstat_t
241{
242 u_long tcps_connattempt; /* connections initiated */
243 u_long tcps_accepts; /* connections accepted */
244 u_long tcps_connects; /* connections established */
245 u_long tcps_drops; /* connections dropped */
246 u_long tcps_conndrops; /* embryonic connections dropped */
247 u_long tcps_closed; /* conn. closed (includes drops) */
248 u_long tcps_segstimed; /* segs where we tried to get rtt */
249 u_long tcps_rttupdated; /* times we succeeded */
250 u_long tcps_delack; /* delayed acks sent */
251 u_long tcps_timeoutdrop; /* conn. dropped in rxmt timeout */
252 u_long tcps_rexmttimeo; /* retransmit timeouts */
253 u_long tcps_persisttimeo; /* persist timeouts */
254 u_long tcps_keeptimeo; /* keepalive timeouts */
255 u_long tcps_keepprobe; /* keepalive probes sent */
256 u_long tcps_keepdrops; /* connections dropped in keepalive */
257
258 u_long tcps_sndtotal; /* total packets sent */
259 u_long tcps_sndpack; /* data packets sent */
260 u_long tcps_sndbyte; /* data bytes sent */
261 u_long tcps_sndrexmitpack; /* data packets retransmitted */
262 u_long tcps_sndrexmitbyte; /* data bytes retransmitted */
263 u_long tcps_sndacks; /* ack-only packets sent */
264 u_long tcps_sndprobe; /* window probes sent */
265 u_long tcps_sndurg; /* packets sent with URG only */
266 u_long tcps_sndwinup; /* window update-only packets sent */
267 u_long tcps_sndctrl; /* control (SYN|FIN|RST) packets sent */
268
269 u_long tcps_rcvtotal; /* total packets received */
270 u_long tcps_rcvpack; /* packets received in sequence */
271 u_long tcps_rcvbyte; /* bytes received in sequence */
272 u_long tcps_rcvbadsum; /* packets received with ccksum errs */
273 u_long tcps_rcvbadoff; /* packets received with bad offset */
274/* u_long tcps_rcvshort; */ /* packets received too short */
275 u_long tcps_rcvduppack; /* duplicate-only packets received */
276 u_long tcps_rcvdupbyte; /* duplicate-only bytes received */
277 u_long tcps_rcvpartduppack; /* packets with some duplicate data */
278 u_long tcps_rcvpartdupbyte; /* dup. bytes in part-dup. packets */
279 u_long tcps_rcvoopack; /* out-of-order packets received */
280 u_long tcps_rcvoobyte; /* out-of-order bytes received */
281 u_long tcps_rcvpackafterwin; /* packets with data after window */
282 u_long tcps_rcvbyteafterwin; /* bytes rcvd after window */
283 u_long tcps_rcvafterclose; /* packets rcvd after "close" */
284 u_long tcps_rcvwinprobe; /* rcvd window probe packets */
285 u_long tcps_rcvdupack; /* rcvd duplicate acks */
286 u_long tcps_rcvacktoomuch; /* rcvd acks for unsent data */
287 u_long tcps_rcvackpack; /* rcvd ack packets */
288 u_long tcps_rcvackbyte; /* bytes acked by rcvd acks */
289 u_long tcps_rcvwinupd; /* rcvd window update packets */
290/* u_long tcps_pawsdrop; */ /* segments dropped due to PAWS */
291 u_long tcps_predack; /* times hdr predict ok for acks */
292 u_long tcps_preddat; /* times hdr predict ok for data pkts */
293 u_long tcps_socachemiss; /* tcp_last_so misses */
294 u_long tcps_didnuttin; /* Times tcp_output didn't do anything XXX */
295#ifdef VBOX_WITH_BSD_REASS
296 u_long tcps_rcvmemdrop;
297#endif /* VBOX_WITH_BSD_REASS */
298};
299
300
301#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette