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