1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 23 /* 24 * Copyright 2014 Gary Mills 25 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 26 * Use is subject to license terms. 27 */ 28 29 #ifndef _TX_H 30 #define _TX_H 31 32 #include <sys/uio.h> 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /* 39 * This file contains declarations local to the TLI/XTI implmentation 40 */ 41 42 /* 43 * Look buffer list 44 * Could be multiple buffers for MT case 45 */ 46 struct _ti_lookbufs { 47 struct _ti_lookbufs *tl_next; /* next in list */ 48 int tl_lookclen; /* "look" ctl part length */ 49 char *tl_lookcbuf; /* pointer to "look" ctl */ 50 int tl_lookdlen; /* "look" data length */ 51 char *tl_lookdbuf; /* pointer to "look" data */ 52 }; 53 54 /* TI interface user level structure - one per open file */ 55 56 struct _ti_user { 57 struct _ti_user *ti_next; /* next one */ 58 struct _ti_user *ti_prev; /* previous one */ 59 int ti_fd; /* file descriptor */ 60 struct _ti_lookbufs ti_lookbufs; /* head of list of look buffers */ 61 int ti_lookcnt; /* buffered look flag */ 62 ushort_t ti_flags; /* flags */ 63 int ti_rcvsize; /* connect or disconnect data buf size */ 64 char *ti_rcvbuf; /* connect or disconnect data buffer */ 65 int ti_ctlsize; /* ctl buffer size */ 66 char *ti_ctlbuf; /* ctl buffer */ 67 int ti_state; /* user level state */ 68 int ti_ocnt; /* # outstanding connect indications */ 69 t_scalar_t ti_maxpsz; /* TIDU size */ 70 t_scalar_t ti_tsdusize; /* TSDU size */ 71 t_scalar_t ti_etsdusize; /* ETSDU size */ 72 t_scalar_t ti_cdatasize; /* CDATA_size */ 73 t_scalar_t ti_ddatasize; /* DDATA_size */ 74 t_scalar_t ti_servtype; /* service type */ 75 t_scalar_t ti_prov_flag; /* TPI PROVIDER_flag */ 76 uint_t ti_qlen; /* listener backlog limit */ 77 t_uscalar_t acceptor_id; /* Saved acceptor_id value */ 78 dev_t ti_rdev; /* for fd validation */ 79 ino_t ti_ino; /* for fd validation */ 80 mutex_t ti_lock; /* lock to protect this data structure */ 81 }; 82 83 /* 84 * Local flags used with ti_flags field in instance structure of 85 * type 'struct _ti_user' declared above. Historical note: 86 * This namespace constants were previously declared in a 87 * a very messed up namespace in timod.h 88 */ 89 #define USED 0x0001 /* data structure in use */ 90 #define MORE 0x0008 /* more data */ 91 #define EXPEDITED 0x0010 /* processing expedited TSDU */ 92 #define V_ACCEPTOR_ID 0x0020 /* acceptor_id field is has valid value */ 93 #define TX_TQFULL_NOTIFIED 0x0040 /* TQFULL error has been returned once */ 94 95 96 /* 97 * Valid flags that can be passed by user in t_sndv() or t_snd() 98 */ 99 100 #define TX_ALL_VALID_FLAGS (T_MORE|T_EXPEDITED|T_PUSH) 101 102 #define _T_MAX(x, y) ((x) > (y) ? (x) : (y)) 103 104 /* 105 * Following are used to indicate which API entry point is calling common 106 * routines 107 */ 108 #define TX_TLI_API 1 /* The API semantics is TLI */ 109 #define TX_XTI_XNS4_API 2 /* The API semantics is XTI Unix95 */ 110 #define TX_XTI_XNS5_API 3 /* The API semantics is XTI Unix98 */ 111 #define TX_XTI_API TX_XTI_XNS4_API 112 /* The base XTI semantics is Unix95 */ 113 114 /* _T_IS_XTI(x) - Is 'x' an XTI inspired api_semantics */ 115 #define _T_IS_XTI(x) ((x) != TX_TLI_API) 116 #define _T_IS_TLI(x) ((x) == TX_TLI_API) 117 118 /* _T_API_VER_LT(x, y) - Is API version 'x' older than API version 'y' */ 119 #define _T_API_VER_LT(x, y) ((x) < (y)) 120 121 /* 122 * Note: T_BADSTATE also defined in <sys/tiuser.h> 123 */ 124 #define T_BADSTATE 8 125 126 #ifdef DEBUG 127 #include <syslog.h> 128 #define _T_TX_SYSLOG2(tiptr, X, Y) if ((tiptr)->ti_state == T_BADSTATE)\ 129 syslog(X, Y) 130 #else 131 #define _T_TX_SYSLOG2(tiptr, X, Y) 132 #endif /* DEBUG */ 133 134 /* 135 * Macro to change state and log invalid state error 136 */ 137 138 #define _T_TX_NEXTSTATE(event, tiptr, errstr) \ 139 { tiptr->ti_state = tiusr_statetbl[event][(tiptr)->ti_state]; \ 140 _T_TX_SYSLOG2((tiptr), LOG_ERR, errstr); \ 141 } 142 143 /* 144 * External declarations 145 */ 146 extern mutex_t _ti_userlock; 147 148 /* 149 * Useful shared local constants 150 */ 151 152 /* 153 * TX_XTI_LEVEL_MAX_OPTBUF: 154 * Max option buffer requirement reserved for any XTI level options 155 * passed in an option buffer. This is intended as an upper bound. 156 * Regardless of what the providers states in OPT_size of T_info_ack, 157 * XTI level options can also be added to the option buffer and XTI 158 * test suite in particular stuffs XTI level options whether we support 159 * them or not. 160 * 161 * Here is the heuristic used to arrive at a value: 162 * 2* [ // factor of 2 for "repeat options" type testing 163 * (sizeof(struct t_opthdr)+10*sizeof(t_scalar_t)) // XTI_DEBUG 164 * +(sizeof(struct t_opthdr)+ 2*sizeof(t_scalar_t)) // XTI_LINGER 165 * +(sizeof(struct t_opthdr)+ sizeof(t_scalar_t)) // XTI_RCVBUF 166 * +(sizeof(struct t_opthdr)+ sizeof(t_scalar_t)) // XTI_RCVLOWAT 167 * +(sizeof(struct t_opthdr)+ sizeof(t_scalar_t)) // XTI_SNDBUF 168 * +(sizeof(struct t_opthdr)+ sizeof(t_scalar_t)) // XTI_SNDLOWAT 169 * ] 170 * => 2* [ 56+24+20+20+20+20 ] 171 * => 172 */ 173 #define TX_XTI_LEVEL_MAX_OPTBUF 320 174 175 176 /* 177 * Historic information note: 178 * The libnsl/nsl code implements TLI and XTI interfaces using common 179 * code. Most data structures are similar in the exposed interfaces for 180 * the two interfaces (<tiuser.h> and <xti.h>). 181 * The common implementation C files include only <xti.h> which is the 182 * superset in terms of the exposed interfaces. However the file <tiuser.h> 183 * exposes (via <sys/tiuser.h>), in the past contained certain declarations 184 * that are strictly internal to the implementation but were exposed through 185 * their presence in the public header (<tiuser.h>). 186 * Since the implmentation still needs these declarations, they follow 187 * in this file and are removed from exposure through the TLI public header 188 * (<tiuser.h>) which exposed them in the past. 189 */ 190 191 /* 192 * The following are TLI/XTI user level events which cause 193 * state changes. 194 * NOTE: Historical namespace pollution warning. 195 * Some of the event names share the namespace with structure tags 196 * so there are defined inside comments here and exposed through 197 * TLI and XTI headers (<tiuser.h> and <xti.h> 198 */ 199 200 #define T_OPEN 0 201 /* #define T_BIND 1 */ 202 /* #define T_OPTMGMT 2 */ 203 #define T_UNBIND 3 204 #define T_CLOSE 4 205 #define T_SNDUDATA 5 206 #define T_RCVUDATA 6 207 #define T_RCVUDERR 7 208 #define T_CONNECT1 8 209 #define T_CONNECT2 9 210 #define T_RCVCONNECT 10 211 #define T_LISTN 11 212 #define T_ACCEPT1 12 213 #define T_ACCEPT2 13 214 #define T_ACCEPT3 14 215 #define T_SND 15 216 #define T_RCV 16 217 #define T_SNDDIS1 17 218 #define T_SNDDIS2 18 219 #define T_RCVDIS1 19 220 #define T_RCVDIS2 20 221 #define T_RCVDIS3 21 222 #define T_SNDREL 22 223 #define T_RCVREL 23 224 #define T_PASSCON 24 225 226 #define T_NOEVENTS 25 227 228 #define T_NOSTATES 9 /* number of legal states */ 229 230 extern char tiusr_statetbl[T_NOEVENTS][T_NOSTATES]; 231 232 /* 233 * Band definitions for data flow. 234 */ 235 #define TI_NORMAL 0 236 #define TI_EXPEDITED 1 237 238 /* 239 * Bogus states from tiuser.h 240 */ 241 #define T_FAKE 8 /* fake state used when state */ 242 /* cannot be determined */ 243 244 /* 245 * Flags for t_getname() from tiuser.h 246 * Note: This routine's counterpart in XTI is substatnially modified 247 * (i.e. t_getprotaddr() and does not use these flags) 248 */ 249 #define LOCALNAME 0 250 #define REMOTENAME 1 251 252 /* 253 * GENERAL UTILITY MACROS 254 */ 255 #define A_CNT(arr) (sizeof (arr)/sizeof (arr[0])) 256 #define A_END(arr) (&arr[A_CNT(arr)]) 257 #define A_LAST(arr) (&arr[A_CNT(arr)-1]) 258 259 /* 260 * Following macro compares a signed size obtained from TPI primitive 261 * to unsigned size of buffer where it needs to go into passed using 262 * the "struct netbuf" type. 263 * Since many programs are buggy and forget to initialize "netbuf" or 264 * (while unlikely!) allocated buffer can legally even be larger than 265 * max signed integer, we use the following macro to do unsigned comparison 266 * after verifying that signed quantity is positive. 267 */ 268 #define TLEN_GT_NLEN(tpilen, netbuflen) \ 269 (((tpilen) > 0) && ((unsigned int)(tpilen) > (netbuflen))) 270 271 272 /* 273 * N.B.: this interface is deprecated. Use t_strerror() instead. 274 */ 275 extern char *t_errlist[]; 276 extern int t_nerr; 277 278 /* 279 * UTILITY ROUTINES FUNCTION PROTOTYPES 280 */ 281 282 extern void _t_adjust_iov(int, struct iovec *, int *); 283 extern struct _ti_user *_t_checkfd(int, int, int); 284 extern int _t_delete_tilink(int); 285 extern int _t_rcv_conn_con(struct _ti_user *, struct t_call *, struct strbuf *, 286 int); 287 extern int _t_snd_conn_req(struct _ti_user *, const struct t_call *, 288 struct strbuf *); 289 extern int _t_aligned_copy(struct strbuf *, int, int, char *, t_scalar_t *); 290 extern struct _ti_user *_t_create(int, struct t_info *, int, int *); 291 extern int _t_do_ioctl(int, char *, int, int, int *); 292 extern int _t_is_event(int, struct _ti_user *); 293 extern int _t_is_ok(int, struct _ti_user *, t_scalar_t); 294 extern int _t_look_locked(int, struct _ti_user *, int, int); 295 extern int _t_register_lookevent(struct _ti_user *, caddr_t, int, caddr_t, int); 296 extern void _t_free_looklist_head(struct _ti_user *); 297 extern void _t_flush_lookevents(struct _ti_user *); 298 extern int _t_acquire_ctlbuf(struct _ti_user *, struct strbuf *, int *); 299 extern int _t_acquire_databuf(struct _ti_user *, struct strbuf *, int *); 300 301 /* 302 * Core function TLI/XTI routines function prototypes 303 */ 304 extern int _tx_accept(int, int, const struct t_call *, int); 305 extern char *_tx_alloc(int, int, int, int); 306 extern int _tx_bind(int, const struct t_bind *, struct t_bind *, int); 307 extern int _tx_close(int, int); 308 extern int _tx_connect(int, const struct t_call *, struct t_call *, int); 309 extern int _tx_error(const char *, int); 310 extern int _tx_free(char *, int, int); 311 extern int _tx_getinfo(int, struct t_info *, int); 312 extern int _tx_getname(int, struct netbuf *, int, int); 313 extern int _tx_getstate(int, int); 314 extern int _tx_getprotaddr(int, struct t_bind *, struct t_bind *, int); 315 extern int _tx_listen(int, struct t_call *, int); 316 extern int _tx_look(int, int); 317 extern int _tx_open(const char *, int, struct t_info *, int); 318 extern int _tx_optmgmt(int, const struct t_optmgmt *, struct t_optmgmt *, int); 319 extern int _tx_rcv(int, char *, unsigned, int *, int); 320 extern int _tx_rcvconnect(int, struct t_call *, int); 321 extern int _tx_rcvdis(int, struct t_discon *, int); 322 extern int _tx_rcvrel(int, int); 323 extern int _tx_rcvudata(int, struct t_unitdata *, int *, int); 324 extern int _tx_rcvuderr(int, struct t_uderr *, int); 325 extern int _tx_snd(int, char *, unsigned, int, int); 326 extern int _tx_snddis(int, const struct t_call *, int); 327 extern int _tx_sndrel(int, int); 328 extern int _tx_sndudata(int, const struct t_unitdata *, int); 329 extern char *_tx_strerror(int, int); 330 extern int _tx_sync(int, int); 331 extern int _tx_unbind(int, int); 332 extern int _tx_unbind_locked(int, struct _ti_user *, struct strbuf *); 333 extern int _t_expinline_queued(int, int *); 334 extern int _t_do_postconn_sync(int, struct _ti_user *); 335 336 /* 337 * The following helper functions are used by scatter/gather functions, 338 * which are defined only for XTI and not available in TLI. Moreover 339 * the definition of struct t_iovec which is used below is not visible to 340 * TLI. Hence tli_wrappers.c should not see the prototypes below. 341 */ 342 #ifndef TLI_WRAPPERS 343 unsigned int _t_bytecount_upto_intmax(const struct t_iovec *, unsigned int); 344 void _t_scatter(struct strbuf *, struct t_iovec *, int); 345 void _t_gather(char *, const struct t_iovec *, unsigned int); 346 void _t_copy_tiov_to_iov(const struct t_iovec *, int, struct iovec *, int *); 347 348 /* 349 * The following scatter/gather and other misc. functions are defined only 350 * for XTI and not available in TLI. Moreover the definition of struct t_iovec 351 * which is used below is not visible to TLI. Hence tli_wrappers.c should not 352 * see the prototypes below. 353 */ 354 extern int _tx_rcvv(int, struct t_iovec *, unsigned int, int *, int); 355 extern int _tx_rcvreldata(int, struct t_discon *, int); 356 extern int _tx_rcvvudata(int, struct t_unitdata *, struct t_iovec *, 357 unsigned int, int *, int); 358 extern int _tx_sndv(int, const struct t_iovec *, unsigned int, int, int); 359 extern int _tx_sndreldata(int, struct t_discon *, int); 360 extern int _tx_sndvudata(int, const struct t_unitdata *, struct t_iovec *, 361 unsigned int, int); 362 extern int _tx_sysconf(int, int); 363 #endif /* TLI_WRAPPERS */ 364 365 #ifdef __cplusplus 366 } 367 #endif 368 369 #endif /* _TX_H */ 370