bringing-rx-into-21st-century-20060504
[openafs.git] / src / rx / rx.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #ifdef KDUMP_RX_LOCK
11 /* kdump for SGI needs MP and SP versions of rx_serverQueueEntry,
12  * rx_peer, rx_connection and rx_call structs. rx.h gets included a
13  * second time to pick up mp_ versions of those structs. Currently
14  * the affected struct's have #ifdef's in them for the second pass.
15  * This should change once we start using only ANSI compilers.
16  * Actually, kdump does not use rx_serverQueueEntry, but I'm including
17  * it for completeness.
18  */
19 #undef _RX_
20 #endif
21
22 #ifndef _RX_
23 #define _RX_
24
25 #ifndef KDUMP_RX_LOCK
26 /* Substitute VOID (char) for void, because some compilers are confused by void
27  * in some situations */
28 #ifndef AFS_NT40_ENV
29 #define VOID    char
30 #endif
31
32 #ifdef  KERNEL
33 #include "rx_kmutex.h"
34 #include "rx_kernel.h"
35 #include "rx_clock.h"
36 #include "rx_event.h"
37 #include "rx_queue.h"
38 #include "rx_packet.h"
39 #include "rx_misc.h"
40 #include "rx_multi.h"
41 #if defined (AFS_OBSD_ENV) && !defined (MLEN)
42 #include "sys/mbuf.h"
43 #endif
44 #include "netinet/in.h"
45 #include "sys/socket.h"
46 #else /* KERNEL */
47 # include <sys/types.h>
48 # include <stdio.h>
49 #ifdef AFS_PTHREAD_ENV
50 # include "rx_pthread.h"
51 #else
52 # include "rx_lwp.h"
53 #endif
54 #ifdef AFS_NT40_ENV
55 #include <malloc.h>
56 #endif
57 # include "rx_user.h"
58 # include "rx_clock.h"
59 # include "rx_event.h"
60 # include "rx_packet.h"
61 # include "rx_misc.h"
62 # include "rx_null.h"
63 # include "rx_multi.h"
64 #ifndef AFS_NT40_ENV
65 # include <netinet/in.h>
66 # include <sys/socket.h>
67 #endif
68 #endif /* KERNEL */
69
70
71 /* Configurable parameters */
72 #define RX_IDLE_DEAD_TIME       60      /* default idle dead time */
73 #define RX_MAX_SERVICES         20      /* Maximum number of services that may be installed */
74 #if defined(KERNEL) && defined(AFS_AIX51_ENV) && defined(__64__)
75 #define RX_DEFAULT_STACK_SIZE   24000
76 #else
77 #define RX_DEFAULT_STACK_SIZE   16000   /* Default process stack size; overriden by rx_SetStackSize */
78 #endif
79
80 /* This parameter should not normally be changed */
81 #define RX_PROCESS_PRIORITY     LWP_NORMAL_PRIORITY
82
83 /* backoff is fixed point binary.  Ie, units of 1/4 seconds */
84 #define MAXBACKOFF 0x1F
85
86 #define ADDRSPERSITE 16
87
88 #ifndef KDUMP_RX_LOCK
89 /* Bottom n-bits of the Call Identifier give the call number */
90 #define RX_MAXCALLS 4           /* Power of 2; max async calls per connection */
91 #define RX_CIDSHIFT 2           /* Log2(RX_MAXCALLS) */
92 #define RX_CHANNELMASK (RX_MAXCALLS-1)
93 #define RX_CIDMASK  (~RX_CHANNELMASK)
94 #endif /* !KDUMP_RX_LOCK */
95
96 #ifndef KERNEL
97 typedef void (*rx_destructor_t) (void *);
98 int rx_KeyCreate(rx_destructor_t);
99 osi_socket rxi_GetHostUDPSocket(struct sockaddr_storage *saddr, int salen);
100 osi_socket rxi_GetUDPSocket(u_short port);
101 #endif /* KERNEL */
102
103
104 int ntoh_syserr_conv(int error);
105
106 #define RX_WAIT     1
107 #define RX_DONTWAIT 0
108
109 #define rx_ConnectionOf(call)           ((call)->conn)
110 #define rx_PeerOf(conn)                 ((conn)->peer)
111 #ifdef AF_INET6
112 #define rx_HostOf(peer)                 ((peer)->saddr.ss_family == AF_INET ? \
113                 ((struct sockaddr_in *) &(peer)->saddr)->sin_addr.s_addr : \
114                                                                 0xffffffff)
115 #define rx_PortOf(peer)                 ((peer)->saddr.ss_family == AF_INET ? \
116                 ((struct sockaddr_in *) &(peer)->saddr)->sin_port : \
117                 ((struct sockaddr_in6 *) &(peer)->saddr)->sin6_port)
118 #else /* AF_INET6 */
119 #define rx_HostOf(peer)                 (((struct sockaddr_in *) &(peer)->saddr)->sin_addr.saddr)
120 #define rx_PortOf(peer)                 (((struct sockaddr_in *) &(peer)->saddr)->sin_port)
121 #endif /* AF_INET6 */
122 #define rx_AddrStringOf(peer)           ((peer)->addrstring)
123 #define rx_SetLocalStatus(call, status) ((call)->localStatus = (status))
124 #define rx_GetLocalStatus(call, status) ((call)->localStatus)
125 #define rx_GetRemoteStatus(call)        ((call)->remoteStatus)
126 #define rx_Error(call)                  ((call)->error)
127 #define rx_ConnError(conn)              ((conn)->error)
128 #define rx_IsServerConn(conn)           ((conn)->type == RX_SERVER_CONNECTION)
129 #define rx_IsClientConn(conn)           ((conn)->type == RX_CLIENT_CONNECTION)
130 /* Don't use these; use the IsServerConn style */
131 #define rx_ServerConn(conn)             ((conn)->type == RX_SERVER_CONNECTION)
132 #define rx_ClientConn(conn)             ((conn)->type == RX_CLIENT_CONNECTION)
133 #define rx_IsUsingPktCksum(conn)        ((conn)->flags & RX_CONN_USING_PACKET_CKSUM)
134 #define rx_ServiceIdOf(conn)            ((conn)->serviceId)
135 #define rx_SecurityClassOf(conn)        ((conn)->securityIndex)
136 #define rx_SecurityObjectOf(conn)       ((conn)->securityObject)
137
138 /*******************
139  * Macros callable by the user to further define attributes of a
140  * service.  Must be called before rx_StartServer
141  */
142
143 /* Set the service stack size.  This currently just sets the stack
144  * size for all processes to be the maximum seen, so far */
145 #define rx_SetStackSize(service, stackSize) \
146   rx_stackSize = (((stackSize) > rx_stackSize)? stackSize: rx_stackSize)
147
148 /* Set minimum number of processes guaranteed to be available for this
149  * service at all times */
150 #define rx_SetMinProcs(service, min) ((service)->minProcs = (min))
151
152 /* Set maximum number of processes that will be made available to this
153  * service (also a guarantee that this number will be made available
154  * if there is no competition) */
155 #define rx_SetMaxProcs(service, max) ((service)->maxProcs = (max))
156
157 /* Define a procedure to be called just before a server connection is destroyed */
158 #define rx_SetDestroyConnProc(service,proc) ((service)->destroyConnProc = (proc))
159
160 /* Define procedure to set service dead time */
161 #define rx_SetIdleDeadTime(service,time) ((service)->idleDeadTime = (time))
162
163 /* Define procedures for getting and setting before and after execute-request procs */
164 #define rx_SetAfterProc(service,proc) ((service)->afterProc = (proc))
165 #define rx_SetBeforeProc(service,proc) ((service)->beforeProc = (proc))
166 #define rx_GetAfterProc(service) ((service)->afterProc)
167 #define rx_GetBeforeProc(service) ((service)->beforeProc)
168
169 /* Define a procedure to be called when a server connection is created */
170 #define rx_SetNewConnProc(service, proc) ((service)->newConnProc = (proc))
171
172 /* NOTE:  We'll probably redefine the following three routines, again, sometime. */
173
174 /* Set the connection dead time for any connections created for this service (server only) */
175 #define rx_SetServiceDeadTime(service, seconds) ((service)->secondsUntilDead = (seconds))
176
177 /* Enable or disable asymmetric client checking for a service */
178 #define rx_SetCheckReach(service, x) ((service)->checkReach = (x))
179
180 /* Set connection hard and idle timeouts for a connection */
181 #define rx_SetConnHardDeadTime(conn, seconds) ((conn)->hardDeadTime = (seconds))
182 #define rx_SetConnIdleDeadTime(conn, seconds) ((conn)->idleDeadTime = (seconds))
183
184 /* Set the overload threshold and the overload error */
185 #define rx_SetBusyThreshold(threshold, code) (rx_BusyThreshold=(threshold),rx_BusyError=(code))
186
187 /* If this flag is set,no new requests are processed by rx, all new requests are
188 returned with an error code of RX_CALL_DEAD ( transient error ) */
189 #define rx_SetRxTranquil()              (rx_tranquil = 1)
190 #define rx_ClearRxTranquil()            (rx_tranquil = 0)
191
192 /* Set the threshold and time to delay aborts for consecutive errors */
193 #define rx_SetCallAbortThreshold(A) (rxi_callAbortThreshhold = (A))
194 #define rx_SetCallAbortDelay(A) (rxi_callAbortDelay = (A))
195 #define rx_SetConnAbortThreshold(A) (rxi_connAbortThreshhold = (A))
196 #define rx_SetConnAbortDelay(A) (rxi_connAbortDelay = (A))
197
198 #define rx_GetCallAbortCode(call) ((call)->abortCode)
199 #define rx_SetCallAbortCode(call, code) ((call)->abortCode = (code))
200
201 #define cpspace(call) ((call)->curlen)
202 #define cppos(call) ((call)->curpos)
203
204 #define rx_Read(call, buf, nbytes)   rx_ReadProc(call, buf, nbytes)
205 #define rx_Read32(call, value)   rx_ReadProc32(call, value)
206 #define rx_Readv(call, iov, nio, maxio, nbytes) \
207    rx_ReadvProc(call, iov, nio, maxio, nbytes)
208 #define rx_Write(call, buf, nbytes) rx_WriteProc(call, buf, nbytes)
209 #define rx_Write32(call, value) rx_WriteProc32(call, value)
210 #define rx_Writev(call, iov, nio, nbytes) \
211    rx_WritevProc(call, iov, nio, nbytes)
212
213 /* This is the maximum size data packet that can be sent on this connection, accounting for security module-specific overheads. */
214 #define rx_MaxUserDataSize(call)                ((call)->MTU - RX_HEADER_SIZE - (call)->conn->securityHeaderSize - (call)->conn->securityMaxTrailerSize)
215
216 /* Macros to turn the hot thread feature on and off. Enabling hot threads
217  * allows the listener thread to trade places with an idle worker thread,
218  * which moves the context switch from listener to worker out of the
219  * critical path.
220  */
221 #define rx_EnableHotThread()            (rx_enable_hot_thread = 1)
222 #define rx_DisableHotThread()           (rx_enable_hot_thread = 0)
223
224 #define rx_PutConnection(conn) rx_DestroyConnection(conn)
225
226 /* A connection is an authenticated communication path, allowing 
227    limited multiple asynchronous conversations. */
228 #ifdef KDUMP_RX_LOCK
229 struct rx_connection_rx_lock {
230     struct rx_connection_rx_lock *next; /*  on hash chain _or_ free list */
231     struct rx_peer_rx_lock *peer;
232 #else
233 struct rx_connection {
234     struct rx_connection *next; /*  on hash chain _or_ free list */
235     struct rx_peer *peer;
236 #endif
237 #ifdef  RX_ENABLE_LOCKS
238     afs_kmutex_t conn_call_lock;        /* locks conn_call_cv */
239     afs_kcondvar_t conn_call_cv;
240     afs_kmutex_t conn_data_lock;        /* locks packet data */
241 #endif
242     afs_uint32 epoch;           /* Process start time of client side of connection */
243     afs_uint32 cid;             /* Connection id (call channel is bottom bits) */
244     afs_int32 error;            /* If this connection is in error, this is it */
245 #ifdef KDUMP_RX_LOCK
246     struct rx_call_rx_lock *call[RX_MAXCALLS];
247 #else
248     struct rx_call *call[RX_MAXCALLS];
249 #endif
250     afs_uint32 callNumber[RX_MAXCALLS]; /* Current call numbers */
251     afs_uint32 serial;          /* Next outgoing packet serial number */
252     afs_uint32 lastSerial;      /* # of last packet received, for computing skew */
253     afs_int32 maxSerial;        /* largest serial number seen on incoming packets */
254 /*    afs_int32 maxPacketSize;    max packet size should be per-connection since */
255     /* peer process could be restarted on us. Includes RX Header.       */
256     struct rxevent *challengeEvent;     /* Scheduled when the server is challenging a     */
257     struct rxevent *delayedAbortEvent;  /* Scheduled to throttle looping client */
258     struct rxevent *checkReachEvent;    /* Scheduled when checking reachability */
259     int abortCount;             /* count of abort messages sent */
260     /* client-- to retransmit the challenge */
261     struct rx_service *service; /* used by servers only */
262     u_short serviceId;          /* To stamp on requests (clients only) */
263     afs_uint32 refCount;                /* Reference count */
264     u_char flags;               /* Defined below */
265     u_char type;                /* Type of connection, defined below */
266     u_char secondsUntilPing;    /* how often to ping for each active call */
267     u_char securityIndex;       /* corresponds to the security class of the */
268     /* securityObject for this conn */
269     struct rx_securityClass *securityObject;    /* Security object for this connection */
270     VOID *securityData;         /* Private data for this conn's security class */
271     u_short securityHeaderSize; /* Length of security module's packet header data */
272     u_short securityMaxTrailerSize;     /* Length of security module's packet trailer data */
273
274     int timeout;                /* Overall timeout per call (seconds) for this conn */
275     int lastSendTime;           /* Last send time for this connection */
276     u_short secondsUntilDead;   /* Maximum silence from peer before RX_CALL_DEAD */
277     u_short hardDeadTime;       /* hard max for call execution */
278     u_short idleDeadTime;       /* max time a call can be idle (no data) */
279     u_char ackRate;             /* how many packets between ack requests */
280     u_char makeCallWaiters;     /* how many rx_NewCalls are waiting */
281     int nSpecific;              /* number entries in specific data */
282     void **specific;            /* pointer to connection specific data */
283 };
284
285
286 /* A service is installed by rx_NewService, and specifies a service type that
287  * is exported by this process.  Incoming calls are stamped with the service
288  * type, and must match an installed service for the call to be accepted.
289  * Each service exported has a (port,serviceId) pair to uniquely identify it.
290  * It is also named:  this is intended to allow a remote statistics gathering
291  * program to retrieve per service statistics without having to know the local
292  * service id's.  Each service has a number of
293  */
294
295 /* security objects (instances of security classes) which implement
296  * various types of end-to-end security protocols for connections made
297  * to this service.  Finally, there are two parameters controlling the
298  * number of requests which may be executed in parallel by this
299  * service: minProcs is the number of requests to this service which
300  * are guaranteed to be able to run in parallel at any time; maxProcs
301  * has two meanings: it limits the total number of requests which may
302  * execute in parallel and it also guarantees that that many requests
303  * may be handled in parallel if no other service is handling any
304  * requests. */
305
306 struct rx_service {
307     u_short serviceId;          /* Service number */
308     u_short servicePort;        /* UDP port for this service */
309     char *serviceName;          /* Name of the service */
310     osi_socket socket;          /* socket structure or file descriptor */
311     u_short nRequestsRunning;   /* Number of requests currently in progress */
312     u_short nSecurityObjects;   /* Number of entries in security objects array */
313     struct rx_securityClass **securityObjects;  /* Array of security class objects */
314       afs_int32(*executeRequestProc) (struct rx_call * acall);  /* Routine to call when an rpc request is received */
315     void (*destroyConnProc) (struct rx_connection * tcon);      /* Routine to call when a server connection is destroyed */
316     void (*newConnProc) (struct rx_connection * tcon);  /* Routine to call when a server connection is created */
317     void (*beforeProc) (struct rx_call * acall);        /* routine to call before a call is executed */
318     void (*afterProc) (struct rx_call * acall, afs_int32 code); /* routine to call after a call is executed */
319     u_short maxProcs;           /* Maximum procs to be used for this service */
320     u_short minProcs;           /* Minimum # of requests guaranteed executable simultaneously */
321     u_short connDeadTime;       /* Seconds until a client of this service will be declared dead, if it is not responding */
322     u_short idleDeadTime;       /* Time a server will wait for I/O to start up again */
323     u_char checkReach;          /* Check for asymmetric clients? */
324 };
325
326 #endif /* KDUMP_RX_LOCK */
327
328 /* A server puts itself on an idle queue for a service using an
329  * instance of the following structure.  When a call arrives, the call
330  * structure pointer is placed in "newcall", the routine to execute to
331  * service the request is placed in executeRequestProc, and the
332  * process is woken up.  The queue entry's address is used for the
333  * sleep/wakeup. If socketp is non-null, then this thread is willing
334  * to become a listener thread. A thread sets *socketp to -1 before
335  * sleeping. If *socketp is not -1 when the thread awakes, it is now
336  * the listener thread for *socketp. When socketp is non-null, tno
337  * contains the server's threadID, which is used to make decitions in GetCall.
338  */
339 #ifdef KDUMP_RX_LOCK
340 struct rx_serverQueueEntry_rx_lock {
341 #else
342 struct rx_serverQueueEntry {
343 #endif
344     struct rx_queue queueItemHeader;
345 #ifdef KDUMP_RX_LOCK
346     struct rx_call_rx_lock *newcall;
347 #else
348     struct rx_call *newcall;
349 #endif
350 #ifdef  RX_ENABLE_LOCKS
351     afs_kmutex_t lock;
352     afs_kcondvar_t cv;
353 #endif
354     int tno;
355     osi_socket *socketp;
356 };
357
358 /* If we don't support IPv6, use this as a fallback */
359 #ifndef INET6_ADDRSTRLEN
360 #define INET6_ADDRSTRLEN 46
361 #endif /* INET6_ADDRSTRLEN */
362
363 /* A peer refers to a peer process, specified by a (host,port) pair.  There may be more than one peer on a given host. */
364 #ifdef KDUMP_RX_LOCK
365 struct rx_peer_rx_lock {
366     struct rx_peer_rx_lock *next;       /* Next in hash conflict or free list */
367 #else
368 struct rx_peer {
369     struct rx_peer *next;       /* Next in hash conflict or free list */
370 #endif
371 #ifdef RX_ENABLE_LOCKS
372     afs_kmutex_t peer_lock;     /* Lock peer */
373 #endif                          /* RX_ENABLE_LOCKS */
374     struct sockaddr_storage saddr;      /* Remote address structure */
375     int saddrlen;                       /* Length of saddr */
376     int socktype;                       /* Socket type (SOCK_DGRAM, etc) */
377     char addrstring[INET6_ADDRSTRLEN];  /* Printable address format */
378
379     /* interface mtu probably used for this host  -  includes RX Header */
380     u_short ifMTU;              /* doesn't include IP header */
381
382     /* For garbage collection */
383     afs_uint32 idleWhen;        /* When the refcountwent to zero */
384     afs_uint32 refCount;                /* Reference count for this structure */
385
386     /* Congestion control parameters */
387     u_char burstSize;           /* Reinitialization size for the burst parameter */
388     u_char burst;               /* Number of packets that can be transmitted right now, without pausing */
389     struct clock burstWait;     /* Delay until new burst is allowed */
390     struct rx_queue congestionQueue;    /* Calls that are waiting for non-zero burst value */
391     int rtt;                    /* Round trip time, measured in milliseconds/8 */
392     int rtt_dev;                /* rtt smoothed error, in milliseconds/4 */
393     struct clock timeout;       /* Current retransmission delay */
394     int nSent;                  /* Total number of distinct data packets sent, not including retransmissions */
395     int reSends;                /* Total number of retransmissions for this peer, since this structure was created */
396
397 /* Skew: if a packet is received N packets later than expected (based
398  * on packet serial numbers), then we define it to have a skew of N.
399  * The maximum skew values allow us to decide when a packet hasn't
400  * been received yet because it is out-of-order, as opposed to when it
401  * is likely to have been dropped. */
402     afs_uint32 inPacketSkew;    /* Maximum skew on incoming packets */
403     afs_uint32 outPacketSkew;   /* Peer-reported max skew on our sent packets */
404     int rateFlag;               /* Flag for rate testing (-no 0yes +decrement) */
405
406     /* the "natural" MTU, excluding IP,UDP headers, is negotiated by the endpoints */
407     u_short natMTU;
408     u_short maxMTU;
409     /* negotiated maximum number of packets to send in a single datagram. */
410     u_short maxDgramPackets;
411     /* local maximum number of packets to send in a single datagram. */
412     u_short ifDgramPackets;
413     /*
414      * MTU, cwind, and nDgramPackets are used to initialize
415      * slow start parameters for new calls. These values are set whenever a
416      * call sends a retransmission and at the end of each call.
417      * congestSeq is incremented each time the congestion parameters are
418      * changed by a call recovering from a dropped packet. A call used
419      * MAX when updating congestion parameters if it started with the
420      * current congestion sequence number, otherwise it uses MIN.
421      */
422     u_short MTU;                /* MTU for AFS 3.4a jumboGrams */
423     u_short cwind;              /* congestion window */
424     u_short nDgramPackets;      /* number packets per AFS 3.5 jumbogram */
425     u_short congestSeq;         /* Changed when a call retransmits */
426     afs_hyper_t bytesSent;      /* Number of bytes sent to this peer */
427     afs_hyper_t bytesReceived;  /* Number of bytes received from this peer */
428     struct rx_queue rpcStats;   /* rpc statistic list */
429     int lastReachTime;          /* Last time we verified reachability */
430 };
431
432
433 #ifndef KDUMP_RX_LOCK
434 /* Flag bits for connection structure */
435 #define RX_CONN_MAKECALL_WAITING    1   /* rx_MakeCall is waiting for a channel */
436 #define RX_CONN_DESTROY_ME          2   /* Destroy *client* connection after last call */
437 #define RX_CONN_USING_PACKET_CKSUM  4   /* non-zero header.spare field seen */
438 #define RX_CONN_KNOW_WINDOW         8   /* window size negotiation works */
439 #define RX_CONN_RESET              16   /* connection is reset, remove */
440 #define RX_CONN_BUSY               32   /* connection is busy; don't delete */
441 #define RX_CONN_ATTACHWAIT         64   /* attach waiting for peer->lastReach */
442
443 /* Type of connection, client or server */
444 #define RX_CLIENT_CONNECTION    0
445 #define RX_SERVER_CONNECTION    1
446 #endif /* !KDUMP_RX_LOCK */
447
448 /* Call structure:  only instantiated for active calls and dallying server calls.  The permanent call state (i.e. the call number as well as state shared with other calls associated with this connection) is maintained in the connection structure. */
449 #ifdef KDUMP_RX_LOCK
450 struct rx_call_rx_lock {
451 #else
452 struct rx_call {
453 #endif
454     struct rx_queue queue_item_header;  /* Call can be on various queues (one-at-a-time) */
455     struct rx_queue tq;         /* Transmit packet queue */
456     struct rx_queue rq;         /* Receive packet queue */
457     /*
458      * The following fields are accessed while the call is unlocked.
459      * These fields are used by the caller/server thread to marshall
460      * and unmarshall RPC data. The only time they may be changed by
461      * other threads is when the RX_CALL_IOVEC_WAIT flag is set. 
462      * 
463      * NOTE: Be sure that these fields start and end on a double
464      *       word boundary. Otherwise threads that are changing
465      *       adjacent fields will cause problems.
466      */
467     struct rx_queue iovq;       /* readv/writev packet queue */
468     u_short nLeft;              /* Number bytes left in first receive packet */
469     u_short curvec;             /* current iovec in currentPacket */
470     u_short curlen;             /* bytes remaining in curvec */
471     u_short nFree;              /* Number bytes free in last send packet */
472     struct rx_packet *currentPacket;    /* Current packet being assembled or being read */
473     char *curpos;               /* current position in curvec */
474     /*
475      * End of fields accessed with call unlocked
476      */
477     u_char channel;             /* Index of call, within connection */
478     u_char state;               /* Current call state as defined below */
479     u_char mode;                /* Current mode of a call in ACTIVE state */
480 #ifdef  RX_ENABLE_LOCKS
481     afs_kmutex_t lock;          /* lock covers data as well as mutexes. */
482     afs_kmutex_t *call_queue_lock;      /* points to lock for queue we're on,
483                                          * if any. */
484     afs_kcondvar_t cv_twind;
485     afs_kcondvar_t cv_rq;
486     afs_kcondvar_t cv_tq;
487 #endif
488 #ifdef KDUMP_RX_LOCK
489     struct rx_connection_rx_lock *conn; /* Parent connection for call */
490 #else
491     struct rx_connection *conn; /* Parent connection for this call */
492 #endif
493     afs_uint32 *callNumber;     /* Pointer to call number field within connection */
494     afs_uint32 flags;           /* Some random flags */
495     u_char localStatus;         /* Local user status sent out of band */
496     u_char remoteStatus;        /* Remote user status received out of band */
497     afs_int32 error;            /* Error condition for this call */
498     afs_uint32 timeout;         /* High level timeout for this call */
499     afs_uint32 rnext;           /* Next sequence number expected to be read by rx_ReadData */
500     afs_uint32 rprev;           /* Previous packet received; used for deciding what the next packet to be received should be, in order to decide whether a negative acknowledge should be sent */
501     afs_uint32 rwind;           /* The receive window:  the peer must not send packets with sequence numbers >= rnext+rwind */
502     afs_uint32 tfirst;          /* First unacknowledged transmit packet number */
503     afs_uint32 tnext;           /* Next transmit sequence number to use */
504     u_short twind;              /* The transmit window:  we cannot assign a sequence number to a packet >= tfirst + twind */
505     u_short cwind;              /* The congestion window */
506     u_short nSoftAcked;         /* Number soft acked transmit packets */
507     u_short nextCwind;          /* The congestion window after recovery */
508     u_short nCwindAcks;         /* Number acks received at current cwind */
509     u_short ssthresh;           /* The slow start threshold */
510     u_short nDgramPackets;      /* Packets per AFS 3.5 jumbogram */
511     u_short nAcks;              /* The number of consecttive acks */
512     u_short nNacks;             /* Number packets acked that follow the
513                                  * first negatively acked packet */
514     u_short nSoftAcks;          /* The number of delayed soft acks */
515     u_short nHardAcks;          /* The number of delayed hard acks */
516     u_short congestSeq;         /* Peer's congestion sequence counter */
517     struct rxevent *resendEvent;        /* If this is non-Null, there is a retransmission event pending */
518     struct rxevent *timeoutEvent;       /* If this is non-Null, then there is an overall timeout for this call */
519     struct rxevent *keepAliveEvent;     /* Scheduled periodically in active calls to keep call alive */
520     struct rxevent *delayedAckEvent;    /* Scheduled after all packets are received to send an ack if a reply or new call is not generated soon */
521     struct rxevent *delayedAbortEvent;  /* Scheduled to throttle looping client */
522     int abortCode;              /* error code from last RPC */
523     int abortCount;             /* number of times last error was sent */
524     u_int lastSendTime;         /* Last time a packet was sent on this call */
525     u_int lastReceiveTime;      /* Last time a packet was received for this call */
526     void (*arrivalProc) (register struct rx_call * call, register VOID * mh, register int index);       /* Procedure to call when reply is received */
527     VOID *arrivalProcHandle;    /* Handle to pass to replyFunc */
528     int arrivalProcArg;         /* Additional arg to pass to reply Proc */
529     afs_uint32 lastAcked;       /* last packet "hard" acked by receiver */
530     afs_uint32 startWait;       /* time server began waiting for input data/send quota */
531     struct clock traceWait;     /* time server began waiting for input data/send quota */
532     struct clock traceStart;    /* time the call started running */
533     u_short MTU;                /* size of packets currently sending */
534 #ifdef RX_ENABLE_LOCKS
535     short refCount;             /* Used to keep calls from disappearring
536                                  * when we get them from a queue. */
537 #endif                          /* RX_ENABLE_LOCKS */
538 /* Call refcount modifiers */
539 #define RX_CALL_REFCOUNT_BEGIN  0       /* GetCall/NewCall/EndCall */
540 #define RX_CALL_REFCOUNT_RESEND 1       /* resend event */
541 #define RX_CALL_REFCOUNT_DELAY  2       /* delayed ack */
542 #define RX_CALL_REFCOUNT_ALIVE  3       /* keep alive event */
543 #define RX_CALL_REFCOUNT_PACKET 4       /* waiting for packets. */
544 #define RX_CALL_REFCOUNT_SEND   5       /* rxi_Send */
545 #define RX_CALL_REFCOUNT_ACKALL 6       /* rxi_AckAll */
546 #define RX_CALL_REFCOUNT_ABORT  7       /* delayed abort */
547 #define RX_CALL_REFCOUNT_MAX    8       /* array size. */
548 #ifdef RX_REFCOUNT_CHECK
549     short refCDebug[RX_CALL_REFCOUNT_MAX];
550 #endif                          /* RX_REFCOUNT_CHECK */
551     int iovNBytes;              /* byte count for current iovec */
552     int iovMax;                 /* number elements in current iovec */
553     int iovNext;                /* next entry in current iovec */
554     struct iovec *iov;          /* current iovec */
555     struct clock queueTime;     /* time call was queued */
556     struct clock startTime;     /* time call was started */
557     afs_hyper_t bytesSent;      /* Number bytes sent */
558     afs_hyper_t bytesRcvd;      /* Number bytes received */
559     u_short tqWaiters;
560 };
561
562 #ifndef KDUMP_RX_LOCK
563 /* Major call states */
564 #define RX_STATE_NOTINIT  0     /* Call structure has never been initialized */
565 #define RX_STATE_PRECALL  1     /* Server-only:  call is not in progress, but packets have arrived */
566 #define RX_STATE_ACTIVE   2     /* An active call; a process is dealing with this call */
567 #define RX_STATE_DALLY    3     /* Dallying after process is done with call */
568 #define RX_STATE_HOLD     4     /* Waiting for acks on reply data packets */
569
570 /* Call modes:  the modes of a call in RX_STATE_ACTIVE state (process attached) */
571 #define RX_MODE_SENDING   1     /* Sending or ready to send */
572 #define RX_MODE_RECEIVING 2     /* Receiving or ready to receive */
573 #define RX_MODE_ERROR     3     /* Something in error for current conversation */
574 #define RX_MODE_EOF       4     /* Server has flushed (or client has read) last reply packet */
575
576 /* Flags */
577 #define RX_CALL_READER_WAIT        1    /* Reader is waiting for next packet */
578 #define RX_CALL_WAIT_WINDOW_ALLOC  2    /* Sender is waiting for window to allocate buffers */
579 #define RX_CALL_WAIT_WINDOW_SEND   4    /* Sender is waiting for window to send buffers */
580 #define RX_CALL_WAIT_PACKETS       8    /* Sender is waiting for packet buffers */
581 #define RX_CALL_WAIT_PROC         16    /* Waiting for a process to be assigned */
582 #define RX_CALL_RECEIVE_DONE      32    /* All packets received on this call */
583 #define RX_CALL_CLEARED           64    /* Receive queue cleared in precall state */
584 #define RX_CALL_TQ_BUSY          128    /* Call's Xmit Queue is busy; don't modify */
585 #define RX_CALL_TQ_CLEARME       256    /* Need to clear this call's TQ later */
586 #define RX_CALL_TQ_SOME_ACKED    512    /* rxi_Start needs to discard ack'd packets. */
587 #define RX_CALL_TQ_WAIT         1024    /* Reader is waiting for TQ_BUSY to be reset */
588 #define RX_CALL_FAST_RECOVER    2048    /* call is doing congestion recovery */
589 #define RX_CALL_FAST_RECOVER_WAIT 4096  /* thread is waiting to start recovery */
590 #define RX_CALL_SLOW_START_OK   8192    /* receiver acks every other packet */
591 #define RX_CALL_IOVEC_WAIT      16384   /* waiting thread is using an iovec */
592 #define RX_CALL_HAVE_LAST       32768   /* Last packet has been received */
593 #define RX_CALL_NEED_START      0x10000 /* tells rxi_Start to start again */
594
595 /* Maximum number of acknowledgements in an acknowledge packet */
596 #define RX_MAXACKS          255
597
598 /* The structure of the data portion of an acknowledge packet: An acknowledge
599  * packet is in network byte order at all times.  An acknowledgement is always
600  * prompted for a specific reason by a specific incoming packet.  This reason
601  * is reported in "reason" and the packet's sequence number in the packet
602  * header.seq.  In addition to this information, all of the current
603  * acknowledgement information about this call is placed in the packet.
604  * "FirstPacket" is the sequence number of the first packet represented in an
605  * array of bytes, "acks", containing acknowledgement information for a number
606  * of consecutive packets.  All packets prior to FirstPacket are implicitly
607  * acknowledged: the sender need no longer be concerned about them.  Packets
608  * from firstPacket+nAcks and on are not acknowledged.  Packets in the range
609  * [firstPacket,firstPacket+nAcks) are each acknowledged explicitly.  The
610  * acknowledgement may be RX_NACK if the packet is not (currently) at the
611  * receiver (it may have never been received, or received and then later
612  * dropped), or it may be RX_ACK if the packet is queued up waiting to be read
613  * by the upper level software.  RX_ACK does not imply that the packet may not
614  * be dropped before it is read; it does imply that the sender should stop
615  * retransmitting the packet until notified otherwise.  The field
616  * previousPacket identifies the previous packet received by the peer.  This
617  * was used in a previous version of this software, and could be used in the
618  * future.  The serial number in the data part of the ack packet corresponds to
619  * the serial number oof the packet which prompted the acknowledge.  Any
620  * packets which are explicitly not acknowledged, and which were last
621  * transmitted with a serial number less than the provided serial number,
622  * should be retransmitted immediately.  Actually, this is slightly inaccurate:
623  * packets are not necessarily received in order.  When packets are habitually
624  * transmitted out of order, this is allowed for in the retransmission
625  * algorithm by introducing the notion of maximum packet skew: the degree of
626  * out-of-orderness of the packets received on the wire.  This number is
627  * communicated from the receiver to the sender in ack packets. */
628
629 struct rx_ackPacket {
630     u_short bufferSpace;        /* Number of packet buffers available.  That is:  the number of buffers that the sender of the ack packet is willing to provide for data, on this or subsequent calls.  Lying is permissable. */
631     u_short maxSkew;            /* Maximum difference between serial# of packet acknowledged and highest packet yet received */
632     afs_uint32 firstPacket;     /* The first packet in the list of acknowledged packets */
633     afs_uint32 previousPacket;  /* The previous packet number received (obsolete?) */
634     afs_uint32 serial;          /* Serial number of the packet which prompted the acknowledge */
635     u_char reason;              /* Reason for the acknowledge of ackPacket, defined below */
636     u_char nAcks;               /* Number of acknowledgements */
637     u_char acks[RX_MAXACKS];    /* Up to RX_MAXACKS packet acknowledgements, defined below */
638     /* Packets <firstPacket are implicitly acknowledged and may be discarded by the sender.  Packets >= firstPacket+nAcks are implicitly NOT acknowledged.  No packets with sequence numbers >= firstPacket should be discarded by the sender (they may thrown out at any time by the receiver) */
639 };
640
641 #define FIRSTACKOFFSET 4
642
643 /* Reason for acknowledge message */
644 #define RX_ACK_REQUESTED        1       /* Peer requested an ack on this packet */
645 #define RX_ACK_DUPLICATE        2       /* Duplicate packet */
646 #define RX_ACK_OUT_OF_SEQUENCE  3       /* Packet out of sequence */
647 #define RX_ACK_EXCEEDS_WINDOW   4       /* Packet sequence number higher than window; discarded */
648 #define RX_ACK_NOSPACE          5       /* No buffer space at all */
649 #define RX_ACK_PING             6       /* This is a keep-alive ack */
650 #define RX_ACK_PING_RESPONSE    7       /* Ack'ing because we were pinged */
651 #define RX_ACK_DELAY            8       /* Ack generated since nothing has happened since receiving packet */
652 #define RX_ACK_IDLE             9       /* Similar to RX_ACK_DELAY, but can 
653                                          * be */
654
655 /* Packet acknowledgement type */
656 #define RX_ACK_TYPE_NACK        0       /* I Don't have this packet */
657 #define RX_ACK_TYPE_ACK         1       /* I have this packet, although I may discard it later */
658
659 /* The packet size transmitted for an acknowledge is adjusted to reflect the actual size of the acks array.  This macro defines the size */
660 #define rx_AckDataSize(nAcks) (3 + nAcks + offsetof(struct rx_ackPacket, acks[0]))
661
662 #define RX_CHALLENGE_TIMEOUT    2       /* Number of seconds before another authentication request packet is generated */
663 #define RX_CHALLENGE_MAXTRIES   50      /* Max # of times we resend challenge */
664 #define RX_CHECKREACH_TIMEOUT   2       /* Number of seconds before another ping is generated */
665 #define RX_CHECKREACH_TTL       60      /* Re-check reachability this often */
666
667 /* RX error codes.  RX uses error codes from -1 to -64.  Rxgen may use other error codes < -64; user programs are expected to return positive error codes */
668
669 /* Something bad happened to the connection; temporary loss of communication */
670 #define RX_CALL_DEAD                (-1)
671
672 /* An invalid operation, such as a client attempting to send data after having received the beginning of a reply from the server */
673 #define RX_INVALID_OPERATION        (-2)
674
675 /* An optional timeout per call may be specified */
676 #define RX_CALL_TIMEOUT             (-3)
677
678 /* End of data on a read */
679 #define RX_EOF                      (-4)
680
681 /* Some sort of low-level protocol error */
682 #define RX_PROTOCOL_ERROR           (-5)
683
684 /* Generic user abort code; used when no more specific error code needs to be communicated.  For example, multi rx clients use this code to abort a multi rx call */
685 #define RX_USER_ABORT               (-6)
686
687 /* Port already in use (from rx_Init) */
688 #define RX_ADDRINUSE                (-7)
689
690 /* EMSGSIZE returned from network.  Packet too big, must fragment */
691 #define RX_MSGSIZE                  (-8)
692
693 /* transient failure detected ( possibly the server is restarting ) */
694 /* this shud be equal to VRESTARTING ( util/errors.h ) for old clients to work */
695 #define RX_RESTARTING               (-100)
696
697 struct rx_securityObjectStats {
698     char type;                  /* 0:unk 1:null,2:vab 3:kad */
699     char level;
700     char sparec[10];            /* force correct alignment */
701     afs_int32 flags;            /* 1=>unalloc, 2=>auth, 4=>expired */
702     afs_uint32 expires;
703     afs_uint32 packetsReceived;
704     afs_uint32 packetsSent;
705     afs_uint32 bytesReceived;
706     afs_uint32 bytesSent;
707     short spares[4];
708     afs_int32 sparel[8];
709 };
710
711 /* XXXX (rewrite this description) A security class object contains a set of
712  * procedures and some private data to implement a security model for rx
713  * connections.  These routines are called by rx as appropriate.  Rx knows
714  * nothing about the internal details of any particular security model, or
715  * about security state.  Rx does maintain state per connection on behalf of
716  * the security class.  Each security class implementation is also expected to
717  * provide routines to create these objects.  Rx provides a basic routine to
718  * allocate one of these objects; this routine must be called by the class. */
719 struct rx_securityClass {
720     struct rx_securityOps {
721         int (*op_Close) (struct rx_securityClass * aobj);
722         int (*op_NewConnection) (struct rx_securityClass * aobj,
723                                  struct rx_connection * aconn);
724         int (*op_PreparePacket) (struct rx_securityClass * aobj,
725                                  struct rx_call * acall,
726                                  struct rx_packet * apacket);
727         int (*op_SendPacket) (struct rx_securityClass * aobj,
728                               struct rx_call * acall,
729                               struct rx_packet * apacket);
730         int (*op_CheckAuthentication) (struct rx_securityClass * aobj,
731                                        struct rx_connection * aconn);
732         int (*op_CreateChallenge) (struct rx_securityClass * aobj,
733                                    struct rx_connection * aconn);
734         int (*op_GetChallenge) (struct rx_securityClass * aobj,
735                                 struct rx_connection * aconn,
736                                 struct rx_packet * apacket);
737         int (*op_GetResponse) (struct rx_securityClass * aobj,
738                                struct rx_connection * aconn,
739                                struct rx_packet * apacket);
740         int (*op_CheckResponse) (struct rx_securityClass * aobj,
741                                  struct rx_connection * aconn,
742                                  struct rx_packet * apacket);
743         int (*op_CheckPacket) (struct rx_securityClass * aobj,
744                                struct rx_call * acall,
745                                struct rx_packet * apacket);
746         int (*op_DestroyConnection) (struct rx_securityClass * aobj,
747                                      struct rx_connection * aconn);
748         int (*op_GetStats) (struct rx_securityClass * aobj,
749                             struct rx_connection * aconn,
750                             struct rx_securityObjectStats * astats);
751         int (*op_Spare1) (void);
752         int (*op_Spare2) (void);
753         int (*op_Spare3) (void);
754     } *ops;
755     VOID *privateData;
756     int refCount;
757 };
758
759 #define RXS_OP(obj,op,args) ((obj && (obj->ops->op_ ## op)) ? (*(obj)->ops->op_ ## op)args : 0)
760
761 #define RXS_Close(obj) RXS_OP(obj,Close,(obj))
762 #define RXS_NewConnection(obj,conn) RXS_OP(obj,NewConnection,(obj,conn))
763 #define RXS_PreparePacket(obj,call,packet) RXS_OP(obj,PreparePacket,(obj,call,packet))
764 #define RXS_SendPacket(obj,call,packet) RXS_OP(obj,SendPacket,(obj,call,packet))
765 #define RXS_CheckAuthentication(obj,conn) RXS_OP(obj,CheckAuthentication,(obj,conn))
766 #define RXS_CreateChallenge(obj,conn) RXS_OP(obj,CreateChallenge,(obj,conn))
767 #define RXS_GetChallenge(obj,conn,packet) RXS_OP(obj,GetChallenge,(obj,conn,packet))
768 #define RXS_GetResponse(obj,conn,packet) RXS_OP(obj,GetResponse,(obj,conn,packet))
769 #define RXS_CheckResponse(obj,conn,packet) RXS_OP(obj,CheckResponse,(obj,conn,packet))
770 #define RXS_CheckPacket(obj,call,packet) RXS_OP(obj,CheckPacket,(obj,call,packet))
771 #define RXS_DestroyConnection(obj,conn) RXS_OP(obj,DestroyConnection,(obj,conn))
772 #define RXS_GetStats(obj,conn,stats) RXS_OP(obj,GetStats,(obj,conn,stats))
773
774
775
776 /* Structure for keeping rx statistics.  Note that this structure is returned
777  * by rxdebug, so, for compatibility reasons, new fields should be appended (or
778  * spares used), the rxdebug protocol checked, if necessary, and the PrintStats
779  * code should be updated as well.
780  *
781  * Clearly we assume that ntohl will work on these structures so sizeof(int)
782  * must equal sizeof(afs_int32). */
783
784 struct rx_stats {               /* General rx statistics */
785     int packetRequests;         /* Number of packet allocation requests */
786     int receivePktAllocFailures;
787     int sendPktAllocFailures;
788     int specialPktAllocFailures;
789     int socketGreedy;           /* Whether SO_GREEDY succeeded */
790     int bogusPacketOnRead;      /* Number of inappropriately short packets received */
791     int bogusHost;              /* Host address from bogus packets */
792     int noPacketOnRead;         /* Number of read packets attempted when there was actually no packet to read off the wire */
793     int noPacketBuffersOnRead;  /* Number of dropped data packets due to lack of packet buffers */
794     int selects;                /* Number of selects waiting for packet or timeout */
795     int sendSelects;            /* Number of selects forced when sending packet */
796     int packetsRead[RX_N_PACKET_TYPES]; /* Total number of packets read, per type */
797     int dataPacketsRead;        /* Number of unique data packets read off the wire */
798     int ackPacketsRead;         /* Number of ack packets read */
799     int dupPacketsRead;         /* Number of duplicate data packets read */
800     int spuriousPacketsRead;    /* Number of inappropriate data packets */
801     int packetsSent[RX_N_PACKET_TYPES]; /* Number of rxi_Sends: packets sent over the wire, per type */
802     int ackPacketsSent;         /* Number of acks sent */
803     int pingPacketsSent;        /* Total number of ping packets sent */
804     int abortPacketsSent;       /* Total number of aborts */
805     int busyPacketsSent;        /* Total number of busies sent received */
806     int dataPacketsSent;        /* Number of unique data packets sent */
807     int dataPacketsReSent;      /* Number of retransmissions */
808     int dataPacketsPushed;      /* Number of retransmissions pushed early by a NACK */
809     int ignoreAckedPacket;      /* Number of packets with acked flag, on rxi_Start */
810     struct clock totalRtt;      /* Total round trip time measured (use to compute average) */
811     struct clock minRtt;        /* Minimum round trip time measured */
812     struct clock maxRtt;        /* Maximum round trip time measured */
813     int nRttSamples;            /* Total number of round trip samples */
814     int nServerConns;           /* Total number of server connections */
815     int nClientConns;           /* Total number of client connections */
816     int nPeerStructs;           /* Total number of peer structures */
817     int nCallStructs;           /* Total number of call structures allocated */
818     int nFreeCallStructs;       /* Total number of previously allocated free call structures */
819     int netSendFailures;
820     afs_int32 fatalErrors;
821     int ignorePacketDally;      /* packets dropped because call is in dally state */
822     int receiveCbufPktAllocFailures;
823     int sendCbufPktAllocFailures;
824     int nBusies;
825     int spares[4];
826 };
827
828 /* structures for debug input and output packets */
829
830 /* debug input types */
831 struct rx_debugIn {
832     afs_int32 type;
833     afs_int32 index;
834 };
835
836 /* Invalid rx debug package type */
837 #define RX_DEBUGI_BADTYPE     (-8)
838
839 #define RX_DEBUGI_VERSION_MINIMUM ('L') /* earliest real version */
840 #define RX_DEBUGI_VERSION     ('R')     /* Latest version */
841     /* first version w/ secStats */
842 #define RX_DEBUGI_VERSION_W_SECSTATS ('L')
843     /* version M is first supporting GETALLCONN and RXSTATS type */
844 #define RX_DEBUGI_VERSION_W_GETALLCONN ('M')
845 #define RX_DEBUGI_VERSION_W_RXSTATS ('M')
846     /* last version with unaligned debugConn */
847 #define RX_DEBUGI_VERSION_W_UNALIGNED_CONN ('L')
848 #define RX_DEBUGI_VERSION_W_WAITERS ('N')
849 #define RX_DEBUGI_VERSION_W_IDLETHREADS ('O')
850 #define RX_DEBUGI_VERSION_W_NEWPACKETTYPES ('P')
851 #define RX_DEBUGI_VERSION_W_GETPEER ('Q')
852 #define RX_DEBUGI_VERSION_W_WAITED ('R')
853
854 #define RX_DEBUGI_GETSTATS      1       /* get basic rx stats */
855 #define RX_DEBUGI_GETCONN       2       /* get connection info */
856 #define RX_DEBUGI_GETALLCONN    3       /* get even uninteresting conns */
857 #define RX_DEBUGI_RXSTATS       4       /* get all rx stats */
858 #define RX_DEBUGI_GETPEER       5       /* get all peer structs */
859
860 struct rx_debugStats {
861     afs_int32 nFreePackets;
862     afs_int32 packetReclaims;
863     afs_int32 callsExecuted;
864     char waitingForPackets;
865     char usedFDs;
866     char version;
867     char spare1;
868     afs_int32 nWaiting;
869     afs_int32 idleThreads;      /* Number of server threads that are idle */
870     afs_int32 nWaited;
871     afs_int32 spare2[7];
872 };
873
874 struct rx_debugConn_vL {
875     afs_int32 host;
876     afs_int32 cid;
877     afs_int32 serial;
878     afs_int32 callNumber[RX_MAXCALLS];
879     afs_int32 error;
880     short port;
881     char flags;
882     char type;
883     char securityIndex;
884     char callState[RX_MAXCALLS];
885     char callMode[RX_MAXCALLS];
886     char callFlags[RX_MAXCALLS];
887     char callOther[RX_MAXCALLS];
888     /* old style getconn stops here */
889     struct rx_securityObjectStats secStats;
890     afs_int32 sparel[10];
891 };
892
893 struct rx_debugConn {
894     afs_int32 host;
895     afs_int32 cid;
896     afs_int32 serial;
897     afs_int32 callNumber[RX_MAXCALLS];
898     afs_int32 error;
899     short port;
900     char flags;
901     char type;
902     char securityIndex;
903     char sparec[3];             /* force correct alignment */
904     char callState[RX_MAXCALLS];
905     char callMode[RX_MAXCALLS];
906     char callFlags[RX_MAXCALLS];
907     char callOther[RX_MAXCALLS];
908     /* old style getconn stops here */
909     struct rx_securityObjectStats secStats;
910     afs_int32 epoch;
911     afs_int32 natMTU;
912     afs_int32 sparel[9];
913 };
914
915 struct rx_debugPeer {
916     afs_uint32 host;
917     u_short port;
918     u_short ifMTU;
919     afs_uint32 idleWhen;
920     short refCount;
921     u_char burstSize;
922     u_char burst;
923     struct clock burstWait;
924     afs_int32 rtt;
925     afs_int32 rtt_dev;
926     struct clock timeout;
927     afs_int32 nSent;
928     afs_int32 reSends;
929     afs_int32 inPacketSkew;
930     afs_int32 outPacketSkew;
931     afs_int32 rateFlag;
932     u_short natMTU;
933     u_short maxMTU;
934     u_short maxDgramPackets;
935     u_short ifDgramPackets;
936     u_short MTU;
937     u_short cwind;
938     u_short nDgramPackets;
939     u_short congestSeq;
940     afs_hyper_t bytesSent;
941     afs_hyper_t bytesReceived;
942     afs_int32 sparel[10];
943 };
944
945 #define RX_OTHER_IN     1       /* packets avail in in queue */
946 #define RX_OTHER_OUT    2       /* packets avail in out queue */
947
948
949
950 /* Only include this once, even when re-loading for kdump. */
951 #ifndef _CALL_REF_DEFINED_
952 #define _CALL_REF_DEFINED_
953
954 #ifdef RX_ENABLE_LOCKS
955 #ifdef RX_REFCOUNT_CHECK
956 /* RX_REFCOUNT_CHECK is used to test for call refcount leaks by event
957  * type.
958  */
959 extern int rx_callHoldType;
960 #define CALL_HOLD(call, type) do { \
961                                  call->refCount++; \
962                                  call->refCDebug[type]++; \
963                                  if (call->refCDebug[type] > 50)  {\
964                                      rx_callHoldType = type; \
965                                      osi_Panic("Huge call refCount"); \
966                                                                } \
967                              } while (0)
968 #define CALL_RELE(call, type) do { \
969                                  call->refCount--; \
970                                  call->refCDebug[type]--; \
971                                  if (call->refCDebug[type] > 50) {\
972                                      rx_callHoldType = type; \
973                                      osi_Panic("Negative call refCount"); \
974                                                               } \
975                              } while (0)
976 #else /* RX_REFCOUNT_CHECK */
977 #define CALL_HOLD(call, type)    call->refCount++
978 #define CALL_RELE(call, type)    call->refCount--
979 #endif /* RX_REFCOUNT_CHECK */
980
981 #else /* RX_ENABLE_LOCKS */
982 #define CALL_HOLD(call, type)
983 #define CALL_RELE(call, type)
984 #endif /* RX_ENABLE_LOCKS */
985
986 #endif /* _CALL_REF_DEFINED_ */
987
988 #define RX_SERVER_DEBUG_SEC_STATS               0x1
989 #define RX_SERVER_DEBUG_ALL_CONN                0x2
990 #define RX_SERVER_DEBUG_RX_STATS                0x4
991 #define RX_SERVER_DEBUG_WAITER_CNT              0x8
992 #define RX_SERVER_DEBUG_IDLE_THREADS            0x10
993 #define RX_SERVER_DEBUG_OLD_CONN                0x20
994 #define RX_SERVER_DEBUG_NEW_PACKETS             0x40
995 #define RX_SERVER_DEBUG_ALL_PEER                0x80
996 #define RX_SERVER_DEBUG_WAITED_CNT              0x100
997
998 #define AFS_RX_STATS_CLEAR_ALL                  0xffffffff
999 #define AFS_RX_STATS_CLEAR_INVOCATIONS          0x1
1000 #define AFS_RX_STATS_CLEAR_BYTES_SENT           0x2
1001 #define AFS_RX_STATS_CLEAR_BYTES_RCVD           0x4
1002 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SUM       0x8
1003 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SQUARE    0x10
1004 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MIN       0x20
1005 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MAX       0x40
1006 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SUM        0x80
1007 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SQUARE     0x100
1008 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MIN        0x200
1009 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MAX        0x400
1010
1011 typedef struct rx_function_entry_v1 {
1012     afs_uint32 remote_peer;
1013     afs_uint32 remote_port;
1014     afs_uint32 remote_is_server;
1015     afs_uint32 interfaceId;
1016     afs_uint32 func_total;
1017     afs_uint32 func_index;
1018     afs_hyper_t invocations;
1019     afs_hyper_t bytes_sent;
1020     afs_hyper_t bytes_rcvd;
1021     struct clock queue_time_sum;
1022     struct clock queue_time_sum_sqr;
1023     struct clock queue_time_min;
1024     struct clock queue_time_max;
1025     struct clock execution_time_sum;
1026     struct clock execution_time_sum_sqr;
1027     struct clock execution_time_min;
1028     struct clock execution_time_max;
1029 } rx_function_entry_v1_t, *rx_function_entry_v1_p;
1030
1031 /*
1032  * If you need to change rx_function_entry, you should probably create a brand
1033  * new structure.  Keeping the old structure will allow backwards compatibility
1034  * with old clients (even if it is only used to calculate allocation size).
1035  * If you do change the size or the format, you'll need to bump
1036  * RX_STATS_RETRIEVAL_VERSION.  This allows some primitive form
1037  * of versioning a la rxdebug.
1038  */
1039
1040 #define RX_STATS_RETRIEVAL_VERSION 1    /* latest version */
1041 #define RX_STATS_RETRIEVAL_FIRST_EDITION 1      /* first implementation */
1042
1043 typedef struct rx_interface_stat {
1044     struct rx_queue queue_header;
1045     struct rx_queue all_peers;
1046     rx_function_entry_v1_t stats[1];    /* make sure this is aligned correctly */
1047 } rx_interface_stat_t, *rx_interface_stat_p;
1048
1049 #define RX_STATS_SERVICE_ID 409
1050
1051 /*
1052  * Definitions for handling struct sockaddr_storage casts, and IPv6
1053  */
1054
1055 #ifdef AF_INET6
1056 #define rx_ss2pn(x) ((x)->ss_family == AF_INET6 ? \
1057                         ((struct sockaddr_in6 *) (x))->sin6_port : \
1058                         ((struct sockaddr_in *) (x))->sin_port)
1059 #define rx_ss2sin6(x) ((struct sockaddr_in6 *) (x))
1060 #define rx_ssfamily(x) ((x)->ss_family)
1061 #define rx_ss2addrp6(x) ((afs_uint16 *) &(((struct sockaddr_in6 *) (x))->sin6_addr.s6_addr))
1062 #define rx_ss2v4addr(x) ((x)->ss_family == AF_INET ? \
1063                         ((struct sockaddr_in *) (x))->sin_addr.s_addr : \
1064                         0xffffffff)
1065 #else /* AF_INET6 */
1066 #define rx_ss2pn(x) (((struct sockaddr_in *) (x))->sin_port)
1067 #define rx_ssfamily(x) (((struct sockaddr_in *) (x))->sin_family)
1068 #define rx_ss2v4addr(x) (((struct sockaddr_in *) (x))->sin_addr.s_addr)
1069 #endif /* AF_INET6 */
1070 #define rx_ss2sin(x) ((struct sockaddr_in *) (x))
1071 #define rx_ss2addrp(x) ((unsigned char *) &(((struct sockaddr_in *) (x))->sin_addr.s_addr))
1072
1073 #endif /* _RX_   End of rx.h */
1074
1075 #ifdef  KERNEL
1076 #include "rx/rx_prototypes.h"
1077 #else
1078 #include "rx_prototypes.h"
1079 #endif
1080
1081 #endif /* !KDUMP_RX_LOCK */