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