rx: Make the rx_call structure private
[openafs.git] / src / rx / rx.h
index c0d2610..5668eba 100644 (file)
@@ -87,6 +87,63 @@ extern int rx_SecurityClassOf(struct rx_connection *);
 extern struct rx_service *rx_ServiceOf(struct rx_connection *);
 extern int rx_ConnError(struct rx_connection *);
 
+/* Call management */
+extern struct rx_connection *rx_ConnectionOf(struct rx_call *call);
+extern int rx_Error(struct rx_call *call);
+extern int rx_GetRemoteStatus(struct rx_call *call);
+extern void rx_SetLocalStatus(struct rx_call *call, int status);
+extern int rx_GetCallAbortCode(struct rx_call *call);
+extern void rx_SetCallAbortCode(struct rx_call *call, int code);
+
+extern void rx_RecordCallStatistics(struct rx_call *call,
+                                   unsigned int rxInterface,
+                                   unsigned int currentFunc,
+                                   unsigned int totalFunc,
+                                   int isServer);
+
+
+/* Debugging */
+
+/* Call flags, states and modes are exposed by the debug interface */
+#ifndef KDUMP_RX_LOCK
+/* Major call states */
+#define        RX_STATE_NOTINIT  0     /* Call structure has never been initialized */
+#define        RX_STATE_PRECALL  1     /* Server-only:  call is not in progress, but packets have arrived */
+#define        RX_STATE_ACTIVE   2     /* An active call; a process is dealing with this call */
+#define        RX_STATE_DALLY    3     /* Dallying after process is done with call */
+#define        RX_STATE_HOLD     4     /* Waiting for acks on reply data packets */
+#define RX_STATE_RESET    5     /* Call is being reset */
+
+/* Call modes:  the modes of a call in RX_STATE_ACTIVE state (process attached) */
+#define        RX_MODE_SENDING   1     /* Sending or ready to send */
+#define        RX_MODE_RECEIVING 2     /* Receiving or ready to receive */
+#define        RX_MODE_ERROR     3     /* Something in error for current conversation */
+#define        RX_MODE_EOF       4     /* Server has flushed (or client has read) last reply packet */
+
+/* Flags */
+#define        RX_CALL_READER_WAIT        1    /* Reader is waiting for next packet */
+#define        RX_CALL_WAIT_WINDOW_ALLOC  2    /* Sender is waiting for window to allocate buffers */
+#define        RX_CALL_WAIT_WINDOW_SEND   4    /* Sender is waiting for window to send buffers */
+#define        RX_CALL_WAIT_PACKETS       8    /* Sender is waiting for packet buffers */
+#define        RX_CALL_WAIT_PROC         16    /* Waiting for a process to be assigned */
+#define        RX_CALL_RECEIVE_DONE      32    /* All packets received on this call */
+#define        RX_CALL_CLEARED           64    /* Receive queue cleared in precall state */
+#define        RX_CALL_TQ_BUSY          128    /* Call's Xmit Queue is busy; don't modify */
+#define        RX_CALL_TQ_CLEARME       256    /* Need to clear this call's TQ later */
+#define RX_CALL_TQ_SOME_ACKED    512   /* rxi_Start needs to discard ack'd packets. */
+#define RX_CALL_TQ_WAIT                1024    /* Reader is waiting for TQ_BUSY to be reset */
+#define RX_CALL_FAST_RECOVER    2048   /* call is doing congestion recovery */
+/* 4096 was RX_CALL_FAST_RECOVER_WAIT */
+#define RX_CALL_SLOW_START_OK   8192   /* receiver acks every other packet */
+#define RX_CALL_IOVEC_WAIT     16384   /* waiting thread is using an iovec */
+#define RX_CALL_HAVE_LAST      32768   /* Last packet has been received */
+#define RX_CALL_NEED_START     0x10000 /* tells rxi_Start to start again */
+#define RX_CALL_PEER_BUSY      0x20000 /* the last packet we received on this call was a
+                                         * BUSY packet; i.e. the channel for this call is busy */
+#define RX_CALL_ACKALL_SENT     0x40000 /* ACKALL has been sent on the call */
+
+#endif
+
 /* Configurable parameters */
 #define        RX_IDLE_DEAD_TIME       60      /* default idle dead time */
 #define        RX_MAX_SERVICES         20      /* Maximum number of services that may be installed */
@@ -122,13 +179,10 @@ int ntoh_syserr_conv(int error);
 #define        RX_WAIT     1
 #define        RX_DONTWAIT 0
 
-#define        rx_ConnectionOf(call)           ((call)->conn)
 #define        rx_HostOf(peer)                 ((peer)->host)
 #define        rx_PortOf(peer)                 ((peer)->port)
-#define        rx_SetLocalStatus(call, status) ((call)->localStatus = (status))
 #define rx_GetLocalStatus(call, status) ((call)->localStatus)
