frame_data.h

Go to the documentation of this file.

/* frame_data.h
 * Definitions for frame_data structures and routines
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef __FRAME_DATA_H__
#define __FRAME_DATA_H__
 
#include <ws_diag_control.h>
#include <ws_symbol_export.h>
#include <wsutil/nstime.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct wtap_rec wtap_rec;
struct _packet_info;
struct epan_session;
 
#define PINFO_FD_VISITED(pinfo)   ((pinfo)->fd->visited)
 
/* Types of character encodings */
typedef enum {
  PACKET_CHAR_ENC_CHAR_ASCII     = 0, /* ASCII */
  PACKET_CHAR_ENC_CHAR_EBCDIC    = 1  /* EBCDIC */
} packet_char_enc;
 
typedef struct _aggregation_key {
  gchar*  field;
  GSList* values;
  int     values_num;
} aggregation_key;
 
struct _color_filter; /* Forward */
DIAG_OFF_PEDANTIC
typedef struct _frame_data {
  uint32_t     num;          
  uint32_t     dis_num;      
  uint32_t     pkt_len;      
  uint32_t     cap_len;      
  int64_t      file_off;     
  /* These two are pointers, meaning 64-bit on LP64 (64-bit UN*X) and
     LLP64 (64-bit Windows) platforms.  Put them here, one after the
     other, so they don't require padding between them. */
  GSList      *pfd;          
  GHashTable  *dependent_frames;     
  const struct _color_filter *color_filter;  
  uint32_t     cum_bytes;    
  /* XXX - cum_bytes presumably ought to be 64-bit as well now */
  uint8_t      tcp_snd_manual_analysis;   
  /* Keep the bitfields below to 24 bits, so this plus the previous field
     are 32 bits. (XXX - The previous field could be a bitfield too.) */
  unsigned int passed_dfilter   : 1; 
  unsigned int dependent_of_displayed : 1; 
  /* Do NOT use packet_char_enc enum here: MSVC compiler does not handle an enum in a bit field properly */
  unsigned int encoding         : 1; 
  unsigned int visited          : 1; 
  unsigned int marked           : 1; 
  unsigned int ref_time         : 1; 
  unsigned int ignored          : 1; 
  unsigned int has_ts           : 1; 
  unsigned int has_modified_block : 1; 
  unsigned int need_colorize    : 1; 
  unsigned int tsprec           : 4; 
  nstime_t     abs_ts;       
  nstime_t     shift_offset; 
  uint32_t     frame_ref_num; 
  /* frame_ref_num == num if ref_time == true, but also if this is the first
   * record that has_ts (or if somehow a record without a TS is a reference
   * time frame, the first frame after that with has_ts == true.) */
  uint32_t     prev_dis_num; 
  GSList*      aggregation_keys; 
} frame_data;
DIAG_ON_PEDANTIC
 
WS_DLL_PUBLIC int frame_data_compare(const struct epan_session *epan, const frame_data *fdata1, const frame_data *fdata2, int field);
 
WS_DLL_PUBLIC int frame_data_aggregation_compare(const frame_data* fdata1, const frame_data* fdata2);
 
WS_DLL_PUBLIC void frame_data_reset(frame_data *fdata);
 
WS_DLL_PUBLIC void frame_data_destroy(frame_data *fdata);
 
WS_DLL_PUBLIC void free_aggregation_key(gpointer key);
 
WS_DLL_PUBLIC void frame_data_aggregation_free(frame_data *fdata);
 
WS_DLL_PUBLIC void frame_data_init(frame_data *fdata, uint32_t num,
                const wtap_rec *rec, int64_t offset,
                uint32_t cum_bytes);
 
extern bool frame_rel_first_frame_time(const struct epan_session *epan,
                                       const frame_data *fdata,
                                       nstime_t *delta);
 
extern bool frame_rel_time(const struct epan_session *epan,
                           const frame_data *fdata, nstime_t *delta);
 
extern bool frame_rel_start_time(const struct epan_session *epan,
                                 const frame_data *fdata, nstime_t *delta);
 
extern bool frame_delta_time_prev_captured(const struct epan_session *epan,
                                           const frame_data *fdata,
                                           nstime_t *delta);
 
extern bool frame_delta_time_prev_displayed(const struct epan_session *epan,
                                            const frame_data *fdata,
                                            nstime_t *delta);
 
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,
                uint32_t *cum_bytes);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif  /* __FRAME_DATA__ */
 
/*
 * Editor modelines  -  https://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:
 */