wiretap/erf.h

   1 /*
   2 *
   3 * Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
   4 * All rights reserved.
   5 *
   6 * This software and documentation has been developed by Endace Technology Ltd.
   7 * along with the DAG PCI network capture cards. For further information please
   8 * visit http://www.endace.com/.
   9 *
  10 * Redistribution and use in source and binary forms, with or without
  11 * modification, are permitted provided that the following conditions are met:
  12 *
  13 *  1. Redistributions of source code must retain the above copyright notice,
  14 *  this list of conditions and the following disclaimer.
  15 *
  16 *  2. Redistributions in binary form must reproduce the above copyright
  17 *  notice, this list of conditions and the following disclaimer in the
  18 *  documentation and/or other materials provided with the distribution.
  19 *
  20 *  3. The name of Endace Technology Ltd may not be used to endorse or promote
  21 *  products derived from this software without specific prior written
  22 *  permission.
  23 *
  24 * THIS SOFTWARE IS PROVIDED BY ENDACE TECHNOLOGY LTD ``AS IS'' AND ANY EXPRESS
  25 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  27 * EVENT SHALL ENDACE TECHNOLOGY LTD BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  29 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  31 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33 * POSSIBILITY OF SUCH DAMAGE.
  34 *
  35 * $Id$
  36 */
  37
  38 #ifndef __W_ERF_H__
  39 #define __W_ERF_H__
  40
  41 /* Record type defines */
  42 #define TYPE_LEGACY             0
  43 #define TYPE_HDLC_POS           1
  44 #define TYPE_ETH                2
  45 #define TYPE_ATM                3
  46 #define TYPE_AAL5               4
  47 #define TYPE_MC_HDLC            5
  48 #define TYPE_MC_RAW             6
  49 #define TYPE_MC_ATM             7
  50 #define TYPE_MC_RAW_CHANNEL     8
  51 #define TYPE_MC_AAL5            9
  52 #define TYPE_COLOR_HDLC_POS     10
  53 #define TYPE_COLOR_ETH          11
  54 #define TYPE_MC_AAL2            12
  55 #define TYPE_IP_COUNTER         13
  56 #define TYPE_TCP_FLOW_COUNTER   14
  57 #define TYPE_DSM_COLOR_HDLC_POS 15
  58 #define TYPE_DSM_COLOR_ETH      16
  59 #define TYPE_COLOR_MC_HDLC_POS  17
  60 #define TYPE_AAL2               18
  61
  62 #define TYPE_PAD                48
  63
  64 #define TYPE_MIN  1   /* sanity checking */
  65 #define TYPE_MAX  48  /* sanity checking */
  66
  67  /*
  68   * The timestamp is 64bit unsigned fixed point little-endian value with
  69   * 32 bits for second and 32 bits for fraction.
  70   */
  71 typedef guint64 erf_timestamp_t;
  72
  73 typedef struct erf_record {
  74         erf_timestamp_t ts;
  75         guint8          type;
  76         guint8          flags;
  77         guint16         rlen;
  78         guint16         lctr;
  79         guint16         wlen;
  80 } erf_header_t;
  81
  82 #define MAX_RECORD_LEN  0x10000 /* 64k */
  83 #define RECORDS_FOR_ERF_CHECK   3
  84 #define FCS_BITS        32
  85
  86 #ifndef min
  87 #define min(a, b) ((a) > (b) ? (b) : (a))
  88 #endif
  89
  90 /*
  91  * ATM snaplength
  92  */
  93 #define ATM_SNAPLEN             48
  94
  95 /*
  96  * Size of ATM payload
  97  */
  98 #define ATM_SLEN(h, e)          ATM_SNAPLEN
  99 #define ATM_WLEN(h, e)          ATM_SNAPLEN
 100
 101 /*
 102  * Size of Ethernet payload
 103  */
 104 #define ETHERNET_WLEN(h, e)     (g_htons((h)->wlen))
 105 #define ETHERNET_SLEN(h, e)     min(ETHERNET_WLEN(h, e), g_htons((h)->rlen) - sizeof(*(h)) - 2)
 106
 107 /*
 108  * Size of HDLC payload
 109  */
 110 #define HDLC_WLEN(h, e)         (g_htons((h)->wlen))
 111 #define HDLC_SLEN(h, e)         min(HDLC_WLEN(h, e), g_htons((h)->rlen) - sizeof(*(h)))
 112
 113 /*
 114  * Size of MC_HDLC payload
 115  */
 116 #define MC_HDLC_WLEN(h, e)              (g_htons((h)->wlen))
 117 #define MC_HDLC_SLEN(h, e)              min(MC_HDLC_WLEN(h, e), g_htons((h)->rlen) - sizeof(*(h)) )
 118
 119 int erf_open(wtap *wth, int *err, gchar **err_info);
 120
 121 #endif /* __W_ERF_H__ */