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