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