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