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