capture.h

   1 /* capture.h
   2  * Definitions for packet capture windows
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 /* This file should only be included if libpcap is present */
  26
  27 #ifndef __CAPTURE_H__
  28 #define __CAPTURE_H__
  29
  30 /** @file
  31  *  Capture related things.
  32  */
  33
  34 /** Name we give to the child process when doing a "-S" capture. */
  35 #define CHILD_NAME      "ethereal-capture"
  36
  37 /** Capture options coming from user interface */
  38 typedef struct capture_options_tag {
  39     /* general */
  40     void     *cf;           /**< handle to cfile (note: untyped handle) */
  41     gchar    *cfilter;      /**< Capture filter string */
  42     gchar    *iface;        /**< the network interface to capture from */
  43
  44 #ifdef _WIN32
  45     int      buffer_size;   /**< the capture buffer size (MB) */
  46 #endif
  47     gboolean has_snaplen;   /**< TRUE if maximum capture packet length
  48                                  is specified */
  49     int      snaplen;       /**< Maximum captured packet length */
  50     gboolean promisc_mode;  /**< Capture in promiscuous mode */
  51     int      linktype;      /**< Data link type to use, or -1 for
  52                                  "use default" */
  53     gchar    *save_file;    /**< the capture file name */
  54
  55     /* GUI related */
  56     gboolean sync_mode;     /**< Fork a child to do the capture,
  57                                  and sync between them */
  58     gboolean show_info;     /**< show the info dialog */
  59     gboolean quit_after_cap;    /** Makes a "capture only mode". Implies -k */
  60
  61     /* multiple files (and ringbuffer) */
  62     gboolean multi_files_on;    /**< TRUE if ring buffer in use */
  63
  64     gboolean has_file_duration; /**< TRUE if ring duration specified */
  65     gint32 file_duration;       /* Switch file after n seconds */
  66     gboolean has_ring_num_files;/**< TRUE if ring num_files specified */
  67     guint32 ring_num_files;     /**< Number of multiple buffer files */
  68
  69     /* autostop conditions */
  70     gboolean has_autostop_files;/**< TRUE if maximum number of capture files
  71                                            are specified */
  72     gint32 autostop_files;      /**< Maximum number of capture files */
  73
  74     gboolean has_autostop_packets;      /**< TRUE if maximum packet count is
  75                                            specified */
  76     int autostop_packets;               /**< Maximum packet count */
  77     gboolean has_autostop_filesize;     /**< TRUE if maximum capture file size
  78                                              is specified */
  79     gint32 autostop_filesize;           /**< Maximum capture file size */
  80     gboolean has_autostop_duration;     /**< TRUE if maximum capture duration
  81                                              is specified */
  82     gint32 autostop_duration;           /**< Maximum capture duration */
  83
  84     /* internally used (don't touch from outside) */
  85     int fork_child;                 /**< If not -1, in parent, process ID of child */
  86 } capture_options;
  87
  88
  89 /* initialize the capture_options with some reasonable values */
  90 extern void
  91 capture_opts_init(capture_options *capture_opts, void *cfile);
  92
  93 extern void
  94 capture_opts_add_opt(capture_options *capture_opts, const char *appname, int opt, const char *optarg, gboolean *start_capture);
  95
  96 /**
  97  * Open a specified file, or create a temporary file, and start a capture
  98  * to the file in question.
  99  *
 100  * @param capture_opts the numerous capture options
 101  * @return TRUE if the capture starts successfully, FALSE otherwise.
 102  */
 103 extern gboolean do_capture(capture_options *capture_opts);
 104
 105 /**
 106  * Capture child told us, we have a new (or the first) capture file.
 107  */
 108 extern gboolean capture_input_new_file(capture_options *capture_opts, gchar *new_file);
 109
 110 /**
 111  * Capture child told us, we have new packets to read.
 112  */
 113 extern void capture_input_new_packets(capture_options *capture_opts, int to_read);
 114
 115 /**
 116  * Capture child closed it's side ot the pipe, do the required cleanup.
 117  */
 118 extern void capture_input_closed(capture_options *capture_opts);
 119
 120 /** Stop a capture (usually from a menu item). */
 121 extern void capture_stop(capture_options *capture_opts);
 122
 123 /** Terminate the capture child cleanly when exiting. */
 124 extern void capture_kill_child(capture_options *capture_opts);
 125
 126
 127
 128 /** Do the low-level work of a capture (start the capture child).
 129  *  Returns TRUE if it succeeds, FALSE otherwise. */
 130 extern int  capture_child_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
 131
 132 /** Stop a capture child (usually from a menu item). */
 133 extern void capture_child_stop(capture_options *capture_opts);
 134
 135 /** Do the low-level work of a capture.
 136  *  Returns TRUE if it succeeds, FALSE otherwise. */
 137 extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
 138
 139 /** Stop a low-level capture. */
 140 extern void capture_loop_stop(void);
 141
 142
 143
 144 /** Current Capture info. */
 145 typedef struct {
 146     /* handles */
 147     gpointer        callback_data;  /**< capture callback handle */
 148     gpointer        ui;             /**< user interfaces own handle */
 149
 150     /* capture info */
 151     packet_counts   *counts;        /**< protocol specific counters */
 152     time_t          running_time;   /**< running time since last update */
 153     gint            new_packets;    /**< packets since last update */
 154 } capture_info;
 155
 156
 157 /** Create the capture info dialog */
 158 extern void capture_info_create(
 159 capture_info    *cinfo,
 160 gchar           *iface);
 161
 162 /** Update the capture info counters in the dialog */
 163 extern void capture_info_update(
 164 capture_info    *cinfo);
 165
 166 /** Destroy the capture info dialog again */
 167 extern void capture_info_destroy(
 168 capture_info    *cinfo);
 169
 170
 171 #endif /* capture.h */