xref: /csrg-svn/sys/netiso/tp_pcb.h (revision 51006)
1 /*-
2  * Copyright (c) 1991 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * %sccs.include.redist.c%
6  *
7  *	@(#)tp_pcb.h	7.14 (Berkeley) 09/05/91
8  */
9 
10 /***********************************************************
11 		Copyright IBM Corporation 1987
12 
13                       All Rights Reserved
14 
15 Permission to use, copy, modify, and distribute this software and its
16 documentation for any purpose and without fee is hereby granted,
17 provided that the above copyright notice appear in all copies and that
18 both that copyright notice and this permission notice appear in
19 supporting documentation, and that the name of IBM not be
20 used in advertising or publicity pertaining to distribution of the
21 software without specific, written prior permission.
22 
23 IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
24 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
25 IBM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
26 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
27 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
28 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
29 SOFTWARE.
30 
31 ******************************************************************/
32 
33 /*
34  * ARGO Project, Computer Sciences Dept., University of Wisconsin - Madison
35  */
36 /*
37  * ARGO TP
38  *
39  * $Header: tp_pcb.h,v 5.2 88/11/18 17:09:32 nhall Exp $
40  * $Source: /usr/argo/sys/netiso/RCS/tp_pcb.h,v $
41  *
42  *
43  * This file defines the transport protocol control block (tpcb).
44  * and a bunch of #define values that are used in the tpcb.
45  */
46 
47 #ifndef  __TP_PCB__
48 #define  __TP_PCB__
49 
50 #include "../netiso/tp_param.h"
51 #include "../netiso/tp_timer.h"
52 #include "../netiso/tp_user.h"
53 #ifndef sblock
54 #include "socketvar.h"
55 #endif sblock
56 
57 /* NOTE: the code depends on REF_CLOSED > REF_OPEN > the rest, and
58  * on REF_FREE being zero
59  *
60  * Possible improvement:
61  * think about merging the tp_ref w/ the tpcb and doing a search
62  * through the tpcb list, from tpb. This would slow down lookup
63  * during data transfer
64  * It would be a little nicer also to have something based on the
65  * clock (like top n bits of the reference is part of the clock, to
66  * minimize the likelihood  of reuse after a crash)
67  * also, need to keep the timer servicing part to a minimum (although
68  * the cost of this is probably independent of whether the timers are
69  * in the pcb or in an array..
70  * Last, would have to make the number of timers a function of the amount of
71  * mbufs available, plus some for the frozen references.
72  *
73  * Possible improvement:
74  * Might not need the ref_state stuff either...
75  * REF_FREE could correspond to tp_state == CLOSED or nonexistend tpcb,
76  * REF_OPEN to tp_state anywhere from AK_WAIT or CR_SENT to CLOSING
77  * REF_OPENING could correspond to LISTENING, because that's the
78  * way it's used, not because the correspondence is exact.
79  * REF_CLOSED could correspond to REFWAIT
80  */
81 #define REF_FROZEN 3	/* has ref timer only */
82 #define REF_OPEN 2		/* has timers, possibly active */
83 #define REF_OPENING 1	/* in use (has a pcb) but no timers */
84 #define REF_FREE 0		/* free to reallocate */
85 
86 #define N_CTIMERS 		4
87 #define N_ETIMERS 		2
88 
89 struct tp_ref {
90 	u_char	 			tpr_state; /* values REF_FROZEN, etc. above */
91 	struct Ccallout 	tpr_callout[N_CTIMERS]; /* C timers */
92 	struct Ecallout		tpr_calltodo;			/* list of active E timers */
93 	struct tp_pcb 		*tpr_pcb;	/* back ptr to PCB */
94 };
95 
96 struct tp_refinfo {
97 	struct tp_ref		*tpr_base;
98 	int					tpr_size;
99 };
100 
101 struct tp_param {
102 	/* PER system stuff (one static structure instead of a bunch of names) */
103 	unsigned 	tpp_configed:1;			/* Has TP been initialized? */
104 };
105 
106 
107 /*
108  * retransmission control and performance measurement
109  */
110 struct tp_rtc {
111 	struct tp_rtc	*tprt_next; /* ptr to next rtc structure in the list */
112 	SeqNum 			tprt_seq;	/* seq # of this TPDU */
113 	int				tprt_eot;	/* Will this TPDU have the eot bit set? */
114 	int				tprt_octets;/* # octets in this TPDU */
115 	struct mbuf		*tprt_data; /* ptr to the octets of data */
116 };
117 
118 struct nl_protosw {
119 	int		nlp_afamily;			/* address family */
120 	int		(*nlp_putnetaddr)();	/* puts addresses in nl pcb */
121 	int		(*nlp_getnetaddr)();	/* gets addresses from nl pcb */
122 	int		(*nlp_cmpnetaddr)();	/* compares address in pcb with sockaddr */
123 	int		(*nlp_putsufx)();		/* puts transport suffixes in nl pcb */
124 	int		(*nlp_getsufx)();		/* gets transport suffixes from nl pcb */
125 	int		(*nlp_recycle_suffix)();/* clears suffix from nl pcb */
126 	int		(*nlp_mtu)();			/* figures out mtu based on nl used */
127 	int		(*nlp_pcbbind)();		/* bind to pcb for net level */
128 	int		(*nlp_pcbconn)();		/* connect for net level */
129 	int		(*nlp_pcbdisc)();		/* disconnect net level */
130 	int		(*nlp_pcbdetach)();		/* detach net level pcb */
131 	int		(*nlp_pcballoc)();		/* allocate a net level pcb */
132 	int		(*nlp_output)();		/* prepare a packet to give to nl */
133 	int		(*nlp_dgoutput)();		/* prepare a packet to give to nl */
134 	int		(*nlp_ctloutput)();		/* hook for network set/get options */
135 	caddr_t	nlp_pcblist;			/* list of xx_pcb's for connections */
136 };
137 
138 
139 struct tp_pcb {
140 	struct tp_pcb		*tp_next;
141 	struct tp_pcb		*tp_prev;
142 	struct tp_pcb		*tp_nextlisten; /* chain all listeners */
143 	u_short 			tp_state;		/* state of fsm */
144 	short 				tp_retrans;		/* # times can still retrans */
145 	struct tp_ref 		*tp_refp;		/* rest of pcb	*/
146 	caddr_t				tp_npcb;		/* to lower layer pcb */
147 	struct nl_protosw	*tp_nlproto;	/* lower-layer dependent routines */
148 	struct socket 		*tp_sock;		/* back ptr */
149 
150 
151 	RefNum				tp_lref;	 	/* local reference */
152 	RefNum 				tp_fref;		/* foreign reference */
153 
154 	u_int				tp_seqmask;		/* mask for seq space */
155 	u_int				tp_seqbit;		/* bit for seq number wraparound */
156 	u_int				tp_seqhalf;		/* half the seq space */
157 
158 	struct mbuf			*tp_ucddata;	/* user connect/disconnect data */
159 
160 	/* credit & sequencing info for SENDING */
161 	u_short 			tp_fcredit;		/* current remote credit in # packets */
162 
163 	u_short				tp_cong_win;	/* congestion window : set to 1 on
164 										 * source quench
165 										 * Minimizes the amount of retrans-
166 										 * missions (independently of the
167 										 * retrans strategy).  Increased
168 										 * by one for each good ack received.
169 										 * Minimizes the amount sent in a
170 										 * regular tp_send() also.
171 										 */
172 	u_int   tp_ackrcvd; /* ACKs received since the send window was updated */
173 	SeqNum              tp_last_retrans;
174 	SeqNum              tp_retrans_hiwat;
175 	SeqNum				tp_snduna;		/* seq # of lowest unacked DT */
176 	SeqNum				tp_sndhiwat;	/* highest seq # sent so far */
177 	SeqNum				tp_sndnum;		/* next seq # to be assigned */
178 	struct mbuf			*tp_sndhiwat_m; /* packet corres. to sndhiwat*/
179 	int					tp_Nwindow;		/* for perf. measurement */
180 
181 	/* credit & sequencing info for RECEIVING */
182 	SeqNum	 			tp_sent_lcdt;	/* cdt according to last ack sent */
183 	SeqNum	 			tp_sent_uwe;	/* uwe according to last ack sent */
184 	SeqNum				tp_rcvnxt;		/* next DT seq # expect to recv */
185 	SeqNum	 			tp_sent_rcvnxt;	/* rcvnxt according to last ack sent
186 										 * needed for perf measurements only
187 										 */
188 	u_short				tp_lcredit;		/* current local credit in # packets */
189 	u_short				tp_maxlcredit;	/* needed for reassembly queue */
190 	struct mbuf			**tp_rsyq;		/* unacked stuff recvd out of order */
191 	int					tp_rsycnt;		/* number of packets */
192 
193 	/* receiver congestion state stuff ...  */
194 	u_int               tp_win_recv;
195 
196 	/* receive window as a scaled int (8 bit fraction part) */
197 
198 	struct cong_sample {
199 		ushort  cs_size; 				/* current window size */
200 		ushort  cs_received;   			/* PDUs received in this sample */
201 		ushort  cs_ce_set;    /* PDUs received in this sample with CE bit set */
202 	} tp_cong_sample;
203 
204 
205 	/* parameters per-connection controllable by user */
206 	struct tp_conn_param _tp_param;
207 
208 #define	tp_Nretrans _tp_param.p_Nretrans
209 #define	tp_dr_ticks _tp_param.p_dr_ticks
210 #define	tp_cc_ticks _tp_param.p_cc_ticks
211 #define	tp_dt_ticks _tp_param.p_dt_ticks
212 #define	tp_xpd_ticks _tp_param.p_x_ticks
213 #define	tp_cr_ticks _tp_param.p_cr_ticks
214 #define	tp_keepalive_ticks _tp_param.p_keepalive_ticks
215 #define	tp_sendack_ticks _tp_param.p_sendack_ticks
216 #define	tp_refer_ticks _tp_param.p_ref_ticks
217 #define	tp_inact_ticks _tp_param.p_inact_ticks
218 #define	tp_xtd_format _tp_param.p_xtd_format
219 #define	tp_xpd_service _tp_param.p_xpd_service
220 #define	tp_ack_strat _tp_param.p_ack_strat
221 #define	tp_rx_strat _tp_param.p_rx_strat
222 #define	tp_use_checksum _tp_param.p_use_checksum
223 #define	tp_use_efc _tp_param.p_use_efc
224 #define	tp_use_nxpd _tp_param.p_use_nxpd
225 #define	tp_use_rcc _tp_param.p_use_rcc
226 #define	tp_tpdusize _tp_param.p_tpdusize
227 #define	tp_class _tp_param.p_class
228 #define	tp_winsize _tp_param.p_winsize
229 #define	tp_no_disc_indications _tp_param.p_no_disc_indications
230 #define	tp_dont_change_params _tp_param.p_dont_change_params
231 #define	tp_netservice _tp_param.p_netservice
232 #define	tp_version _tp_param.p_version
233 
234 	int tp_l_tpdusize;
235 		/* whereas tp_tpdusize is log2(the negotiated max size)
236 		 * l_tpdusize is the size we'll use when sending, in # chars
237 		 */
238 
239 	struct timeval	tp_rtv;					/* max round-trip time variance */
240 	struct timeval	tp_rtt; 					/* smoothed round-trip time */
241 	struct timeval 	tp_rttemit[ TP_RTT_NUM + 1 ];
242 					/* times that the last TP_RTT_NUM DT_TPDUs were emitted */
243 	unsigned
244 		tp_sendfcc:1,			/* shall next ack include FCC parameter? */
245 		tp_trace:1,				/* is this pcb being traced? (not used yet) */
246 		tp_perf_on:1,			/* 0/1 -> performance measuring on  */
247 		tp_reneged:1,			/* have we reneged on cdt since last ack? */
248 		tp_decbit:3,			/* dec bit was set, we're in reneg mode  */
249 		tp_cebit_off:1,			/* the real DEC bit algorithms not in use */
250 		tp_flags:8,				/* values: */
251 #define TPF_NLQOS_PDN	 	TPFLAG_NLQOS_PDN
252 #define TPF_PEER_ON_SAMENET	TPFLAG_PEER_ON_SAMENET
253 #define TPF_GENERAL_ADDR	TPFLAG_GENERAL_ADDR
254 
255 #define PEER_IS_LOCAL(t)	(((t)->tp_flags & TPF_PEER_ON_SAME_NET) != 0)
256 #define USES_PDN(t)			(((t)->tp_flags & TPF_NLQOS_PDN) != 0)
257 
258 		tp_oktonagle:1,			/* Last unsent packet that may be append to */
259 		tp_notdetached:1,		/* Call tp_detach before freeing XXXXXXX */
260 		tp_unused:14;
261 
262 
263 #ifdef TP_PERF_MEAS
264 	/* performance stats - see tp_stat.h */
265 	struct tp_pmeas		*tp_p_meas;
266 	struct mbuf			*tp_p_mbuf;
267 #endif TP_PERF_MEAS
268 	/* addressing */
269 	u_short				tp_domain;		/* domain (INET, ISO) */
270 	/* for compatibility with the *old* way and with INET, be sure that
271 	 * that lsuffix and fsuffix are aligned to a short addr.
272 	 * having them follow the u_short *suffixlen should suffice (choke)
273 	 */
274 	u_short				tp_fsuffixlen;	/* foreign suffix */
275 	char				tp_fsuffix[MAX_TSAP_SEL_LEN];
276 	u_short				tp_lsuffixlen;	/* local suffix */
277 	char				tp_lsuffix[MAX_TSAP_SEL_LEN];
278 #define SHORT_LSUFXP(tpcb) ((short *)((tpcb)->tp_lsuffix))
279 #define SHORT_FSUFXP(tpcb) ((short *)((tpcb)->tp_fsuffix))
280 
281 	u_char 				tp_vers;		/* protocol version */
282 	u_char 				tp_peer_acktime; /* used to compute DT retrans time */
283 
284 	struct sockbuf		tp_Xsnd;		/* for expedited data */
285 /*	struct sockbuf		tp_Xrcv;		/* for expedited data */
286 #define tp_Xrcv tp_sock->so_rcv
287 	SeqNum				tp_Xsndnxt;	/* next XPD seq # to send */
288 	SeqNum				tp_Xuna;		/* seq # of unacked XPD */
289 	SeqNum				tp_Xrcvnxt;	/* next XPD seq # expect to recv */
290 
291 	/* AK subsequencing */
292 	u_short				tp_s_subseq;	/* next subseq to send */
293 	u_short				tp_r_subseq;	/* highest recv subseq */
294 
295 };
296 
297 u_int	tp_start_win;
298 
299 #define ROUND(scaled_int) (((scaled_int) >> 8) + (((scaled_int) & 0x80) ? 1:0))
300 
301 /* to round off a scaled int with an 8 bit fraction part */
302 
303 #define CONG_INIT_SAMPLE(pcb) \
304 	pcb->tp_cong_sample.cs_received = \
305     pcb->tp_cong_sample.cs_ce_set = 0; \
306     pcb->tp_cong_sample.cs_size = MAX(pcb->tp_lcredit, 1) << 1;
307 
308 #define CONG_UPDATE_SAMPLE(pcb, ce_bit) \
309     pcb->tp_cong_sample.cs_received++; \
310     if (ce_bit) { \
311         pcb->tp_cong_sample.cs_ce_set++; \
312     } \
313     if (pcb->tp_cong_sample.cs_size <= pcb->tp_cong_sample.cs_received) { \
314         if ((pcb->tp_cong_sample.cs_ce_set << 1) >=  \
315                     pcb->tp_cong_sample.cs_size ) { \
316             pcb->tp_win_recv -= pcb->tp_win_recv >> 3; /* multiply by .875 */ \
317             pcb->tp_win_recv = MAX(1 << 8, pcb->tp_win_recv); \
318         } \
319         else { \
320             pcb->tp_win_recv += (1 << 8); /* add one to the scaled int */ \
321         } \
322         pcb->tp_lcredit = ROUND(pcb->tp_win_recv); \
323         CONG_INIT_SAMPLE(pcb); \
324     }
325 
326 #define CONG_ACK(pcb, seq) \
327 { int   newacks = SEQ_SUB(pcb, seq, pcb->tp_snduna); \
328 	if (newacks > 0) { \
329 		pcb->tp_ackrcvd += newacks; \
330 		if (pcb->tp_ackrcvd >= MIN(pcb->tp_fcredit, pcb->tp_cong_win)) { \
331 			++pcb->tp_cong_win; \
332 			pcb->tp_ackrcvd = 0; \
333 		} \
334 	} \
335 }
336 
337 #ifdef KERNEL
338 extern struct timeval 	time;
339 extern struct tp_refinfo 	tp_refinfo;
340 extern struct tp_ref *tp_ref;
341 extern struct tp_param	tp_param;
342 extern struct nl_protosw  nl_protosw[];
343 extern struct tp_pcb	*tp_listeners;
344 extern struct tp_pcb	*tp_intercepts;
345 #endif
346 
347 #define	sototpcb(so) 	((struct tp_pcb *)(so->so_pcb))
348 #define	sototpref(so)	((sototpcb(so)->tp_ref))
349 #define	tpcbtoso(tp)	((struct socket *)((tp)->tp_sock))
350 #define	tpcbtoref(tp)	((struct tp_ref *)((tp)->tp_ref))
351 
352 #endif  __TP_PCB__
353