/* wtap-int.h
- *
- * $Id$
*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
*
* 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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_LIBZ
#ifdef HAVE_WINSOCK2_H
#include <winsock2.h>
#endif
-#include <zlib.h>
-#define FILE_T gzFile
-#else /* No zLib */
-#define FILE_T FILE *
-#endif /* HAVE_LIBZ */
+
+#include <wsutil/file_util.h>
#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 */
- long comp_offset; /* current offset in compressed data stream */
- long uncomp_offset; /* current offset in uncompressed data stream */
-} ngsniffer_comp_stream_t;
-
-typedef struct {
- guint maj_vers;
- guint min_vers;
- double timeunit;
- time_t start;
- gboolean is_atm;
- 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 {
- 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 timeunit;
- double start_timestamp;
- gboolean wrapped;
- int 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;
- long 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 {
- guint32 atm_encap;
- gboolean is_rawatm;
- gboolean is_ppp;
-} erf_t;
-
-typedef struct _k12_t k12_t;
-
-typedef gboolean (*subtype_read_func)(struct wtap*, int*, char**, long*);
-typedef gboolean (*subtype_seek_read_func)(struct wtap*, long, union wtap_pseudo_header*,
- guint8*, int, int *, char **);
+WS_DLL_PUBLIC
+int wtap_fstat(wtap *wth, ws_statb64 *statb, int *err);
+
+typedef gboolean (*subtype_read_func)(struct wtap*, int*, char**, gint64*);
+typedef gboolean (*subtype_seek_read_func)(struct wtap*, gint64,
+ struct wtap_pkthdr *, Buffer *buf,
+ int *, char **);
+/**
+ * Struct holding data of the currently read file.
+ */
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;
-
- long data_offset;
-
- union {
- libpcap_t *pcap;
- lanalyzer_t *lanalyzer;
- ngsniffer_t *ngsniffer;
- i4btrace_t *i4btrace;
- nettl_t *nettl;
- netmon_t *netmon;
- netxray_t *netxray;
- ascend_t *ascend;
- csids_t *csids;
- etherpeek_t *etherpeek;
- airopeek9_t *airopeek9;
- erf_t *erf;
- k12_t *k12;
- void *generic;
- } 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 */
+ FILE_T fh;
+ FILE_T random_fh; /**< Secondary FILE_T for random access */
+ int file_type_subtype;
+ guint snapshot_length;
+ struct Buffer *frame_buffer;
+ struct wtap_pkthdr phdr;
+ struct wtapng_section_s shb_hdr;
+ GArray *interface_data; /**< An array holding the interface data from pcapng IDB:s or equivalent(?)*/
+ wtapng_name_res_t *nrb_hdr; /**< holds the Name Res Block's comment/custom_opts, or NULL */
+
+ void *priv; /* this one holds per-file state and is free'd automatically by wtap_close() */
+ void *wslua_data; /* this one holds wslua state info and is not free'd */
+
+ 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 rather than per-packet
+ * encapsulation types
+ */
+ int file_tsprec; /* per-file timestamp precision
+ * of the fractional part of
+ * the time stamp, for those
+ * file formats that have
+ * per-file timestamp
+ * precision rather than
+ * per-packet timestamp
+ * precision
+ * e.g. WTAP_TSPREC_USEC
+ */
+ wtap_new_ipv4_callback_t add_new_ipv4;
+ wtap_new_ipv6_callback_t add_new_ipv6;
+ GPtrArray *fast_seek;
};
struct wtap_dumper;
+/*
+ * This could either be a FILE * or a gzFile.
+ */
+typedef void *WFILE_T;
+
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 timeval start;
- guint32 nframes;
-} netxray_dump_t;
-
-typedef struct {
- gboolean got_first_record_time;
- struct timeval first_record_time;
- guint32 frame_table_offset;
- guint32 *frame_table;
- guint frame_table_index;
- guint frame_table_size;
-} netmon_dump_t;
-
-typedef struct {
- guint32 nframes;
-} _5views_dump_t;
-
-typedef struct {
- guint64 packet_count;
- guint8 network_type;
-} niobserver_dump_t;
+ const struct wtap_pkthdr*,
+ const guint8*, int*, gchar**);
+typedef gboolean (*subtype_finish_func)(struct wtap_dumper*, int*);
struct wtap_dumper {
- FILE* fh;
- int file_type;
- int snaplen;
- int encap;
- long 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;
- } dump;
-
- subtype_write_func subtype_write;
- subtype_close_func subtype_close;
+ WFILE_T fh;
+ gboolean is_stdout; /* TRUE if we're writing to the standard output */
+ int file_type_subtype;
+ int snaplen;
+ int encap;
+ gboolean compressed;
+ gint64 bytes_dumped;
+
+ void *priv; /* this one holds per-file state and is free'd automatically by wtap_dump_close() */
+ void *wslua_data; /* this one holds wslua state info and is not free'd */
+
+ subtype_write_func subtype_write; /* write out a record */
+ subtype_finish_func subtype_finish; /* write out information to finish writing file */
+
+ int tsprecision; /**< timestamp precision of the lower 32bits
+ * e.g. WTAP_TSPREC_USEC
+ */
+ addrinfo_lists_t *addrinfo_lists; /**< Struct containing lists of resolved addresses */
+ wtapng_section_t *shb_hdr;
+ wtapng_name_res_t *nrb_hdr; /**< name resolution comment/custom_opt, or NULL */
+ GArray *interface_data; /**< An array holding the interface data from pcapng IDB:s or equivalent(?) NULL if not present.*/
};
+WS_DLL_PUBLIC gboolean wtap_dump_file_write(wtap_dumper *wdh, const void *buf,
+ size_t bufsize, int *err);
+WS_DLL_PUBLIC gint64 wtap_dump_file_seek(wtap_dumper *wdh, gint64 offset, int whence, int *err);
+WS_DLL_PUBLIC gint64 wtap_dump_file_tell(wtap_dumper *wdh, int *err);
-/* Macros to byte-swap 32-bit and 16-bit quantities. */
-#define BSWAP32(x) \
- ((((x)&0xFF000000)>>24) | \
- (((x)&0x00FF0000)>>8) | \
- (((x)&0x0000FF00)<<8) | \
- (((x)&0x000000FF)<<24))
-#define BSWAP16(x) \
- ((((x)&0xFF00)>>8) | \
- (((x)&0x00FF)<<8))
-
-/* Turn host-byte-order values into little-endian values. */
-#define htoles(s) GUINT16_TO_LE(s)
-#define htolel(l) GUINT32_TO_LE(l)
-#ifdef G_HAVE_GINT64
-#define htolell(ll) GUINT64_TO_LE(ll)
-#endif /* G_HAVE_GINT64 */
-
-/* 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.
- *
- * If G_HAVE_GINT64 is defined, so we can use "gint64" and "guint64" to
- * refer to 64-bit integral quantities, we also provide pntohll and
- * phtolell, which extract 64-bit integral quantities.
- */
-#ifndef pntohs
-#define pntohs(p) ((guint16) \
- ((guint16)*((const guint8 *)(p)+0)<<8| \
- (guint16)*((const guint8 *)(p)+1)<<0))
-#endif
+extern gint wtap_num_file_types;
-#ifndef pntoh24
-#define pntoh24(p) ((guint32)*((const guint8 *)(p)+0)<<16| \
- (guint32)*((const guint8 *)(p)+1)<<8| \
- (guint32)*((const guint8 *)(p)+2)<<0)
-#endif
+#include <wsutil/pint.h>
-#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
+/* Macros to byte-swap possibly-unaligned 64-bit, 32-bit and 16-bit quantities;
+ * they take a pointer to the quantity, and byte-swap it in place.
+ */
+#define PBSWAP64(p) \
+ { \
+ guint8 tmp; \
+ tmp = (p)[7]; \
+ (p)[7] = (p)[0]; \
+ (p)[0] = tmp; \
+ tmp = (p)[6]; \
+ (p)[6] = (p)[1]; \
+ (p)[1] = tmp; \
+ tmp = (p)[5]; \
+ (p)[5] = (p)[2]; \
+ (p)[2] = tmp; \
+ tmp = (p)[4]; \
+ (p)[4] = (p)[3]; \
+ (p)[3] = tmp; \
+ }
+#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; \
+ }
+
+
+/* Pointer routines to put items out in a particular byte order.
+ * These will work regardless of the byte alignment of the pointer.
+ */
-#ifdef G_HAVE_GINT64
-#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 phtons
+#define phtons(p, v) \
+ { \
+ (p)[0] = (guint8)((v) >> 8); \
+ (p)[1] = (guint8)((v) >> 0); \
+ }
#endif
-
-#ifndef phtons
-#define phtons(p) ((guint16) \
- ((guint16)*((const guint8 *)(p)+0)<<8| \
- (guint16)*((const guint8 *)(p)+1)<<0))
+#ifndef phton24
+#define phton24(p, v) \
+ { \
+ (p)[0] = (guint8)((v) >> 16); \
+ (p)[1] = (guint8)((v) >> 8); \
+ (p)[2] = (guint8)((v) >> 0); \
+ }
#endif
#ifndef phtonl
-#define phtonl(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)
+#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 pletohs
-#define pletohs(p) ((guint16) \
- ((guint16)*((const guint8 *)(p)+1)<<8| \
- (guint16)*((const guint8 *)(p)+0)<<0))
+#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 pletoh24
-#define pletoh24(p) ((guint32)*((const guint8 *)(p)+2)<<16| \
- (guint32)*((const guint8 *)(p)+1)<<8| \
- (guint32)*((const guint8 *)(p)+0)<<0)
+#ifndef phtoles
+#define phtoles(p, v) \
+ { \
+ (p)[0] = (guint8)((v) >> 0); \
+ (p)[1] = (guint8)((v) >> 8); \
+ }
#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)
+#ifndef phtolel
+#define phtolel(p, v) \
+ { \
+ (p)[0] = (guint8)((v) >> 0); \
+ (p)[1] = (guint8)((v) >> 8); \
+ (p)[2] = (guint8)((v) >> 16); \
+ (p)[3] = (guint8)((v) >> 24); \
+ }
#endif
-
-#ifdef G_HAVE_GINT64
-#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
+#ifndef phtolell
+#define phtolell(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
+/*
+ * Table of extensions for compressed file types we support.
+ * Last pointer in the list is null.
+ */
+extern const char *compressed_file_extension_table[];
+
+/*
+ * Read a given number of bytes from a file.
+ *
+ * If we succeed, return TRUE.
+ *
+ * If we get an EOF, return FALSE with *err set to 0, reporting this
+ * as an EOF.
+ *
+ * If we get fewer bytes than the specified number, return FALSE with
+ * *err set to WTAP_ERR_SHORT_READ, reporting this as a short read
+ * error.
+ *
+ * If we get a read error, return FALSE with *err and *err_info set
+ * appropriately.
+ */
+WS_DLL_PUBLIC
+gboolean
+wtap_read_bytes_or_eof(FILE_T fh, void *buf, unsigned int count, int *err,
+ gchar **err_info);
+
+/*
+ * Read a given number of bytes from a file.
+ *
+ * If we succeed, return TRUE.
+ *
+ * If we get fewer bytes than the specified number, including getting
+ * an EOF, return FALSE with *err set to WTAP_ERR_SHORT_READ, reporting
+ * this as a short read error.
+ *
+ * If we get a read error, return FALSE with *err and *err_info set
+ * appropriately.
+ */
+WS_DLL_PUBLIC
+gboolean
+wtap_read_bytes(FILE_T fh, void *buf, unsigned int count, int *err,
+ gchar **err_info);
+
+/*
+ * Read packet data into a Buffer, growing the buffer as necessary.
+ *
+ * This returns an error on a short read, even if the short read hit
+ * the EOF immediately. (The assumption is that each packet has a
+ * header followed by raw packet data, and that we've already read the
+ * header, so if we get an EOF trying to read the packet data, the file
+ * has been cut short, even if the read didn't read any data at all.)
+ */
+WS_DLL_PUBLIC
+gboolean
+wtap_read_packet_bytes(FILE_T fh, Buffer *buf, guint length, int *err,
+ gchar **err_info);
+
#endif /* __WTAP_INT_H__ */
+
+/*
+ * Editor modelines
+ *
+ * Local Variables:
+ * c-basic-offset: 8
+ * tab-width: 8
+ * indent-tabs-mode: t
+ * End:
+ *
+ * ex: set shiftwidth=8 tabstop=8 noexpandtab:
+ * :indentSize=8:tabSize=8:noTabs=false:
+ */
git.samba.org / metze / wireshark / wip.git / blobdiff