forked from osmocom/wireshark
![Michael Mann](/assets/img/avatar_default.png)
Bug: 13652 Bug: 12535 Change-Id: Ie4c140acbe983a585776bc1430cf407cdcd6e07a Reviewed-on: https://code.wireshark.org/review/21356 Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Guy Harris <guy@alum.mit.edu>
337 lines
11 KiB
C
337 lines
11 KiB
C
/* wtap-int.h
|
|
*
|
|
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef __WTAP_INT_H__
|
|
#define __WTAP_INT_H__
|
|
|
|
#include <glib.h>
|
|
#include <time.h>
|
|
|
|
#ifdef HAVE_WINSOCK2_H
|
|
#include <winsock2.h>
|
|
#endif
|
|
|
|
#include <wsutil/file_util.h>
|
|
|
|
#include "wtap.h"
|
|
#include "wtap_opttypes.h"
|
|
|
|
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;
|
|
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;
|
|
GArray *shb_hdrs;
|
|
GArray *interface_data; /**< An array holding the interface data from pcapng IDB:s or equivalent(?)*/
|
|
GArray *nrb_hdrs; /**< 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 guint8*, int*, gchar**);
|
|
typedef gboolean (*subtype_finish_func)(struct wtap_dumper*, int*);
|
|
|
|
struct wtap_dumper {
|
|
WFILE_T fh;
|
|
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 */
|
|
|
|
addrinfo_lists_t *addrinfo_lists; /**< Struct containing lists of resolved addresses */
|
|
GArray *shb_hdrs;
|
|
GArray *nrb_hdrs; /**< 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);
|
|
|
|
|
|
extern gint wtap_num_file_types;
|
|
|
|
#include <wsutil/pint.h>
|
|
|
|
/* 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.
|
|
*/
|
|
|
|
#ifndef phtons
|
|
#define phtons(p, v) \
|
|
{ \
|
|
(p)[0] = (guint8)((v) >> 8); \
|
|
(p)[1] = (guint8)((v) >> 0); \
|
|
}
|
|
#endif
|
|
|
|
#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, 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 phtole8
|
|
#define phtole8(p, v) \
|
|
{ \
|
|
(p)[0] = (guint8)((v) >> 0); \
|
|
}
|
|
#endif
|
|
|
|
#ifndef phtoles
|
|
#define phtoles(p, v) \
|
|
{ \
|
|
(p)[0] = (guint8)((v) >> 0); \
|
|
(p)[1] = (guint8)((v) >> 8); \
|
|
}
|
|
#endif
|
|
|
|
#ifndef phtole24
|
|
#define phtole24(p, v) \
|
|
{ \
|
|
(p)[0] = (guint8)((v) >> 0); \
|
|
(p)[1] = (guint8)((v) >> 8); \
|
|
(p)[2] = (guint8)((v) >> 16); \
|
|
}
|
|
#endif
|
|
|
|
#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
|
|
|
|
#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
|
|
|
|
/* 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 into a buffer or, if
|
|
* buf is NULL, just discard them.
|
|
*
|
|
* 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 into a buffer or, if
|
|
* buf is NULL, just discard them.
|
|
*
|
|
* 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:
|
|
*/
|