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