rx: Use a red black tree for the event stack
[openafs.git] / src / rx / rx_packet.h
index 36b391c..b7cbd0a 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * Copyright 2000, International Business Machines Corporation and others.
  * All Rights Reserved.
- * 
+ *
  * This software has been released under the terms of the IBM Public
  * License.  For details, see the LICENSE file in the top-level source
  * directory or online at http://www.openafs.org/dl/license10.html
@@ -9,19 +9,20 @@
 
 #ifndef _RX_PACKET_
 #define _RX_PACKET_
-#ifndef UKERNEL
-#if defined(AFS_NT40_ENV) 
+
+#include "rx_queue.h"
+
+#if defined(AFS_NT40_ENV)
 #include "rx_xmit_nt.h"
 #endif
 #ifndef AFS_NT40_ENV
 #include <sys/uio.h>
 #endif /* !AFS_NT40_ENV */
-#endif /* !UKERNEL */
 /* this file includes the macros and decls which depend on packet
  * format, and related packet manipulation macros.  Note that code
  * which runs at NETPRI should not sleep, or AIX will panic */
-/* There are some assumptions that various code makes -- I'll try to 
- * express them all here: 
+/* There are some assumptions that various code makes -- I'll try to
+ * express them all here:
  * 1.  rx_ReceiveAckPacket assumes that it can get an entire ack
  * contiguous in the first iovec.  As a result, the iovec buffers must
  * be >= sizeof (struct rx_ackpacket)
@@ -33,7 +34,7 @@
  */
 
 
-#if defined(AFS_NT40_ENV) 
+#if defined(AFS_NT40_ENV)
 #ifndef MIN
 #define MIN(a,b)  ((a)<(b)?(a):(b))
 #endif
@@ -41,7 +42,7 @@
 #define MAX(a,b)  ((a)>(b)?(a):(b))
 #endif
 #else /* AFS_NT40_ENV */
-#if !defined(AFS_DARWIN_ENV) && !defined(AFS_USR_DARWIN_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_USR_FBSD_ENV) && !defined(AFS_LINUX20_ENV)
+#if !defined(AFS_DARWIN_ENV) && !defined(AFS_USR_DARWIN_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_USR_FBSD_ENV) && !defined(AFS_USR_DFBSD_ENV) && !defined(AFS_LINUX20_ENV)
 #include <sys/sysmacros.h>     /* MIN, MAX on Solaris */
 #endif
 #include <sys/param.h>         /* MIN, MAX elsewhere */
 #define IPv6_FRAG_HDR_SIZE      8      /* IPv6 Fragment Header */
 #define UDP_HDR_SIZE             8     /* UDP Header */
 #define        RX_IP_SIZE              (IPv6_HDR_SIZE + IPv6_FRAG_HDR_SIZE)
-#define        RX_IPUDP_SIZE           (RX_IP_SIZE + UDP_HDR_SIZE)
+#define        _RX_IPUDP_SIZE          (RX_IP_SIZE + UDP_HDR_SIZE)
 
 /* REMOTE_PACKET_SIZE is currently the same as local.  This is because REMOTE
- * is defined much too generally for my tastes, and includes the case of 
- * multiple class C nets connected with a router within one campus or MAN. 
+ * is defined much too generally for my tastes, and includes the case of
+ * multiple class C nets connected with a router within one campus or MAN.
  * I don't want to make local performance suffer just because of some
  * out-dated protocol that used to be in use on the NSFANET that's
  * practically unused anymore.  Any modern IP implementation will be
  * size will be larger than that. */
 
 #ifdef notdef
-/*  some sample MTUs 
-           4352   what FDDI(RFC1188) uses... Larger? 
-           4096   VJ's recommendation for FDDI 
-          17914   what IBM 16MB TR  uses   
-           8166   IEEE 802.4 
+/*  some sample MTUs
+           4352   what FDDI(RFC1188) uses... Larger?
+           4096   VJ's recommendation for FDDI
+          17914   what IBM 16MB TR  uses
+           8166   IEEE 802.4
            4464   IEEE 802.5 MAX
-           2002   IEEE 802.5 Recommended 
-          1500   what Ethernet uses 
+           2002   IEEE 802.5 Recommended
+          1500   what Ethernet uses
           1492   what 802.3 uses ( 8 bytes for 802.2 SAP )
           9180   Classical IP over ATM (RFC2225)
 */
 /* The minimum MTU for an IP network is 576 bytes including headers */
 #define RX_MIN_PACKET_SIZE      (576 - RX_IPUDP_SIZE)
 #define        RX_PP_PACKET_SIZE       RX_MIN_PACKET_SIZE
+#define _RX_MIN_PACKET_SIZE      (576 - _RX_IPUDP_SIZE)
+#define        _RX_PP_PACKET_SIZE      _RX_MIN_PACKET_SIZE
 
 #define        OLD_MAX_PACKET_SIZE     (1500 - RX_IPUDP_SIZE)
+#define        _OLD_MAX_PACKET_SIZE    (1500 - _RX_IPUDP_SIZE)
 
 /* if the other guy is not on the local net, use this size */
 #define        RX_REMOTE_PACKET_SIZE   (1500 - RX_IPUDP_SIZE)
+#define        _RX_REMOTE_PACKET_SIZE  (1500 - _RX_IPUDP_SIZE)
 
 /* for now, never send more data than this */
 #define        RX_MAX_PACKET_SIZE      16384
                                         * grows past 13, rxdebug packets
                                         * will need to be modified */
 
