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