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