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