capture_opts.h

   1 /* capture_opts.h
   2  * Capture options (all parameters needed to do the actual capture)
   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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25
  26 /** @file
  27  *
  28  *  Capture options (all parameters needed to do the actual capture)
  29  *
  30  */
  31
  32 #ifndef __CAPTURE_OPTS_H__
  33 #define __CAPTURE_OPTS_H__
  34
  35
  36 /* Current state of capture engine. XXX - differentiate states */
  37 typedef enum {
  38     CAPTURE_STOPPED,        /**< stopped */
  39     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
  40     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
  41 } capture_state;
  42
  43
  44 /** Capture options coming from user interface */
  45 typedef struct capture_options_tag {
  46     /* general */
  47     void     *cf;                   /**< handle to cfile (note: untyped handle) */
  48     gboolean has_cfilter;           /**< TRUE if capture filter specified on command line */
  49     gchar    *cfilter;              /**< Capture filter string */
  50     gchar    *iface;                /**< the network interface to capture from */
  51     gchar    *iface_descr;          /**< A human readable description of iface.
  52                                       *< NOTE: capture_opts.c is not able to
  53                                       *< set this field because doing so
  54                                       *< requires too many dependencies.
  55                                       *< Readers of this field should use
  56                                       *< get_iface_description() from
  57                                       *< "capture_ui_utils.h" to access it. */
  58
  59 #ifdef _WIN32
  60     int      buffer_size;           /**< the capture buffer size (MB) */
  61 #endif
  62     gboolean has_snaplen;           /**< TRUE if maximum capture packet length
  63                                          is specified */
  64     int      snaplen;               /**< Maximum captured packet length */
  65     gboolean promisc_mode;          /**< Capture in promiscuous mode */
  66     int      linktype;              /**< Data link type to use, or -1 for
  67                                          "use default" */
  68     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
  69     gchar    *save_file;            /**< the capture file name */
  70
  71     /* GUI related */
  72     gboolean real_time_mode;        /**< Update list of packets in real time */
  73     gboolean show_info;             /**< show the info dialog */
  74     gboolean quit_after_cap;        /**< Makes a "capture only mode". Implies -k */
  75     gboolean restart;               /**< restart after closing is done */
  76
  77     /* multiple files (and ringbuffer) */
  78     gboolean multi_files_on;        /**< TRUE if ring buffer in use */
  79
  80     gboolean has_file_duration;     /**< TRUE if ring duration specified */
  81     gint32 file_duration;           /**< Switch file after n seconds */
  82     gboolean has_ring_num_files;    /**< TRUE if ring num_files specified */
  83     guint32 ring_num_files;         /**< Number of multiple buffer files */
  84
  85     /* autostop conditions */
  86     gboolean has_autostop_files;    /**< TRUE if maximum number of capture files
  87                                          are specified */
  88     gint32 autostop_files;          /**< Maximum number of capture files */
  89
  90     gboolean has_autostop_packets;  /**< TRUE if maximum packet count is
  91                                          specified */
  92     int autostop_packets;           /**< Maximum packet count */
  93     gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
  94                                          is specified */
  95     gint32 autostop_filesize;       /**< Maximum capture file size */
  96     gboolean has_autostop_duration; /**< TRUE if maximum capture duration
  97                                          is specified */
  98     gint32 autostop_duration;       /**< Maximum capture duration */
  99
 100     /* internally used (don't touch from outside) */
 101     int fork_child;                 /**< If not -1, in parent, process ID of child */
 102 #ifdef _WIN32
 103     int signal_pipe_write_fd;       /**< the pipe to signal the child */
 104 #endif
 105     capture_state state;            /**< current state of the capture engine */
 106     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
 107 #ifndef _WIN32
 108     uid_t owner;                    /**< owner of the cfile */
 109     gid_t group;                    /**< group of the cfile */
 110 #endif
 111 } capture_options;
 112
 113 /* initialize the capture_options with some reasonable values */
 114 extern void
 115 capture_opts_init(capture_options *capture_opts, void *cfile);
 116
 117 /* set a command line option value */
 118 extern int
 119 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
 120
 121 /* log content of capture_opts */
 122 extern void
 123 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
 124
 125 /* list link layer types */
 126 extern int
 127 capture_opts_list_link_layer_types(capture_options *capture_opts, gboolean machine_readable);
 128
 129 /* list interfaces */
 130 extern int
 131 capture_opts_list_interfaces(gboolean machine_readable);
 132
 133 /* print interface statistics */
 134 extern int
 135 capture_opts_print_statistics(gboolean machine_readable);
 136
 137 /* trim the snaplen entry */
 138 extern void
 139 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 140
 141 /* trim the ring_num_files entry */
 142 extern void
 143 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 144
 145 /* trim the interface entry */
 146 extern gboolean
 147 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
 148
 149 #endif /* capture_opts.h */