sl_compress.h
上传用户:luoyougen
上传日期:2008-05-12
资源大小:23136k
文件大小:9k
源码类别:

VxWorks

开发平台:

C/C++

  1. /* sl_compress.h - Definitions for tcp compression routines */
  2. /* $NetBSD: slcompress.h,v 1.8 1994/06/29 06:36:51 cgd Exp $ */
  3. /*
  4.  * Copyright (c) 1989, 1993
  5.  * The Regents of the University of California.  All rights reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 1. Redistributions of source code must retain the above copyright
  11.  *    notice, this list of conditions and the following disclaimer.
  12.  * 2. Redistributions in binary form must reproduce the above copyright
  13.  *    notice, this list of conditions and the following disclaimer in the
  14.  *    documentation and/or other materials provided with the distribution.
  15.  * 3. All advertising materials mentioning features or use of this software
  16.  *    must display the following acknowledgement:
  17.  * This product includes software developed by the University of
  18.  * California, Berkeley and its contributors.
  19.  * 4. Neither the name of the University nor the names of its contributors
  20.  *    may be used to endorse or promote products derived from this software
  21.  *    without specific prior written permission.
  22.  *
  23.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33.  * SUCH DAMAGE.
  34.  *
  35.  * @(#)slcompress.h 8.1 (Berkeley) 6/10/93
  36.  */
  37. /*
  38.  * Definitions for tcp compression routines.
  39.  *
  40.  * Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
  41.  * - Initial distribution.
  42.  */
  43. /*
  44. modification history
  45. --------------------
  46. 01d,17nov96,bin  removed MLEN replaced with CL_SIZE_128
  47. 01c,01aug96,vin  integrated with BSD4.4, moved to netinet made universal
  48.  for CSLIP as well as PPP.
  49. 01b,16jun95,dzb  added necessary header file inclusions.
  50. 01a,16jan95,dzb  WRS-ize.  added prototype of ppp_sl_uncompress_tcp_part().
  51.                  prepended "ppp_" due to conflict with CSLIP's slcompress.
  52. */
  53. #ifndef __INCsl_compressh
  54. #define __INCsl_compressh
  55. #ifdef  __cplusplus
  56. extern "C" {
  57. #endif
  58. /* includes */
  59. #include "netinet/in_systm.h"
  60. #include "net/mbuf.h"
  61. #include "netinet/ip.h"
  62. #define SL_STATS /* define to include statistics counters */
  63. #define MAX_STATES 16           /* must be > 2 and < 256 */
  64. #define MAX_HDR    CL_SIZE_128
  65. /*
  66.  * Compressed packet format:
  67.  *
  68.  * The first octet contains the packet type (top 3 bits), TCP
  69.  * 'push' bit, and flags that indicate which of the 4 TCP sequence
  70.  * numbers have changed (bottom 5 bits).  The next octet is a
  71.  * conversation number that associates a saved IP/TCP header with
  72.  * the compressed packet.  The next two octets are the TCP checksum
  73.  * from the original datagram.  The next 0 to 15 octets are
  74.  * sequence number changes, one change per bit set in the header
  75.  * (there may be no changes and there are two special cases where
  76.  * the receiver implicitly knows what changed -- see below).
  77.  * 
  78.  * There are 5 numbers which can change (they are always inserted
  79.  * in the following order): TCP urgent pointer, window,
  80.  * acknowlegement, sequence number and IP ID.  (The urgent pointer
  81.  * is different from the others in that its value is sent, not the
  82.  * change in value.)  Since typical use of SLIP links is biased
  83.  * toward small packets (see comments on MTU/MSS below), changes
  84.  * use a variable length coding with one octet for numbers in the
  85.  * range 1 - 255 and 3 octets (0, MSB, LSB) for numbers in the
  86.  * range 256 - 65535 or 0.  (If the change in sequence number or
  87.  * ack is more than 65535, an uncompressed packet is sent.)
  88.  */
  89. /*
  90.  * Packet types (must not conflict with IP protocol version)
  91.  *
  92.  * The top nibble of the first octet is the packet type.  There are
  93.  * three possible types: IP (not proto TCP or tcp with one of the
  94.  * control flags set); uncompressed TCP (a normal IP/TCP packet but
  95.  * with the 8-bit protocol field replaced by an 8-bit connection id --
  96.  * this type of packet syncs the sender & receiver); and compressed
  97.  * TCP (described above).
  98.  *
  99.  * LSB of 4-bit field is TCP "PUSH" bit (a worthless anachronism) and
  100.  * is logically part of the 4-bit "changes" field that follows.  Top
  101.  * three bits are actual packet type.  For backward compatibility
  102.  * and in the interest of conserving bits, numbers are chosen so the
  103.  * IP protocol version number (4) which normally appears in this nibble
  104.  * means "IP packet".
  105.  */
  106. /* packet types */
  107. #define TYPE_IP 0x40
  108. #define TYPE_UNCOMPRESSED_TCP 0x70
  109. #define TYPE_COMPRESSED_TCP 0x80
  110. #define TYPE_ERROR 0x00
  111. /* Bits in first octet of compressed packet */
  112. #define NEW_C 0x40 /* flag bits for what changed in a packet */
  113. #define NEW_I 0x20
  114. #define NEW_S 0x08
  115. #define NEW_A 0x04
  116. #define NEW_W 0x02
  117. #define NEW_U 0x01
  118. /* reserved, special-case values of above */
  119. #define SPECIAL_I (NEW_S|NEW_W|NEW_U) /* echoed interactive traffic */
  120. #define SPECIAL_D (NEW_S|NEW_A|NEW_W|NEW_U) /* unidirectional data */
  121. #define SPECIALS_MASK (NEW_S|NEW_A|NEW_W|NEW_U)
  122. #define TCP_PUSH_BIT 0x10
  123. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  124. #pragma align 1                 /* tell gcc960 not to optimize alignments */
  125. #endif  /* CPU_FAMILY==I960 */
  126. /*
  127.  * "state" data for each active tcp conversation on the wire.  This is
  128.  * basically a copy of the entire IP/TCP header from the last packet
  129.  * we saw from the conversation together with a small identifier
  130.  * the transmit & receive ends of the line use to locate saved header.
  131.  */
  132. struct cstate {
  133. struct cstate *cs_next; /* next most recently used cstate (xmit only) */
  134. u_short cs_hlen; /* size of hdr (receive only) */
  135. u_char cs_id; /* connection # associated with this state */
  136. u_char cs_filler;
  137. union {
  138. char csu_hdr[MAX_HDR];
  139. struct ip csu_ip; /* ip/tcp hdr from most recent packet */
  140. } slcs_u;
  141. };
  142. #define cs_ip slcs_u.csu_ip
  143. #define cs_hdr slcs_u.csu_hdr
  144. /*
  145.  * all the state data for one serial line (we need one of these
  146.  * per line).
  147.  */
  148. struct slcompress {
  149. struct cstate *last_cs; /* most recently used tstate */
  150. u_char last_recv; /* last rcvd conn. id */
  151. u_char last_xmit; /* last sent conn. id */
  152. u_short flags;
  153. #ifdef SL_STATS
  154. u_int sls_packets; /* outbound packets */
  155. u_int sls_compressed; /* outbound compressed packets */
  156. u_int sls_searches; /* searches for connection state */
  157. u_int sls_misses; /* times couldn't find conn. state */
  158. u_int sls_uncompressedin; /* inbound uncompressed packets */
  159. u_int sls_compressedin; /* inbound compressed packets */
  160. u_int sls_errorin; /* inbound unknown type packets */
  161. u_int sls_tossed; /* inbound packets tossed because of error */
  162. #endif
  163. struct cstate tstate[MAX_STATES]; /* xmit connection states */
  164. struct cstate rstate[MAX_STATES]; /* receive connection states */
  165. };
  166. #if ((CPU_FAMILY==I960) && (defined __GNUC__))
  167. #pragma align 0                 /* turn off alignment requirement */
  168. #endif  /* CPU_FAMILY==I960 */
  169. /* flag values */
  170. #define SLF_TOSS 1 /* tossing rcvd frames because of input err */
  171. #ifdef SL_STATS
  172. #define INCR(counter) ++comp->counter;
  173. #else
  174. #define INCR(counter)
  175. #endif
  176. #define BCMP(p1, p2, n) bcmp((char *)(p1), (char *)(p2), (int)(n))
  177. #ifdef BCOPY
  178. #undef BCOPY
  179. #endif /* BCOPY */
  180. #define BCOPY(s, d, l) bcopy((char *) s, (char *) d, (int) l)
  181. #ifndef KERNEL
  182. #define ovbcopy bcopy
  183. #endif
  184. /* ENCODE encodes a number that is known to be non-zero.  ENCODEZ
  185.  * checks for zero (since zero has to be encoded in the long, 3 byte
  186.  * form).
  187.  */
  188. #define ENCODE(n) { 
  189. if ((u_short)(n) >= 256) { 
  190. *cp++ = 0; 
  191. cp[1] = (n); 
  192. cp[0] = (n) >> 8; 
  193. cp += 2; 
  194. } else { 
  195. *cp++ = (n); 
  196. }
  197. #define ENCODEZ(n) { 
  198. if ((u_short)(n) >= 256 || (u_short)(n) == 0) { 
  199. *cp++ = 0; 
  200. cp[1] = (n); 
  201. cp[0] = (n) >> 8; 
  202. cp += 2; 
  203. } else { 
  204. *cp++ = (n); 
  205. }
  206. #define DECODEL(f) { 
  207. if (*cp == 0) {
  208. (f) = htonl(ntohl(f) + ((cp[1] << 8) | cp[2])); 
  209. cp += 3; 
  210. } else { 
  211. (f) = htonl(ntohl(f) + (u_long)*cp); 
  212. cp++; 
  213. }
  214. #define DECODES(f) { 
  215. if (*cp == 0) {
  216. (f) = htons(ntohs(f) + ((cp[1] << 8) | cp[2])); 
  217. cp += 3; 
  218. } else { 
  219. (f) = htons(ntohs(f) + (u_long)*cp); 
  220. cp++; 
  221. }
  222. #define DECODEU(f) { 
  223. if (*cp == 0) {
  224. (f) = htons((cp[1] << 8) | cp[2]); 
  225. cp += 3; 
  226. } else { 
  227. (f) = htons((u_long)*cp); 
  228. cp++; 
  229. }
  230. /* function declarations */
  231. #if defined(__STDC__) || defined(__cplusplus)
  232. extern void sl_compress_init (struct slcompress *comp);
  233. extern u_int sl_compress_tcp (struct mbuf *m, struct ip *ip,
  234.     struct slcompress *comp, int compress_cid);
  235. extern int sl_uncompress_tcp (u_char** bufp, int len, u_int type,
  236.     struct slcompress *comp);
  237. #else /* __STDC__ */
  238. extern void ppp_sl_compress_init ();
  239. extern void ppp_sl_compress_setup ();
  240. extern u_char ppp_sl_compress_tcp  ();
  241. extern int ppp_sl_uncompress_tcp ();
  242. extern int ppp_sl_uncompress_tcp_part ();
  243. #endif /* __STDC__ */
  244. #ifdef  __cplusplus
  245. }
  246. #endif
  247. #endif /* __INCsl_compressh */