Commit | Line | Data |
---|---|---|
7bcd1bb8 KB |
1 | /*- |
2 | * Copyright (c) 1991 The Regents of the University of California. | |
3 | * All rights reserved. | |
4 | * | |
5 | * %sccs.include.redist.c% | |
6 | * | |
3a2fbed9 | 7 | * @(#)tp_pcb.h 7.15 (Berkeley) %G% |
7bcd1bb8 KB |
8 | */ |
9 | ||
ff72d400 KS |
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 | |
e663c139 | 54 | #include "socketvar.h" |
ff72d400 KS |
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 | ||
3a2fbed9 | 86 | #define N_CTIMERS 6 |
ff72d400 KS |
87 | |
88 | struct tp_ref { | |
3a2fbed9 KS |
89 | /* u_char tpr_state; /* values REF_FROZEN, etc. above */ |
90 | /* struct Ccallout tpr_callout[N_CTIMERS]; /* C timers */ | |
91 | /* struct Ecallout tpr_calltodo; /* list of active E timers */ | |
92 | #define tpr_state tpr_pcb->tp_refstate | |
93 | #define tpr_callout tpr_pcb->tp_refcallout | |
94 | #define tpr_calltodo tpr_pcb->tp_refcalltodo | |
ff72d400 KS |
95 | struct tp_pcb *tpr_pcb; /* back ptr to PCB */ |
96 | }; | |
97 | ||
aade66bc KS |
98 | struct tp_refinfo { |
99 | struct tp_ref *tpr_base; | |
100 | int tpr_size; | |
3a2fbed9 KS |
101 | int tpr_maxopen; |
102 | int tpr_numopen; | |
aade66bc KS |
103 | }; |
104 | ||
ff72d400 KS |
105 | struct tp_param { |
106 | /* PER system stuff (one static structure instead of a bunch of names) */ | |
107 | unsigned tpp_configed:1; /* Has TP been initialized? */ | |
108 | }; | |
109 | ||
110 | ||
111 | /* | |
112 | * retransmission control and performance measurement | |
113 | */ | |
114 | struct tp_rtc { | |
115 | struct tp_rtc *tprt_next; /* ptr to next rtc structure in the list */ | |
116 | SeqNum tprt_seq; /* seq # of this TPDU */ | |
117 | int tprt_eot; /* Will this TPDU have the eot bit set? */ | |
118 | int tprt_octets;/* # octets in this TPDU */ | |
119 | struct mbuf *tprt_data; /* ptr to the octets of data */ | |
120 | }; | |
121 | ||
ff72d400 KS |
122 | struct nl_protosw { |
123 | int nlp_afamily; /* address family */ | |
124 | int (*nlp_putnetaddr)(); /* puts addresses in nl pcb */ | |
125 | int (*nlp_getnetaddr)(); /* gets addresses from nl pcb */ | |
63f88aec | 126 | int (*nlp_cmpnetaddr)(); /* compares address in pcb with sockaddr */ |
ff72d400 KS |
127 | int (*nlp_putsufx)(); /* puts transport suffixes in nl pcb */ |
128 | int (*nlp_getsufx)(); /* gets transport suffixes from nl pcb */ | |
129 | int (*nlp_recycle_suffix)();/* clears suffix from nl pcb */ | |
130 | int (*nlp_mtu)(); /* figures out mtu based on nl used */ | |
131 | int (*nlp_pcbbind)(); /* bind to pcb for net level */ | |
132 | int (*nlp_pcbconn)(); /* connect for net level */ | |
133 | int (*nlp_pcbdisc)(); /* disconnect net level */ | |
134 | int (*nlp_pcbdetach)(); /* detach net level pcb */ | |
135 | int (*nlp_pcballoc)(); /* allocate a net level pcb */ | |
136 | int (*nlp_output)(); /* prepare a packet to give to nl */ | |
137 | int (*nlp_dgoutput)(); /* prepare a packet to give to nl */ | |
138 | int (*nlp_ctloutput)(); /* hook for network set/get options */ | |
139 | caddr_t nlp_pcblist; /* list of xx_pcb's for connections */ | |
63f88aec | 140 | }; |
ff72d400 | 141 | |
ff72d400 KS |
142 | |
143 | struct tp_pcb { | |
63f88aec KS |
144 | struct tp_pcb *tp_next; |
145 | struct tp_pcb *tp_prev; | |
146 | struct tp_pcb *tp_nextlisten; /* chain all listeners */ | |
ff72d400 KS |
147 | u_short tp_state; /* state of fsm */ |
148 | short tp_retrans; /* # times can still retrans */ | |
149 | struct tp_ref *tp_refp; /* rest of pcb */ | |
ff72d400 KS |
150 | caddr_t tp_npcb; /* to lower layer pcb */ |
151 | struct nl_protosw *tp_nlproto; /* lower-layer dependent routines */ | |
152 | struct socket *tp_sock; /* back ptr */ | |
153 | ||
ff72d400 KS |
154 | |
155 | RefNum tp_lref; /* local reference */ | |
156 | RefNum tp_fref; /* foreign reference */ | |
157 | ||
158 | u_int tp_seqmask; /* mask for seq space */ | |
159 | u_int tp_seqbit; /* bit for seq number wraparound */ | |
160 | u_int tp_seqhalf; /* half the seq space */ | |
161 | ||
98af392b KS |
162 | struct mbuf *tp_ucddata; /* user connect/disconnect data */ |
163 | ||
ff72d400 KS |
164 | /* credit & sequencing info for SENDING */ |
165 | u_short tp_fcredit; /* current remote credit in # packets */ | |
166 | ||
167 | u_short tp_cong_win; /* congestion window : set to 1 on | |
168 | * source quench | |
169 | * Minimizes the amount of retrans- | |
170 | * missions (independently of the | |
171 | * retrans strategy). Increased | |
172 | * by one for each good ack received. | |
173 | * Minimizes the amount sent in a | |
174 | * regular tp_send() also. | |
175 | */ | |
0132e4b5 KS |
176 | u_int tp_ackrcvd; /* ACKs received since the send window was updated */ |
177 | SeqNum tp_last_retrans; | |
178 | SeqNum tp_retrans_hiwat; | |
ff72d400 | 179 | SeqNum tp_snduna; /* seq # of lowest unacked DT */ |
ff72d400 | 180 | SeqNum tp_sndhiwat; /* highest seq # sent so far */ |
98af392b KS |
181 | SeqNum tp_sndnum; /* next seq # to be assigned */ |
182 | struct mbuf *tp_sndhiwat_m; /* packet corres. to sndhiwat*/ | |
ff72d400 KS |
183 | int tp_Nwindow; /* for perf. measurement */ |
184 | ||
185 | /* credit & sequencing info for RECEIVING */ | |
186 | SeqNum tp_sent_lcdt; /* cdt according to last ack sent */ | |
187 | SeqNum tp_sent_uwe; /* uwe according to last ack sent */ | |
98af392b | 188 | SeqNum tp_rcvnxt; /* next DT seq # expect to recv */ |
ff72d400 KS |
189 | SeqNum tp_sent_rcvnxt; /* rcvnxt according to last ack sent |
190 | * needed for perf measurements only | |
191 | */ | |
192 | u_short tp_lcredit; /* current local credit in # packets */ | |
98af392b | 193 | u_short tp_maxlcredit; /* needed for reassembly queue */ |
98af392b KS |
194 | struct mbuf **tp_rsyq; /* unacked stuff recvd out of order */ |
195 | int tp_rsycnt; /* number of packets */ | |
ff72d400 | 196 | |
0132e4b5 KS |
197 | /* receiver congestion state stuff ... */ |
198 | u_int tp_win_recv; | |
199 | ||
200 | /* receive window as a scaled int (8 bit fraction part) */ | |
201 | ||
202 | struct cong_sample { | |
203 | ushort cs_size; /* current window size */ | |
204 | ushort cs_received; /* PDUs received in this sample */ | |
205 | ushort cs_ce_set; /* PDUs received in this sample with CE bit set */ | |
206 | } tp_cong_sample; | |
207 | ||
208 | ||
ff72d400 KS |
209 | /* parameters per-connection controllable by user */ |
210 | struct tp_conn_param _tp_param; | |
211 | ||
212 | #define tp_Nretrans _tp_param.p_Nretrans | |
213 | #define tp_dr_ticks _tp_param.p_dr_ticks | |
214 | #define tp_cc_ticks _tp_param.p_cc_ticks | |
215 | #define tp_dt_ticks _tp_param.p_dt_ticks | |
216 | #define tp_xpd_ticks _tp_param.p_x_ticks | |
217 | #define tp_cr_ticks _tp_param.p_cr_ticks | |
218 | #define tp_keepalive_ticks _tp_param.p_keepalive_ticks | |
219 | #define tp_sendack_ticks _tp_param.p_sendack_ticks | |
220 | #define tp_refer_ticks _tp_param.p_ref_ticks | |
221 | #define tp_inact_ticks _tp_param.p_inact_ticks | |
222 | #define tp_xtd_format _tp_param.p_xtd_format | |
223 | #define tp_xpd_service _tp_param.p_xpd_service | |
224 | #define tp_ack_strat _tp_param.p_ack_strat | |
225 | #define tp_rx_strat _tp_param.p_rx_strat | |
226 | #define tp_use_checksum _tp_param.p_use_checksum | |
227 | #define tp_use_efc _tp_param.p_use_efc | |
228 | #define tp_use_nxpd _tp_param.p_use_nxpd | |
229 | #define tp_use_rcc _tp_param.p_use_rcc | |
230 | #define tp_tpdusize _tp_param.p_tpdusize | |
231 | #define tp_class _tp_param.p_class | |
232 | #define tp_winsize _tp_param.p_winsize | |
233 | #define tp_no_disc_indications _tp_param.p_no_disc_indications | |
234 | #define tp_dont_change_params _tp_param.p_dont_change_params | |
235 | #define tp_netservice _tp_param.p_netservice | |
bebb97ee | 236 | #define tp_version _tp_param.p_version |
ff72d400 KS |
237 | |
238 | int tp_l_tpdusize; | |
239 | /* whereas tp_tpdusize is log2(the negotiated max size) | |
240 | * l_tpdusize is the size we'll use when sending, in # chars | |
241 | */ | |
242 | ||
243 | struct timeval tp_rtv; /* max round-trip time variance */ | |
244 | struct timeval tp_rtt; /* smoothed round-trip time */ | |
245 | struct timeval tp_rttemit[ TP_RTT_NUM + 1 ]; | |
246 | /* times that the last TP_RTT_NUM DT_TPDUs were emitted */ | |
247 | unsigned | |
248 | tp_sendfcc:1, /* shall next ack include FCC parameter? */ | |
249 | tp_trace:1, /* is this pcb being traced? (not used yet) */ | |
250 | tp_perf_on:1, /* 0/1 -> performance measuring on */ | |
251 | tp_reneged:1, /* have we reneged on cdt since last ack? */ | |
0132e4b5 KS |
252 | tp_decbit:3, /* dec bit was set, we're in reneg mode */ |
253 | tp_cebit_off:1, /* the real DEC bit algorithms not in use */ | |
ff72d400 | 254 | tp_flags:8, /* values: */ |
ff72d400 KS |
255 | #define TPF_NLQOS_PDN TPFLAG_NLQOS_PDN |
256 | #define TPF_PEER_ON_SAMENET TPFLAG_PEER_ON_SAMENET | |
4fd60a05 | 257 | #define TPF_GENERAL_ADDR TPFLAG_GENERAL_ADDR |
3a2fbed9 KS |
258 | #define TPF_DELACK 0x8 |
259 | #define TPF_ACKNOW 0x10 | |
ff72d400 | 260 | |
4fd60a05 KS |
261 | #define PEER_IS_LOCAL(t) (((t)->tp_flags & TPF_PEER_ON_SAME_NET) != 0) |
262 | #define USES_PDN(t) (((t)->tp_flags & TPF_NLQOS_PDN) != 0) | |
ff72d400 | 263 | |
98af392b | 264 | tp_oktonagle:1, /* Last unsent packet that may be append to */ |
fab7bc7c KS |
265 | tp_notdetached:1, /* Call tp_detach before freeing XXXXXXX */ |
266 | tp_unused:14; | |
ff72d400 | 267 | |
ff72d400 KS |
268 | |
269 | #ifdef TP_PERF_MEAS | |
270 | /* performance stats - see tp_stat.h */ | |
a50e2bc0 KS |
271 | struct tp_pmeas *tp_p_meas; |
272 | struct mbuf *tp_p_mbuf; | |
ff72d400 | 273 | #endif TP_PERF_MEAS |
a50e2bc0 KS |
274 | /* addressing */ |
275 | u_short tp_domain; /* domain (INET, ISO) */ | |
276 | /* for compatibility with the *old* way and with INET, be sure that | |
277 | * that lsuffix and fsuffix are aligned to a short addr. | |
278 | * having them follow the u_short *suffixlen should suffice (choke) | |
279 | */ | |
280 | u_short tp_fsuffixlen; /* foreign suffix */ | |
281 | char tp_fsuffix[MAX_TSAP_SEL_LEN]; | |
282 | u_short tp_lsuffixlen; /* local suffix */ | |
283 | char tp_lsuffix[MAX_TSAP_SEL_LEN]; | |
284 | #define SHORT_LSUFXP(tpcb) ((short *)((tpcb)->tp_lsuffix)) | |
285 | #define SHORT_FSUFXP(tpcb) ((short *)((tpcb)->tp_fsuffix)) | |
286 | ||
3a2fbed9 KS |
287 | /* Timer stuff */ |
288 | u_char tp_vers; /* protocol version */ | |
289 | u_char tp_peer_acktime; /* used for DT retrans time */ | |
290 | u_char tp_refstate; /* values REF_FROZEN, etc. above */ | |
291 | struct tp_pcb *tp_fasttimeo; /* limit pcbs to examine */ | |
292 | struct Ccallout tp_refcallout[N_CTIMERS]; /* C timers */ | |
293 | struct Ecallarg tp_retransargs; /* dunt ask ... */ | |
a50e2bc0 KS |
294 | |
295 | struct sockbuf tp_Xsnd; /* for expedited data */ | |
296 | /* struct sockbuf tp_Xrcv; /* for expedited data */ | |
297 | #define tp_Xrcv tp_sock->so_rcv | |
298 | SeqNum tp_Xsndnxt; /* next XPD seq # to send */ | |
299 | SeqNum tp_Xuna; /* seq # of unacked XPD */ | |
300 | SeqNum tp_Xrcvnxt; /* next XPD seq # expect to recv */ | |
301 | ||
302 | /* AK subsequencing */ | |
303 | u_short tp_s_subseq; /* next subseq to send */ | |
304 | u_short tp_r_subseq; /* highest recv subseq */ | |
305 | ||
ff72d400 KS |
306 | }; |
307 | ||
0132e4b5 KS |
308 | u_int tp_start_win; |
309 | ||
310 | #define ROUND(scaled_int) (((scaled_int) >> 8) + (((scaled_int) & 0x80) ? 1:0)) | |
311 | ||
312 | /* to round off a scaled int with an 8 bit fraction part */ | |
313 | ||
314 | #define CONG_INIT_SAMPLE(pcb) \ | |
315 | pcb->tp_cong_sample.cs_received = \ | |
316 | pcb->tp_cong_sample.cs_ce_set = 0; \ | |
317 | pcb->tp_cong_sample.cs_size = MAX(pcb->tp_lcredit, 1) << 1; | |
318 | ||
319 | #define CONG_UPDATE_SAMPLE(pcb, ce_bit) \ | |
320 | pcb->tp_cong_sample.cs_received++; \ | |
321 | if (ce_bit) { \ | |
322 | pcb->tp_cong_sample.cs_ce_set++; \ | |
323 | } \ | |
324 | if (pcb->tp_cong_sample.cs_size <= pcb->tp_cong_sample.cs_received) { \ | |
325 | if ((pcb->tp_cong_sample.cs_ce_set << 1) >= \ | |
326 | pcb->tp_cong_sample.cs_size ) { \ | |
327 | pcb->tp_win_recv -= pcb->tp_win_recv >> 3; /* multiply by .875 */ \ | |
328 | pcb->tp_win_recv = MAX(1 << 8, pcb->tp_win_recv); \ | |
329 | } \ | |
330 | else { \ | |
331 | pcb->tp_win_recv += (1 << 8); /* add one to the scaled int */ \ | |
332 | } \ | |
333 | pcb->tp_lcredit = ROUND(pcb->tp_win_recv); \ | |
334 | CONG_INIT_SAMPLE(pcb); \ | |
335 | } | |
336 | ||
337 | #define CONG_ACK(pcb, seq) \ | |
338 | { int newacks = SEQ_SUB(pcb, seq, pcb->tp_snduna); \ | |
339 | if (newacks > 0) { \ | |
340 | pcb->tp_ackrcvd += newacks; \ | |
341 | if (pcb->tp_ackrcvd >= MIN(pcb->tp_fcredit, pcb->tp_cong_win)) { \ | |
342 | ++pcb->tp_cong_win; \ | |
343 | pcb->tp_ackrcvd = 0; \ | |
344 | } \ | |
345 | } \ | |
346 | } | |
347 | ||
63f88aec | 348 | #ifdef KERNEL |
ff72d400 | 349 | extern struct timeval time; |
aade66bc KS |
350 | extern struct tp_refinfo tp_refinfo; |
351 | extern struct tp_ref *tp_ref; | |
ff72d400 | 352 | extern struct tp_param tp_param; |
63f88aec KS |
353 | extern struct nl_protosw nl_protosw[]; |
354 | extern struct tp_pcb *tp_listeners; | |
3a2fbed9 | 355 | extern struct tp_pcb *tp_ftimeolist; |
63f88aec | 356 | #endif |
ff72d400 | 357 | |
f15f73d2 KS |
358 | #define sototpcb(so) ((struct tp_pcb *)(so->so_pcb)) |
359 | #define sototpref(so) ((sototpcb(so)->tp_ref)) | |
ff72d400 KS |
360 | #define tpcbtoso(tp) ((struct socket *)((tp)->tp_sock)) |
361 | #define tpcbtoref(tp) ((struct tp_ref *)((tp)->tp_ref)) | |
ff72d400 KS |
362 | |
363 | #endif __TP_PCB__ |