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.17 (Berkeley) 09/26/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 TM_NTIMERS 6 87 88 struct tp_ref { 89 /* u_char tpr_state; /* values REF_FROZEN, etc. above */ 90 #define tpr_state tpr_pcb->tp_refstate 91 struct tp_pcb *tpr_pcb; /* back ptr to PCB */ 92 }; 93 94 struct tp_refinfo { 95 struct tp_ref *tpr_base; 96 int tpr_size; 97 int tpr_maxopen; 98 int tpr_numopen; 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 struct nl_protosw { 108 int nlp_afamily; /* address family */ 109 int (*nlp_putnetaddr)(); /* puts addresses in nl pcb */ 110 int (*nlp_getnetaddr)(); /* gets addresses from nl pcb */ 111 int (*nlp_cmpnetaddr)(); /* compares address in pcb with sockaddr */ 112 int (*nlp_putsufx)(); /* puts transport suffixes in nl pcb */ 113 int (*nlp_getsufx)(); /* gets transport suffixes from nl pcb */ 114 int (*nlp_recycle_suffix)();/* clears suffix from nl pcb */ 115 int (*nlp_mtu)(); /* figures out mtu based on nl used */ 116 int (*nlp_pcbbind)(); /* bind to pcb for net level */ 117 int (*nlp_pcbconn)(); /* connect for net level */ 118 int (*nlp_pcbdisc)(); /* disconnect net level */ 119 int (*nlp_pcbdetach)(); /* detach net level pcb */ 120 int (*nlp_pcballoc)(); /* allocate a net level pcb */ 121 int (*nlp_output)(); /* prepare a packet to give to nl */ 122 int (*nlp_dgoutput)(); /* prepare a packet to give to nl */ 123 int (*nlp_ctloutput)(); /* hook for network set/get options */ 124 caddr_t nlp_pcblist; /* list of xx_pcb's for connections */ 125 }; 126 127 128 struct tp_pcb { 129 struct tp_pcb *tp_next; 130 struct tp_pcb *tp_prev; 131 struct tp_pcb *tp_nextlisten; /* chain all listeners */ 132 u_short tp_state; /* state of fsm */ 133 short tp_retrans; /* # times can still retrans */ 134 struct tp_ref *tp_refp; /* rest of pcb */ 135 caddr_t tp_npcb; /* to lower layer pcb */ 136 struct nl_protosw *tp_nlproto; /* lower-layer dependent routines */ 137 struct socket *tp_sock; /* back ptr */ 138 139 140 RefNum tp_lref; /* local reference */ 141 RefNum tp_fref; /* foreign reference */ 142 143 u_int tp_seqmask; /* mask for seq space */ 144 u_int tp_seqbit; /* bit for seq number wraparound */ 145 u_int tp_seqhalf; /* half the seq space */ 146 147 struct mbuf *tp_ucddata; /* user connect/disconnect data */ 148 149 /* credit & sequencing info for SENDING */ 150 u_short tp_fcredit; /* current remote credit in # packets */ 151 u_short tp_maxfcredit; /* max remote credit in # packets */ 152 u_short tp_dupacks; /* intuit packet loss before rxt timo */ 153 u_long tp_cong_win; /* congestion window in bytes. 154 * see profuse comments in TCP code 155 */ 156 u_long tp_ssthresh; /* cong_win threshold for slow start 157 * exponential to linear switch 158 */ 159 SeqNum tp_snduna; /* seq # of lowest unacked DT */ 160 SeqNum tp_sndnew; /* seq # of lowest unsent DT */ 161 SeqNum tp_sndnum; /* next seq # to be assigned */ 162 SeqNum tp_sndnxt; /* what to do next; poss. rxt */ 163 struct mbuf *tp_sndnxt_m; /* packet corres. to sndnxt*/ 164 int tp_Nwindow; /* for perf. measurement */ 165 166 /* credit & sequencing info for RECEIVING */ 167 SeqNum tp_rcvnxt; /* next DT seq # expect to recv */ 168 SeqNum tp_sent_lcdt; /* cdt according to last ack sent */ 169 SeqNum tp_sent_uwe; /* uwe according to last ack sent */ 170 SeqNum tp_sent_rcvnxt; /* rcvnxt according to last ack sent 171 * needed for perf measurements only 172 */ 173 u_short tp_lcredit; /* current local credit in # packets */ 174 u_short tp_maxlcredit; /* needed for reassembly queue */ 175 struct mbuf **tp_rsyq; /* unacked stuff recvd out of order */ 176 int tp_rsycnt; /* number of packets "" "" "" "" */ 177 178 /* receiver congestion state stuff ... */ 179 u_int tp_win_recv; 180 181 /* receive window as a scaled int (8 bit fraction part) */ 182 183 struct cong_sample { 184 ushort cs_size; /* current window size */ 185 ushort cs_received; /* PDUs received in this sample */ 186 ushort cs_ce_set; /* PDUs received in this sample with CE bit set */ 187 } tp_cong_sample; 188 189 190 /* parameters per-connection controllable by user */ 191 struct tp_conn_param _tp_param; 192 193 #define tp_Nretrans _tp_param.p_Nretrans 194 #define tp_dr_ticks _tp_param.p_dr_ticks 195 #define tp_cc_ticks _tp_param.p_cc_ticks 196 #define tp_dt_ticks _tp_param.p_dt_ticks 197 #define tp_xpd_ticks _tp_param.p_x_ticks 198 #define tp_cr_ticks _tp_param.p_cr_ticks 199 #define tp_keepalive_ticks _tp_param.p_keepalive_ticks 200 #define tp_sendack_ticks _tp_param.p_sendack_ticks 201 #define tp_refer_ticks _tp_param.p_ref_ticks 202 #define tp_inact_ticks _tp_param.p_inact_ticks 203 #define tp_xtd_format _tp_param.p_xtd_format 204 #define tp_xpd_service _tp_param.p_xpd_service 205 #define tp_ack_strat _tp_param.p_ack_strat 206 #define tp_rx_strat _tp_param.p_rx_strat 207 #define tp_use_checksum _tp_param.p_use_checksum 208 #define tp_use_efc _tp_param.p_use_efc 209 #define tp_use_nxpd _tp_param.p_use_nxpd 210 #define tp_use_rcc _tp_param.p_use_rcc 211 #define tp_tpdusize _tp_param.p_tpdusize 212 #define tp_class _tp_param.p_class 213 #define tp_winsize _tp_param.p_winsize 214 #define tp_no_disc_indications _tp_param.p_no_disc_indications 215 #define tp_dont_change_params _tp_param.p_dont_change_params 216 #define tp_netservice _tp_param.p_netservice 217 #define tp_version _tp_param.p_version 218 219 int tp_l_tpdusize; 220 /* whereas tp_tpdusize is log2(the negotiated max size) 221 * l_tpdusize is the size we'll use when sending, in # chars 222 */ 223 224 int tp_rtv; /* max round-trip time variance */ 225 int tp_rtt; /* smoothed round-trip time */ 226 SeqNum tp_rttseq; /* packet being timed */ 227 int tp_rttemit; /* when emitted, in ticks */ 228 int tp_idle; /* last activity, in ticks */ 229 short tp_rxtcur; /* current retransmit value */ 230 short tp_rxtshift; /* log(2) of rexmt exp. backoff */ 231 232 unsigned 233 tp_sendfcc:1, /* shall next ack include FCC parameter? */ 234 tp_trace:1, /* is this pcb being traced? (not used yet) */ 235 tp_perf_on:1, /* 0/1 -> performance measuring on */ 236 tp_reneged:1, /* have we reneged on cdt since last ack? */ 237 tp_decbit:3, /* dec bit was set, we're in reneg mode */ 238 tp_cebit_off:1, /* the real DEC bit algorithms not in use */ 239 tp_flags:8, /* values: */ 240 #define TPF_NLQOS_PDN TPFLAG_NLQOS_PDN 241 #define TPF_PEER_ON_SAMENET TPFLAG_PEER_ON_SAMENET 242 #define TPF_GENERAL_ADDR TPFLAG_GENERAL_ADDR 243 #define TPF_DELACK 0x8 244 #define TPF_ACKNOW 0x10 245 246 #define PEER_IS_LOCAL(t) (((t)->tp_flags & TPF_PEER_ON_SAME_NET) != 0) 247 #define USES_PDN(t) (((t)->tp_flags & TPF_NLQOS_PDN) != 0) 248 249 tp_oktonagle:1, /* Last unsent packet that may be append to */ 250 tp_notdetached:1, /* Call tp_detach before freeing XXXXXXX */ 251 tp_unused:14; 252 253 254 #ifdef TP_PERF_MEAS 255 /* performance stats - see tp_stat.h */ 256 struct tp_pmeas *tp_p_meas; 257 struct mbuf *tp_p_mbuf; 258 #endif TP_PERF_MEAS 259 /* addressing */ 260 u_short tp_domain; /* domain (INET, ISO) */ 261 /* for compatibility with the *old* way and with INET, be sure that 262 * that lsuffix and fsuffix are aligned to a short addr. 263 * having them follow the u_short *suffixlen should suffice (choke) 264 */ 265 u_short tp_fsuffixlen; /* foreign suffix */ 266 char tp_fsuffix[MAX_TSAP_SEL_LEN]; 267 u_short tp_lsuffixlen; /* local suffix */ 268 char tp_lsuffix[MAX_TSAP_SEL_LEN]; 269 #define SHORT_LSUFXP(tpcb) ((short *)((tpcb)->tp_lsuffix)) 270 #define SHORT_FSUFXP(tpcb) ((short *)((tpcb)->tp_fsuffix)) 271 272 /* Timer stuff */ 273 u_char tp_vers; /* protocol version */ 274 u_char tp_peer_acktime; /* used for DT retrans time */ 275 u_char tp_refstate; /* values REF_FROZEN, etc. above */ 276 struct tp_pcb *tp_fasttimeo; /* limit pcbs to examine */ 277 u_int tp_timer[TM_NTIMERS]; /* C timers */ 278 struct Ecallarg tp_retransargs; /* dunt ask ... */ 279 280 struct sockbuf tp_Xsnd; /* for expedited data */ 281 /* struct sockbuf tp_Xrcv; /* for expedited data */ 282 #define tp_Xrcv tp_sock->so_rcv 283 SeqNum tp_Xsndnxt; /* next XPD seq # to send */ 284 SeqNum tp_Xuna; /* seq # of unacked XPD */ 285 SeqNum tp_Xrcvnxt; /* next XPD seq # expect to recv */ 286 287 /* AK subsequencing */ 288 u_short tp_s_subseq; /* next subseq to send */ 289 u_short tp_r_subseq; /* highest recv subseq */ 290 291 }; 292 293 u_int tp_start_win; 294 295 #define ROUND(scaled_int) (((scaled_int) >> 8) + (((scaled_int) & 0x80) ? 1:0)) 296 297 /* to round off a scaled int with an 8 bit fraction part */ 298 299 #define CONG_INIT_SAMPLE(pcb) \ 300 pcb->tp_cong_sample.cs_received = \ 301 pcb->tp_cong_sample.cs_ce_set = 0; \ 302 pcb->tp_cong_sample.cs_size = MAX(pcb->tp_lcredit, 1) << 1; 303 304 #define CONG_UPDATE_SAMPLE(pcb, ce_bit) \ 305 pcb->tp_cong_sample.cs_received++; \ 306 if (ce_bit) { \ 307 pcb->tp_cong_sample.cs_ce_set++; \ 308 } \ 309 if (pcb->tp_cong_sample.cs_size <= pcb->tp_cong_sample.cs_received) { \ 310 if ((pcb->tp_cong_sample.cs_ce_set << 1) >= \ 311 pcb->tp_cong_sample.cs_size ) { \ 312 pcb->tp_win_recv -= pcb->tp_win_recv >> 3; /* multiply by .875 */ \ 313 pcb->tp_win_recv = MAX(1 << 8, pcb->tp_win_recv); \ 314 } \ 315 else { \ 316 pcb->tp_win_recv += (1 << 8); /* add one to the scaled int */ \ 317 } \ 318 pcb->tp_lcredit = ROUND(pcb->tp_win_recv); \ 319 CONG_INIT_SAMPLE(pcb); \ 320 } 321 322 #ifdef KERNEL 323 extern struct tp_refinfo tp_refinfo; 324 extern struct timeval time; 325 extern struct tp_ref *tp_ref; 326 extern struct tp_param tp_param; 327 extern struct nl_protosw nl_protosw[]; 328 extern struct tp_pcb *tp_listeners; 329 extern struct tp_pcb *tp_ftimeolist; 330 #endif 331 332 #define sototpcb(so) ((struct tp_pcb *)(so->so_pcb)) 333 #define sototpref(so) ((sototpcb(so)->tp_ref)) 334 #define tpcbtoso(tp) ((struct socket *)((tp)->tp_sock)) 335 #define tpcbtoref(tp) ((struct tp_ref *)((tp)->tp_ref)) 336 337 #endif __TP_PCB__ 338