src/rx/rx.h

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