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 #ifndef __CAPTURE_H__
  26 #define __CAPTURE_H__
  27
  28 /** @file
  29  *  Capture related things.
  30  */
  31
  32 /** Name we give to the child process when doing a "-S" capture. */
  33 #define CHILD_NAME      "ethereal-capture"
  34
  35 #ifdef HAVE_LIBPCAP
  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 #ifdef _WIN32
  42     int buffer_size;        /**< the capture buffer size (MB) */
  43 #endif
  44         gboolean has_snaplen;           /**< TRUE if maximum capture packet
  45                                            length is specified */
  46         int snaplen;                    /**< Maximum captured packet length */
  47         gboolean promisc_mode;  /**< Capture in promiscuous mode */
  48         int linktype;                   /**< Data link type to use, or -1 for
  49                                            "use default" */
  50         gboolean capture_child; /**< True if this is the child for "-S" */
  51     gchar    *save_file;    /**< File the capture was saved in */
  52     int      save_file_fd;  /**< File descriptor for saved file */
  53
  54     /* GUI related */
  55         gboolean sync_mode;                     /**< Fork a child to do the capture,
  56                                            and sync between them */
  57     gboolean show_info;     /**< show the info dialog */
  58     gboolean quit_after_cap;    /** Makes a "capture only mode". Implies -k */
  59
  60     /* multiple files (and ringbuffer) */
  61     gboolean multi_files_on;    /**< TRUE if ring buffer in use */
  62
  63         gboolean has_file_duration;     /**< TRUE if ring duration specified */
  64         gint32 file_duration;     /* Switch file after n seconds */
  65         gboolean has_ring_num_files;/**< TRUE if ring num_files specified */
  66         guint32 ring_num_files;         /**< Number of multiple buffer files */
  67
  68     /* autostop conditions */
  69     gboolean has_autostop_files;/**< TRUE if maximum number of capture files
  70                                            are specified */
  71     gint32 autostop_files;      /**< Maximum number of capture files */
  72
  73     gboolean has_autostop_packets;      /**< TRUE if maximum packet count is
  74                                            specified */
  75         int autostop_packets;           /**< Maximum packet count */
  76         gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
  77                                            is specified */
  78         gint32 autostop_filesize;       /**< Maximum capture file size */
  79         gboolean has_autostop_duration; /**< TRUE if maximum capture duration
  80                                            is specified */
  81         gint32 autostop_duration;       /**< Maximum capture duration */
  82
  83     /* internally used (don't touch from outside) */
  84     int fork_child;                 /**< If not -1, in parent, process ID of child */
  85 } capture_options;
  86
  87
  88 /**
  89  * Open a specified file, or create a temporary file, and start a capture
  90  * to the file in question.
  91  *
  92  * @param capture_opts the numerous capture options
  93  * @param save_file the name of the capture file, or NULL for a temporary file
  94  * @return TRUE if the capture starts successfully, FALSE otherwise.
  95  */
  96 extern gboolean do_capture(capture_options *capture_opts, const char *save_file);
  97
  98 /** Do the low-level work of a capture (start the capture child). */
  99 extern int  capture_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
 100
 101 /** Stop a capture (usually from a menu item). */
 102 extern void capture_stop(capture_options *capture_opts);
 103
 104 /** Terminate the capture child cleanly when exiting. */
 105 extern void capture_kill_child(capture_options *capture_opts);
 106
 107 /** Do the low-level work of a capture. */
 108 extern int  capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats);
 109
 110 /** Stop a low-level capture. */
 111 extern void capture_loop_stop(void);
 112
 113
 114
 115 /** Current Capture info. */
 116 typedef struct {
 117     /* handles */
 118     gpointer        callback_data;  /**< capture callback handle */
 119     gpointer        ui;             /**< user interfaces own handle */
 120
 121     /* capture info */
 122     packet_counts   *counts;        /**< protocol specific counters */
 123     time_t          running_time;   /**< running time since last update */
 124     gint            new_packets;    /**< packets since last update */
 125 } capture_info;
 126
 127
 128 /** Create the capture info dialog */
 129 extern void capture_info_create(
 130 capture_info    *cinfo,
 131 gchar           *iface);
 132
 133 /** Update the capture info counters in the dialog */
 134 extern void capture_info_update(
 135 capture_info    *cinfo);
 136
 137 /** Destroy the capture info dialog again */
 138 extern void capture_info_destroy(
 139 capture_info    *cinfo);
 140
 141
 142 #endif /* HAVE_LIBPCAP */
 143
 144 #endif /* capture.h */