-#define        rx_GetRemoteStatus(call)        ((call)->remoteStatus)
-#define        rx_Error(call)                  ((call)->error)
+
 
 static_inline int
 rx_IsLoopbackAddr(afs_uint32 addr)
@@ -198,8 +252,7 @@ returned with an error code of RX_CALL_DEAD ( transient error ) */
 #define rx_SetConnAbortThreshold(A) (rxi_connAbortThreshhold = (A))
 #define rx_SetConnAbortDelay(A) (rxi_connAbortDelay = (A))
 
-#define rx_GetCallAbortCode(call) ((call)->abortCode)
-#define rx_SetCallAbortCode(call, code) ((call)->abortCode = (code))
+
 
 #define cpspace(call) ((call)->curlen)
 #define cppos(call) ((call)->curpos)
@@ -394,188 +447,7 @@ struct rx_peer {
 /* Maximum number of acknowledgements in an acknowledge packet */
 #define        RX_MAXACKS          255
 
-/* 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. */
-#ifdef KDUMP_RX_LOCK
-struct rx_call_rx_lock {
-#else
-struct rx_call {
-#endif
-    struct rx_queue queue_item_header; /* Call can be on various queues (one-at-a-time) */
-    struct rx_queue tq;                /* Transmit packet queue */
-    struct rx_queue rq;                /* Receive packet queue */
-    /*
-     * The following fields are accessed while the call is unlocked.
-     * These fields are used by the caller/server thread to marshall
-     * and unmarshall RPC data. The only time they may be changed by
-     * other threads is when the RX_CALL_IOVEC_WAIT flag is set.
-     *
-     * NOTE: Be sure that these fields start and end on a double
-     *       word boundary. Otherwise threads that are changing
-     *       adjacent fields will cause problems.
-     */
-    struct rx_queue iovq;      /* readv/writev packet queue */
-    u_short nLeft;             /* Number bytes left in first receive packet */
-    u_short curvec;            /* current iovec in currentPacket */
-    u_short curlen;            /* bytes remaining in curvec */
-    u_short nFree;             /* Number bytes free in last send packet */
-    struct rx_packet *currentPacket;   /* Current packet being assembled or being read */
-    char *curpos;              /* current position in curvec */
-    /*
-     * End of fields accessed with call unlocked
-     */
-    u_char channel;            /* Index of call, within connection */
-    u_char state;              /* Current call state as defined below */
-    u_char mode;               /* Current mode of a call in ACTIVE state */
-#ifdef RX_ENABLE_LOCKS
-    afs_kmutex_t lock;         /* lock covers data as well as mutexes. */
-    afs_kmutex_t *call_queue_lock;     /* points to lock for queue we're on,
-                                        * if any. */
-    afs_kcondvar_t cv_twind;
-    afs_kcondvar_t cv_rq;
-    afs_kcondvar_t cv_tq;
-#endif
-#ifdef KDUMP_RX_LOCK
-    struct rx_connection_rx_lock *conn;        /* Parent connection for call */
-#else
-    struct rx_connection *conn;        /* Parent connection for this call */
-#endif
-    afs_uint32 *callNumber;    /* Pointer to call number field within connection */
-    afs_uint32 flags;          /* Some random flags */
-    u_char localStatus;                /* Local user status sent out of band */
-    u_char remoteStatus;       /* Remote user status received out of band */
-    afs_int32 error;           /* Error condition for this call */
-    afs_uint32 timeout;                /* High level timeout for this call */
-    afs_uint32 rnext;          /* Next sequence number expected to be read by rx_ReadData */
-    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 */
-    afs_uint32 rwind;          /* The receive window:  the peer must not send packets with sequence numbers >= rnext+rwind */
-    afs_uint32 tfirst;         /* First unacknowledged transmit packet number */
-    afs_uint32 tnext;          /* Next transmit sequence number to use */
-    afs_uint32 tprev;          /* Last packet that we saw an ack for */
-    u_short twind;             /* The transmit window:  we cannot assign a sequence number to a packet >= tfirst + twind */
-    u_short cwind;             /* The congestion window */
-    u_short nSoftAcked;                /* Number soft acked transmit packets */
-    u_short nextCwind;         /* The congestion window after recovery */
-    u_short nCwindAcks;                /* Number acks received at current cwind */
-    u_short ssthresh;          /* The slow start threshold */
-    u_short nDgramPackets;     /* Packets per AFS 3.5 jumbogram */
-    u_short nAcks;             /* The number of consecutive acks */
-    u_short nNacks;            /* Number packets acked that follow the
-                                * first negatively acked packet */
-    u_short nSoftAcks;         /* The number of delayed soft acks */
-    u_short nHardAcks;         /* The number of delayed hard acks */
-    u_short congestSeq;                /* Peer's congestion sequence counter */
-    int rtt;
-    int rtt_dev;
-    struct clock rto;          /* The round trip timeout calculated for this call */
-    struct rxevent *resendEvent;       /* If this is non-Null, there is a retransmission event pending */
-    struct rxevent *timeoutEvent;      /* If this is non-Null, then there is an overall timeout for this call */
-    struct rxevent *keepAliveEvent;    /* Scheduled periodically in active calls to keep call alive */
-    struct rxevent *growMTUEvent;      /* Scheduled periodically in active calls to discover true maximum MTU */
-    struct rxevent *delayedAckEvent;   /* Scheduled after all packets are received to send an ack if a reply or new call is not generated soon */
-    struct clock delayedAckTime;        /* Time that next delayed ack was scheduled  for */
-    struct rxevent *delayedAbortEvent; /* Scheduled to throttle looping client */
-    int abortCode;             /* error code from last RPC */
-    int abortCount;            /* number of times last error was sent */
-    u_int lastSendTime;                /* Last time a packet was sent on this call */
-    u_int lastReceiveTime;     /* Last time a packet was received for this call */
-    u_int lastSendData;                /* Last time a nonping was sent on this call */
-    void (*arrivalProc) (struct rx_call * call, void * mh, int index); /* Procedure to call when reply is received */
-    void *arrivalProcHandle;   /* Handle to pass to replyFunc */
-    int arrivalProcArg;         /* Additional arg to pass to reply Proc */
-    afs_uint32 lastAcked;      /* last packet "hard" acked by receiver */
-    afs_uint32 startWait;      /* time server began waiting for input data/send quota */
-    struct clock traceWait;    /* time server began waiting for input data/send quota */
-    struct clock traceStart;   /* time the call started running */
-    u_short MTU;               /* size of packets currently sending */
-#ifdef RX_ENABLE_LOCKS
-    short refCount;            /* Used to keep calls from disappearring
-                                * when we get them from a queue. (rx_refcnt_lock) */
-#endif                          /* RX_ENABLE_LOCKS */
-/* Call refcount modifiers */
-#define RX_CALL_REFCOUNT_BEGIN  0      /* GetCall/NewCall/EndCall */
-#define RX_CALL_REFCOUNT_RESEND 1      /* resend event */
-#define RX_CALL_REFCOUNT_DELAY  2      /* delayed ack */
-#define RX_CALL_REFCOUNT_ALIVE  3      /* keep alive event */
-#define RX_CALL_REFCOUNT_PACKET 4      /* waiting for packets. */
-#define RX_CALL_REFCOUNT_SEND   5      /* rxi_Send */
-#define RX_CALL_REFCOUNT_ACKALL 6      /* rxi_AckAll */
-#define RX_CALL_REFCOUNT_ABORT  7      /* delayed abort */
-#define RX_CALL_REFCOUNT_MAX    8      /* array size. */
-#ifdef RX_REFCOUNT_CHECK
-    short refCDebug[RX_CALL_REFCOUNT_MAX];
-#endif                         /* RX_REFCOUNT_CHECK */
-
-    /*
-     * iov, iovNBytes, iovMax, and iovNext are set in rxi_ReadvProc()
-     * and adjusted by rxi_FillReadVec().  iov does not own the buffers
-     * it refers to.  The buffers belong to the packets stored in iovq.
-     * Only one call to rx_ReadvProc() can be active at a time.
-     */
-
-    int iovNBytes;             /* byte count for current iovec */
-    int iovMax;                        /* number elements in current iovec */
-    int iovNext;               /* next entry in current iovec */
-    struct iovec *iov;         /* current iovec */
-
-    struct clock queueTime;    /* time call was queued */
-    struct clock startTime;    /* time call was started */
-    afs_hyper_t bytesSent;     /* Number bytes sent */
-    afs_hyper_t bytesRcvd;     /* Number bytes received */
-    u_short tqWaiters;
-
-    struct rx_packet *xmitList[RX_MAXACKS]; /* Can't xmit more than we ack */
-                                /* Protected by setting RX_CALL_TQ_BUSY */
-#ifdef RXDEBUG_PACKET
-    u_short tqc;                /* packet count in tq */
-    u_short rqc;                /* packet count in rq */
-    u_short iovqc;              /* packet count in iovq */
-
-#ifdef KDUMP_RX_LOCK
-    struct rx_call_rx_lock *allNextp;
-#else
-    struct rx_call *allNextp;
-#endif
-    afs_uint32 call_id;
-#endif
-};
-
 #ifndef KDUMP_RX_LOCK
-/* Major call states */
-#define        RX_STATE_NOTINIT  0     /* Call structure has never been initialized */
-#define        RX_STATE_PRECALL  1     /* Server-only:  call is not in progress, but packets have arrived */
-#define        RX_STATE_ACTIVE   2     /* An active call; a process is dealing with this call */
-#define        RX_STATE_DALLY    3     /* Dallying after process is done with call */
-#define        RX_STATE_HOLD     4     /* Waiting for acks on reply data packets */
-#define RX_STATE_RESET    5     /* Call is being reset */
-
-/* Call modes:  the modes of a call in RX_STATE_ACTIVE state (process attached) */
-#define        RX_MODE_SENDING   1     /* Sending or ready to send */
-#define        RX_MODE_RECEIVING 2     /* Receiving or ready to receive */
-#define        RX_MODE_ERROR     3     /* Something in error for current conversation */
-#define        RX_MODE_EOF       4     /* Server has flushed (or client has read) last reply packet */
-
-/* Flags */
-#define        RX_CALL_READER_WAIT        1    /* Reader is waiting for next packet */
-#define        RX_CALL_WAIT_WINDOW_ALLOC  2    /* Sender is waiting for window to allocate buffers */
-#define        RX_CALL_WAIT_WINDOW_SEND   4    /* Sender is waiting for window to send buffers */
-#define        RX_CALL_WAIT_PACKETS       8    /* Sender is waiting for packet buffers */
-#define        RX_CALL_WAIT_PROC         16    /* Waiting for a process to be assigned */
-#define        RX_CALL_RECEIVE_DONE      32    /* All packets received on this call */
-#define        RX_CALL_CLEARED           64    /* Receive queue cleared in precall state */
-#define        RX_CALL_TQ_BUSY          128    /* Call's Xmit Queue is busy; don't modify */
-#define        RX_CALL_TQ_CLEARME       256    /* Need to clear this call's TQ later */
-#define RX_CALL_TQ_SOME_ACKED    512   /* rxi_Start needs to discard ack'd packets. */
-#define RX_CALL_TQ_WAIT                1024    /* Reader is waiting for TQ_BUSY to be reset */
-#define RX_CALL_FAST_RECOVER    2048   /* call is doing congestion recovery */
-/* 4096 was RX_CALL_FAST_RECOVER_WAIT */
-#define RX_CALL_SLOW_START_OK   8192   /* receiver acks every other packet */
-#define RX_CALL_IOVEC_WAIT     16384   /* waiting thread is using an iovec */
-#define RX_CALL_HAVE_LAST      32768   /* Last packet has been received */
-#define RX_CALL_NEED_START     0x10000 /* tells rxi_Start to start again */
-#define RX_CALL_PEER_BUSY      0x20000 /* the last packet we received on this call was a
-                                         * BUSY packet; i.e. the channel for this call is busy */
-#define RX_CALL_ACKALL_SENT     0x40000 /* ACKALL has been sent on the call */
-
 
 /* The structure of the data portion of an acknowledge packet: An acknowledge
  * packet is in network byte order at all times.  An acknowledgement is always
@@ -956,46 +828,6 @@ struct rx_debugPeer {
 #define        RX_OTHER_IN     1       /* packets avail in in queue */
 #define        RX_OTHER_OUT    2       /* packets avail in out queue */
 
-
-
-/* Only include this once, even when re-loading for kdump. */
-#ifndef _CALL_REF_DEFINED_
-#define _CALL_REF_DEFINED_
-
-#ifdef RX_ENABLE_LOCKS
-#ifdef RX_REFCOUNT_CHECK
-/* RX_REFCOUNT_CHECK is used to test for call refcount leaks by event
- * type.
- */
-extern int rx_callHoldType;
-#define CALL_HOLD(call, type) do { \
-                                call->refCount++; \
-                                call->refCDebug[type]++; \
-                                if (call->refCDebug[type] > 50)  {\
-                                    rx_callHoldType = type; \
-                                    osi_Panic("Huge call refCount"); \
-                                                              } \
-                            } while (0)
-#define CALL_RELE(call, type) do { \
-                                call->refCount--; \
-                                call->refCDebug[type]--; \
-                                if (call->refCDebug[type] > 50) {\
-                                    rx_callHoldType = type; \
-                                    osi_Panic("Negative call refCount"); \
-                                                             } \
-                            } while (0)
-#else /* RX_REFCOUNT_CHECK */
-#define CALL_HOLD(call, type)   call->refCount++
-#define CALL_RELE(call, type)   call->refCount--
-#endif /* RX_REFCOUNT_CHECK */
-
-#else /* RX_ENABLE_LOCKS */
-#define CALL_HOLD(call, type)
-#define CALL_RELE(call, type)
-#endif /* RX_ENABLE_LOCKS */
-
-#endif /* _CALL_REF_DEFINED_ */
-
 #define RX_SERVER_DEBUG_SEC_STATS              0x1
 #define RX_SERVER_DEBUG_ALL_CONN               0x2
 #define RX_SERVER_DEBUG_RX_STATS               0x4