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