/* frame_data.h
* Definitions for frame_data structures and routines
*
- * $Id: frame_data.h,v 1.12 2004/01/10 13:15:41 jmayer Exp $
- *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- * 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.
+ * SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __FRAME_DATA_H__
#define __FRAME_DATA_H__
-#include "column_info.h"
-#include "tvbuff.h"
-
-#if 0
-/* Defined in color.h */
-#ifndef __COLOR_H__
-typedef struct _color_t /* {
- guint32 pixel;
- guint16 red;
- guint16 green;
- guint16 blue;
-} */ color_t;
-#endif
-#endif
-
-/* XXX - some of this stuff is used only while a packet is being dissected;
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+#include <ws_diag_control.h>
+#include <ws_symbol_export.h>
+#include <wsutil/nstime.h>
+
+#include <wiretap/wtap.h>
+
+struct _packet_info;
+struct epan_session;
+
+#define PINFO_FD_VISITED(pinfo) ((pinfo)->fd->flags.visited)
+
+/** @file
+ * Low-level frame data and metadata.
+ */
+
+/** @defgroup framedata Frame Data
+ *
+ * @{
+ */
+
+/** @todo XXX - some of this stuff is used only while a packet is being dissected;
should we keep that stuff in the "packet_info" structure, instead, to
save memory? */
+
+/* Types of character encodings */
+typedef enum {
+ PACKET_CHAR_ENC_CHAR_ASCII = 0, /* ASCII */
+ PACKET_CHAR_ENC_CHAR_EBCDIC = 1 /* EBCDIC */
+} packet_char_enc;
+
+/** The frame number is the ordinal number of the frame in the capture, so
+ it's 1-origin. In various contexts, 0 as a frame number means "frame
+ number unknown". */
+struct _color_filter; /* Forward */
+DIAG_OFF_PEDANTIC
typedef struct _frame_data {
- struct _frame_data *next; /* Next element in list */
- struct _frame_data *prev; /* Previous element in list */
- GSList *pfd; /* Per frame proto data */
- guint32 num; /* Frame number */
- guint32 pkt_len; /* Packet length */
- guint32 cap_len; /* Amount actually captured */
- guint32 cul_bytes; /* Culmulative bytes into the capture */
- gint32 rel_secs; /* Relative seconds (yes, it can be negative) */
- gint32 rel_usecs; /* Relative microseconds (yes, it can be negative) */
- guint32 abs_secs; /* Absolute seconds */
- guint32 abs_usecs; /* Absolute microseconds */
- gint32 del_secs; /* Delta seconds (yes, it can be negative) */
- gint32 del_usecs; /* Delta microseconds (yes, it can be negative) */
- long file_off; /* File offset */
- int lnk_t; /* Per-packet encapsulation/data-link type */
+ GSList *pfd; /**< Per frame proto data */
+ guint32 num; /**< Frame number */
+ guint32 pkt_len; /**< Packet length */
+ guint32 cap_len; /**< Amount actually captured */
+ guint32 cum_bytes; /**< Cumulative bytes into the capture */
+ gint64 file_off; /**< File offset */
+ guint16 subnum; /**< subframe number, for protocols that require this */
+ gint16 tsprec; /**< Time stamp precision */
struct {
- unsigned int passed_dfilter : 1; /* 1 = display, 0 = no display */
- unsigned int encoding : 2; /* Character encoding (ASCII, EBCDIC...) */
- unsigned int visited : 1; /* Has this packet been visited yet? 1=Yes,0=No*/
- unsigned int marked : 1; /* 1 = marked by user, 0 = normal */
- unsigned int ref_time : 1; /* 1 = marked as a reference time frame, 0 = normal */
+ unsigned int passed_dfilter : 1; /**< 1 = display, 0 = no display */
+ unsigned int dependent_of_displayed : 1; /**< 1 if a displayed frame depends on this frame */
+ /* Do NOT use packet_char_enc enum here: MSVC compiler does not handle an enum in a bit field properly */
+ unsigned int encoding : 1; /**< Character encoding (ASCII, EBCDIC...) */
+ unsigned int visited : 1; /**< Has this packet been visited yet? 1=Yes,0=No*/
+ unsigned int marked : 1; /**< 1 = marked by user, 0 = normal */
+ unsigned int ref_time : 1; /**< 1 = marked as a reference time frame, 0 = normal */
+ unsigned int ignored : 1; /**< 1 = ignore this frame, 0 = normal */
+ unsigned int has_ts : 1; /**< 1 = has time stamp, 0 = no time stamp */
+ unsigned int has_phdr_comment : 1; /** 1 = there's comment for this packet */
+ unsigned int has_user_comment : 1; /** 1 = user set (also deleted) comment for this packet */
+ unsigned int need_colorize : 1; /**< 1 = need to (re-)calculate packet color */
} flags;
- void *color_filter; /* Per-packet matching color_filter_t object */
+
+ const struct _color_filter *color_filter; /**< Per-packet matching color_filter_t object */
+
+ nstime_t abs_ts; /**< Absolute timestamp */
+ nstime_t shift_offset; /**< How much the abs_tm of the frame is shifted */
+ guint32 frame_ref_num; /**< Previous reference frame (0 if this is one) */
+ guint32 prev_dis_num; /**< Previous displayed frame (0 if first one) */
} frame_data;
+DIAG_ON_PEDANTIC
-/*
- * A data source.
- * Has a tvbuff and a name.
- */
-typedef struct {
- tvbuff_t *tvb;
- char *name;
-} data_source;
+/** compare two frame_datas */
+WS_DLL_PUBLIC gint frame_data_compare(const struct epan_session *epan, const frame_data *fdata1, const frame_data *fdata2, int field);
+
+WS_DLL_PUBLIC void frame_data_reset(frame_data *fdata);
+
+WS_DLL_PUBLIC void frame_data_destroy(frame_data *fdata);
-/* Utility routines used by packet*.c */
+WS_DLL_PUBLIC void frame_data_init(frame_data *fdata, guint32 num,
+ const wtap_rec *rec, gint64 offset,
+ guint32 cum_bytes);
-extern void p_add_proto_data(frame_data *, int, void *);
-extern void *p_get_proto_data(frame_data *, int);
-extern void p_rem_proto_data(frame_data *fd, int proto);
+extern void frame_delta_abs_time(const struct epan_session *epan, const frame_data *fdata,
+ guint32 prev_num, nstime_t *delta);
+/**
+ * Sets the frame data struct values before dissection.
+ */
+WS_DLL_PUBLIC void frame_data_set_before_dissect(frame_data *fdata,
+ nstime_t *elapsed_time,
+ const frame_data **frame_ref,
+ const frame_data *prev_dis);
+
+WS_DLL_PUBLIC void frame_data_set_after_dissect(frame_data *fdata,
+ guint32 *cum_bytes);
-/* An init routine to be called by epan_init */
-extern void frame_data_init(void);
+/** @} */
-/* A cleanup routine to be called by epan_cleanup */
-extern void frame_data_cleanup(void);
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
#endif /* __FRAME_DATA__ */
+
+/*
+ * Editor modelines - http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 2
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=2 tabstop=8 expandtab:
+ * :indentSize=2:tabSize=8:noTabs=true:
+ */
git.samba.org / metze / wireshark / wip.git / blobdiff