cfile.h

   1 /* cfile.h
   2  * capture_file definition & GUI-independent manipulation
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __CFILE_H__
  26 #define __CFILE_H__
  27
  28 #include <epan/dfilter/dfilter.h>
  29 #include <epan/frame_data.h>
  30 #include <epan/frame_data_sequence.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif /* __cplusplus */
  35
  36 /* Current state of file. */
  37 typedef enum {
  38   FILE_CLOSED,                  /* No file open */
  39   FILE_READ_IN_PROGRESS,        /* Reading a file we've opened */
  40   FILE_READ_ABORTED,            /* Read aborted by user */
  41   FILE_READ_DONE                /* Read completed */
  42 } file_state;
  43
  44 /* Character set for text search. */
  45 typedef enum {
  46   SCS_NARROW_AND_WIDE,
  47   SCS_NARROW,
  48   SCS_WIDE
  49   /* add EBCDIC when it's implemented */
  50 } search_charset_t;
  51
  52 typedef enum {
  53   SD_FORWARD,
  54   SD_BACKWARD
  55 } search_direction;
  56
  57 /*
  58  * We store the frame_data structures in a radix tree, with 1024
  59  * elements per level.  The leaf nodes are arrays of 1024 frame_data
  60  * structures; the nodes above them are arrays of 1024 pointers to
  61  * the nodes below them.  The capture_file structure has a pointer
  62  * to the root node.
  63  *
  64  * As frame numbers are 32 bits, and as 1024 is 2^10, that gives us
  65  * up to 4 levels of tree.
  66  */
  67 #define LOG2_NODES_PER_LEVEL    10
  68 #define NODES_PER_LEVEL         (1<<LOG2_NODES_PER_LEVEL)
  69
  70 typedef struct _capture_file {
  71   epan_t      *epan;
  72   file_state   state;           /* Current state of capture file */
  73   gchar       *filename;        /* Name of capture file */
  74   gchar       *source;          /* Temp file source, e.g. "Pipe from elsewhere" */
  75   gboolean     is_tempfile;     /* Is capture file a temporary file? */
  76   gboolean     unsaved_changes; /* Does the capture file have changes that have not been saved? */
  77   gint64       f_datalen;       /* Size of capture file data (uncompressed) */
  78   guint16      cd_t;            /* File type of capture file */
  79   gboolean     iscompressed;    /* TRUE if the file is compressed */
  80   int          lnk_t;           /* File link-layer type; could be WTAP_ENCAP_PER_PACKET */
  81   GArray      *linktypes;       /* Array of packet link-layer types */
  82   guint32      count;           /* Total number of frames */
  83   guint64      packet_comment_count; /* Number of comments in frames (could be >1 per frame... */
  84   guint32      displayed_count; /* Number of displayed frames */
  85   guint32      marked_count;    /* Number of marked frames */
  86   guint32      ignored_count;   /* Number of ignored frames */
  87   guint32      ref_time_count;  /* Number of time referenced frames */
  88   gboolean     drops_known;     /* TRUE if we know how many packets were dropped */
  89   guint32      drops;           /* Dropped packets */
  90   nstime_t     elapsed_time;    /* Elapsed time */
  91   gboolean     has_snap;        /* TRUE if maximum capture packet length is known */
  92   int          snap;            /* Maximum captured packet length */
  93   wtap        *wth;             /* Wiretap session */
  94   dfilter_t   *rfcode;          /* Compiled read filter program */
  95   dfilter_t   *dfcode;          /* Compiled display filter program */
  96   gchar       *dfilter;         /* Display filter string */
  97   gboolean     redissecting;    /* TRUE if currently redissecting (cf_redissect_packets) */
  98   /* search */
  99   gchar       *sfilter;         /* Filter, hex value, or string being searched */
 100   gboolean     hex;             /* TRUE if "Hex value" search was last selected */
 101   gboolean     string;          /* TRUE if "String" search was last selected */
 102   gboolean     summary_data;    /* TRUE if "String" search in "Packet list" (Info column) was last selected */
 103   gboolean     decode_data;     /* TRUE if "String" search in "Packet details" was last selected */
 104   gboolean     packet_data;     /* TRUE if "String" search in "Packet data" was last selected */
 105   guint32      search_pos;      /* Byte position of last byte found in a hex search */
 106   gboolean     case_type;       /* TRUE if case-insensitive text search */
 107   search_charset_t scs_type;    /* Character set for text search */
 108   search_direction dir;         /* Direction in which to do searches */
 109   gboolean     search_in_progress; /* TRUE if user just clicked OK in the Find dialog or hit <control>N/B */
 110   /* packet data */
 111   struct wtap_pkthdr phdr;                /* Packet header */
 112   Buffer       buf;             /* Packet data */
 113   /* frames */
 114   frame_data_sequence *frames;  /* Sequence of frames, if we're keeping that information */
 115   guint32      first_displayed; /* Frame number of first frame displayed */
 116   guint32      last_displayed;  /* Frame number of last frame displayed */
 117   column_info  cinfo;           /* Column formatting information */
 118   gboolean     columns_changed; /**< Have the columns been changed in the prefs? */
 119   frame_data  *current_frame;   /* Frame data for current frame */
 120   gint         current_row;     /* Row number for current frame */
 121   epan_dissect_t *edt;          /* Protocol dissection for currently selected packet */
 122   field_info  *finfo_selected;  /* Field info for currently selected field */
 123 #ifdef WANT_PACKET_EDITOR
 124   GTree       *edited_frames;   /* BST with modified frames */
 125 #endif
 126   gpointer     window;          /* Top-level window associated with file */
 127   GTree       *frames_user_comments;   /* BST with user comments for frames (key = frame_data) */
 128   gulong       computed_elapsed;
 129
 130   guint32      cum_bytes;
 131   const frame_data *ref;
 132   frame_data  *prev_dis;
 133   frame_data  *prev_cap;
 134 } capture_file;
 135
 136 extern void cap_file_init(capture_file *cf);
 137
 138 extern const char *cap_file_get_interface_name(void *data, guint32 interface_id);
 139
 140 #ifdef __cplusplus
 141 }
 142 #endif /* __cplusplus */
 143
 144 #endif /* cfile.h */