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