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 * 33 * 34 * This file defines the transport protocol control block (tpcb). 35 * and a bunch of #define values that are used in the tpcb. 36 */ 37 38 #ifndef __TP_PCB__ 39 #define __TP_PCB__ 40 41 #include "../netiso/tp_param.h" 42 #include "../netiso/tp_timer.h" 43 #include "../netiso/tp_user.h" 44 #ifndef sblock 45 #include "socketvar.h" 46 #endif sblock 47 48 /* NOTE: the code depends on REF_CLOSED > REF_OPEN > the rest, and 49 * on REF_FREE being zero 50 * 51 * Possible improvement: 52 * think about merging the tp_ref w/ the tpcb and doing a search 53 * through the tpcb list, from tpb. This would slow down lookup 54 * during data transfer 55 * It would be a little nicer also to have something based on the 56 * clock (like top n bits of the reference is part of the clock, to 57 * minimize the likelihood of reuse after a crash) 58 * also, need to keep the timer servicing part to a minimum (although 59 * the cost of this is probably independent of whether the timers are 60 * in the pcb or in an array.. 61 * Last, would have to make the number of timers a function of the amount of 62 * mbufs available, plus some for the frozen references. 63 * 64 * Possible improvement: 65 * Might not need the ref_state stuff either... 66 * REF_FREE could correspond to tp_state == CLOSED or nonexistend tpcb, 67 * REF_OPEN to tp_state anywhere from AK_WAIT or CR_SENT to CLOSING 68 * REF_OPENING could correspond to LISTENING, because that's the 69 * way it's used, not because the correspondence is exact. 70 * REF_CLOSED could correspond to REFWAIT 71 */ 72 #define REF_FROZEN 3 /* has ref timer only */ 73 #define REF_OPEN 2 /* has timers, possibly active */ 74 #define REF_OPENING 1 /* in use (has a pcb) but no timers */ 75 #define REF_FREE 0 /* free to reallocate */ 76 77 #define N_CTIMERS 4 78 #define N_ETIMERS 2 79 80 struct tp_ref { 81 u_char tpr_state; /* values REF_FROZEN, etc. above */ 82 struct Ccallout tpr_callout[N_CTIMERS]; /* C timers */ 83 struct Ecallout tpr_calltodo; /* list of active E timers */ 84 struct tp_pcb *tpr_pcb; /* back ptr to PCB */ 85 }; 86 87 struct tp_param { 88 /* PER system stuff (one static structure instead of a bunch of names) */ 89 unsigned tpp_configed:1; /* Has TP been initialized? */ 90 }; 91 92 93 /* 94 * retransmission control and performance measurement 95 */ 96 struct tp_rtc { 97 struct tp_rtc *tprt_next; /* ptr to next rtc structure in the list */ 98 SeqNum tprt_seq; /* seq # of this TPDU */ 99 int tprt_eot; /* Will this TPDU have the eot bit set? */ 100 int tprt_octets;/* # octets in this TPDU */ 101 struct mbuf *tprt_data; /* ptr to the octets of data */ 102 }; 103 104 extern 105 struct nl_protosw { 106 int nlp_afamily; /* address family */ 107 int (*nlp_putnetaddr)(); /* puts addresses in nl pcb */ 108 int (*nlp_getnetaddr)(); /* gets addresses from nl pcb */ 109 int (*nlp_putsufx)(); /* puts transport suffixes in nl pcb */ 110 int (*nlp_getsufx)(); /* gets transport suffixes from nl pcb */ 111 int (*nlp_recycle_suffix)();/* clears suffix from nl pcb */ 112 int (*nlp_mtu)(); /* figures out mtu based on nl used */ 113 int (*nlp_pcbbind)(); /* bind to pcb for net level */ 114 int (*nlp_pcbconn)(); /* connect for net level */ 115 int (*nlp_pcbdisc)(); /* disconnect net level */ 116 int (*nlp_pcbdetach)(); /* detach net level pcb */ 117 int (*nlp_pcballoc)(); /* allocate a net level pcb */ 118 int (*nlp_output)(); /* prepare a packet to give to nl */ 119 int (*nlp_dgoutput)(); /* prepare a packet to give to nl */ 120 int (*nlp_ctloutput)(); /* hook for network set/get options */ 121 caddr_t nlp_pcblist; /* list of xx_pcb's for connections */ 122 } nl_protosw[]; 123 124 125 struct tp_pcb { 126 u_short tp_state; /* state of fsm */ 127 short tp_retrans; /* # times can still retrans */ 128 struct tp_ref *tp_refp; /* rest of pcb */ 129 caddr_t tp_npcb; /* to lower layer pcb */ 130 struct nl_protosw *tp_nlproto; /* lower-layer dependent routines */ 131 struct socket *tp_sock; /* back ptr */ 132 133 134 RefNum tp_lref; /* local reference */ 135 RefNum tp_fref; /* foreign reference */ 136 137 u_int tp_seqmask; /* mask for seq space */ 138 u_int tp_seqbit; /* bit for seq number wraparound */ 139 u_int tp_seqhalf; /* half the seq space */ 140 141 /* credit & sequencing info for SENDING */ 142 u_short tp_fcredit; /* current remote credit in # packets */ 143 144 u_short tp_cong_win; /* congestion window : set to 1 on 145 * source quench 146 * Minimizes the amount of retrans- 147 * missions (independently of the 148 * retrans strategy). Increased 149 * by one for each good ack received. 150 * Minimizes the amount sent in a 151 * regular tp_send() also. 152 */ 153 SeqNum tp_snduna; /* seq # of lowest unacked DT */ 154 struct tp_rtc *tp_snduna_rtc; /* lowest unacked stuff sent so far */ 155 SeqNum tp_sndhiwat; /* highest seq # sent so far */ 156 struct tp_rtc *tp_sndhiwat_rtc; /* last stuff sent so far */ 157 int tp_Nwindow; /* for perf. measurement */ 158 struct mbuf *tp_ucddata; /* user connect/disconnect data */ 159 160 /* credit & sequencing info for RECEIVING */ 161 SeqNum tp_sent_lcdt; /* cdt according to last ack sent */ 162 SeqNum tp_sent_uwe; /* uwe according to last ack sent */ 163 SeqNum tp_sent_rcvnxt; /* rcvnxt according to last ack sent 164 * needed for perf measurements only 165 */ 166 u_short tp_lcredit; /* current local credit in # packets */ 167 SeqNum tp_rcvnxt; /* next DT seq # expect to recv */ 168 struct tp_rtc *tp_rcvnxt_rtc; /* unacked stuff recvd out of order */ 169 170 /* parameters per-connection controllable by user */ 171 struct tp_conn_param _tp_param; 172 173 #define tp_Nretrans _tp_param.p_Nretrans 174 #define tp_dr_ticks _tp_param.p_dr_ticks 175 #define tp_cc_ticks _tp_param.p_cc_ticks 176 #define tp_dt_ticks _tp_param.p_dt_ticks 177 #define tp_xpd_ticks _tp_param.p_x_ticks 178 #define tp_cr_ticks _tp_param.p_cr_ticks 179 #define tp_keepalive_ticks _tp_param.p_keepalive_ticks 180 #define tp_sendack_ticks _tp_param.p_sendack_ticks 181 #define tp_refer_ticks _tp_param.p_ref_ticks 182 #define tp_inact_ticks _tp_param.p_inact_ticks 183 #define tp_xtd_format _tp_param.p_xtd_format 184 #define tp_xpd_service _tp_param.p_xpd_service 185 #define tp_ack_strat _tp_param.p_ack_strat 186 #define tp_rx_strat _tp_param.p_rx_strat 187 #define tp_use_checksum _tp_param.p_use_checksum 188 #define tp_use_efc _tp_param.p_use_efc 189 #define tp_use_nxpd _tp_param.p_use_nxpd 190 #define tp_use_rcc _tp_param.p_use_rcc 191 #define tp_tpdusize _tp_param.p_tpdusize 192 #define tp_class _tp_param.p_class 193 #define tp_winsize _tp_param.p_winsize 194 #define tp_no_disc_indications _tp_param.p_no_disc_indications 195 #define tp_dont_change_params _tp_param.p_dont_change_params 196 #define tp_netservice _tp_param.p_netservice 197 198 int tp_l_tpdusize; 199 /* whereas tp_tpdusize is log2(the negotiated max size) 200 * l_tpdusize is the size we'll use when sending, in # chars 201 */ 202 203 struct timeval tp_rtv; /* max round-trip time variance */ 204 struct timeval tp_rtt; /* smoothed round-trip time */ 205 struct timeval tp_rttemit[ TP_RTT_NUM + 1 ]; 206 /* times that the last TP_RTT_NUM DT_TPDUs were emitted */ 207 unsigned 208 tp_sendfcc:1, /* shall next ack include FCC parameter? */ 209 tp_trace:1, /* is this pcb being traced? (not used yet) */ 210 tp_perf_on:1, /* 0/1 -> performance measuring on */ 211 tp_reneged:1, /* have we reneged on cdt since last ack? */ 212 tp_decbit:4, /* dec bit was set, we're in reneg mode */ 213 tp_flags:8, /* values: */ 214 #define TPF_CONN_DATA_OUT TPFLAG_CONN_DATA_OUT 215 #define TPF_CONN_DATA_IN TPFLAG_CONN_DATA_IN 216 #define TPF_DISC_DATA_IN TPFLAG_DISC_DATA_IN 217 #define TPF_DISC_DATA_OUT TPFLAG_DISC_DATA_OUT 218 #define TPF_XPD_PRESENT TPFLAG_XPD_PRESENT 219 #define TPF_NLQOS_PDN TPFLAG_NLQOS_PDN 220 #define TPF_PEER_ON_SAMENET TPFLAG_PEER_ON_SAMENET 221 222 #define PEER_IS_LOCAL(t) \ 223 (((t)->tp_flags & TPF_PEER_ON_SAME_NET)==TPF_PEER_ON_SAME_NET) 224 #define USES_PDN(t) \ 225 (((t)->tp_flags & TPF_NLQOS_PDN)==TPF_NLQOS_PDN) 226 227 tp_unused:16; 228 229 230 #ifdef TP_PERF_MEAS 231 /* performance stats - see tp_stat.h */ 232 struct tp_pmeas *tp_p_meas; 233 struct mbuf *tp_p_mbuf; 234 #endif TP_PERF_MEAS 235 /* addressing */ 236 u_short tp_domain; /* domain (INET, ISO) */ 237 /* for compatibility with the *old* way and with INET, be sure that 238 * that lsuffix and fsuffix are aligned to a short addr. 239 * having them follow the u_short *suffixlen should suffice (choke) 240 */ 241 u_short tp_fsuffixlen; /* foreign suffix */ 242 char tp_fsuffix[MAX_TSAP_SEL_LEN]; 243 u_short tp_lsuffixlen; /* local suffix */ 244 char tp_lsuffix[MAX_TSAP_SEL_LEN]; 245 #define SHORT_LSUFXP(tpcb) ((short *)((tpcb)->tp_lsuffix)) 246 #define SHORT_FSUFXP(tpcb) ((short *)((tpcb)->tp_fsuffix)) 247 248 u_char tp_vers; /* protocol version */ 249 u_char tp_peer_acktime; /* used to compute DT retrans time */ 250 251 struct sockbuf tp_Xsnd; /* for expedited data */ 252 /* struct sockbuf tp_Xrcv; /* for expedited data */ 253 #define tp_Xrcv tp_sock->so_rcv 254 SeqNum tp_Xsndnxt; /* next XPD seq # to send */ 255 SeqNum tp_Xuna; /* seq # of unacked XPD */ 256 SeqNum tp_Xrcvnxt; /* next XPD seq # expect to recv */ 257 258 /* AK subsequencing */ 259 u_short tp_s_subseq; /* next subseq to send */ 260 u_short tp_r_subseq; /* highest recv subseq */ 261 262 }; 263 264 extern struct timeval time; 265 extern struct tp_ref tp_ref[]; 266 extern struct tp_param tp_param; 267 268 #define sototpcb(so) ((struct tp_pcb *)(so->so_tpcb)) 269 #define sototpref(so) ((struct tp_ref *)((so)->so_tpcb->tp_ref)) 270 #define tpcbtoso(tp) ((struct socket *)((tp)->tp_sock)) 271 #define tpcbtoref(tp) ((struct tp_ref *)((tp)->tp_ref)) 272 273 #endif __TP_PCB__ 274