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.
27 #include "rx_kmutex.h"
28 #include "rx_kernel.h"
29 #if defined (AFS_OBSD_ENV) && !defined (MLEN)
32 #include "netinet/in.h"
33 #include "sys/socket.h"
35 # include <sys/types.h>
38 #ifdef AFS_PTHREAD_ENV
39 # include "rx_pthread.h"
50 # include <netinet/in.h>
51 # include <sys/socket.h>
55 #include <opr/queue.h>
63 /* These items are part of the new RX API. They're living in this section
64 * for now, to keep them separate from everything else... */
70 /* Connection management */
72 extern afs_uint32 rx_GetConnectionEpoch(struct rx_connection *conn);
73 extern afs_uint32 rx_GetConnectionId(struct rx_connection *conn);
74 extern void *rx_GetSecurityData(struct rx_connection *conn);
75 extern void rx_SetSecurityData(struct rx_connection *conn, void *data);
76 extern int rx_IsUsingPktCksum(struct rx_connection *conn);
77 extern void rx_SetSecurityHeaderSize(struct rx_connection *conn, afs_uint32 size);
78 extern afs_uint32 rx_GetSecurityHeaderSize(struct rx_connection *conn);
79 extern void rx_SetSecurityMaxTrailerSize(struct rx_connection *conn, afs_uint32 size);
80 extern afs_uint32 rx_GetSecurityMaxTrailerSize(struct rx_connection *conn);
81 extern void rx_SetMsgsizeRetryErr(struct rx_connection *conn, int err);
82 extern int rx_IsServerConn(struct rx_connection *conn);
83 extern int rx_IsClientConn(struct rx_connection *conn);
84 extern struct rx_securityClass *rx_SecurityObjectOf(const struct rx_connection *);
85 extern struct rx_peer *rx_PeerOf(struct rx_connection *);
86 extern u_short rx_ServiceIdOf(struct rx_connection *);
87 extern int rx_SecurityClassOf(struct rx_connection *);
88 extern struct rx_service *rx_ServiceOf(struct rx_connection *);
89 extern int rx_ConnError(struct rx_connection *);
92 extern struct rx_connection *rx_ConnectionOf(struct rx_call *call);
93 extern int rx_Error(struct rx_call *call);
94 extern int rx_GetRemoteStatus(struct rx_call *call);
95 extern void rx_SetLocalStatus(struct rx_call *call, int status);
96 extern int rx_GetCallAbortCode(struct rx_call *call);
97 extern void rx_SetCallAbortCode(struct rx_call *call, int code);
99 extern void rx_RecordCallStatistics(struct rx_call *call,
100 unsigned int rxInterface,
101 unsigned int currentFunc,
102 unsigned int totalFunc,
105 /* Peer management */
106 extern afs_uint32 rx_HostOf(struct rx_peer *peer);
107 extern u_short rx_PortOf(struct rx_peer *peer);
111 /* Packet classes, for rx_AllocPacket and rx_packetQuota */
112 #define RX_PACKET_CLASS_RECEIVE 0
113 #define RX_PACKET_CLASS_SEND 1
114 #define RX_PACKET_CLASS_SPECIAL 2
115 #define RX_PACKET_CLASS_RECV_CBUF 3
116 #define RX_PACKET_CLASS_SEND_CBUF 4
118 #define RX_N_PACKET_CLASSES 5 /* Must agree with above list */
120 #define RX_PACKET_TYPES {"data", "ack", "busy", "abort", "ackall", "challenge", "response", "debug", "params", "unused", "unused", "unused", "version"}
121 #define RX_N_PACKET_TYPES 13 /* Must agree with above list;
123 * WARNING: if this number ever
124 * grows past 13, rxdebug packets
125 * will need to be modified */
128 /* For most Unixes, maximum elements in an iovec is 16 */
129 #define RX_MAXIOVECS 16 /* limit for ReadvProc/WritevProc */
130 #define RX_MAXWVECS (RX_MAXIOVECS-1) /* need one iovec for packet header */
134 /* Call flags, states and modes are exposed by the debug interface */
135 #ifndef KDUMP_RX_LOCK
136 /* Major call states */
137 #define RX_STATE_NOTINIT 0 /* Call structure has never been initialized */
138 #define RX_STATE_PRECALL 1 /* Server-only: call is not in progress, but packets have arrived */
139 #define RX_STATE_ACTIVE 2 /* An active call; a process is dealing with this call */
140 #define RX_STATE_DALLY 3 /* Dallying after process is done with call */
141 #define RX_STATE_HOLD 4 /* Waiting for acks on reply data packets */
142 #define RX_STATE_RESET 5 /* Call is being reset */
144 /* Call modes: the modes of a call in RX_STATE_ACTIVE state (process attached) */
145 #define RX_MODE_SENDING 1 /* Sending or ready to send */
146 #define RX_MODE_RECEIVING 2 /* Receiving or ready to receive */
147 #define RX_MODE_ERROR 3 /* Something in error for current conversation */
148 #define RX_MODE_EOF 4 /* Server has flushed (or client has read) last reply packet */
151 #define RX_CALL_READER_WAIT 1 /* Reader is waiting for next packet */
152 #define RX_CALL_WAIT_WINDOW_ALLOC 2 /* Sender is waiting for window to allocate buffers */
153 #define RX_CALL_WAIT_WINDOW_SEND 4 /* Sender is waiting for window to send buffers */
154 #define RX_CALL_WAIT_PACKETS 8 /* Sender is waiting for packet buffers */
155 #define RX_CALL_WAIT_PROC 16 /* Waiting for a process to be assigned */
156 #define RX_CALL_RECEIVE_DONE 32 /* All packets received on this call */
157 #define RX_CALL_CLEARED 64 /* Receive queue cleared in precall state */
158 #define RX_CALL_TQ_BUSY 128 /* Call's Xmit Queue is busy; don't modify */
159 #define RX_CALL_TQ_CLEARME 256 /* Need to clear this call's TQ later */
160 #define RX_CALL_TQ_SOME_ACKED 512 /* rxi_Start needs to discard ack'd packets. */
161 #define RX_CALL_TQ_WAIT 1024 /* Reader is waiting for TQ_BUSY to be reset */
162 #define RX_CALL_FAST_RECOVER 2048 /* call is doing congestion recovery */
163 /* 4096 was RX_CALL_FAST_RECOVER_WAIT */
164 #define RX_CALL_SLOW_START_OK 8192 /* receiver acks every other packet */
165 #define RX_CALL_IOVEC_WAIT 16384 /* waiting thread is using an iovec */
166 #define RX_CALL_HAVE_LAST 32768 /* Last packet has been received */
167 #define RX_CALL_NEED_START 0x10000 /* tells rxi_Start to start again */
168 #define RX_CALL_PEER_BUSY 0x20000 /* the last packet we received on this call was a
169 * BUSY packet; i.e. the channel for this call is busy */
170 #define RX_CALL_ACKALL_SENT 0x40000 /* ACKALL has been sent on the call */
171 #define RX_CALL_FLUSH 0x80000 /* Transmit queue should be flushed to peer */
175 /* Configurable parameters */
176 #define RX_IDLE_DEAD_TIME 60 /* default idle dead time */
177 #define RX_MAX_SERVICES 20 /* Maximum number of services that may be installed */
178 #if defined(KERNEL) && defined(AFS_AIX51_ENV) && defined(__64__)
179 #define RX_DEFAULT_STACK_SIZE 24000
181 #define RX_DEFAULT_STACK_SIZE 16000 /* Default process stack size; overriden by rx_SetStackSize */
184 /* This parameter should not normally be changed */
185 #define RX_PROCESS_PRIORITY LWP_NORMAL_PRIORITY
187 #define ADDRSPERSITE 16
189 #ifndef KDUMP_RX_LOCK
190 /* Bottom n-bits of the Call Identifier give the call number */
191 #define RX_MAXCALLS 4 /* Power of 2; max async calls per connection */
192 #define RX_CIDSHIFT 2 /* Log2(RX_MAXCALLS) */
193 #define RX_CHANNELMASK (RX_MAXCALLS-1)
194 #define RX_CIDMASK (~RX_CHANNELMASK)
195 #endif /* !KDUMP_RX_LOCK */
198 typedef void (*rx_destructor_t) (void *);
199 int rx_KeyCreate(rx_destructor_t);
200 osi_socket rxi_GetHostUDPSocket(u_int host, u_short port);
201 osi_socket rxi_GetUDPSocket(u_short port);
205 int ntoh_syserr_conv(int error);
208 #define RX_DONTWAIT 0
210 #define rx_GetLocalStatus(call, status) ((call)->localStatus)
214 rx_IsLoopbackAddr(afs_uint32 addr)
216 return ((addr & 0xffff0000) == 0x7f000000);
220 * Macros callable by the user to further define attributes of a
221 * service. Must be called before rx_StartServer
224 /* Set the service stack size. This currently just sets the stack
225 * size for all processes to be the maximum seen, so far */
226 #define rx_SetStackSize(service, stackSize) \
227 rx_stackSize = (((stackSize) > rx_stackSize)? stackSize: rx_stackSize)
229 /* Set minimum number of processes guaranteed to be available for this
230 * service at all times */
231 #define rx_SetMinProcs(service, min) ((service)->minProcs = (min))
233 /* Set maximum number of processes that will be made available to this
234 * service (also a guarantee that this number will be made available
235 * if there is no competition) */
236 #define rx_SetMaxProcs(service, max) ((service)->maxProcs = (max))
238 /* Define a procedure to be called just before a server connection is destroyed */
239 #define rx_SetDestroyConnProc(service,proc) ((service)->destroyConnProc = (proc))
241 /* Define procedure to set service dead time */
242 #define rx_SetIdleDeadTime(service,time) ((service)->idleDeadTime = (time))
244 /* Define procedures for getting and setting before and after execute-request procs */
245 #define rx_SetAfterProc(service,proc) ((service)->afterProc = (proc))
246 #define rx_SetBeforeProc(service,proc) ((service)->beforeProc = (proc))
247 #define rx_GetAfterProc(service) ((service)->afterProc)
248 #define rx_GetBeforeProc(service) ((service)->beforeProc)
249 #define rx_SetPostProc(service,proc) ((service)->postProc = (proc))
250 #define rx_GetPostProc(service) ((service)->postProc)
252 /* Define a procedure to be called when a server connection is created */
253 #define rx_SetNewConnProc(service, proc) ((service)->newConnProc = (proc))
255 /* NOTE: We'll probably redefine the following three routines, again, sometime. */
257 /* Set the connection dead time for any connections created for this service (server only) */
258 #define rx_SetServiceDeadTime(service, seconds) ((service)->secondsUntilDead = (seconds))
260 /* Enable or disable asymmetric client checking for a service */
261 #define rx_SetCheckReach(service, x) ((service)->checkReach = (x))
263 /* Set the overload threshold and the overload error */
264 #define rx_SetBusyThreshold(threshold, code) (rx_BusyThreshold=(threshold),rx_BusyError=(code))
266 /* If this flag is set,no new requests are processed by rx, all new requests are
267 returned with an error code of RX_CALL_DEAD ( transient error ) */
268 #define rx_SetRxTranquil() (rx_tranquil = 1)
269 #define rx_ClearRxTranquil() (rx_tranquil = 0)
271 /* Set the threshold and time to delay aborts for consecutive errors */
272 #define rx_SetCallAbortThreshold(A) (rxi_callAbortThreshhold = (A))
273 #define rx_SetCallAbortDelay(A) (rxi_callAbortDelay = (A))
274 #define rx_SetConnAbortThreshold(A) (rxi_connAbortThreshhold = (A))
275 #define rx_SetConnAbortDelay(A) (rxi_connAbortDelay = (A))
279 #define cpspace(call) ((call)->curlen)
280 #define cppos(call) ((call)->curpos)
282 #define rx_Read(call, buf, nbytes) rx_ReadProc(call, buf, nbytes)
283 #define rx_Read32(call, value) rx_ReadProc32(call, value)
284 #define rx_Readv(call, iov, nio, maxio, nbytes) \
285 rx_ReadvProc(call, iov, nio, maxio, nbytes)
286 #define rx_Write(call, buf, nbytes) rx_WriteProc(call, buf, nbytes)
287 #define rx_Write32(call, value) rx_WriteProc32(call, value)
288 #define rx_Writev(call, iov, nio, nbytes) \
289 rx_WritevProc(call, iov, nio, nbytes)
291 /* This is the maximum size data packet that can be sent on this connection, accounting for security module-specific overheads. */
292 #define rx_MaxUserDataSize(call) ((call)->MTU - RX_HEADER_SIZE - (call)->conn->securityHeaderSize - (call)->conn->securityMaxTrailerSize)
294 /* Macros to turn the hot thread feature on and off. Enabling hot threads
295 * allows the listener thread to trade places with an idle worker thread,
296 * which moves the context switch from listener to worker out of the
299 #define rx_EnableHotThread() (rx_enable_hot_thread = 1)
300 #define rx_DisableHotThread() (rx_enable_hot_thread = 0)
302 #define rx_PutConnection(conn) rx_DestroyConnection(conn)
304 /* A service is installed by rx_NewService, and specifies a service type that
305 * is exported by this process. Incoming calls are stamped with the service
306 * type, and must match an installed service for the call to be accepted.
307 * Each service exported has a (port,serviceId) pair to uniquely identify it.
308 * It is also named: this is intended to allow a remote statistics gathering
309 * program to retrieve per service statistics without having to know the local
310 * service id's. Each service has a number of
313 /* security objects (instances of security classes) which implement
314 * various types of end-to-end security protocols for connections made
315 * to this service. Finally, there are two parameters controlling the
316 * number of requests which may be executed in parallel by this
317 * service: minProcs is the number of requests to this service which
318 * are guaranteed to be able to run in parallel at any time; maxProcs
319 * has two meanings: it limits the total number of requests which may
320 * execute in parallel and it also guarantees that that many requests
321 * may be handled in parallel if no other service is handling any
325 u_short serviceId; /* Service number */
326 afs_uint32 serviceHost; /* IP address for this service */
327 u_short servicePort; /* UDP port for this service */
328 char *serviceName; /* Name of the service */
329 osi_socket socket; /* socket structure or file descriptor */
330 u_short nRequestsRunning; /* Number of requests currently in progress */
331 u_short nSecurityObjects; /* Number of entries in security objects array */
332 struct rx_securityClass **securityObjects; /* Array of security class objects */
333 afs_int32(*executeRequestProc) (struct rx_call * acall); /* Routine to call when an rpc request is received */
334 void (*destroyConnProc) (struct rx_connection * tcon); /* Routine to call when a server connection is destroyed */
335 void (*newConnProc) (struct rx_connection * tcon); /* Routine to call when a server connection is created */
336 void (*beforeProc) (struct rx_call * acall); /* routine to call before a call is executed */
337 void (*afterProc) (struct rx_call * acall, afs_int32 code); /* routine to call after a call is executed */
338 void (*postProc) (afs_int32 code); /* routine to call after the call has ended */
339 u_short maxProcs; /* Maximum procs to be used for this service */
340 u_short minProcs; /* Minimum # of requests guaranteed executable simultaneously */
341 u_short connDeadTime; /* Seconds until a client of this service will be declared dead, if it is not responding */
342 u_short idleDeadTime; /* Time a server will wait for I/O to start up again */
343 u_char checkReach; /* Check for asymmetric clients? */
344 int nSpecific; /* number entries in specific data */
345 void **specific; /* pointer to connection specific data */
346 #ifdef RX_ENABLE_LOCKS
347 afs_kmutex_t svc_data_lock; /* protect specific data */
352 #endif /* KDUMP_RX_LOCK */
354 #ifndef KDUMP_RX_LOCK
355 /* Flag bits for connection structure */
356 #define RX_CONN_MAKECALL_WAITING 1 /* rx_NewCall is waiting for a channel */
357 #define RX_CONN_DESTROY_ME 2 /* Destroy *client* connection after last call */
358 #define RX_CONN_USING_PACKET_CKSUM 4 /* non-zero header.spare field seen */
359 #define RX_CONN_KNOW_WINDOW 8 /* window size negotiation works */
360 #define RX_CONN_RESET 16 /* connection is reset, remove */
361 #define RX_CONN_BUSY 32 /* connection is busy; don't delete */
362 #define RX_CONN_ATTACHWAIT 64 /* attach waiting for peer->lastReach */
363 #define RX_CONN_MAKECALL_ACTIVE 128 /* a thread is actively in rx_NewCall */
364 #define RX_CONN_NAT_PING 256 /* nat ping requested */
366 /* Type of connection, client or server */
367 #define RX_CLIENT_CONNECTION 0
368 #define RX_SERVER_CONNECTION 1
369 #endif /* !KDUMP_RX_LOCK */
371 /* Maximum number of acknowledgements in an acknowledge packet */
372 #define RX_MAXACKS 255
374 #ifndef KDUMP_RX_LOCK
376 /* The structure of the data portion of an acknowledge packet: An acknowledge
377 * packet is in network byte order at all times. An acknowledgement is always
378 * prompted for a specific reason by a specific incoming packet. This reason
379 * is reported in "reason" and the packet's sequence number in the packet
380 * header.seq. In addition to this information, all of the current
381 * acknowledgement information about this call is placed in the packet.
382 * "FirstPacket" is the sequence number of the first packet represented in an
383 * array of bytes, "acks", containing acknowledgement information for a number
384 * of consecutive packets. All packets prior to FirstPacket are implicitly
385 * acknowledged: the sender need no longer be concerned about them. Packets
386 * from firstPacket+nAcks and on are not acknowledged. Packets in the range
387 * [firstPacket,firstPacket+nAcks) are each acknowledged explicitly. The
388 * acknowledgement may be RX_NACK if the packet is not (currently) at the
389 * receiver (it may have never been received, or received and then later
390 * dropped), or it may be RX_ACK if the packet is queued up waiting to be read
391 * by the upper level software. RX_ACK does not imply that the packet may not
392 * be dropped before it is read; it does imply that the sender should stop
393 * retransmitting the packet until notified otherwise. The field
394 * previousPacket identifies the previous packet received by the peer. This
395 * was used in a previous version of this software, and could be used in the
396 * future. The serial number in the data part of the ack packet corresponds to
397 * the serial number oof the packet which prompted the acknowledge. Any
398 * packets which are explicitly not acknowledged, and which were last
399 * transmitted with a serial number less than the provided serial number,
400 * should be retransmitted immediately. Actually, this is slightly inaccurate:
401 * packets are not necessarily received in order. When packets are habitually
402 * transmitted out of order, this is allowed for in the retransmission
403 * algorithm by introducing the notion of maximum packet skew: the degree of
404 * out-of-orderness of the packets received on the wire. This number is
405 * communicated from the receiver to the sender in ack packets. */
407 struct rx_ackPacket {
408 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. */
409 u_short maxSkew; /* Maximum difference between serial# of packet acknowledged and highest packet yet received */
410 afs_uint32 firstPacket; /* The first packet in the list of acknowledged packets */
411 afs_uint32 previousPacket; /* The previous packet number received (obsolete?) */
412 afs_uint32 serial; /* Serial number of the packet which prompted the acknowledge */
413 u_char reason; /* Reason for the acknowledge of ackPacket, defined below */
414 u_char nAcks; /* Number of acknowledgements */
415 u_char acks[RX_MAXACKS]; /* Up to RX_MAXACKS packet acknowledgements, defined below */
416 /* 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) */
419 #define FIRSTACKOFFSET 4
421 /* Reason for acknowledge message */
422 #define RX_ACK_REQUESTED 1 /* Peer requested an ack on this packet */
423 #define RX_ACK_DUPLICATE 2 /* Duplicate packet */
424 #define RX_ACK_OUT_OF_SEQUENCE 3 /* Packet out of sequence */
425 #define RX_ACK_EXCEEDS_WINDOW 4 /* Packet sequence number higher than window; discarded */
426 #define RX_ACK_NOSPACE 5 /* No buffer space at all */
427 #define RX_ACK_PING 6 /* This is a keep-alive ack */
428 #define RX_ACK_PING_RESPONSE 7 /* Ack'ing because we were pinged */
429 #define RX_ACK_DELAY 8 /* Ack generated since nothing has happened since receiving packet */
430 #define RX_ACK_IDLE 9 /* Similar to RX_ACK_DELAY, but can
431 * be used to compute RTT */
432 #define RX_ACK_MTU -1 /* will be rewritten to ACK_PING */
434 /* Packet acknowledgement type */
435 #define RX_ACK_TYPE_NACK 0 /* I Don't have this packet */
436 #define RX_ACK_TYPE_ACK 1 /* I have this packet, although I may discard it later */
438 /* The packet size transmitted for an acknowledge is adjusted to reflect the actual size of the acks array. This macro defines the size */
439 #define rx_AckDataSize(nAcks) (3 + nAcks + offsetof(struct rx_ackPacket, acks[0]))
441 #define RX_CHALLENGE_TIMEOUT 2 /* Number of seconds before another authentication request packet is generated */
442 #define RX_CHALLENGE_MAXTRIES 50 /* Max # of times we resend challenge */
443 #define RX_CHECKREACH_TIMEOUT 2 /* Number of seconds before another ping is generated */
444 #define RX_CHECKREACH_TTL 60 /* Re-check reachability this often */
447 * rx_GetNetworkError 'origin' constants. These define the meaning of the
448 * 'type' and 'code' values returned by rx_GetNetworkError.
451 /* Used for ICMP errors; the type and code are the ICMP type and code,
453 #define RX_NETWORK_ERROR_ORIGIN_ICMP (0)
456 * RX error codes. RX uses error codes from -1 to -64 and -100.
457 * Rxgen uses other error codes < -64 (see src/rxgen/rpc_errors.h);
458 * user programs are expected to return positive error codes
461 /* Something bad happened to the connection; temporary loss of communication */
462 #define RX_CALL_DEAD (-1)
465 * An invalid operation, such as a client attempting to send data
466 * after having received the beginning of a reply from the server.
468 #define RX_INVALID_OPERATION (-2)
470 /* An optional timeout per call may be specified */
471 #define RX_CALL_TIMEOUT (-3)
473 /* End of data on a read. Not currently in use. */
476 /* Some sort of low-level protocol error. */
477 #define RX_PROTOCOL_ERROR (-5)
480 * Generic user abort code; used when no more specific error code needs to be
481 * communicated. For example, multi rx clients use this code to abort a multi-
484 #define RX_USER_ABORT (-6)
486 /* Port already in use (from rx_Init). This error is never sent on the wire. */
487 #define RX_ADDRINUSE (-7)
489 /* EMSGSIZE returned from network. Packet too big, must fragment */
490 #define RX_MSGSIZE (-8)
492 /* The value -9 was previously used for RX_CALL_IDLE but is now free for
496 * Busy call channel error. This error is never sent on the wire.
497 * rxi_SendCallAbort() translates RX_CALL_BUSY to RX_CALL_TIMEOUT.
499 #define RX_CALL_BUSY (-10)
501 /* transient failure detected ( possibly the server is restarting ) */
502 /* this should be equal to VRESTARTING ( util/errors.h ) for old clients to work */
503 #define RX_RESTARTING (-100)
506 RX_SECIDX_NULL = 0, /** rxnull, no security. */
507 RX_SECIDX_VAB = 1, /** vice tokens with bcrypt. Unused. */
508 RX_SECIDX_KAD = 2, /** kerberos/DES. */
509 RX_SECIDX_KAE = 3, /** rxkad, but always encrypt. */
510 RX_SECIDX_GK = 4, /** rxgk, RFC 3961 crypto. */
511 RX_SECIDX_K5 = 5, /** kerberos 5 tickets as tokens. */
515 * We use an enum for the symbol definitions but have no need for a typedef
516 * because the enum is at least as wide as 'int' and these have to fit into
517 * a field of type 'char'. Direct assigment will do the right thing if the
518 * enum value fits into that type.
526 struct rx_securityObjectStats {
527 char type; /* An RX_SECTYPE_* value */
529 char sparec[10]; /* force correct alignment */
530 afs_int32 flags; /* 1=>unalloc, 2=>auth, 4=>expired */
532 afs_uint32 packetsReceived;
533 afs_uint32 packetsSent;
534 afs_uint32 bytesReceived;
535 afs_uint32 bytesSent;
540 /* Configuration settings */
542 /* Enum for storing configuration variables which can be set via the
543 * SetConfiguration method in the rx_securityClass, below
547 RXS_CONFIG_FLAGS /* afs_uint32 set of bitwise flags */
548 } rx_securityConfigVariables;
550 /* For the RXS_CONFIG_FLAGS, the following bit values are defined */
552 /* Disable the principal name contains dot check in rxkad */
553 #define RXS_CONFIG_FLAGS_DISABLE_DOTCHECK 0x01
555 /* XXXX (rewrite this description) A security class object contains a set of
556 * procedures and some private data to implement a security model for rx
557 * connections. These routines are called by rx as appropriate. Rx knows
558 * nothing about the internal details of any particular security model, or
559 * about security state. Rx does maintain state per connection on behalf of
560 * the security class. Each security class implementation is also expected to
561 * provide routines to create these objects. Rx provides a basic routine to
562 * allocate one of these objects; this routine must be called by the class. */
563 struct rx_securityClass {
564 struct rx_securityOps {
565 int (*op_Close) (struct rx_securityClass * aobj);
566 int (*op_NewConnection) (struct rx_securityClass * aobj,
567 struct rx_connection * aconn);
568 int (*op_PreparePacket) (struct rx_securityClass * aobj,
569 struct rx_call * acall,
570 struct rx_packet * apacket);
571 int (*op_SendPacket) (struct rx_securityClass * aobj,
572 struct rx_call * acall,
573 struct rx_packet * apacket);
574 int (*op_CheckAuthentication) (struct rx_securityClass * aobj,
575 struct rx_connection * aconn);
576 int (*op_CreateChallenge) (struct rx_securityClass * aobj,
577 struct rx_connection * aconn);
578 int (*op_GetChallenge) (struct rx_securityClass * aobj,
579 struct rx_connection * aconn,
580 struct rx_packet * apacket);
581 int (*op_GetResponse) (struct rx_securityClass * aobj,
582 struct rx_connection * aconn,
583 struct rx_packet * apacket);
584 int (*op_CheckResponse) (struct rx_securityClass * aobj,
585 struct rx_connection * aconn,
586 struct rx_packet * apacket);
587 int (*op_CheckPacket) (struct rx_securityClass * aobj,
588 struct rx_call * acall,
589 struct rx_packet * apacket);
590 int (*op_DestroyConnection) (struct rx_securityClass * aobj,
591 struct rx_connection * aconn);
592 int (*op_GetStats) (struct rx_securityClass * aobj,
593 struct rx_connection * aconn,
594 struct rx_securityObjectStats * astats);
595 int (*op_SetConfiguration) (struct rx_securityClass * aobj,
596 struct rx_connection * aconn,
597 rx_securityConfigVariables atype,
599 void ** acurrentValue);
600 int (*op_Spare2) (void);
601 int (*op_Spare3) (void);
607 #define RXS_OP(obj,op,args) ((obj && (obj->ops->op_ ## op)) ? (*(obj)->ops->op_ ## op)args : 0)
609 #define RXS_Close(obj) RXS_OP(obj,Close,(obj))
610 #define RXS_NewConnection(obj,conn) RXS_OP(obj,NewConnection,(obj,conn))
611 #define RXS_PreparePacket(obj,call,packet) RXS_OP(obj,PreparePacket,(obj,call,packet))
612 #define RXS_SendPacket(obj,call,packet) RXS_OP(obj,SendPacket,(obj,call,packet))
613 #define RXS_CheckAuthentication(obj,conn) RXS_OP(obj,CheckAuthentication,(obj,conn))
614 #define RXS_CreateChallenge(obj,conn) RXS_OP(obj,CreateChallenge,(obj,conn))
615 #define RXS_GetChallenge(obj,conn,packet) RXS_OP(obj,GetChallenge,(obj,conn,packet))
616 #define RXS_GetResponse(obj,conn,packet) RXS_OP(obj,GetResponse,(obj,conn,packet))
617 #define RXS_CheckResponse(obj,conn,packet) RXS_OP(obj,CheckResponse,(obj,conn,packet))
618 #define RXS_CheckPacket(obj,call,packet) RXS_OP(obj,CheckPacket,(obj,call,packet))
619 #define RXS_DestroyConnection(obj,conn) RXS_OP(obj,DestroyConnection,(obj,conn))
620 #define RXS_GetStats(obj,conn,stats) RXS_OP(obj,GetStats,(obj,conn,stats))
621 #define RXS_SetConfiguration(obj, conn, type, value, currentValue) RXS_OP(obj, SetConfiguration,(obj,conn,type,value,currentValue))
625 /* Structure for keeping rx statistics. Note that this structure is returned
626 * by rxdebug, so, for compatibility reasons, new fields should be appended (or
627 * spares used), the rxdebug protocol checked, if necessary, and the PrintStats
628 * code should be updated as well.
630 * Clearly we assume that ntohl will work on these structures so sizeof(int)
631 * must equal sizeof(afs_int32). */
633 struct rx_statistics { /* General rx statistics */
634 int packetRequests; /* Number of packet allocation requests */
635 int receivePktAllocFailures;
636 int sendPktAllocFailures;
637 int specialPktAllocFailures;
638 int socketGreedy; /* Whether SO_GREEDY succeeded */
639 int bogusPacketOnRead; /* Number of inappropriately short packets received */
640 int bogusHost; /* Host address from bogus packets */
641 int noPacketOnRead; /* Number of read packets attempted when there was actually no packet to read off the wire */
642 int noPacketBuffersOnRead; /* Number of dropped data packets due to lack of packet buffers */
643 int selects; /* Number of selects waiting for packet or timeout */
644 int sendSelects; /* Number of selects forced when sending packet */
645 int packetsRead[RX_N_PACKET_TYPES]; /* Total number of packets read, per type */
646 int dataPacketsRead; /* Number of unique data packets read off the wire */
647 int ackPacketsRead; /* Number of ack packets read */
648 int dupPacketsRead; /* Number of duplicate data packets read */
649 int spuriousPacketsRead; /* Number of inappropriate data packets */
650 int packetsSent[RX_N_PACKET_TYPES]; /* Number of rxi_Sends: packets sent over the wire, per type */
651 int ackPacketsSent; /* Number of acks sent */
652 int pingPacketsSent; /* Total number of ping packets sent */
653 int abortPacketsSent; /* Total number of aborts */
654 int busyPacketsSent; /* Total number of busies sent received */
655 int dataPacketsSent; /* Number of unique data packets sent */
656 int dataPacketsReSent; /* Number of retransmissions */
657 int dataPacketsPushed; /* Number of retransmissions pushed early by a NACK */
658 int ignoreAckedPacket; /* Number of packets with acked flag, on rxi_Start */
659 struct clock totalRtt; /* Total round trip time measured (use to compute average) */
660 struct clock minRtt; /* Minimum round trip time measured */
661 struct clock maxRtt; /* Maximum round trip time measured */
662 int nRttSamples; /* Total number of round trip samples */
663 int nServerConns; /* Total number of server connections */
664 int nClientConns; /* Total number of client connections */
665 int nPeerStructs; /* Total number of peer structures */
666 int nCallStructs; /* Total number of call structures allocated */
667 int nFreeCallStructs; /* Total number of previously allocated free call structures */
669 afs_int32 fatalErrors;
670 int ignorePacketDally; /* packets dropped because call is in dally state */
671 int receiveCbufPktAllocFailures;
672 int sendCbufPktAllocFailures;
677 /* structures for debug input and output packets */
679 /* debug input types */
685 /* Invalid rx debug package type */
686 #define RX_DEBUGI_BADTYPE (-8)
688 #define RX_DEBUGI_VERSION_MINIMUM ('L') /* earliest real version */
689 #define RX_DEBUGI_VERSION ('S') /* Latest version */
690 /* first version w/ secStats */
691 #define RX_DEBUGI_VERSION_W_SECSTATS ('L')
692 /* version M is first supporting GETALLCONN and RXSTATS type */
693 #define RX_DEBUGI_VERSION_W_GETALLCONN ('M')
694 #define RX_DEBUGI_VERSION_W_RXSTATS ('M')
695 /* last version with unaligned debugConn */
696 #define RX_DEBUGI_VERSION_W_UNALIGNED_CONN ('L')
697 #define RX_DEBUGI_VERSION_W_WAITERS ('N')
698 #define RX_DEBUGI_VERSION_W_IDLETHREADS ('O')
699 #define RX_DEBUGI_VERSION_W_NEWPACKETTYPES ('P')
700 #define RX_DEBUGI_VERSION_W_GETPEER ('Q')
701 #define RX_DEBUGI_VERSION_W_WAITED ('R')
702 #define RX_DEBUGI_VERSION_W_PACKETS ('S')
704 #define RX_DEBUGI_GETSTATS 1 /* get basic rx stats */
705 #define RX_DEBUGI_GETCONN 2 /* get connection info */
706 #define RX_DEBUGI_GETALLCONN 3 /* get even uninteresting conns */
707 #define RX_DEBUGI_RXSTATS 4 /* get all rx stats */
708 #define RX_DEBUGI_GETPEER 5 /* get all peer structs */
710 struct rx_debugStats {
711 afs_int32 nFreePackets;
712 afs_int32 packetReclaims;
713 afs_int32 callsExecuted;
714 char waitingForPackets;
719 afs_int32 idleThreads; /* Number of server threads that are idle */
725 struct rx_debugConn_vL {
729 afs_int32 callNumber[RX_MAXCALLS];
735 char callState[RX_MAXCALLS];
736 char callMode[RX_MAXCALLS];
737 char callFlags[RX_MAXCALLS];
738 char callOther[RX_MAXCALLS];
739 /* old style getconn stops here */
740 struct rx_securityObjectStats secStats;
741 afs_int32 sparel[10];
744 struct rx_debugConn {
748 afs_int32 callNumber[RX_MAXCALLS];
754 char sparec[3]; /* force correct alignment */
755 char callState[RX_MAXCALLS];
756 char callMode[RX_MAXCALLS];
757 char callFlags[RX_MAXCALLS];
758 char callOther[RX_MAXCALLS];
759 /* old style getconn stops here */
760 struct rx_securityObjectStats secStats;
766 struct rx_debugPeer {
774 struct clock burstWait;
777 struct clock timeout;
780 afs_int32 inPacketSkew;
781 afs_int32 outPacketSkew;
785 u_short maxDgramPackets;
786 u_short ifDgramPackets;
789 u_short nDgramPackets;
791 afs_hyper_t bytesSent;
792 afs_hyper_t bytesReceived;
793 afs_int32 sparel[10];
796 #define RX_OTHER_IN 1 /* packets avail in in queue */
797 #define RX_OTHER_OUT 2 /* packets avail in out queue */
799 #define RX_SERVER_DEBUG_SEC_STATS 0x1
800 #define RX_SERVER_DEBUG_ALL_CONN 0x2
801 #define RX_SERVER_DEBUG_RX_STATS 0x4
802 #define RX_SERVER_DEBUG_WAITER_CNT 0x8
803 #define RX_SERVER_DEBUG_IDLE_THREADS 0x10
804 #define RX_SERVER_DEBUG_OLD_CONN 0x20
805 #define RX_SERVER_DEBUG_NEW_PACKETS 0x40
806 #define RX_SERVER_DEBUG_ALL_PEER 0x80
807 #define RX_SERVER_DEBUG_WAITED_CNT 0x100
808 #define RX_SERVER_DEBUG_PACKETS_CNT 0x200
810 #define AFS_RX_STATS_CLEAR_ALL 0xffffffff
811 #define AFS_RX_STATS_CLEAR_INVOCATIONS 0x1
812 #define AFS_RX_STATS_CLEAR_BYTES_SENT 0x2
813 #define AFS_RX_STATS_CLEAR_BYTES_RCVD 0x4
814 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SUM 0x8
815 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_SQUARE 0x10
816 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MIN 0x20
817 #define AFS_RX_STATS_CLEAR_QUEUE_TIME_MAX 0x40
818 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SUM 0x80
819 #define AFS_RX_STATS_CLEAR_EXEC_TIME_SQUARE 0x100
820 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MIN 0x200
821 #define AFS_RX_STATS_CLEAR_EXEC_TIME_MAX 0x400
823 typedef struct rx_function_entry_v1 {
824 afs_uint32 remote_peer;
825 afs_uint32 remote_port;
826 afs_uint32 remote_is_server;
827 afs_uint32 interfaceId;
828 afs_uint32 func_total;
829 afs_uint32 func_index;
830 afs_uint64 invocations;
831 afs_uint64 bytes_sent;
832 afs_uint64 bytes_rcvd;
833 struct clock queue_time_sum;
834 struct clock queue_time_sum_sqr;
835 struct clock queue_time_min;
836 struct clock queue_time_max;
837 struct clock execution_time_sum;
838 struct clock execution_time_sum_sqr;
839 struct clock execution_time_min;
840 struct clock execution_time_max;
841 } rx_function_entry_v1_t, *rx_function_entry_v1_p;
844 * If you need to change rx_function_entry, you should probably create a brand
845 * new structure. Keeping the old structure will allow backwards compatibility
846 * with old clients (even if it is only used to calculate allocation size).
847 * If you do change the size or the format, you'll need to bump
848 * RX_STATS_RETRIEVAL_VERSION. This allows some primitive form
849 * of versioning a la rxdebug.
852 #define RX_STATS_RETRIEVAL_VERSION 1 /* latest version */
853 #define RX_STATS_RETRIEVAL_FIRST_EDITION 1 /* first implementation */
855 typedef struct rx_interface_stat {
856 struct opr_queue entry;
857 struct opr_queue entryPeers;
858 rx_function_entry_v1_t stats[1]; /* make sure this is aligned correctly */
859 } rx_interface_stat_t, *rx_interface_stat_p;
861 #define RX_STATS_SERVICE_ID 409
864 extern int rx_DumpCalls(FILE *outputFile, char *cookie);
867 #endif /* _RX_ End of rx.h */
870 #include "rx/rx_prototypes.h"
872 #include "rx_prototypes.h"
875 static_inline afs_uint32
876 RPCOpStat_Peer(void *blob) {
877 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
878 return rpcop_stat->remote_peer;
881 static_inline afs_uint32
882 RPCOpStat_Port(void *blob) {
883 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
884 return rpcop_stat->remote_port;
887 static_inline afs_uint32
888 RPCOpStat_IsServer(void *blob) {
889 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
890 return rpcop_stat->remote_is_server;
893 static_inline afs_uint32
894 RPCOpStat_InterfaceId(void *blob) {
895 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
896 return rpcop_stat->interfaceId;
899 static_inline afs_uint32
900 RPCOpStat_NumFuncs(void *blob) {
901 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
902 return rpcop_stat->func_total;
905 static_inline afs_uint32
906 RPCOpStat_CurFunc(void *blob) {
907 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
908 return rpcop_stat->func_index;
911 static_inline struct clock *
912 RPCOpStat_QTimeSum(void *blob) {
913 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
914 return &(rpcop_stat->queue_time_sum);
917 static_inline struct clock *
918 RPCOpStat_QTimeSumSqr(void *blob) {
919 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
920 return &(rpcop_stat->queue_time_sum_sqr);
923 static_inline struct clock *
924 RPCOpStat_QTimeSumMin(void *blob) {
925 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
926 return &(rpcop_stat->queue_time_min);
929 static_inline struct clock *
930 RPCOpStat_QTimeSumMax(void *blob) {
931 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
932 return &(rpcop_stat->queue_time_max);
935 static_inline struct clock *
936 RPCOpStat_ExecTimeSum(void *blob) {
937 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
938 return &(rpcop_stat->execution_time_sum);
941 static_inline struct clock *
942 RPCOpStat_ExecTimeSumSqr(void *blob) {
943 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
944 return &(rpcop_stat->execution_time_sum_sqr);
947 static_inline struct clock *
948 RPCOpStat_ExecTimeSumMin(void *blob) {
949 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
950 return &(rpcop_stat->execution_time_min);
953 static_inline struct clock *
954 RPCOpStat_ExecTimeSumMax(void *blob) {
955 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
956 return &(rpcop_stat->execution_time_max);
959 static_inline afs_uint64
960 RPCOpStat_NumCalls(void *blob) {
961 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
962 return rpcop_stat->invocations;
965 static_inline afs_uint64
966 RPCOpStat_BytesSent(void *blob) {
967 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
968 return rpcop_stat->bytes_sent;
971 static_inline afs_uint64
972 RPCOpStat_BytesRcvd(void *blob) {
973 rx_function_entry_v1_p rpcop_stat = (rx_function_entry_v1_p)blob;
974 return rpcop_stat->bytes_rcvd;
976 #endif /* !KDUMP_RX_LOCK */