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