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