file.h

   1 /* file.h
   2  * Definitions for file structures and routines
   3  *
   4  * $Id: file.h,v 1.75 2000/08/11 13:34:30 deniel Exp $
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@zing.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #ifndef __FILE_H__
  27 #define __FILE_H__
  28
  29 #ifdef HAVE_SYS_TYPES_H
  30 #include <sys/types.h>
  31 #endif
  32
  33 #include "wiretap/wtap.h"
  34
  35 #ifdef HAVE_LIBPCAP
  36 #include <pcap.h>
  37 #endif
  38
  39 #include "dfilter.h"
  40 #include "gtk/colors.h"         /* XXX */
  41 #include "print.h"
  42
  43 #include <errno.h>
  44
  45 #ifdef HAVE_LIBZ
  46 #include "zlib.h"
  47 #define FILE_T gzFile
  48 #define file_open gzopen
  49 #define filed_open gzdopen
  50 #define file_close gzclose
  51 #else /* No zLib */
  52 #define FILE_T FILE *
  53 #define file_open fopen
  54 #define filed_open fdopen
  55 #define file_close fclose
  56 #endif /* HAVE_LIBZ */
  57
  58 typedef struct bpf_program bpf_prog;
  59
  60 /* Current state of file. */
  61 typedef enum {
  62         FILE_CLOSED,            /* No file open */
  63         FILE_READ_IN_PROGRESS,  /* Reading a file we've opened */
  64         FILE_READ_ABORTED,      /* Read aborted by user */
  65         FILE_READ_DONE          /* Read completed */
  66 } file_state;
  67
  68 typedef struct _capture_file {
  69   file_state   state;     /* Current state of capture file */
  70   int          filed;     /* File descriptor of capture file */
  71   gchar       *filename;  /* Name of capture file */
  72   gboolean     is_tempfile; /* Is capture file a temporary file? */
  73   gboolean     user_saved;/* If capture file is temporary, has it been saved by user yet? */
  74   long         f_len;     /* Length of capture file */
  75   guint16      cd_t;      /* File type of capture file */
  76   int          lnk_t;     /* Link-layer type with which to save capture */
  77   guint32      vers;      /* Version.  For tcpdump minor is appended to major */
  78   guint32      count;     /* Packet count */
  79   guint32      drops;     /* Dropped packets */
  80   guint32      esec;      /* Elapsed seconds */
  81   guint32      eusec;     /* Elapsed microseconds */
  82   guint32      snap;      /* Captured packet length */
  83   long         progbar_quantum; /* Number of bytes read per progress bar update */
  84   long         progbar_nextstep; /* Next point at which to update progress bar */
  85   gchar       *iface;     /* Interface */
  86   gchar       *save_file; /* File that user saved capture to */
  87   int          save_file_fd; /* File descriptor for saved file */
  88   wtap        *wth;       /* Wiretap session */
  89   dfilter     *rfcode;    /* Compiled read filter program */
  90   gchar       *dfilter;   /* Display filter string */
  91   colfilter   *colors;    /* Colors for colorizing packet window */
  92   dfilter     *dfcode;    /* Compiled display filter program */
  93 #ifdef HAVE_LIBPCAP
  94   gchar       *cfilter;   /* Capture filter string */
  95   bpf_prog     fcode;     /* Compiled capture filter program */
  96 #endif
  97   gchar       *sfilter;   /* Search filter string */
  98   gboolean     sbackward;  /* TRUE if search is backward, FALSE if forward */
  99   union wtap_pseudo_header pseudo_header;      /* Packet pseudo_header */
 100   guint8       pd[WTAP_MAX_PACKET_SIZE];  /* Packet data */
 101   GMemChunk   *plist_chunk; /* Memory chunk for frame_data structures */
 102   frame_data  *plist;     /* Packet list */
 103   frame_data  *plist_end; /* Last packet in list */
 104   frame_data  *first_displayed; /* First frame displayed */
 105   frame_data  *last_displayed;  /* Last frame displayed */
 106   column_info  cinfo;    /* Column formatting information */
 107   frame_data  *current_frame;  /* Frame data for current frame */
 108   proto_tree  *protocol_tree; /* Protocol tree for currently selected packet */
 109   FILE        *print_fh;  /* File we're printing to */
 110 } capture_file;
 111
 112 /* Return values from "read_cap_file()", "continue_tail_cap_file()",
 113    and "finish_tail_cap_file()". */
 114 typedef enum {
 115         READ_SUCCESS,   /* read succeeded */
 116         READ_ERROR,     /* read got an error */
 117         READ_ABORTED    /* read aborted by user */
 118 } read_status_t;
 119
 120 int  open_cap_file(char *, gboolean, capture_file *);
 121 void close_cap_file(capture_file *, void *);
 122 read_status_t read_cap_file(capture_file *, int *);
 123 int  start_tail_cap_file(char *, gboolean, capture_file *);
 124 read_status_t continue_tail_cap_file(capture_file *, int, int *);
 125 read_status_t finish_tail_cap_file(capture_file *, int *);
 126 /* size_t read_frame_header(capture_file *); */
 127 int  save_cap_file(char *, capture_file *, gboolean, guint);
 128
 129 int filter_packets(capture_file *cf, gchar *dfilter);
 130 void colorize_packets(capture_file *);
 131 void redissect_packets(capture_file *cf);
 132 int print_packets(capture_file *cf, print_args_t *print_args);
 133 void change_time_formats(capture_file *);
 134 gboolean find_packet(capture_file *cf, dfilter *sfcode);
 135
 136 typedef enum {
 137   FOUND_FRAME,          /* found the frame */
 138   NO_SUCH_FRAME,        /* no frame with that number */
 139   FRAME_NOT_DISPLAYED   /* frame with that number isn't displayed */
 140 } goto_result_t;
 141 goto_result_t goto_frame(capture_file *cf, guint fnumber);
 142
 143 void select_packet(capture_file *, int);
 144 void unselect_packet(capture_file *);
 145
 146 /* Moves or copies a file. Returns 0 on failure, 1 on success */
 147 int file_mv(char *from, char *to);
 148
 149 /* Copies a file. Returns 0 on failure, 1 on success */
 150 int file_cp(char *from, char *to);
 151
 152 char *file_open_error_message(int, gboolean);
 153 char *file_read_error_message(int);
 154 char *file_write_error_message(int);
 155
 156 #endif /* file.h */