Geiger counter http://geigermaps.jp/Create/Tutorials/mbed_geiger/ja

Dependencies:   mbed

Committer:
okini3939
Date:
Fri Apr 15 16:51:30 2011 +0000
Revision:
0:5b2e60110d9b

        

Who changed what in which revision?

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