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