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