2 * Copyright 2000, International Business Machines Corporation and others.
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
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.
26 /* Substitute VOID (char) for void, because some compilers are confused by void
27 * in some situations */
33 #include "rx_kmutex.h"
34 #include "rx_kernel.h"
38 #include "rx_packet.h"
41 #if defined (AFS_OBSD_ENV) && !defined (MLEN)
44 #include "netinet/in.h"
45 #include "sys/socket.h"
47 # include <sys/types.h>
49 #ifdef AFS_PTHREAD_ENV
50 # include "rx_pthread.h"
58 # include "rx_clock.h"
59 # include "rx_event.h"
60 # include "rx_packet.h"
63 # include "rx_multi.h"
65 # include <netinet/in.h>
66 # include <sys/socket.h>
71 /* Configurable parameters */
72 #define RX_IDLE_DEAD_TIME 60 /* default idle dead time */
73 #define RX_MAX_SERVICES 20 /* Maximum number of services that may be installed */
74 #define RX_DEFAULT_STACK_SIZE 16000 /* Default process stack size; overriden by rx_SetStackSize */
76 /* This parameter should not normally be changed */
77 #define RX_PROCESS_PRIORITY LWP_NORMAL_PRIORITY
79 /* backoff is fixed point binary. Ie, units of 1/4 seconds */
80 #define MAXBACKOFF 0x1F
82 #define ADDRSPERSITE 16
85 /* Bottom n-bits of the Call Identifier give the call number */
86 #define RX_MAXCALLS 4 /* Power of 2; max async calls per connection */
87 #define RX_CIDSHIFT 2 /* Log2(RX_MAXCALLS) */
88 #define RX_CHANNELMASK (RX_MAXCALLS-1)
89 #define RX_CIDMASK (~RX_CHANNELMASK)
90 #endif /* !KDUMP_RX_LOCK */
93 typedef void (*rx_destructor_t)(void *);
94 int rx_KeyCreate(rx_destructor_t);
95 osi_socket rxi_GetUDPSocket(u_short port);
99 int ntoh_syserr_conv(int error);
102 #define RX_DONTWAIT 0
104 #define rx_ConnectionOf(call) ((call)->conn)
105 #define rx_PeerOf(conn) ((conn)->peer)
106 #define rx_HostOf(peer) ((peer)->host)
107 #define rx_PortOf(peer) ((peer)->port)
108 #define rx_SetLocalStatus(call, status) ((call)->localStatus = (status))
109 #define rx_GetLocalStatus(call, status) ((call)->localStatus)
110 #define rx_GetRemoteStatus(call) ((call)->remoteStatus)
111 #define rx_Error(call) ((call)->error)
112 #define rx_ConnError(conn) ((conn)->error)
113 #define rx_IsServerConn(conn) ((conn)->type == RX_SERVER_CONNECTION)
114 #define rx_IsClientConn(conn) ((conn)->type == RX_CLIENT_CONNECTION)
115 /* Don't use these; use the IsServerConn style */
116 #define rx_ServerConn(conn) ((conn)->type == RX_SERVER_CONNECTION)
117 #define rx_ClientConn(conn) ((conn)->type == RX_CLIENT_CONNECTION)
118 #define rx_IsUsingPktCksum(conn) ((conn)->flags & RX_CONN_USING_PACKET_CKSUM)
119 #define rx_ServiceIdOf(conn) ((conn)->serviceId)
120 #define rx_SecurityClassOf(conn) ((conn)->securityIndex)
121 #define rx_SecurityObjectOf(conn) ((conn)->securityObject)
124 * Macros callable by the user to further define attributes of a
125 * service. Must be called before rx_StartServer
128 /* Set the service stack size. This currently just sets the stack
129 * size for all processes to be the maximum seen, so far */
130 #define rx_SetStackSize(service, stackSize) \
131 rx_stackSize = (((stackSize) > rx_stackSize)? stackSize: rx_stackSize)
133 /* Set minimum number of processes guaranteed to be available for this
134 * service at all times */
135 #define rx_SetMinProcs(service, min) ((service)->minProcs = (min))
137 /* Set maximum number of processes that will be made available to this
138 * service (also a guarantee that this number will be made available
139 * if there is no competition) */
140 #define rx_SetMaxProcs(service, max) ((service)->maxProcs = (max))
142 /* Define a procedure to be called just before a server connection is destroyed */
143 #define rx_SetDestroyConnProc(service,proc) ((service)->destroyConnProc = (proc))
145 /* Define procedure to set service dead time */
146 #define rx_SetIdleDeadTime(service,time) ((service)->idleDeadTime = (time))
148 /* Define procedures for getting and setting before and after execute-request procs */
149 #define rx_SetAfterProc(service,proc) ((service)->afterProc = (proc))
150 #define rx_SetBeforeProc(service,proc) ((service)->beforeProc = (proc))
151 #define rx_GetAfterProc(service) ((service)->afterProc)
152 #define rx_GetBeforeProc(service) ((service)->beforeProc)
154 /* Define a procedure to be called when a server connection is created */
155 #define rx_SetNewConnProc(service, proc) ((service)->newConnProc = (proc))
157 /* NOTE: We'll probably redefine the following three routines, again, sometime. */
159 /* Set the connection dead time for any connections created for this service (server only) */
160 #define rx_SetServiceDeadTime(service, seconds) ((service)->secondsUntilDead = (seconds))
162 /* Enable or disable asymmetric client checking for a service */
163 #define rx_SetCheckReach(service, x) ((service)->checkReach = (x))
165 /* Set connection hard and idle timeouts for a connection */
166 #define rx_SetConnHardDeadTime(conn, seconds) ((conn)->hardDeadTime = (seconds))
167 #define rx_SetConnIdleDeadTime(conn, seconds) ((conn)->idleDeadTime = (seconds))
169 /* Set the overload threshold and the overload error */
170 #define rx_SetBusyThreshold(threshold, code) (rx_BusyThreshold=(threshold),rx_BusyError=(code))
172 /* If this flag is set,no new requests are processed by rx, all new requests are
173 returned with an error code of RX_CALL_DEAD ( transient error ) */
174 #define rx_SetRxTranquil() (rx_tranquil = 1)
175 #define rx_ClearRxTranquil() (rx_tranquil = 0)
177 /* Set the threshold and time to delay aborts for consecutive errors */
178 #define rx_SetCallAbortThreshold(A) (rxi_callAbortThreshhold = (A))
179 #define rx_SetCallAbortDelay(A) (rxi_callAbortDelay = (A))
180 #define rx_SetConnAbortThreshold(A) (rxi_connAbortThreshhold = (A))
181 #define rx_SetConnAbortDelay(A) (rxi_connAbortDelay = (A))
183 #define rx_GetCallAbortCode(call) ((call)->abortCode)
184 #define rx_SetCallAbortCode(call, code) ((call)->abortCode = (code))
186 #define cpspace(call) ((call)->curlen)
187 #define cppos(call) ((call)->curpos)
189 #define rx_Read(call, buf, nbytes) rx_ReadProc(call, buf, nbytes)
190 #define rx_Read32(call, value) rx_ReadProc32(call, value)
191 #define rx_Readv(call, iov, nio, maxio, nbytes) \
192 rx_ReadvProc(call, iov, nio, maxio, nbytes)
193 #define rx_Write(call, buf, nbytes) rx_WriteProc(call, buf, nbytes)
194 #define rx_Write32(call, value) rx_WriteProc32(call, value)
195 #define rx_Writev(call, iov, nio, nbytes) \
196 rx_WritevProc(call, iov, nio, nbytes)
198 /* This is the maximum size data packet that can be sent on this connection, accounting for security module-specific overheads. */
199 #define rx_MaxUserDataSize(call) ((call)->MTU - RX_HEADER_SIZE - (call)->conn->securityHeaderSize - (call)->conn->securityMaxTrailerSize)
201 /* Macros to turn the hot thread feature on and off. Enabling hot threads
202 * allows the listener thread to trade places with an idle worker thread,
203 * which moves the context switch from listener to worker out of the
206 #define rx_EnableHotThread() (rx_enable_hot_thread = 1)
207 #define rx_DisableHotThread() (rx_enable_hot_thread = 0)
209 /* A connection is an authenticated communication path, allowing
210 limited multiple asynchronous conversations. */
212 struct rx_connection_rx_lock {
213 struct rx_connection_rx_lock *next; /* on hash chain _or_ free list */
214 struct rx_peer_rx_lock *peer;
216 struct rx_connection {
217 struct rx_connection *next; /* on hash chain _or_ free list */
218 struct rx_peer *peer;
220 #ifdef RX_ENABLE_LOCKS
221 afs_kmutex_t conn_call_lock; /* locks conn_call_cv */
222 afs_kcondvar_t conn_call_cv;
223 afs_kmutex_t conn_data_lock; /* locks packet data */
225 afs_uint32 epoch; /* Process start time of client side of connection */
226 afs_uint32 cid; /* Connection id (call channel is bottom bits) */
227 afs_int32 error; /* If this connection is in error, this is it */
229 struct rx_call_rx_lock *call[RX_MAXCALLS];
231 struct rx_call *call[RX_MAXCALLS];
233 afs_uint32 callNumber[RX_MAXCALLS]; /* Current call numbers */
234 afs_uint32 serial; /* Next outgoing packet serial number */
235 afs_uint32 lastSerial; /* # of last packet received, for computing skew */
236 afs_int32 maxSerial; /* largest serial number seen on incoming packets */
237 /* afs_int32 maxPacketSize; max packet size should be per-connection since */
238 /* peer process could be restarted on us. Includes RX Header. */
239 struct rxevent *challengeEvent; /* Scheduled when the server is challenging a */
240 struct rxevent *delayedAbortEvent; /* Scheduled to throttle looping client */
241 struct rxevent *checkReachEvent; /* Scheduled when checking reachability */
242 int abortCount; /* count of abort messages sent */
243 /* client-- to retransmit the challenge */
244 struct rx_service *service; /* used by servers only */
245 u_short serviceId; /* To stamp on requests (clients only) */
246 u_short refCount; /* Reference count */
247 u_char flags; /* Defined below */
248 u_char type; /* Type of connection, defined below */
249 u_char secondsUntilPing; /* how often to ping for each active call */
250 u_char securityIndex; /* corresponds to the security class of the */
251 /* securityObject for this conn */
252 struct rx_securityClass *securityObject; /* Security object for this connection */
253 VOID *securityData; /* Private data for this conn's security class */
254 u_short securityHeaderSize; /* Length of security module's packet header data */
255 u_short securityMaxTrailerSize; /* Length of security module's packet trailer data */
257 int timeout; /* Overall timeout per call (seconds) for this conn */
258 int lastSendTime; /* Last send time for this connection */
259 u_short secondsUntilDead; /* Maximum silence from peer before RX_CALL_DEAD */
260 u_short hardDeadTime; /* hard max for call execution */
261 u_short idleDeadTime; /* max time a call can be idle (no data) */
262 u_char ackRate; /* how many packets between ack requests */
263 u_char makeCallWaiters; /* how many rx_NewCalls are waiting */
264 int nSpecific; /* number entries in specific data */
265 void **specific; /* pointer to connection specific data */
269 /* A service is installed by rx_NewService, and specifies a service type that
270 * is exported by this process. Incoming calls are stamped with the service
271 * type, and must match an installed service for the call to be accepted.
272 * Each service exported has a (port,serviceId) pair to uniquely identify it.
273 * It is also named: this is intended to allow a remote statistics gathering
274 * program to retrieve per service statistics without having to know the local
275 * service id's. Each service has a number of
278 /* security objects (instances of security classes) which implement
279 * various types of end-to-end security protocols for connections made
280 * to this service. Finally, there are two parameters controlling the
281 * number of requests which may be executed in parallel by this
282 * service: minProcs is the number of requests to this service which
283 * are guaranteed to be able to run in parallel at any time; maxProcs
284 * has two meanings: it limits the total number of requests which may
285 * execute in parallel and it also guarantees that that many requests
286 * may be handled in parallel if no other service is handling any
290 u_short serviceId; /* Service number */
291 u_short servicePort; /* UDP port for this service */
292 char *serviceName; /* Name of the service */
293 osi_socket socket; /* socket structure or file descriptor */
294 u_short nRequestsRunning; /* Number of requests currently in progress */
295 u_short nSecurityObjects; /* Number of entries in security objects array */
296 struct rx_securityClass **securityObjects; /* Array of security class objects */
297 afs_int32 (*executeRequestProc)(struct rx_call *acall); /* Routine to call when an rpc request is received */
298 void (*destroyConnProc)(struct rx_connection *tcon); /* Routine to call when a server connection is destroyed */
299 void (*newConnProc)(struct rx_connection *tcon); /* Routine to call when a server connection is created */
300 void (*beforeProc)(struct rx_call *acall); /* routine to call before a call is executed */
301 void (*afterProc)(struct rx_call *acall, afs_int32 code); /* routine to call after a call is executed */
302 u_short maxProcs; /* Maximum procs to be used for this service */
303 u_short minProcs; /* Minimum # of requests guaranteed executable simultaneously */
304 u_short connDeadTime; /* Seconds until a client of this service will be declared dead, if it is not responding */
305 u_short idleDeadTime; /* Time a server will wait for I/O to start up again */
306 u_char checkReach; /* Check for asymmetric clients? */
309 #endif /* KDUMP_RX_LOCK */
311 /* A server puts itself on an idle queue for a service using an
312 * instance of the following structure. When a call arrives, the call
313 * structure pointer is placed in "newcall", the routine to execute to
314 * service the request is placed in executeRequestProc, and the
315 * process is woken up. The queue entry's address is used for the
316 * sleep/wakeup. If socketp is non-null, then this thread is willing
317 * to become a listener thread. A thread sets *socketp to -1 before
318 * sleeping. If *socketp is not -1 when the thread awakes, it is now
319 * the listener thread for *socketp. When socketp is non-null, tno
320 * contains the server's threadID, which is used to make decitions in GetCall.
323 struct rx_serverQueueEntry_rx_lock {
325 struct rx_serverQueueEntry {
327 struct rx_queue queueItemHeader;
329 struct rx_call_rx_lock *newcall;
331 struct rx_call *newcall;
333 #ifdef RX_ENABLE_LOCKS
342 /* A peer refers to a peer process, specified by a (host,port) pair. There may be more than one peer on a given host. */
344 struct rx_peer_rx_lock {
345 struct rx_peer_rx_lock *next; /* Next in hash conflict or free list */
348 struct rx_peer *next; /* Next in hash conflict or free list */
350 #ifdef RX_ENABLE_LOCKS
351 afs_kmutex_t peer_lock; /* Lock peer */
352 #endif /* RX_ENABLE_LOCKS */
353 afs_uint32 host; /* Remote IP address, in net byte order */
354 u_short port; /* Remote UDP port, in net byte order */
356 /* interface mtu probably used for this host - includes RX Header */
357 u_short ifMTU; /* doesn't include IP header */
359 /* For garbage collection */
360 afs_uint32 idleWhen; /* When the refcountwent to zero */
361 short refCount; /* Reference count for this structure */
363 /* Congestion control parameters */
364 u_char burstSize; /* Reinitialization size for the burst parameter */
365 u_char burst; /* Number of packets that can be transmitted right now, without pausing */
366 struct clock burstWait; /* Delay until new burst is allowed */
367 struct rx_queue congestionQueue; /* Calls that are waiting for non-zero burst value */
368 int rtt; /* Round trip time, measured in milliseconds/8 */
369 int rtt_dev; /* rtt smoothed error, in milliseconds/4 */
370 struct clock timeout; /* Current retransmission delay */
371 int nSent; /* Total number of distinct data packets sent, not including retransmissions */
372 int reSends; /* Total number of retransmissions for this peer, since this structure was created */
374 /* Skew: if a packet is received N packets later than expected (based
375 * on packet serial numbers), then we define it to have a skew of N.
376 * The maximum skew values allow us to decide when a packet hasn't
377 * been received yet because it is out-of-order, as opposed to when it
378 * is likely to have been dropped. */
379 afs_uint32 inPacketSkew; /* Maximum skew on incoming packets */
380 afs_uint32 outPacketSkew; /* Peer-reported max skew on our sent packets */
381 int rateFlag; /* Flag for rate testing (-no 0yes +decrement) */
383 /* the "natural" MTU, excluding IP,UDP headers, is negotiated by the endpoints */
386 /* negotiated maximum number of packets to send in a single datagram. */
387 u_short maxDgramPackets;
388 /* local maximum number of packets to send in a single datagram. */
389 u_short ifDgramPackets;
391 * MTU, cwind, and nDgramPackets are used to initialize
392 * slow start parameters for new calls. These values are set whenever a
393 * call sends a retransmission and at the end of each call.
394 * congestSeq is incremented each time the congestion parameters are
395 * changed by a call recovering from a dropped packet. A call used
396 * MAX when updating congestion parameters if it started with the
397 * current congestion sequence number, otherwise it uses MIN.
399 u_short MTU; /* MTU for AFS 3.4a jumboGrams */
400 u_short cwind; /* congestion window */
401 u_short nDgramPackets; /* number packets per AFS 3.5 jumbogram */
402 u_short congestSeq; /* Changed when a call retransmits */
403 afs_hyper_t bytesSent; /* Number of bytes sent to this peer */
404 afs_hyper_t bytesReceived; /* Number of bytes received from this peer */
405 struct rx_queue rpcStats; /* rpc statistic list */
406 int lastReachTime; /* Last time we verified reachability */
410 #ifndef KDUMP_RX_LOCK
411 /* Flag bits for connection structure */
412 #define RX_CONN_MAKECALL_WAITING 1 /* rx_MakeCall is waiting for a channel */
413 #define RX_CONN_DESTROY_ME 2 /* Destroy *client* connection after last call */
414 #define RX_CONN_USING_PACKET_CKSUM 4 /* non-zero header.spare field seen */
415 #define RX_CONN_KNOW_WINDOW 8 /* window size negotiation works */
416 #define RX_CONN_RESET 16 /* connection is reset, remove */
417 #define RX_CONN_BUSY 32 /* connection is busy; don't delete */
418 #define RX_CONN_ATTACHWAIT 64 /* attach waiting for peer->lastReach */
420 /* Type of connection, client or server */
421 #define RX_CLIENT_CONNECTION 0
422 #define RX_SERVER_CONNECTION 1
423 #endif /* !KDUMP_RX_LOCK */
425 /* 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. */
427 struct rx_call_rx_lock {
431 struct rx_queue queue_item_header; /* Call can be on various queues (one-at-a-time) */
432 struct rx_queue tq; /* Transmit packet queue */
433 struct rx_queue rq; /* Receive packet queue */
435 * The following fields are accessed while the call is unlocked.
436 * These fields are used by the caller/server thread to marshall
437 * and unmarshall RPC data. The only time they may be changed by
438 * other threads is when the RX_CALL_IOVEC_WAIT flag is set.
440 * NOTE: Be sure that these fields start and end on a double
441 * word boundary. Otherwise threads that are changing
442 * adjacent fields will cause problems.
444 struct rx_queue iovq; /* readv/writev packet queue */
445 u_short nLeft; /* Number bytes left in first receive packet */
446 u_short curvec; /* current iovec in currentPacket */
447 u_short curlen; /* bytes remaining in curvec */
448 u_short nFree; /* Number bytes free in last send packet */
449 struct rx_packet *currentPacket;/* Current packet being assembled or being read */
450 char *curpos; /* current position in curvec */
452 * End of fields accessed with call unlocked
454 u_char channel; /* Index of call, within connection */
455 u_char state; /* Current call state as defined below */
456 u_char mode; /* Current mode of a call in ACTIVE state */
457 #ifdef RX_ENABLE_LOCKS
458 afs_kmutex_t lock; /* lock covers data as well as mutexes. */
459 afs_kmutex_t *call_queue_lock; /* points to lock for queue we're on,
461 afs_kcondvar_t cv_twind;
462 afs_kcondvar_t cv_rq;
463 afs_kcondvar_t cv_tq;
466 struct rx_connection_rx_lock *conn; /* Parent connection for call */
468 struct rx_connection *conn; /* Parent connection for this call */
470 afs_uint32 *callNumber; /* Pointer to call number field within connection */
471 afs_uint32 flags; /* Some random flags */
472 u_char localStatus; /* Local user status sent out of band */
473 u_char remoteStatus; /* Remote user status received out of band */
474 afs_int32 error; /* Error condition for this call */
475 afs_uint32 timeout; /* High level timeout for this call */
476 afs_uint32 rnext; /* Next sequence number expected to be read by rx_ReadData */
477 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 */
478 afs_uint32 rwind; /* The receive window: the peer must not send packets with sequence numbers >= rnext+rwind */
479 afs_uint32 tfirst; /* First unacknowledged transmit packet number */
480 afs_uint32 tnext; /* Next transmit sequence number to use */
481 u_short twind; /* The transmit window: we cannot assign a sequence number to a packet >= tfirst + twind */
482 u_short cwind; /* The congestion window */
483 u_short nSoftAcked; /* Number soft acked transmit packets */
484 u_short nextCwind; /* The congestion window after recovery */
485 u_short nCwindAcks; /* Number acks received at current cwind */
486 u_short ssthresh; /* The slow start threshold */
487 u_short nDgramPackets; /* Packets per AFS 3.5 jumbogram */
488 u_short nAcks; /* The number of consecttive acks */
489 u_short nNacks; /* Number packets acked that follow the
490 * first negatively acked packet */
491 u_short nSoftAcks; /* The number of delayed soft acks */
492 u_short nHardAcks; /* The number of delayed hard acks */
493 u_short congestSeq; /* Peer's congestion sequence counter */
494 struct rxevent *resendEvent; /* If this is non-Null, there is a retransmission event pending */
495 struct rxevent *timeoutEvent; /* If this is non-Null, then there is an overall timeout for this call */
496 struct rxevent *keepAliveEvent; /* Scheduled periodically in active calls to keep call alive */
497 struct rxevent *delayedAckEvent; /* Scheduled after all packets are received to send an ack if a reply or new call is not generated soon */
498 struct rxevent *delayedAbortEvent; /* Scheduled to throttle looping client */
499 int abortCode; /* error code from last RPC */
500 int abortCount; /* number of times last error was sent */
501 u_int lastSendTime; /* Last time a packet was sent on this call */
502 u_int lastReceiveTime; /* Last time a packet was received for this call */
503 VOID (*arrivalProc)(register struct rx_call *call,
504 register struct multi_handle *mh, register int index); /* Procedure to call when reply is received */
505 VOID *arrivalProcHandle; /* Handle to pass to replyFunc */
506 VOID *arrivalProcArg; /* Additional arg to pass to reply Proc */
507 afs_uint32 lastAcked; /* last packet "hard" acked by receiver */
508 afs_uint32 startWait; /* time server began waiting for input data/send quota */
509 struct clock traceWait; /* time server began waiting for input data/send quota */
510 struct clock traceStart; /* time the call started running */
511 u_short MTU; /* size of packets currently sending */
512 #ifdef RX_ENABLE_LOCKS
513 short refCount; /* Used to keep calls from disappearring
514 when we get them from a queue. */
515 #endif /* RX_ENABLE_LOCKS */
516 /* Call refcount modifiers */
517 #define RX_CALL_REFCOUNT_BEGIN 0 /* GetCall/NewCall/EndCall */
518 #define RX_CALL_REFCOUNT_RESEND 1 /* resend event */
519 #define RX_CALL_REFCOUNT_DELAY 2 /* delayed ack */
520 #define RX_CALL_REFCOUNT_ALIVE 3 /* keep alive event */
521 #define RX_CALL_REFCOUNT_PACKET 4 /* waiting for packets. */
522 #define RX_CALL_REFCOUNT_SEND 5 /* rxi_Send */
523 #define RX_CALL_REFCOUNT_ACKALL 6 /* rxi_AckAll */
524 #define RX_CALL_REFCOUNT_ABORT 7 /* delayed abort */
525 #define RX_CALL_REFCOUNT_MAX 8 /* array size. */
526 #ifdef RX_REFCOUNT_CHECK
527 short refCDebug[RX_CALL_REFCOUNT_MAX];
528 #endif /* RX_REFCOUNT_CHECK */
529 int iovNBytes; /* byte count for current iovec */
530 int iovMax; /* number elements in current iovec */
531 int iovNext; /* next entry in current iovec */
532 struct iovec *iov; /* current iovec */
533 struct clock queueTime; /* time call was queued */
534 struct clock startTime; /* time call was started */
535 afs_hyper_t bytesSent; /* Number bytes sent */
536 afs_hyper_t bytesRcvd; /* Number bytes received */
539 #ifndef KDUMP_RX_LOCK
540 /* Major call states */
541 #define RX_STATE_NOTINIT 0 /* Call structure has never been initialized */
542 #define RX_STATE_PRECALL 1 /* Server-only: call is not in progress, but packets have arrived */
543 #define RX_STATE_ACTIVE 2 /* An active call; a process is dealing with this call */
544 #define RX_STATE_DALLY 3 /* Dallying after process is done with call */
545 #define RX_STATE_HOLD 4 /* Waiting for acks on reply data packets */
547 /* Call modes: the modes of a call in RX_STATE_ACTIVE state (process attached) */
548 #define RX_MODE_SENDING 1 /* Sending or ready to send */
549 #define RX_MODE_RECEIVING 2 /* Receiving or ready to receive */
550 #define RX_MODE_ERROR 3 /* Something in error for current conversation */
551 #define RX_MODE_EOF 4 /* Server has flushed (or client has read) last reply packet */
554 #define RX_CALL_READER_WAIT 1 /* Reader is waiting for next packet */
555 #define RX_CALL_WAIT_WINDOW_ALLOC 2 /* Sender is waiting for window to allocate buffers */
556 #define RX_CALL_WAIT_WINDOW_SEND 4 /* Sender is waiting for window to send buffers */
557 #define RX_CALL_WAIT_PACKETS 8 /* Sender is waiting for packet buffers */
558 #define RX_CALL_WAIT_PROC 16 /* Waiting for a process to be assigned */
559 #define RX_CALL_RECEIVE_DONE 32 /* All packets received on this call */
560 #define RX_CALL_CLEARED 64 /* Receive queue cleared in precall state */
561 #define RX_CALL_TQ_BUSY 128 /* Call's Xmit Queue is busy; don't modify */
562 #define RX_CALL_TQ_CLEARME 256 /* Need to clear this call's TQ later */
563 #define RX_CALL_TQ_SOME_ACKED 512 /* rxi_Start needs to discard ack'd packets. */
564 #define RX_CALL_TQ_WAIT 1024 /* Reader is waiting for TQ_BUSY to be reset */
565 #define RX_CALL_FAST_RECOVER 2048 /* call is doing congestion recovery */
566 #define RX_CALL_FAST_RECOVER_WAIT 4096 /* thread is waiting to start recovery */
567 #define RX_CALL_SLOW_START_OK 8192 /* receiver acks every other packet */
568 #define RX_CALL_IOVEC_WAIT 16384 /* waiting thread is using an iovec */
569 #define RX_CALL_HAVE_LAST 32768 /* Last packet has been received */
570 #define RX_CALL_NEED_START 0x10000 /* tells rxi_Start to start again */
572 /* Maximum number of acknowledgements in an acknowledge packet */
573 #define RX_MAXACKS 255
575 /* The structure of the data portion of an acknowledge packet: An acknowledge
576 * packet is in network byte order at all times. An acknowledgement is always
577 * prompted for a specific reason by a specific incoming packet. This reason
578 * is reported in "reason" and the packet's sequence number in the packet
579 * header.seq. In addition to this information, all of the current
580 * acknowledgement information about this call is placed in the packet.
581 * "FirstPacket" is the sequence number of the first packet represented in an
582 * array of bytes, "acks", containing acknowledgement information for a number
583 * of consecutive packets. All packets prior to FirstPacket are implicitly
584 * acknowledged: the sender need no longer be concerned about them. Packets
585 * from firstPacket+nAcks and on are not acknowledged. Packets in the range
586 * [firstPacket,firstPacket+nAcks) are each acknowledged explicitly. The
587 * acknowledgement may be RX_NACK if the packet is not (currently) at the
588 * receiver (it may have never been received, or received and then later
589 * dropped), or it may be RX_ACK if the packet is queued up waiting to be read
590 * by the upper level software. RX_ACK does not imply that the packet may not
591 * be dropped before it is read; it does imply that the sender should stop
592 * retransmitting the packet until notified otherwise. The field
593 * previousPacket identifies the previous packet received by the peer. This
594 * was used in a previous version of this software, and could be used in the
595 * future. The serial number in the data part of the ack packet corresponds to
596 * the serial number oof the packet which prompted the acknowledge. Any
597 * packets which are explicitly not acknowledged, and which were last
598 * transmitted with a serial number less than the provided serial number,
599 * should be retransmitted immediately. Actually, this is slightly inaccurate:
600 * packets are not necessarily received in order. When packets are habitually
601 * transmitted out of order, this is allowed for in the retransmission
602 * algorithm by introducing the notion of maximum packet skew: the degree of
603 * out-of-orderness of the packets received on the wire. This number is
604 * communicated from the receiver to the sender in ack packets. */
606 struct rx_ackPacket {
607 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. */
608 u_short maxSkew; /* Maximum difference between serial# of packet acknowledged and highest packet yet received */
609 afs_uint32 firstPacket; /* The first packet in the list of acknowledged packets */
610 afs_uint32 previousPacket; /* The previous packet number received (obsolete?) */
611 afs_uint32 serial; /* Serial number of the packet which prompted the acknowledge */
612 u_char reason; /* Reason for the acknowledge of ackPacket, defined below */
613 u_char nAcks; /* Number of acknowledgements */
614 u_char acks[RX_MAXACKS]; /* Up to RX_MAXACKS packet acknowledgements, defined below */
615 /* 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) */
618 #define FIRSTACKOFFSET 4
620 /* Reason for acknowledge message */
621 #define RX_ACK_REQUESTED 1 /* Peer requested an ack on this packet */
622 #define RX_ACK_DUPLICATE 2 /* Duplicate packet */
623 #define RX_ACK_OUT_OF_SEQUENCE 3 /* Packet out of sequence */
624 #define RX_ACK_EXCEEDS_WINDOW 4 /* Packet sequence number higher than window; discarded */
625 #define RX_ACK_NOSPACE 5 /* No buffer space at all */
626 #define RX_ACK_PING 6 /* This is a keep-alive ack */
627 #define RX_ACK_PING_RESPONSE 7 /* Ack'ing because we were pinged */
628 #define RX_ACK_DELAY 8 /* Ack generated since nothing has happened since receiving packet */
629 #define RX_ACK_IDLE 9 /* Similar to RX_ACK_DELAY, but can
632 /* Packet acknowledgement type */
633 #define RX_ACK_TYPE_NACK 0 /* I Don't have this packet */
634 #define RX_ACK_TYPE_ACK 1 /* I have this packet, although I may discard it later */
636 /* The packet size transmitted for an acknowledge is adjusted to reflect the actual size of the acks array. This macro defines the size */
637 #define rx_AckDataSize(nAcks) (3 + nAcks + offsetof(struct rx_ackPacket, acks[0]))
639 #define RX_CHALLENGE_TIMEOUT 2 /* Number of seconds before another authentication request packet is generated */
640 #define RX_CHALLENGE_MAXTRIES 50 /* Max # of times we resend challenge */
641 #define RX_CHECKREACH_TIMEOUT 2 /* Number of seconds before another ping is generated */
642 #define RX_CHECKREACH_TTL 60 /* Re-check reachability this often */
644 /* 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 */
646 /* Something bad happened to the connection; temporary loss of communication */
647 #define RX_CALL_DEAD (-1)
649 /* An invalid operation, such as a client attempting to send data after having received the beginning of a reply from the server */
650 #define RX_INVALID_OPERATION (-2)
652 /* An optional timeout per call may be specified */
653 #define RX_CALL_TIMEOUT (-3)
655 /* End of data on a read */
658 /* Some sort of low-level protocol error */
659 #define RX_PROTOCOL_ERROR (-5)
661 /* 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 */
662 #define RX_USER_ABORT (-6)
664 /* Port already in use (from rx_Init) */
665 #define RX_ADDRINUSE (-7)
667 /* EMSGSIZE returned from network. Packet too big, must fragment */
668 #define RX_MSGSIZE (-8)
670 /* transient failure detected ( possibly the server is restarting ) */
671 /* this shud be equal to VRESTARTING ( util/errors.h ) for old clients to work */
672 #define RX_RESTARTING (-100)
674 struct rx_securityObjectStats {
675 char type; /* 0:unk 1:null,2:vab 3:kad */
677 char sparec[10]; /* force correct alignment */
678 afs_int32 flags; /* 1=>unalloc, 2=>auth, 4=>expired */
680 afs_uint32 packetsReceived;
681 afs_uint32 packetsSent;
682 afs_uint32 bytesReceived;
683 afs_uint32 bytesSent;
688 /* XXXX (rewrite this description) A security class object contains a set of
689 * procedures and some private data to implement a security model for rx
690 * connections. These routines are called by rx as appropriate. Rx knows
691 * nothing about the internal details of any particular security model, or
692 * about security state. Rx does maintain state per connection on behalf of
693 * the security class. Each security class implementation is also expected to
694 * provide routines to create these objects. Rx provides a basic routine to
695 * allocate one of these objects; this routine must be called by the class. */
696 struct rx_securityClass {
697 struct rx_securityOps {
698 int (*op_Close)(struct rx_securityClass *aobj);
699 int (*op_NewConnection)(struct rx_securityClass *aobj, struct rx_connection *aconn);
700 int (*op_PreparePacket)(struct rx_securityClass *aobj, struct rx_call *acall, struct rx_packet *apacket);
701 int (*op_SendPacket)(struct rx_securityClass *aobj, struct rx_call *acall, struct rx_packet *apacket);
702 int (*op_CheckAuthentication)(struct rx_securityClass *aobj, struct rx_connection *aconn);
703 int (*op_CreateChallenge)(struct rx_securityClass *aobj, struct rx_connection *aconn);
704 int (*op_GetChallenge)(struct rx_securityClass *aobj, struct rx_connection *aconn, struct rx_packet *apacket);
705 int (*op_GetResponse)(struct rx_securityClass *aobj, struct rx_connection *aconn, struct rx_packet *apacket);
706 int (*op_CheckResponse)(struct rx_securityClass *aobj, struct rx_connection *aconn, struct rx_packet *apacket);
707 int (*op_CheckPacket) (struct rx_securityClass *aobj, struct rx_call *acall, struct rx_packet *apacket);
708 int (*op_DestroyConnection)(struct rx_securityClass *aobj, struct rx_connection *aconn);
709 int (*op_GetStats)(struct rx_securityClass *aobj, struct rx_connection *aconn, struct rx_securityObjectStats *astats);
710 int (*op_Spare1)(void);
711 int (*op_Spare2)(void);
712 int (*op_Spare3)(void);
718 #define RXS_OP(obj,op,args) ((obj && (obj->ops->op_ ## op)) ? (*(obj)->ops->op_ ## op)args : 0)
720 #define RXS_Close(obj) RXS_OP(obj,Close,(obj))
721 #define RXS_NewConnection(obj,conn) RXS_OP(obj,NewConnection,(obj,conn))
722 #define RXS_PreparePacket(obj,call,packet) RXS_OP(obj,PreparePacket,(obj,call,packet))
723 #define RXS_SendPacket(obj,call,packet) RXS_OP(obj,SendPacket,(obj,call,packet))
724 #define RXS_CheckAuthentication(obj,conn) RXS_OP(obj,CheckAuthentication,(obj,conn))
725 #define RXS_CreateChallenge(obj,conn) RXS_OP(obj,CreateChallenge,(obj,conn))
726 #define RXS_GetChallenge(obj,conn,packet) RXS_OP(obj,GetChallenge,(obj,conn,packet))
727 #define RXS_GetResponse(obj,conn,packet) RXS_OP(obj,GetResponse,(obj,conn,packet))
728 #define RXS_CheckResponse(obj,conn,packet) RXS_OP(obj,CheckResponse,(obj,conn,packet))
729 #define RXS_CheckPacket(obj,call,packet) RXS_OP(obj,CheckPacket,(obj,call,packet))
730 #define RXS_DestroyConnection(obj,conn) RXS_OP(obj,DestroyConnection,(obj,conn))
731 #define RXS_GetStats(obj,conn,stats) RXS_OP(obj,GetStats,(obj,conn,stats))
735 /* Structure for keeping rx statistics. Note that this structure is returned
736 * by rxdebug, so, for compatibility reasons, new fields should be appended (or
737 * spares used), the rxdebug protocol checked, if necessary, and the PrintStats
738 * code should be updated as well.
740 * Clearly we assume that ntohl will work on these structures so sizeof(int)
741 * must equal sizeof(afs_int32). */
743 struct rx_stats { /* General rx statistics */
744 int packetRequests; /* Number of packet allocation requests */
745 int receivePktAllocFailures;
746 int sendPktAllocFailures;
747 int specialPktAllocFailures;
748 int socketGreedy; /* Whether SO_GREEDY succeeded */
749 int bogusPacketOnRead; /* Number of inappropriately short packets received */
750 int bogusHost; /* Host address from bogus packets */
751 int noPacketOnRead; /* Number of read packets attempted when there was actually no packet to read off the wire */
752 int noPacketBuffersOnRead; /* Number of dropped data packets due to lack of packet buffers */
753 int selects; /* Number of selects waiting for packet or timeout */
754 int sendSelects; /* Number of selects forced when sending packet */
755 int packetsRead[RX_N_PACKET_TYPES]; /* Total number of packets read, per type */
756 int dataPacketsRead; /* Number of unique data packets read off the wire */
757 int ackPacketsRead; /* Number of ack packets read */
758 int dupPacketsRead; /* Number of duplicate data packets read */
759 int spuriousPacketsRead;/* Number of inappropriate data packets */
760 int packetsSent[RX_N_PACKET_TYPES]; /* Number of rxi_Sends: packets sent over the wire, per type */
761 int ackPacketsSent; /* Number of acks sent */
762 int pingPacketsSent; /* Total number of ping packets sent */
763 int abortPacketsSent; /* Total number of aborts */
764 int busyPacketsSent; /* Total number of busies sent received */
765 int dataPacketsSent; /* Number of unique data packets sent */
766 int dataPacketsReSent; /* Number of retransmissions */
767 int dataPacketsPushed; /* Number of retransmissions pushed early by a NACK */
768 int ignoreAckedPacket; /* Number of packets with acked flag, on rxi_Start */
769 struct clock totalRtt; /* Total round trip time measured (use to compute average) */
770 struct clock minRtt; /* Minimum round trip time measured */
771 struct clock maxRtt; /* Maximum round trip time measured */
772 int nRttSamples; /* Total number of round trip samples */
773 int nServerConns; /* Total number of server connections */
774 int nClientConns; /* Total number of client connections */
775 int nPeerStructs; /* Total number of peer structures */
776 int nCallStructs; /* Total number of call structures allocated */
777 int nFreeCallStructs; /* Total number of previously allocated free call structures */
779 afs_int32 fatalErrors;
780 int ignorePacketDally; /* packets dropped because call is in dally state */
781 int receiveCbufPktAllocFailures;
782 int sendCbufPktAllocFailures;
786 /* structures for debug input and output packets */
788 /* debug input types */
794 /* Invalid rx debug package type */
795 #define RX_DEBUGI_BADTYPE (-8)
797 #define RX_DEBUGI_VERSION_MINIMUM ('L') /* earliest real version */
798 #define RX_DEBUGI_VERSION ('Q') /* Latest version */
799 /* first version w/ secStats */
800 #define RX_DEBUGI_VERSION_W_SECSTATS ('L')
801 /* version M is first supporting GETALLCONN and RXSTATS type */
802 #define RX_DEBUGI_VERSION_W_GETALLCONN ('M')
803 #define RX_DEBUGI_VERSION_W_RXSTATS ('M')
804 /* last version with unaligned debugConn */
805 #define RX_DEBUGI_VERSION_W_UNALIGNED_CONN ('L')
806 #define RX_DEBUGI_VERSION_W_WAITERS ('N')
807 #define RX_DEBUGI_VERSION_W_IDLETHREADS ('O')
808 #define RX_DEBUGI_VERSION_W_NEWPACKETTYPES ('P')
809 #define RX_DEBUGI_VERSION_W_GETPEER ('Q')
811 #define RX_DEBUGI_GETSTATS 1 /* get basic rx stats */
812 #define RX_DEBUGI_GETCONN 2 /* get connection info */
813 #define RX_DEBUGI_GETALLCONN 3 /* get even uninteresting conns */
814 #define RX_DEBUGI_RXSTATS 4 /* get all rx stats */
815 #define RX_DEBUGI_GETPEER 5 /* get all peer structs */
817 struct rx_debugStats {
818 afs_int32 nFreePackets;
819 afs_int32 packetReclaims;
820 afs_int32 callsExecuted;
821 char waitingForPackets;
826 afs_int32 idleThreads; /* Number of server threads that are idle */
830 struct rx_debugConn_vL {
834 afs_int32 callNumber[RX_MAXCALLS];
840 char callState[RX_MAXCALLS];
841 char callMode[RX_MAXCALLS];
842 char callFlags[RX_MAXCALLS];
843 char callOther[RX_MAXCALLS];
844 /* old style getconn stops here */
845 struct rx_securityObjectStats secStats;
846 afs_int32 sparel[10];
849 struct rx_debugConn {
853 afs_int32 callNumber[RX_MAXCALLS];
859 char sparec[3]; /* force correct alignment */
860 char callState[RX_MAXCALLS];
861 char callMode[RX_MAXCALLS];
862 char callFlags[RX_MAXCALLS];
863 char callOther[RX_MAXCALLS];
864 /* old style getconn stops here */
865 struct rx_securityObjectStats secStats;
871 struct rx_debugPeer {
879 struct clock burstWait;
882 struct clock timeout;
885 afs_int32 inPacketSkew;
886 afs_int32 outPacketSkew;
890 u_short maxDgramPackets;
891 u_short ifDgramPackets;
894 u_short nDgramPackets;
896 afs_hyper_t bytesSent;
897 afs_hyper_t bytesReceived;
898 afs_int32 sparel[10];
901 #define RX_OTHER_IN 1 /* packets avail in in queue */
902 #define RX_OTHER_OUT 2 /* packets avail in out queue */
906 /* Only include this once, even when re-loading for kdump. */
907 #ifndef _CALL_REF_DEFINED_
908 #define _CALL_REF_DEFINED_
910 #ifdef RX_ENABLE_LOCKS
911 #ifdef RX_REFCOUNT_CHECK
912 /* RX_REFCOUNT_CHECK is used to test for call refcount leaks by event
915 extern int rx_callHoldType;
916 #define CALL_HOLD(call, type) do { \
918 call->refCDebug[type]++; \
919 if (call->refCDebug[type] > 50) {\
920 rx_callHoldType = type; \
921 osi_Panic("Huge call refCount"); \
924 #define CALL_RELE(call, type) do { \
926 call->refCDebug[type]--; \
927 if (call->refCDebug[type] > 50) {\
928 rx_callHoldType = type; \
929 osi_Panic("Negative call refCount"); \
932 #else /* RX_REFCOUNT_CHECK */
933 #define CALL_HOLD(call, type) call->refCount++
934 #define CALL_RELE(call, type) call->refCount--
935 #endif /* RX_REFCOUNT_CHECK */
937 #else /* RX_ENABLE_LOCKS */
938 #define CALL_HOLD(call, type)
939 #define CALL_RELE(call, type)
940 #endif /* RX_ENABLE_LOCKS */
942 #endif /* _CALL_REF_DEFINED_ */
944 #define RX_SERVER_DEBUG_SEC_STATS 0x1
945 #define RX_SERVER_DEBUG_ALL_CONN 0x2
946 #define RX_SERVER_DEBUG_RX_STATS 0x4
947 #define RX_SERVER_DEBUG_WAITER_CNT 0x8
948 #define RX_SERVER_DEBUG_IDLE_THREADS 0x10
949 #define RX_SERVER_DEBUG_OLD_CONN 0x20
950 #define RX_SERVER_DEBUG_NEW_PACKETS 0x40
951 #define RX_SERVER_DEBUG_ALL_PEER 0x80
953 #define AFS_RX_STATS_CLEAR_ALL 0xffffffff
954 #define AFS_RX_STATS_CLEAR_INVOCATIONS 0x1
955 #define AFS_RX_STATS_CLEAR_BYTES_SENT 0x2
956 #define AFS_RX_STATS_CLEAR_BYTES_RCVD 0x4
957 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SUM 0x8
958 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SQUARE 0x10
959 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MIN 0x20
960 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MAX 0x40
961 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SUM 0x80
962 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SQUARE 0x100
963 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MIN 0x200
964 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MAX 0x400
966 typedef struct rx_function_entry_v1 {
967 afs_uint32 remote_peer;
968 afs_uint32 remote_port;
969 afs_uint32 remote_is_server;
970 afs_uint32 interfaceId;
971 afs_uint32 func_total;
972 afs_uint32 func_index;
973 afs_hyper_t invocations;
974 afs_hyper_t bytes_sent;
975 afs_hyper_t bytes_rcvd;
976 struct clock queue_time_sum;
977 struct clock queue_time_sum_sqr;
978 struct clock queue_time_min;
979 struct clock queue_time_max;
980 struct clock execution_time_sum;
981 struct clock execution_time_sum_sqr;
982 struct clock execution_time_min;
983 struct clock execution_time_max;
984 } rx_function_entry_v1_t, *rx_function_entry_v1_p;
987 * If you need to change rx_function_entry, you should probably create a brand
988 * new structure. Keeping the old structure will allow backwards compatibility
989 * with old clients (even if it is only used to calculate allocation size).
990 * If you do change the size or the format, you'll need to bump
991 * RX_STATS_RETRIEVAL_VERSION. This allows some primitive form
992 * of versioning a la rxdebug.
995 #define RX_STATS_RETRIEVAL_VERSION 1 /* latest version */
996 #define RX_STATS_RETRIEVAL_FIRST_EDITION 1 /* first implementation */
998 typedef struct rx_interface_stat {
999 struct rx_queue queue_header;
1000 struct rx_queue all_peers;
1001 rx_function_entry_v1_t stats[1]; /* make sure this is aligned correctly */
1002 } rx_interface_stat_t, *rx_interface_stat_p;
1004 #define RX_STATS_SERVICE_ID 409
1008 #endif /* _RX_ End of rx.h */
1011 #include "rx/rx_prototypes.h"
1013 #include "rx_prototypes.h"
1016 #endif /* !KDUMP_RX_LOCK */
git://git.openafs.org / openafs.git / blob