Dependencies:   mbed

Committer:
slowness
Date:
Tue Sep 06 18:10:36 2011 +0000
Revision:
0:cd4c47744fa1

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:cd4c47744fa1 1 /*
slowness 0:cd4c47744fa1 2 * Definitions for tcp compression routines.
slowness 0:cd4c47744fa1 3 *
slowness 0:cd4c47744fa1 4 * $Id: vj.h,v 1.7 2010/02/22 17:52:09 goldsimon Exp $
slowness 0:cd4c47744fa1 5 *
slowness 0:cd4c47744fa1 6 * Copyright (c) 1989 Regents of the University of California.
slowness 0:cd4c47744fa1 7 * All rights reserved.
slowness 0:cd4c47744fa1 8 *
slowness 0:cd4c47744fa1 9 * Redistribution and use in source and binary forms are permitted
slowness 0:cd4c47744fa1 10 * provided that the above copyright notice and this paragraph are
slowness 0:cd4c47744fa1 11 * duplicated in all such forms and that any documentation,
slowness 0:cd4c47744fa1 12 * advertising materials, and other materials related to such
slowness 0:cd4c47744fa1 13 * distribution and use acknowledge that the software was developed
slowness 0:cd4c47744fa1 14 * by the University of California, Berkeley. The name of the
slowness 0:cd4c47744fa1 15 * University may not be used to endorse or promote products derived
slowness 0:cd4c47744fa1 16 * from this software without specific prior written permission.
slowness 0:cd4c47744fa1 17 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
slowness 0:cd4c47744fa1 18 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
slowness 0:cd4c47744fa1 19 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
slowness 0:cd4c47744fa1 20 *
slowness 0:cd4c47744fa1 21 * Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
slowness 0:cd4c47744fa1 22 * - Initial distribution.
slowness 0:cd4c47744fa1 23 */
slowness 0:cd4c47744fa1 24
slowness 0:cd4c47744fa1 25 #ifndef VJ_H
slowness 0:cd4c47744fa1 26 #define VJ_H
slowness 0:cd4c47744fa1 27
slowness 0:cd4c47744fa1 28 #include "lwip/ip.h"
slowness 0:cd4c47744fa1 29 #include "lwip/tcp_impl.h"
slowness 0:cd4c47744fa1 30
slowness 0:cd4c47744fa1 31 #define MAX_SLOTS 16 /* must be > 2 and < 256 */
slowness 0:cd4c47744fa1 32 #define MAX_HDR 128
slowness 0:cd4c47744fa1 33
slowness 0:cd4c47744fa1 34 /*
slowness 0:cd4c47744fa1 35 * Compressed packet format:
slowness 0:cd4c47744fa1 36 *
slowness 0:cd4c47744fa1 37 * The first octet contains the packet type (top 3 bits), TCP
slowness 0:cd4c47744fa1 38 * 'push' bit, and flags that indicate which of the 4 TCP sequence
slowness 0:cd4c47744fa1 39 * numbers have changed (bottom 5 bits). The next octet is a
slowness 0:cd4c47744fa1 40 * conversation number that associates a saved IP/TCP header with
slowness 0:cd4c47744fa1 41 * the compressed packet. The next two octets are the TCP checksum
slowness 0:cd4c47744fa1 42 * from the original datagram. The next 0 to 15 octets are
slowness 0:cd4c47744fa1 43 * sequence number changes, one change per bit set in the header
slowness 0:cd4c47744fa1 44 * (there may be no changes and there are two special cases where
slowness 0:cd4c47744fa1 45 * the receiver implicitly knows what changed -- see below).
slowness 0:cd4c47744fa1 46 *
slowness 0:cd4c47744fa1 47 * There are 5 numbers which can change (they are always inserted
slowness 0:cd4c47744fa1 48 * in the following order): TCP urgent pointer, window,
slowness 0:cd4c47744fa1 49 * acknowlegement, sequence number and IP ID. (The urgent pointer
slowness 0:cd4c47744fa1 50 * is different from the others in that its value is sent, not the
slowness 0:cd4c47744fa1 51 * change in value.) Since typical use of SLIP links is biased
slowness 0:cd4c47744fa1 52 * toward small packets (see comments on MTU/MSS below), changes
slowness 0:cd4c47744fa1 53 * use a variable length coding with one octet for numbers in the
slowness 0:cd4c47744fa1 54 * range 1 - 255 and 3 octets (0, MSB, LSB) for numbers in the
slowness 0:cd4c47744fa1 55 * range 256 - 65535 or 0. (If the change in sequence number or
slowness 0:cd4c47744fa1 56 * ack is more than 65535, an uncompressed packet is sent.)
slowness 0:cd4c47744fa1 57 */
slowness 0:cd4c47744fa1 58
slowness 0:cd4c47744fa1 59 /*
slowness 0:cd4c47744fa1 60 * Packet types (must not conflict with IP protocol version)
slowness 0:cd4c47744fa1 61 *
slowness 0:cd4c47744fa1 62 * The top nibble of the first octet is the packet type. There are
slowness 0:cd4c47744fa1 63 * three possible types: IP (not proto TCP or tcp with one of the
slowness 0:cd4c47744fa1 64 * control flags set); uncompressed TCP (a normal IP/TCP packet but
slowness 0:cd4c47744fa1 65 * with the 8-bit protocol field replaced by an 8-bit connection id --
slowness 0:cd4c47744fa1 66 * this type of packet syncs the sender & receiver); and compressed
slowness 0:cd4c47744fa1 67 * TCP (described above).
slowness 0:cd4c47744fa1 68 *
slowness 0:cd4c47744fa1 69 * LSB of 4-bit field is TCP "PUSH" bit (a worthless anachronism) and
slowness 0:cd4c47744fa1 70 * is logically part of the 4-bit "changes" field that follows. Top
slowness 0:cd4c47744fa1 71 * three bits are actual packet type. For backward compatibility
slowness 0:cd4c47744fa1 72 * and in the interest of conserving bits, numbers are chosen so the
slowness 0:cd4c47744fa1 73 * IP protocol version number (4) which normally appears in this nibble
slowness 0:cd4c47744fa1 74 * means "IP packet".
slowness 0:cd4c47744fa1 75 */
slowness 0:cd4c47744fa1 76
slowness 0:cd4c47744fa1 77 /* packet types */
slowness 0:cd4c47744fa1 78 #define TYPE_IP 0x40
slowness 0:cd4c47744fa1 79 #define TYPE_UNCOMPRESSED_TCP 0x70
slowness 0:cd4c47744fa1 80 #define TYPE_COMPRESSED_TCP 0x80
slowness 0:cd4c47744fa1 81 #define TYPE_ERROR 0x00
slowness 0:cd4c47744fa1 82
slowness 0:cd4c47744fa1 83 /* Bits in first octet of compressed packet */
slowness 0:cd4c47744fa1 84 #define NEW_C 0x40 /* flag bits for what changed in a packet */
slowness 0:cd4c47744fa1 85 #define NEW_I 0x20
slowness 0:cd4c47744fa1 86 #define NEW_S 0x08
slowness 0:cd4c47744fa1 87 #define NEW_A 0x04
slowness 0:cd4c47744fa1 88 #define NEW_W 0x02
slowness 0:cd4c47744fa1 89 #define NEW_U 0x01
slowness 0:cd4c47744fa1 90
slowness 0:cd4c47744fa1 91 /* reserved, special-case values of above */
slowness 0:cd4c47744fa1 92 #define SPECIAL_I (NEW_S|NEW_W|NEW_U) /* echoed interactive traffic */
slowness 0:cd4c47744fa1 93 #define SPECIAL_D (NEW_S|NEW_A|NEW_W|NEW_U) /* unidirectional data */
slowness 0:cd4c47744fa1 94 #define SPECIALS_MASK (NEW_S|NEW_A|NEW_W|NEW_U)
slowness 0:cd4c47744fa1 95
slowness 0:cd4c47744fa1 96 #define TCP_PUSH_BIT 0x10
slowness 0:cd4c47744fa1 97
slowness 0:cd4c47744fa1 98
slowness 0:cd4c47744fa1 99 /*
slowness 0:cd4c47744fa1 100 * "state" data for each active tcp conversation on the wire. This is
slowness 0:cd4c47744fa1 101 * basically a copy of the entire IP/TCP header from the last packet
slowness 0:cd4c47744fa1 102 * we saw from the conversation together with a small identifier
slowness 0:cd4c47744fa1 103 * the transmit & receive ends of the line use to locate saved header.
slowness 0:cd4c47744fa1 104 */
slowness 0:cd4c47744fa1 105 struct cstate {
slowness 0:cd4c47744fa1 106 struct cstate *cs_next; /* next most recently used state (xmit only) */
slowness 0:cd4c47744fa1 107 u_short cs_hlen; /* size of hdr (receive only) */
slowness 0:cd4c47744fa1 108 u_char cs_id; /* connection # associated with this state */
slowness 0:cd4c47744fa1 109 u_char cs_filler;
slowness 0:cd4c47744fa1 110 union {
slowness 0:cd4c47744fa1 111 char csu_hdr[MAX_HDR];
slowness 0:cd4c47744fa1 112 struct ip_hdr csu_ip; /* ip/tcp hdr from most recent packet */
slowness 0:cd4c47744fa1 113 } vjcs_u;
slowness 0:cd4c47744fa1 114 };
slowness 0:cd4c47744fa1 115 #define cs_ip vjcs_u.csu_ip
slowness 0:cd4c47744fa1 116 #define cs_hdr vjcs_u.csu_hdr
slowness 0:cd4c47744fa1 117
slowness 0:cd4c47744fa1 118
slowness 0:cd4c47744fa1 119 struct vjstat {
slowness 0:cd4c47744fa1 120 unsigned long vjs_packets; /* outbound packets */
slowness 0:cd4c47744fa1 121 unsigned long vjs_compressed; /* outbound compressed packets */
slowness 0:cd4c47744fa1 122 unsigned long vjs_searches; /* searches for connection state */
slowness 0:cd4c47744fa1 123 unsigned long vjs_misses; /* times couldn't find conn. state */
slowness 0:cd4c47744fa1 124 unsigned long vjs_uncompressedin; /* inbound uncompressed packets */
slowness 0:cd4c47744fa1 125 unsigned long vjs_compressedin; /* inbound compressed packets */
slowness 0:cd4c47744fa1 126 unsigned long vjs_errorin; /* inbound unknown type packets */
slowness 0:cd4c47744fa1 127 unsigned long vjs_tossed; /* inbound packets tossed because of error */
slowness 0:cd4c47744fa1 128 };
slowness 0:cd4c47744fa1 129
slowness 0:cd4c47744fa1 130 /*
slowness 0:cd4c47744fa1 131 * all the state data for one serial line (we need one of these per line).
slowness 0:cd4c47744fa1 132 */
slowness 0:cd4c47744fa1 133 struct vjcompress {
slowness 0:cd4c47744fa1 134 struct cstate *last_cs; /* most recently used tstate */
slowness 0:cd4c47744fa1 135 u_char last_recv; /* last rcvd conn. id */
slowness 0:cd4c47744fa1 136 u_char last_xmit; /* last sent conn. id */
slowness 0:cd4c47744fa1 137 u_short flags;
slowness 0:cd4c47744fa1 138 u_char maxSlotIndex;
slowness 0:cd4c47744fa1 139 u_char compressSlot; /* Flag indicating OK to compress slot ID. */
slowness 0:cd4c47744fa1 140 #if LINK_STATS
slowness 0:cd4c47744fa1 141 struct vjstat stats;
slowness 0:cd4c47744fa1 142 #endif
slowness 0:cd4c47744fa1 143 struct cstate tstate[MAX_SLOTS]; /* xmit connection states */
slowness 0:cd4c47744fa1 144 struct cstate rstate[MAX_SLOTS]; /* receive connection states */
slowness 0:cd4c47744fa1 145 };
slowness 0:cd4c47744fa1 146
slowness 0:cd4c47744fa1 147 /* flag values */
slowness 0:cd4c47744fa1 148 #define VJF_TOSS 1U /* tossing rcvd frames because of input err */
slowness 0:cd4c47744fa1 149
slowness 0:cd4c47744fa1 150 extern void vj_compress_init (struct vjcompress *comp);
slowness 0:cd4c47744fa1 151 extern u_int vj_compress_tcp (struct vjcompress *comp, struct pbuf *pb);
slowness 0:cd4c47744fa1 152 extern void vj_uncompress_err (struct vjcompress *comp);
slowness 0:cd4c47744fa1 153 extern int vj_uncompress_uncomp(struct pbuf *nb, struct vjcompress *comp);
slowness 0:cd4c47744fa1 154 extern int vj_uncompress_tcp (struct pbuf **nb, struct vjcompress *comp);
slowness 0:cd4c47744fa1 155
slowness 0:cd4c47744fa1 156 #endif /* VJ_H */