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