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