-/* Packet classes, for rx_AllocPacket */
+/* Packet classes, for rx_AllocPacket and rx_packetQuota */
 #define        RX_PACKET_CLASS_RECEIVE     0
 #define        RX_PACKET_CLASS_SEND        1
 #define        RX_PACKET_CLASS_SPECIAL     2
  * most part.  These live in rx_packet->flags.
  */
 #define        RX_PKTFLAG_ACKED        0x01
+#ifdef RX_TRACK_PACKETS
 #define        RX_PKTFLAG_FREE         0x02
-
+#define RX_PKTFLAG_TQ           0x04
+#define RX_PKTFLAG_RQ           0x08
+#define RX_PKTFLAG_IOVQ         0x10
+#define RX_PKTFLAG_CP           0x20
+#endif
+#define RX_PKTFLAG_SENT                0x40
 
 /* The rx part of the header of a packet, in host form */
 struct rx_header {
@@ -202,8 +213,8 @@ struct rx_jumboHeader {
 };
 
 /* For most Unixes, maximum elements in an iovec is 16 */
-#define RX_MAXIOVECS 16                /* limit for ReadvProc/WritevProc */
-#define RX_MAXWVECS RX_MAXIOVECS-1     /* need one iovec for packet header */
+#define RX_MAXIOVECS 16                        /* limit for ReadvProc/WritevProc */
+#define RX_MAXWVECS (RX_MAXIOVECS-1)   /* need one iovec for packet header */
 
 /*
  * The values for the RX buffer sizes are calculated to ensure efficient
@@ -226,8 +237,8 @@ struct rx_jumboHeader {
 #define RX_JUMBOBUFFERSIZE 1412
 #define RX_JUMBOHEADERSIZE 4
 /*
- * RX_FIRSTBUFFERSIZE must be larger than the largest ack packet, 
- * the largest possible challenge or response packet. 
+ * RX_FIRSTBUFFERSIZE must be larger than the largest ack packet,
+ * the largest possible challenge or response packet.
  * Both Firstbuffersize and cbuffersize must be integral multiples of 8,
  * so the security header and trailer stuff works for rxkad_crypt.  yuck.
  */
@@ -242,28 +253,44 @@ struct rx_jumboHeader {
  */
 #define RX_EXTRABUFFERSIZE 4
 
+#ifndef RX_MAXWVECS
+#error RX_MAXWVECS not defined
+#endif
+
 struct rx_packet {
     struct rx_queue queueItemHeader;   /* Packets are chained using the queue.h package */
-    struct clock retryTime;    /* When this packet should NEXT be re-transmitted */
     struct clock timeSent;     /* When this packet was transmitted last */
     afs_uint32 firstSerial;    /* Original serial number of this packet */
     struct clock firstSent;    /* When this packet was transmitted first */
     struct rx_header header;   /* The internal packet header */
-    unsigned int niovecs;
+    unsigned int niovecs;       /* # of iovecs that potentially have data */
+    unsigned int aiovecs;       /* # of allocated iovecs */
     struct iovec wirevec[RX_MAXWVECS + 1];     /* the new form of the packet */
 
     u_char flags;              /* Flags for local state of this packet */
-    u_char backoff;            /* for multiple re-sends */
+    u_char unused;             /* was backoff, now just here for alignment */
     u_short length;            /* Data length */
     /* NT port relies on the fact that the next two are physically adjacent.
      * If that assumption changes change sendmsg and recvmsg in rx_xmit_nt.c .
      * The jumbo datagram code also relies on the next two being
      * physically adjacent.
      * The Linux port uses this knowledge as well in osi_NetSend.
+     *
+     * The extradata field is padding in case the recvmsg implementation
+     * writes beyond the end of the final iovec buffer.  We do not know
+     * what platforms had this problem so we are reluctant to remove it.
+     * the extradata must be adjacent to localdata.
+     * See rxk_ReadPacket and rxi_ReadPacket.
      */
     afs_uint32 wirehead[RX_HEADER_SIZE / sizeof(afs_int32)];
     afs_uint32 localdata[RX_CBUFFERSIZE / sizeof(afs_int32)];
     afs_uint32 extradata[RX_EXTRABUFFERSIZE / sizeof(afs_int32)];
+
+#ifdef RXDEBUG_PACKET
+    /* For debugging */
+    struct rx_packet *allNextp; /* A list of all packets */
+    afs_uint32  packetId;       /* An unique id number for debugging */
+#endif
 };
 
 /* Macro to convert continuation buffer pointers to packet pointers */
@@ -324,7 +351,7 @@ struct rx_packet {
     rx_SlowReadPacket(p, off, len, (char*)(out)) :             \
     ((memcpy((char *)(out), (char*)((p)->wirevec[1].iov_base)+(off), (len))),0))
 
-#define rx_computelen(p,l) { register int i; \
+#define rx_computelen(p,l) { unsigned int i; \
    for (l=0, i=1; i < p->niovecs; i++ ) l += p->wirevec[i].iov_len; }
 
 /* return what the actual contiguous space is: should be min(length,size) */
@@ -351,4 +378,9 @@ struct rx_packet {
 /* DEPRECATED */
 #define        rx_UserDataOf(conn, packet)     (((char *) (packet)->wirevec[1].iov_base) + (conn)->securityHeaderSize)
 
+#ifdef AFS_NT40_ENV
+/* Debugging for Windows Cache Manager - fs memdump */
+int rx_DumpPackets(FILE *outputFile, char *cookie);
+#endif /* AFS_NT40_ENV */
+
 #endif /* _RX_PACKET_ */