wireshark/wiretap/wtap-int.h

514 lines
13 KiB
C

/* wtap-int.h
*
* $Id$
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __WTAP_INT_H__
#define __WTAP_INT_H__
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#include <glib.h>
#include <stdio.h>
#include <time.h>
#ifdef HAVE_WINSOCK2_H
#include <winsock2.h>
#endif
#ifdef HAVE_LIBZ
#include <zlib.h>
#define FILE_T gzFile
#else /* No zLib */
#define FILE_T FILE *
#endif /* HAVE_LIBZ */
#include "wtap.h"
/* Information for a compressed Sniffer data stream. */
typedef struct {
unsigned char *buf; /* buffer into which we uncompress data */
size_t nbytes; /* number of bytes of data in that buffer */
int nextout; /* offset in that buffer of stream's current position */
gint64 comp_offset; /* current offset in compressed data stream */
gint64 uncomp_offset; /* current offset in uncompressed data stream */
} ngsniffer_comp_stream_t;
typedef struct {
char *sdate; /* Packet start date */
gboolean tcp_formatted; /* TCP/IP data formated Y/N */
int format; /* Trace format type */
} iseries_t;
typedef struct {
guint maj_vers;
guint min_vers;
guint32 timeunit;
time_t start;
guint network; /* network type */
ngsniffer_comp_stream_t seq; /* sequential access */
ngsniffer_comp_stream_t rand; /* random access */
GList *first_blob; /* list element for first blob */
GList *last_blob; /* list element for last blob */
GList *current_blob; /* list element for current blob */
} ngsniffer_t;
typedef struct {
gboolean byte_swapped;
} i4btrace_t;
typedef struct {
gboolean is_hpux_11;
} nettl_t;
typedef struct {
time_t start;
} lanalyzer_t;
typedef enum {
NOT_SWAPPED,
SWAPPED,
MAYBE_SWAPPED
} swapped_type_t;
typedef struct {
gboolean byte_swapped;
swapped_type_t lengths_swapped;
guint16 version_major;
guint16 version_minor;
} libpcap_t;
typedef struct {
gboolean byte_swapped;
guint16 version_major;
guint16 version_minor;
gint8 if_fcslen;
GArray *interface_data;
guint number_of_interfaces;
} pcapng_t;
typedef struct {
time_t start_secs;
guint32 start_usecs;
guint8 version_major;
guint32 *frame_table;
guint32 frame_table_size;
guint current_frame;
} netmon_t;
typedef struct {
time_t start_time;
double ticks_per_sec;
double start_timestamp;
gboolean wrapped;
guint32 nframes;
gint64 start_offset;
gint64 end_offset;
int version_major;
gboolean fcs_valid; /* if packets have valid FCS at the end */
guint isdn_type; /* 1 = E1 PRI, 2 = T1 PRI, 3 = BRI */
} netxray_t;
typedef struct {
time_t inittime;
int adjusted;
gint64 next_packet_seek_start;
} ascend_t;
typedef struct {
gboolean byteswapped;
} csids_t;
typedef struct {
struct timeval reference_time;
} etherpeek_t;
typedef struct {
gboolean has_fcs;
} airopeek9_t;
typedef struct _k12_t k12_t;
typedef struct {
time_t start_secs;
guint32 start_usecs;
} catapult_dct2000_t;
typedef struct {
struct wtap_nstime now;
time_t t0;
} mpeg_t;
typedef struct {
gchar *pnstrace_buf;
gint32 nstrace_buf_offset;
gint32 nstrace_buflen;
/* Performance Monitor Time variables */
guint32 nspm_curtime; /* current time since 1970 */
guint64 nspm_curtimemsec; /* current time in mili second */
guint64 nspm_curtimelastmsec; /* nspm_curtime last update time in milisec */
guint64 nsg_creltime;
guint64 file_size;
} nstrace_t;
typedef gboolean (*subtype_read_func)(struct wtap*, int*, char**, gint64*);
typedef gboolean (*subtype_seek_read_func)(struct wtap*, gint64, union wtap_pseudo_header*,
guint8*, int, int *, char **);
struct wtap {
FILE_T fh;
int fd; /* File descriptor for cap file */
FILE_T random_fh; /* Secondary FILE_T for random access */
int file_type;
int snapshot_length;
struct Buffer *frame_buffer;
struct wtap_pkthdr phdr;
union wtap_pseudo_header pseudo_header;
gint64 data_offset;
union {
libpcap_t *pcap;
lanalyzer_t *lanalyzer;
ngsniffer_t *ngsniffer;
iseries_t *iseries;
i4btrace_t *i4btrace;
nettl_t *nettl;
netmon_t *netmon;
netxray_t *netxray;
ascend_t *ascend;
csids_t *csids;
etherpeek_t *etherpeek;
airopeek9_t *airopeek9;
k12_t *k12;
catapult_dct2000_t *catapult_dct2000;
mpeg_t *mpeg;
nstrace_t *nstrace;
void *generic;
pcapng_t *pcapng;
} capture;
subtype_read_func subtype_read;
subtype_seek_read_func subtype_seek_read;
void (*subtype_sequential_close)(struct wtap*);
void (*subtype_close)(struct wtap*);
int file_encap; /* per-file, for those
file formats that have
per-file encapsulation
types */
int tsprecision; /* timestamp precision of the lower 32bits
* e.g. WTAP_FILE_TSPREC_USEC */
};
struct wtap_dumper;
typedef gboolean (*subtype_write_func)(struct wtap_dumper*,
const struct wtap_pkthdr*, const union wtap_pseudo_header*,
const guchar*, int*);
typedef gboolean (*subtype_close_func)(struct wtap_dumper*, int*);
typedef struct {
gboolean first_frame;
time_t start;
} ngsniffer_dump_t;
typedef struct {
gboolean first_frame;
struct wtap_nstime start;
guint32 nframes;
} netxray_dump_t;
typedef struct {
gboolean got_first_record_time;
struct wtap_nstime first_record_time;
guint32 frame_table_offset;
guint32 *frame_table;
guint frame_table_index;
guint frame_table_size;
} netmon_dump_t;
typedef struct {
guint16 page_offset;
guint16 page_len;
guint32 absrec_time;
} nstrace_dump_t;
typedef struct {
guint32 nframes;
} _5views_dump_t;
typedef struct {
guint64 packet_count;
guint8 network_type;
} niobserver_dump_t;
typedef struct {
guint32 file_len;
guint32 num_of_records;
guint32 file_offset;
} k12_dump_t;
typedef struct {
gboolean first_packet_written;
struct wtap_nstime start_time;
} dct2000_dump_t;
typedef struct {
GArray *interface_data;
guint number_of_interfaces;
} pcapng_dump_t;
struct wtap_dumper {
FILE* fh;
int file_type;
int snaplen;
int encap;
gboolean compressed;
gint64 bytes_dumped;
union {
void *opaque;
ngsniffer_dump_t *ngsniffer;
netmon_dump_t *netmon;
netxray_dump_t *netxray;
_5views_dump_t *_5views;
niobserver_dump_t *niobserver;
k12_dump_t *k12;
dct2000_dump_t *dct2000;
nstrace_dump_t *nstr;
pcapng_dump_t *pcapng;
} dump;
subtype_write_func subtype_write;
subtype_close_func subtype_close;
int tsprecision; /* timestamp precision of the lower 32bits
* e.g. WTAP_FILE_TSPREC_USEC */
};
extern gboolean wtap_dump_file_write_all(wtap_dumper *wdh, const void *buf, unsigned bufsize, int *err);
extern size_t wtap_dump_file_write(wtap_dumper *wdh, const void *buf, size_t bufsize);
extern int wtap_dump_file_ferror(wtap_dumper *wdh);
extern gint wtap_num_file_types;
/* Macros to byte-swap 64-bit, 32-bit and 16-bit quantities. */
#define BSWAP64(x) \
((((x)&G_GINT64_CONSTANT(0xFF00000000000000U))>>56) | \
(((x)&G_GINT64_CONSTANT(0x00FF000000000000U))>>40) | \
(((x)&G_GINT64_CONSTANT(0x0000FF0000000000U))>>24) | \
(((x)&G_GINT64_CONSTANT(0x000000FF00000000U))>>8) | \
(((x)&G_GINT64_CONSTANT(0x00000000FF000000U))<<8) | \
(((x)&G_GINT64_CONSTANT(0x0000000000FF0000U))<<24) | \
(((x)&G_GINT64_CONSTANT(0x000000000000FF00U))<<40) | \
(((x)&G_GINT64_CONSTANT(0x00000000000000FFU))<<56))
#define BSWAP32(x) \
((((x)&0xFF000000)>>24) | \
(((x)&0x00FF0000)>>8) | \
(((x)&0x0000FF00)<<8) | \
(((x)&0x000000FF)<<24))
#define BSWAP16(x) \
((((x)&0xFF00)>>8) | \
(((x)&0x00FF)<<8))
/* Macros to byte-swap possibly-unaligned 32-bit and 16-bit quantities;
* they take a pointer to the quantity, and byte-swap it in place.
*/
#define PBSWAP32(p) \
{ \
guint8 tmp; \
tmp = (p)[3]; \
(p)[3] = (p)[0]; \
(p)[0] = tmp; \
tmp = (p)[2]; \
(p)[2] = (p)[1]; \
(p)[1] = tmp; \
}
#define PBSWAP16(p) \
{ \
guint8 tmp; \
tmp = (p)[1]; \
(p)[1] = (p)[0]; \
(p)[0] = tmp; \
}
/* Turn host-byte-order values into little-endian values. */
#define htoles(s) GUINT16_TO_LE(s)
#define htolel(l) GUINT32_TO_LE(l)
#define htolell(ll) GUINT64_TO_LE(ll)
/* Pointer versions of ntohs and ntohl. Given a pointer to a member of a
* byte array, returns the value of the two or four bytes at the pointer.
* The pletoh[sl] versions return the little-endian representation.
* We also provide pntohll and pletohll, which extract 64-bit integral
* quantities.
*
* These will work regardless of the byte alignment of the pointer.
*/
#ifndef pntohs
#define pntohs(p) ((guint16) \
((guint16)*((const guint8 *)(p)+0)<<8| \
(guint16)*((const guint8 *)(p)+1)<<0))
#endif
#ifndef pntoh24
#define pntoh24(p) ((guint32)*((const guint8 *)(p)+0)<<16| \
(guint32)*((const guint8 *)(p)+1)<<8| \
(guint32)*((const guint8 *)(p)+2)<<0)
#endif
#ifndef pntohl
#define pntohl(p) ((guint32)*((const guint8 *)(p)+0)<<24| \
(guint32)*((const guint8 *)(p)+1)<<16| \
(guint32)*((const guint8 *)(p)+2)<<8| \
(guint32)*((const guint8 *)(p)+3)<<0)
#endif
#ifndef pntohll
#define pntohll(p) ((guint64)*((const guint8 *)(p)+0)<<56| \
(guint64)*((const guint8 *)(p)+1)<<48| \
(guint64)*((const guint8 *)(p)+2)<<40| \
(guint64)*((const guint8 *)(p)+3)<<32| \
(guint64)*((const guint8 *)(p)+4)<<24| \
(guint64)*((const guint8 *)(p)+5)<<16| \
(guint64)*((const guint8 *)(p)+6)<<8| \
(guint64)*((const guint8 *)(p)+7)<<0)
#endif
#ifndef pletohs
#define pletohs(p) ((guint16) \
((guint16)*((const guint8 *)(p)+1)<<8| \
(guint16)*((const guint8 *)(p)+0)<<0))
#endif
#ifndef pletoh24
#define pletoh24(p) ((guint32)*((const guint8 *)(p)+2)<<16| \
(guint32)*((const guint8 *)(p)+1)<<8| \
(guint32)*((const guint8 *)(p)+0)<<0)
#endif
#ifndef pletohl
#define pletohl(p) ((guint32)*((const guint8 *)(p)+3)<<24| \
(guint32)*((const guint8 *)(p)+2)<<16| \
(guint32)*((const guint8 *)(p)+1)<<8| \
(guint32)*((const guint8 *)(p)+0)<<0)
#endif
#ifndef pletohll
#define pletohll(p) ((guint64)*((const guint8 *)(p)+7)<<56| \
(guint64)*((const guint8 *)(p)+6)<<48| \
(guint64)*((const guint8 *)(p)+5)<<40| \
(guint64)*((const guint8 *)(p)+4)<<32| \
(guint64)*((const guint8 *)(p)+3)<<24| \
(guint64)*((const guint8 *)(p)+2)<<16| \
(guint64)*((const guint8 *)(p)+1)<<8| \
(guint64)*((const guint8 *)(p)+0)<<0)
#endif
/* Pointer routines to put items out in a particular byte order.
* These will work regardless of the byte alignment of the pointer.
*/
#ifndef phtons
#define phtons(p, v) \
{ \
(p)[0] = (guint8)((v) >> 8); \
(p)[1] = (guint8)((v) >> 0); \
}
#endif
#ifndef phtonl
#define phtonl(p, v) \
{ \
(p)[0] = (guint8)((v) >> 24); \
(p)[1] = (guint8)((v) >> 16); \
(p)[2] = (guint8)((v) >> 8); \
(p)[3] = (guint8)((v) >> 0); \
}
#endif
#ifndef phtonll
#define phtonll(p, v) \
{ \
(p)[0] = (guint8)((v) >> 56); \
(p)[1] = (guint8)((v) >> 48); \
(p)[2] = (guint8)((v) >> 40); \
(p)[3] = (guint8)((v) >> 32); \
(p)[4] = (guint8)((v) >> 24); \
(p)[5] = (guint8)((v) >> 16); \
(p)[6] = (guint8)((v) >> 8); \
(p)[7] = (guint8)((v) >> 0); \
}
#endif
#ifndef pletonll
#define pletonll(p, v) \
{ \
(p)[0] = (guint8)((v) >> 0); \
(p)[1] = (guint8)((v) >> 8); \
(p)[2] = (guint8)((v) >> 16); \
(p)[3] = (guint8)((v) >> 24); \
(p)[4] = (guint8)((v) >> 32); \
(p)[5] = (guint8)((v) >> 40); \
(p)[6] = (guint8)((v) >> 48); \
(p)[7] = (guint8)((v) >> 56); \
}
#endif
#define wtap_file_read_unknown_bytes(target, num_bytes, fh, err) \
G_STMT_START \
{ \
int _bytes_read; \
_bytes_read = file_read((target), 1, (num_bytes), (fh)); \
if (_bytes_read != (int) (num_bytes)) { \
*(err) = file_error((fh)); \
return FALSE; \
} \
} \
G_STMT_END
#define wtap_file_read_expected_bytes(target, num_bytes, fh, err) \
G_STMT_START \
{ \
int _bytes_read; \
_bytes_read = file_read((target), 1, (num_bytes), (fh)); \
if (_bytes_read != (int) (num_bytes)) { \
*(err) = file_error((fh)); \
if (*(err) == 0 && _bytes_read > 0) { \
*(err) = WTAP_ERR_SHORT_READ; \
} \
return FALSE; \
} \
} \
G_STMT_END
/* glib doesn't have g_ptr_array_len of all things!*/
#ifndef g_ptr_array_len
#define g_ptr_array_len(a) ((a)->len)
#endif
#endif /* __WTAP_INT_H__ */