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