wiretap/wtap-int.h

   1 /* wtap-int.h
   2  *
   3  * $Id: wtap-int.h,v 1.13 2001/08/25 03:18:48 guy Exp $
   4  *
   5  * Wiretap Library
   6  * Copyright (c) 1998 by Gilbert Ramirez <gram@xiexie.org>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  */
  23
  24 #ifndef __WTAP_INT_H__
  25 #define __WTAP_INT_H__
  26
  27 #ifdef HAVE_SYS_TYPES_H
  28 #include <sys/types.h>
  29 #endif
  30
  31 #ifdef HAVE_SYS_TIME_H
  32 #include <sys/time.h>
  33 #endif
  34
  35 #ifdef HAVE_WINSOCK_H
  36 #include <winsock.h>
  37 #endif
  38
  39 #include <glib.h>
  40 #include <stdio.h>
  41 #include <time.h>
  42
  43 #ifdef HAVE_LIBZ
  44 #include "zlib.h"
  45 #define FILE_T  gzFile
  46 #else /* No zLib */
  47 #define FILE_T  FILE *
  48 #endif /* HAVE_LIBZ */
  49
  50 #include "wtap.h"
  51
  52 /* Information for a compressed Sniffer data stream. */
  53 typedef struct {
  54         unsigned char *buf;     /* buffer into which we uncompress data */
  55         size_t  nbytes;         /* number of bytes of data in that buffer */
  56         int     nextout;        /* offset in that buffer of stream's current position */
  57         long    comp_offset;    /* current offset in compressed data stream */
  58         long    uncomp_offset;  /* current offset in uncompressed data stream */
  59 } ngsniffer_comp_stream_t;
  60
  61 typedef struct {
  62         double  timeunit;
  63         time_t  start;
  64         int     is_atm;
  65         ngsniffer_comp_stream_t seq;    /* sequential access */
  66         ngsniffer_comp_stream_t rand;   /* random access */
  67         GList   *first_blob;            /* list element for first blob */
  68         GList   *last_blob;             /* list element for last blob */
  69         GList   *current_blob;          /* list element for current blob */
  70 } ngsniffer_t;
  71
  72 typedef struct {
  73         gboolean byte_swapped;
  74         int bchannel_prot[2];   /* For the V.120 heuristic */
  75 } i4btrace_t;
  76
  77 typedef struct {
  78         gboolean is_hpux_11;
  79 } nettl_t;
  80
  81 typedef struct {
  82         time_t  start;
  83 } lanalyzer_t;
  84
  85 typedef struct {
  86         gboolean byte_swapped;
  87         guint16 version_major;
  88         guint16 version_minor;
  89 } libpcap_t;
  90
  91 typedef struct {
  92         time_t  start_secs;
  93         guint32 start_usecs;
  94         guint8  version_major;
  95         guint32 *frame_table;
  96         guint32 frame_table_size;
  97         guint   current_frame;
  98 } netmon_t;
  99
 100 typedef struct {
 101         time_t  start_time;
 102         double  timeunit;
 103         double  start_timestamp;
 104         int     wrapped;
 105         int     end_offset;
 106         int     version_major;
 107 } netxray_t;
 108
 109 typedef struct {
 110         time_t inittime;
 111         int adjusted;
 112         int next_packet_seek_start;
 113 } ascend_t;
 114
 115 typedef struct {
 116         gboolean byteswapped;
 117 } csids_t;
 118
 119 typedef int (*subtype_read_func)(struct wtap*, int*, int*);
 120 typedef int (*subtype_seek_read_func)(struct wtap*, int, union wtap_pseudo_header*,
 121                                         guint8*, int);
 122 struct wtap {
 123         FILE_T                  fh;
 124         int                     fd;           /* File descriptor for cap file */
 125         FILE_T                  random_fh;    /* Secondary FILE_T for random access */
 126         int                     file_type;
 127         int                     snapshot_length;
 128         struct Buffer           *frame_buffer;
 129         struct wtap_pkthdr      phdr;
 130         union wtap_pseudo_header pseudo_header;
 131
 132         long                    data_offset;
 133
 134         union {
 135                 libpcap_t               *pcap;
 136                 lanalyzer_t             *lanalyzer;
 137                 ngsniffer_t             *ngsniffer;
 138                 i4btrace_t              *i4btrace;
 139                 nettl_t                 *nettl;
 140                 netmon_t                *netmon;
 141                 netxray_t               *netxray;
 142                 ascend_t                *ascend;
 143                 csids_t                 *csids;
 144                 void                    *generic;
 145         } capture;
 146
 147         subtype_read_func       subtype_read;
 148         subtype_seek_read_func  subtype_seek_read;
 149         void                    (*subtype_sequential_close)(struct wtap*);
 150         void                    (*subtype_close)(struct wtap*);
 151         int                     file_encap;     /* per-file, for those
 152                                                    file formats that have
 153                                                    per-file encapsulation
 154                                                    types */
 155 };
 156
 157 struct wtap_dumper;
 158
 159 typedef gboolean (*subtype_write_func)(struct wtap_dumper*,
 160                 const struct wtap_pkthdr*, const union wtap_pseudo_header*,
 161                 const u_char*, int*);
 162 typedef gboolean (*subtype_close_func)(struct wtap_dumper*, int*);
 163
 164 typedef struct {
 165         gboolean first_frame;
 166         time_t start;
 167 } ngsniffer_dump_t;
 168
 169 typedef struct {
 170         gboolean first_frame;
 171         struct timeval start;
 172         guint32 nframes;
 173 } netxray_dump_t;
 174
 175 typedef struct {
 176         gboolean got_first_record_time;
 177         struct timeval first_record_time;
 178         guint32 frame_table_offset;
 179         guint32 *frame_table;
 180         guint   frame_table_index;
 181         guint   frame_table_size;
 182 } netmon_dump_t;
 183
 184 struct wtap_dumper {
 185         FILE*                   fh;
 186         int                     file_type;
 187         int                     snaplen;
 188         int                     encap;
 189
 190         union {
 191                 void                    *opaque;
 192                 ngsniffer_dump_t        *ngsniffer;
 193                 netmon_dump_t           *netmon;
 194                 netxray_dump_t          *netxray;
 195         } dump;
 196
 197         subtype_write_func      subtype_write;
 198         subtype_close_func      subtype_close;
 199 };
 200
 201
 202 /* Macros to byte-swap 32-bit and 16-bit quantities. */
 203 #define BSWAP32(x) \
 204         ((((x)&0xFF000000)>>24) | \
 205          (((x)&0x00FF0000)>>8) | \
 206          (((x)&0x0000FF00)<<8) | \
 207          (((x)&0x000000FF)<<24))
 208 #define BSWAP16(x) \
 209          ((((x)&0xFF00)>>8) | \
 210           (((x)&0x00FF)<<8))
 211
 212 /* Turn host-byte-order values into little-endian values. */
 213 #ifdef WORDS_BIGENDIAN
 214 #define htoles(s) ((guint16)                       \
 215                     ((guint16)((s) & 0x00FF)<<8|  \
 216                      (guint16)((s) & 0xFF00)>>8))
 217
 218 #define htolel(l) ((guint32)((l) & 0x000000FF)<<24|  \
 219                    (guint32)((l) & 0x0000FF00)<<8|  \
 220                    (guint32)((l) & 0x00FF0000)>>8|   \
 221                    (guint32)((l) & 0xFF000000)>>24)
 222
 223 #ifdef G_HAVE_GINT64
 224 #define htolell(ll) GUINT64_TO_LE(ll)
 225 #endif /* G_HAVE_GINT64 */
 226
 227 #else /* WORDS_BIGENDIAN */
 228 #define htoles(s)       (s)
 229 #define htolel(l)       (l)
 230 #define htolell(ll)     (ll)
 231 #endif /* WORDS_BIGENDIAN */
 232
 233 /* Pointer versions of ntohs and ntohl.  Given a pointer to a member of a
 234  * byte array, returns the value of the two or four bytes at the pointer.
 235  * The pletoh[sl] versions return the little-endian representation.
 236  *
 237  * If G_HAVE_GINT64 is defined, so we can use "gint64" and "guint64" to
 238  * refer to 64-bit integral quantities, we also provide pntohll and
 239  * phtolell, which extract 64-bit integral quantities.
 240  */
 241
 242 #ifndef pntohs
 243 #define pntohs(p)  ((guint16)                       \
 244                     ((guint16)*((guint8 *)(p)+0)<<8|  \
 245                      (guint16)*((guint8 *)(p)+1)<<0))
 246 #endif
 247
 248 #ifndef pntoh24
 249 #define pntoh24(p)  ((guint32)*((guint8 *)(p)+0)<<16| \
 250                      (guint32)*((guint8 *)(p)+1)<<8|  \
 251                      (guint32)*((guint8 *)(p)+2)<<0)
 252 #endif
 253
 254 #ifndef pntohl
 255 #define pntohl(p)  ((guint32)*((guint8 *)(p)+0)<<24|  \
 256                     (guint32)*((guint8 *)(p)+1)<<16|  \
 257                     (guint32)*((guint8 *)(p)+2)<<8|   \
 258                     (guint32)*((guint8 *)(p)+3)<<0)
 259 #endif
 260
 261 #ifdef G_HAVE_GINT64
 262 #ifndef pntohll
 263 #define pntohll(p)  ((guint64)*((guint8 *)(p)+0)<<56|  \
 264                      (guint64)*((guint8 *)(p)+1)<<48|  \
 265                      (guint64)*((guint8 *)(p)+2)<<40|  \
 266                      (guint64)*((guint8 *)(p)+3)<<32|  \
 267                      (guint64)*((guint8 *)(p)+4)<<24|  \
 268                      (guint64)*((guint8 *)(p)+5)<<16|  \
 269                      (guint64)*((guint8 *)(p)+6)<<8|   \
 270                      (guint64)*((guint8 *)(p)+7)<<0)
 271 #endif
 272 #endif
 273
 274
 275 #ifndef phtons
 276 #define phtons(p)  ((guint16)                       \
 277                     ((guint16)*((guint8 *)(p)+0)<<8|  \
 278                      (guint16)*((guint8 *)(p)+1)<<0))
 279 #endif
 280
 281 #ifndef phtonl
 282 #define phtonl(p)  ((guint32)*((guint8 *)(p)+0)<<24|  \
 283                     (guint32)*((guint8 *)(p)+1)<<16|  \
 284                     (guint32)*((guint8 *)(p)+2)<<8|   \
 285                     (guint32)*((guint8 *)(p)+3)<<0)
 286 #endif
 287
 288 #ifndef pletohs
 289 #define pletohs(p) ((guint16)                       \
 290                     ((guint16)*((guint8 *)(p)+1)<<8|  \
 291                      (guint16)*((guint8 *)(p)+0)<<0))
 292 #endif
 293
 294 #ifndef pletoh24
 295 #define pletoh24(p) ((guint32)*((guint8 *)(p)+2)<<16|  \
 296                      (guint32)*((guint8 *)(p)+1)<<8|  \
 297                      (guint32)*((guint8 *)(p)+0)<<0)
 298 #endif
 299
 300
 301 #ifndef pletohl
 302 #define pletohl(p) ((guint32)*((guint8 *)(p)+3)<<24|  \
 303                     (guint32)*((guint8 *)(p)+2)<<16|  \
 304                     (guint32)*((guint8 *)(p)+1)<<8|   \
 305                     (guint32)*((guint8 *)(p)+0)<<0)
 306 #endif
 307
 308
 309 #ifdef G_HAVE_GINT64
 310 #ifndef pletohll
 311 #define pletohll(p) ((guint64)*((guint8 *)(p)+7)<<56|  \
 312                      (guint64)*((guint8 *)(p)+6)<<48|  \
 313                      (guint64)*((guint8 *)(p)+5)<<40|  \
 314                      (guint64)*((guint8 *)(p)+4)<<32|  \
 315                      (guint64)*((guint8 *)(p)+3)<<24|  \
 316                      (guint64)*((guint8 *)(p)+2)<<16|  \
 317                      (guint64)*((guint8 *)(p)+1)<<8|   \
 318                      (guint64)*((guint8 *)(p)+0)<<0)
 319 #endif
 320 #endif
 321
 322 #define wtap_file_read_unknown_bytes(target, num_bytes, fh, err) \
 323         G_STMT_START \
 324         { \
 325                 int _bytes_read; \
 326                 _bytes_read = file_read((target), 1, (num_bytes), (fh)); \
 327                 if (_bytes_read != (num_bytes)) { \
 328                         *(err) = file_error((fh)); \
 329                         return FALSE; \
 330                 } \
 331         } \
 332         G_STMT_END
 333
 334 #define wtap_file_read_expected_bytes(target, num_bytes, fh, err) \
 335         G_STMT_START \
 336         { \
 337                 int _bytes_read; \
 338                 _bytes_read = file_read((target), 1, (num_bytes), (fh)); \
 339                 if (_bytes_read != (num_bytes)) { \
 340                         *(err) = file_error((fh)); \
 341                         if (*(err) == 0 && _bytes_read > 0) { \
 342                                 *(err) = WTAP_ERR_SHORT_READ; \
 343                         } \
 344                         return FALSE; \
 345                 } \
 346         } \
 347         G_STMT_END
 348
 349 #endif /* __WTAP_INT_H__ */