rx: Use a red black tree for the event stack
[openafs.git] / src / rx / rx_packet.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 #ifndef _RX_PACKET_
11 #define _RX_PACKET_
12
13 #include "rx_queue.h"
14
15 #if defined(AFS_NT40_ENV)
16 #include "rx_xmit_nt.h"
17 #endif
18 #ifndef AFS_NT40_ENV
19 #include <sys/uio.h>
20 #endif /* !AFS_NT40_ENV */
21 /* this file includes the macros and decls which depend on packet
22  * format, and related packet manipulation macros.  Note that code
23  * which runs at NETPRI should not sleep, or AIX will panic */
24 /* There are some assumptions that various code makes -- I'll try to
25  * express them all here:
26  * 1.  rx_ReceiveAckPacket assumes that it can get an entire ack
27  * contiguous in the first iovec.  As a result, the iovec buffers must
28  * be >= sizeof (struct rx_ackpacket)
29  * 2. All callers of rx_Pullup besides rx_ReceiveAckPacket try to pull
30  * up less data than rx_ReceiveAckPacket does.
31  * 3. rx_GetInt32 and rx_PutInt32 (and the slow versions of same) assume
32  * that the iovec buffers are all integral multiples of the word size,
33  * and that the offsets are as well.
34  */
35
36
37 #if defined(AFS_NT40_ENV)
38 #ifndef MIN
39 #define MIN(a,b)  ((a)<(b)?(a):(b))
40 #endif
41 #ifndef MAX
42 #define MAX(a,b)  ((a)>(b)?(a):(b))
43 #endif
44 #else /* AFS_NT40_ENV */
45 #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)
46 #include <sys/sysmacros.h>      /* MIN, MAX on Solaris */
47 #endif
48 #include <sys/param.h>          /* MIN, MAX elsewhere */
49 #endif /* AFS_NT40_ENV */
50
51 #define IPv6_HDR_SIZE           40      /* IPv6 Header */
52 #define IPv6_FRAG_HDR_SIZE       8      /* IPv6 Fragment Header */
53 #define UDP_HDR_SIZE             8      /* UDP Header */
54 #define RX_IP_SIZE              (IPv6_HDR_SIZE + IPv6_FRAG_HDR_SIZE)
55 #define _RX_IPUDP_SIZE          (RX_IP_SIZE + UDP_HDR_SIZE)
56
57 /* REMOTE_PACKET_SIZE is currently the same as local.  This is because REMOTE
58  * is defined much too generally for my tastes, and includes the case of
59  * multiple class C nets connected with a router within one campus or MAN.
60  * I don't want to make local performance suffer just because of some
61  * out-dated protocol that used to be in use on the NSFANET that's
62  * practically unused anymore.  Any modern IP implementation will be
63  * using MTU discovery, and even old routers shouldn't frag packets
64  * when sending from one connected network directly to another.  Maybe
65  * the next release of RX will do MTU discovery. */
66
67 /* MTUXXX the various "MAX" params here must be rationalized.  From now on,
68  * the MAX packet size will be the maximum receive size, but the maximum send
69  * size will be larger than that. */
70
71 #ifdef notdef
72 /*  some sample MTUs
73            4352   what FDDI(RFC1188) uses... Larger?
74            4096   VJ's recommendation for FDDI
75           17914   what IBM 16MB TR  uses
76            8166   IEEE 802.4
77            4464   IEEE 802.5 MAX
78            2002   IEEE 802.5 Recommended
79            1500   what Ethernet uses
80            1492   what 802.3 uses ( 8 bytes for 802.2 SAP )
81            9180   Classical IP over ATM (RFC2225)
82 */
83
84 /* * * * these are the old defines
85 */
86 #define RX_MAX_PACKET_SIZE      (RX_MAX_DL_MTU -RX_IPUDP_SIZE)
87
88 #define RX_MAX_PACKET_DATA_SIZE (RX_MAX_PACKET_SIZE-RX_HEADER_SIZE)
89 #ifdef AFS_HPUX_ENV
90 /* HPUX by default uses an 802.3 size, and it's not evident from SIOCGIFCONF */
91 #define RX_LOCAL_PACKET_SIZE    (1492 - RX_IPUDP_SIZE)
92 #define RX_REMOTE_PACKET_SIZE   (1492 - RX_IPUDP_SIZE)
93 #else
94 #define RX_LOCAL_PACKET_SIZE    RX_MAX_PACKET_SIZE      /* For hosts on same net */
95 #define RX_REMOTE_PACKET_SIZE   RX_MAX_PACKET_SIZE      /* see note above */
96 #endif
97 #endif /* notdef */
98
99 /* These are the new, streamlined ones.
100  */
101 #define RX_HEADER_SIZE          sizeof (struct rx_header)
102
103 /* The minimum MTU for an IP network is 576 bytes including headers */
104 #define RX_MIN_PACKET_SIZE      (576 - RX_IPUDP_SIZE)
105 #define RX_PP_PACKET_SIZE       RX_MIN_PACKET_SIZE
106 #define _RX_MIN_PACKET_SIZE      (576 - _RX_IPUDP_SIZE)
107 #define _RX_PP_PACKET_SIZE      _RX_MIN_PACKET_SIZE
108
109 #define OLD_MAX_PACKET_SIZE     (1500 - RX_IPUDP_SIZE)
110 #define _OLD_MAX_PACKET_SIZE    (1500 - _RX_IPUDP_SIZE)
111
112 /* if the other guy is not on the local net, use this size */
113 #define RX_REMOTE_PACKET_SIZE   (1500 - RX_IPUDP_SIZE)
114 #define _RX_REMOTE_PACKET_SIZE  (1500 - _RX_IPUDP_SIZE)
115
116 /* for now, never send more data than this */
117 #define RX_MAX_PACKET_SIZE      16384
118 #define RX_MAX_PACKET_DATA_SIZE (16384 - RX_HEADER_SIZE)
119
120 /* Packet types, for rx_packet.type */
121 #define RX_PACKET_TYPE_DATA         1   /* A vanilla data packet */
122 #define RX_PACKET_TYPE_ACK          2   /* Acknowledge packet */
123 #define RX_PACKET_TYPE_BUSY         3   /* Busy: can't accept call immediately; try later */
124 #define RX_PACKET_TYPE_ABORT        4   /* Abort packet.  No response needed. */
125 #define RX_PACKET_TYPE_ACKALL       5   /* Acknowledges receipt of all packets */
126 #define RX_PACKET_TYPE_CHALLENGE    6   /* Challenge client's identity: request credentials */
127 #define RX_PACKET_TYPE_RESPONSE     7   /* Respond to challenge packet */
128 #define RX_PACKET_TYPE_DEBUG        8   /* Get debug information */
129
130 #define RX_PACKET_TYPE_PARAMS       9   /* exchange size params (showUmine) */
131 #define RX_PACKET_TYPE_VERSION     13   /* get AFS version */
132
133
134 #define RX_PACKET_TYPES     {"data", "ack", "busy", "abort", "ackall", "challenge", "response", "debug", "params", "unused", "unused", "unused", "version"}
135 #define RX_N_PACKET_TYPES           13  /* Must agree with above list;
136                                          * counts 0
137                                          * WARNING: if this number ever
138                                          * grows past 13, rxdebug packets
139                                          * will need to be modified */
140
141 /* Packet classes, for rx_AllocPacket and rx_packetQuota */
142 #define RX_PACKET_CLASS_RECEIVE     0
143 #define RX_PACKET_CLASS_SEND        1
144 #define RX_PACKET_CLASS_SPECIAL     2
145 #define RX_PACKET_CLASS_RECV_CBUF   3
146 #define RX_PACKET_CLASS_SEND_CBUF   4
147
148 #define RX_N_PACKET_CLASSES         5   /* Must agree with above list */
149
150 /* Flags for rx_header flags field */
151 #define RX_CLIENT_INITIATED     1       /* Packet is sent/received from client side of call */
152 #define RX_REQUEST_ACK          2       /* Peer requests acknowledgement */
153 #define RX_LAST_PACKET          4       /* This is the last packet from this side of the call */
154 #define RX_MORE_PACKETS         8       /* There are more packets following this,
155                                          * i.e. the next sequence number seen by
156                                          * the receiver should be greater than
157                                          * this one, rather than a resend of an
158                                          * earlier sequence number */
159 #define RX_SLOW_START_OK        32      /* Set this flag in an ack packet to
160                                          * inform the sender that slow start is
161                                          * supported by the receiver. */
162 #define RX_JUMBO_PACKET         32      /* Set this flag in a data packet to
163                                          * indicate that more packets follow
164                                          * this packet in the datagram */
165
166 /* The following flags are preset per packet, i.e. they don't change
167  * on retransmission of the packet */
168 #define RX_PRESET_FLAGS         (RX_CLIENT_INITIATED | RX_LAST_PACKET)
169
170
171 /*
172  * Flags for the packet structure itself, housekeeping for the
173  * most part.  These live in rx_packet->flags.
174  */
175 #define RX_PKTFLAG_ACKED        0x01
176 #ifdef RX_TRACK_PACKETS
177 #define RX_PKTFLAG_FREE         0x02
178 #define RX_PKTFLAG_TQ           0x04
179 #define RX_PKTFLAG_RQ           0x08
180 #define RX_PKTFLAG_IOVQ         0x10
181 #define RX_PKTFLAG_CP           0x20
182 #endif
183 #define RX_PKTFLAG_SENT         0x40
184
185 /* The rx part of the header of a packet, in host form */
186 struct rx_header {
187     afs_uint32 epoch;           /* Start time of client process */
188     afs_uint32 cid;             /* Connection id (defined by client) */
189     afs_uint32 callNumber;      /* Current call number */
190     afs_uint32 seq;             /* Sequence number of this packet, within this call */
191     afs_uint32 serial;          /* Serial number of this packet: a new serial
192                                  * number is stamped on each packet sent out */
193     u_char type;                /* RX packet type */
194     u_char flags;               /* Flags, defined below */
195     u_char userStatus;          /* User defined status information,
196                                  * returned/set by macros
197                                  * rx_Get/SetLocal/RemoteStatus */
198     u_char securityIndex;       /* Which service-defined security method to use */
199     u_short serviceId;          /* service this packet is directed _to_ */
200     /* This spare is now used for packet header checkksum.  see
201      * rxi_ReceiveDataPacket and packet cksum macros above for details. */
202     u_short spare;
203 };
204
205 /* The abbreviated header for jumbo packets. Most fields in the
206  * jumbo packet headers are either the same as or can be quickly
207  * derived from their counterparts in the main packet header.
208  */
209 struct rx_jumboHeader {
210     u_char flags;               /* Flags, defined below */
211     u_char spare1;
212     u_short cksum;              /* packet header checksum */
213 };
214
215 /* For most Unixes, maximum elements in an iovec is 16 */
216 #define RX_MAXIOVECS 16                 /* limit for ReadvProc/WritevProc */
217 #define RX_MAXWVECS (RX_MAXIOVECS-1)    /* need one iovec for packet header */
218
219 /*
220  * The values for the RX buffer sizes are calculated to ensure efficient
221  * use of network resources when sending AFS 3.5 jumbograms over Ethernet,
222  * 802.3, FDDI, and ATM networks running IPv4 or IPv6. Changing these
223  * values may affect interoperability with AFS 3.5 clients.
224  */
225
226 /*
227  * We always transmit jumbo grams so that each packet starts at the
228  * beginning of a packet buffer. Because of the requirement that all
229  * segments of a 3.4a jumbogram contain multiples of eight bytes, the
230  * receivers iovec has RX_HEADERSIZE bytes in the first element,
231  * RX_FIRSTBUFFERSIZE bytes in the second element, and RX_CBUFFERSIZE
232  * bytes in each successive entry.  All packets in a jumbogram
233  * except for the last must contain RX_JUMBOBUFFERSIZE bytes of data
234  * so the receiver can split the AFS 3.5 jumbograms back into packets
235  * without having to copy any of the data.
236  */
237 #define RX_JUMBOBUFFERSIZE 1412
238 #define RX_JUMBOHEADERSIZE 4
239 /*
240  * RX_FIRSTBUFFERSIZE must be larger than the largest ack packet,
241  * the largest possible challenge or response packet.
242  * Both Firstbuffersize and cbuffersize must be integral multiples of 8,
243  * so the security header and trailer stuff works for rxkad_crypt.  yuck.
244  */
245 #define RX_FIRSTBUFFERSIZE (RX_JUMBOBUFFERSIZE+RX_JUMBOHEADERSIZE)
246 /*
247  * The size of a continuation buffer is buffer is the same as the
248  * size of the first buffer, which must also the size of a jumbo packet
249  * buffer plus the size of a jumbo packet header. */
250 #define RX_CBUFFERSIZE (RX_JUMBOBUFFERSIZE+RX_JUMBOHEADERSIZE)
251 /*
252  * Add an extra four bytes of slop at the end of each buffer.
253  */
254 #define RX_EXTRABUFFERSIZE 4
255
256 #ifndef RX_MAXWVECS
257 #error RX_MAXWVECS not defined
258 #endif
259
260 struct rx_packet {
261     struct rx_queue queueItemHeader;    /* Packets are chained using the queue.h package */
262     struct clock timeSent;      /* When this packet was transmitted last */
263     afs_uint32 firstSerial;     /* Original serial number of this packet */
264     struct clock firstSent;     /* When this packet was transmitted first */
265     struct rx_header header;    /* The internal packet header */
266     unsigned int niovecs;       /* # of iovecs that potentially have data */
267     unsigned int aiovecs;       /* # of allocated iovecs */
268     struct iovec wirevec[RX_MAXWVECS + 1];      /* the new form of the packet */
269
270     u_char flags;               /* Flags for local state of this packet */
271     u_char unused;              /* was backoff, now just here for alignment */
272     u_short length;             /* Data length */
273     /* NT port relies on the fact that the next two are physically adjacent.
274      * If that assumption changes change sendmsg and recvmsg in rx_xmit_nt.c .
275      * The jumbo datagram code also relies on the next two being
276      * physically adjacent.
277      * The Linux port uses this knowledge as well in osi_NetSend.
278      *
279      * The extradata field is padding in case the recvmsg implementation
280      * writes beyond the end of the final iovec buffer.  We do not know
281      * what platforms had this problem so we are reluctant to remove it.
282      * the extradata must be adjacent to localdata.
283      * See rxk_ReadPacket and rxi_ReadPacket.
284      */
285     afs_uint32 wirehead[RX_HEADER_SIZE / sizeof(afs_int32)];
286     afs_uint32 localdata[RX_CBUFFERSIZE / sizeof(afs_int32)];
287     afs_uint32 extradata[RX_EXTRABUFFERSIZE / sizeof(afs_int32)];
288
289 #ifdef RXDEBUG_PACKET
290     /* For debugging */
291     struct rx_packet *allNextp; /* A list of all packets */
292     afs_uint32  packetId;       /* An unique id number for debugging */
293 #endif
294 };
295
296 /* Macro to convert continuation buffer pointers to packet pointers */
297 #define RX_CBUF_TO_PACKET(CP, PP) \
298     ((struct rx_packet *) \
299      ((char *)(CP) - ((char *)(&(PP)->localdata[0])-(char *)(PP))))
300
301 /* Macros callable by security modules, to set header/trailer lengths,
302  * set actual packet size, and find the beginning of the security
303  * header (or data) */
304 #define rx_SetSecurityHeaderSize(conn, length) ((conn)->securityHeaderSize = (length))
305 #define rx_SetSecurityMaxTrailerSize(conn, length) ((conn)->securityMaxTrailerSize = (length))
306 #define rx_GetSecurityHeaderSize(conn) ((conn)->securityHeaderSize)
307 #define rx_GetSecurityMaxTrailerSize(conn) ((conn)->securityMaxTrailerSize)
308
309 /* This is the address of the data portion of the packet.  Any encryption
310  * headers will be at this address, the actual data, for a data packet, will
311  * start at this address + the connection's security header size. */
312 #define rx_DataOf(packet)               ((char *) (packet)->wirevec[1].iov_base)
313 #define rx_GetDataSize(packet)          ((packet)->length)
314 #define rx_SetDataSize(packet, size)    ((packet)->length = (size))
315
316 /* These macros used in conjunction with reuse of packet header spare as a
317  * packet cksum for rxkad security module. */
318 #define rx_GetPacketCksum(packet)        ((packet)->header.spare)
319 #define rx_SetPacketCksum(packet, cksum) ((packet)->header.spare = (cksum))
320
321 #ifdef KERNEL
322 #define rxi_OverQuota(packetclass) (rx_nFreePackets - 1 < rx_packetQuota[packetclass])
323 #define rxi_OverQuota2(packetclass,num_alloc) (rx_nFreePackets - (num_alloc) < rx_packetQuota[packetclass])
324 #endif /* KERNEL */
325
326 /* this returns an afs_int32 from byte offset o in packet p.  offset must
327  * always be aligned properly for an afs_int32, I'm leaving this up to the
328  * caller. */
329 #define rx_GetInt32(p,off) (( (off) >= (p)->wirevec[1].iov_len) ? \
330    rx_SlowGetInt32((p), (off)) :  \
331   *((afs_int32 *)((char *)((p)->wirevec[1].iov_base) + (off))))
332
333 #define rx_PutInt32(p,off,b) { \
334        if ((off) >= (p)->wirevec[1].iov_len) \
335           rx_SlowPutInt32((p), (off), (b));   \
336        else *((afs_int32 *)((char *)((p)->wirevec[1].iov_base) + (off))) = b; }
337
338 #define rx_data(p, o, l) ((l=((struct rx_packet*)(p))->wirevec[(o+1)].iov_len),\
339   (((struct rx_packet*)(p))->wirevec[(o+1)].iov_base))
340
341
342 /* copy data into an RX packet */
343 #define rx_packetwrite(p, off, len, in)               \
344   ( (off) + (len) > (p)->wirevec[1].iov_len ?         \
345     rx_SlowWritePacket(p, off, len, (char*)(in)) :             \
346     ((memcpy((char*)((p)->wirevec[1].iov_base)+(off), (char *)(in), (len))),0))
347
348 /* copy data from an RX packet */
349 #define rx_packetread(p, off, len, out)               \
350   ( (off) + (len) > (p)->wirevec[1].iov_len ?         \
351     rx_SlowReadPacket(p, off, len, (char*)(out)) :             \
352     ((memcpy((char *)(out), (char*)((p)->wirevec[1].iov_base)+(off), (len))),0))
353
354 #define rx_computelen(p,l) { unsigned int i; \
355    for (l=0, i=1; i < p->niovecs; i++ ) l += p->wirevec[i].iov_len; }
356
357 /* return what the actual contiguous space is: should be min(length,size) */
358 /* The things that call this really want something like ...pullup MTUXXX  */
359 #define rx_Contiguous(p) \
360     MIN((unsigned) (p)->length, (unsigned) ((p)->wirevec[1].iov_len))
361
362 #ifndef TRUE
363 #define TRUE 1
364 #define FALSE 0
365 #endif
366
367 /* === packet-ized down to here, the following macros work temporarily */
368 /* Unfortunately, they know that the cbuf stuff isn't there. */
369
370 /* try to ensure that rx_DataOf will return a contiguous space at
371  * least size bytes long */
372 /* return what the actual contiguous space is: should be min(length,size) */
373 #define rx_Pullup(p,size)       /* this idea here is that this will make a guarantee */
374
375
376 /* The offset of the actual user's data in the packet, skipping any
377  * security header */
378 /* DEPRECATED */
379 #define rx_UserDataOf(conn, packet)     (((char *) (packet)->wirevec[1].iov_base) + (conn)->securityHeaderSize)
380
381 #ifdef AFS_NT40_ENV
382 /* Debugging for Windows Cache Manager - fs memdump */
383 int rx_DumpPackets(FILE *outputFile, char *cookie);
384 #endif /* AFS_NT40_ENV */
385
386 #endif /* _RX_PACKET_ */