Make the frame_data_sequence structure opaque, and move some other
[obnox/wireshark/wip.git] / 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 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>     /* for gid_t */
37 #endif
38
39 #include "capture_ifinfo.h"
40
41 /* Current state of capture engine. XXX - differentiate states */
42 typedef enum {
43     CAPTURE_STOPPED,        /**< stopped */
44     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
45     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
46 } capture_state;
47
48 #ifdef HAVE_PCAP_REMOTE
49 /* Type of capture source */
50 typedef enum {
51     CAPTURE_IFLOCAL,        /**< Local network interface */
52     CAPTURE_IFREMOTE        /**< Remote network interface */
53 } capture_source;
54
55 /* Type of RPCAPD Authentication */
56 typedef enum {
57     CAPTURE_AUTH_NULL,      /**< No authentication */
58     CAPTURE_AUTH_PWD        /**< User/password authentication */
59 } capture_auth;
60 #endif
61 #ifdef HAVE_PCAP_SETSAMPLING
62 /**
63  * Method of packet sampling (dropping some captured packets),
64  * may require additional integer parameter, marked here as N
65  */
66 typedef enum {
67     CAPTURE_SAMP_NONE,      /**< No sampling - capture all packets */
68     CAPTURE_SAMP_BY_COUNT,  /**< Counter-based sampling -
69                                  capture 1 packet from every N */
70     CAPTURE_SAMP_BY_TIMER   /**< Timer-based sampling -
71                                  capture no more than 1 packet
72                                  in N milliseconds */
73 } capture_sampling;
74 #endif
75
76 /** Capture options coming from user interface */
77 typedef struct capture_options_tag {
78     /* general */
79     void     *cf;                   /**< handle to cfile (note: untyped handle) */
80     gboolean has_cfilter;           /**< TRUE if capture filter specified on command line */
81     gchar    *cfilter;              /**< Capture filter string */
82     gchar    *iface;                /**< the network interface to capture from */
83     gchar    *iface_descr;          /**< A human readable description of iface.
84                                       *< NOTE: capture_opts.c is not able to
85                                       *< set this field because doing so
86                                       *< requires too many dependencies.
87                                       *< Readers of this field should use
88                                       *< get_iface_description() from
89                                       *< "capture_ui_utils.h" to access it. */
90 #ifdef HAVE_PCAP_REMOTE
91     capture_source src_type;        /**< Capturing on remote interface */
92     gchar    *remote_host;          /**< Host name or network address
93                                       *< for remote capturing */
94     gchar    *remote_port;          /**< TCP port of remote RPCAP server */
95
96     capture_auth  auth_type;
97     gchar    *auth_username;
98     gchar    *auth_password;        /**< Remote authentication parameters */
99
100     gboolean datatx_udp;            /**< Whether to use UDP for data transfer */
101     gboolean nocap_rpcap;           /**< Whether to capture RPCAP own traffic */
102     gboolean nocap_local;           /**< TODO: Whether to capture local traffic */
103 #endif
104 #ifdef HAVE_PCAP_SETSAMPLING
105     capture_sampling sampling_method; /**< PCAP packet sampling method */
106     int sampling_param;             /**< PCAP packet sampling parameter */
107 #endif
108 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
109     int      buffer_size;           /**< the capture buffer size (MB) */
110 #endif
111     gboolean has_snaplen;           /**< TRUE if maximum capture packet length
112                                          is specified */
113     int      snaplen;               /**< Maximum captured packet length */
114     gboolean promisc_mode;          /**< Capture in promiscuous mode */
115     int      linktype;              /**< Data link type to use, or -1 for
116                                          "use default" */
117     gboolean monitor_mode;          /**< Capture in monitor mode, if available */
118     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
119     gchar    *save_file;            /**< the capture file name */
120     gboolean group_read_access;     /**< TRUE is group read permission needs to be set */
121     gboolean use_pcapng;            /**< TRUE if file format is pcapng */
122
123     /* GUI related */
124     gboolean real_time_mode;        /**< Update list of packets in real time */
125     gboolean show_info;             /**< show the info dialog */
126     gboolean quit_after_cap;        /**< Makes a "capture only mode". Implies -k */
127     gboolean restart;               /**< restart after closing is done */
128
129     /* multiple files (and ringbuffer) */
130     gboolean multi_files_on;        /**< TRUE if ring buffer in use */
131
132     gboolean has_file_duration;     /**< TRUE if ring duration specified */
133     gint32 file_duration;           /**< Switch file after n seconds */
134     gboolean has_ring_num_files;    /**< TRUE if ring num_files specified */
135     guint32 ring_num_files;         /**< Number of multiple buffer files */
136
137     /* autostop conditions */
138     gboolean has_autostop_files;    /**< TRUE if maximum number of capture files
139                                          are specified */
140     gint32 autostop_files;          /**< Maximum number of capture files */
141
142     gboolean has_autostop_packets;  /**< TRUE if maximum packet count is
143                                          specified */
144     int autostop_packets;           /**< Maximum packet count */
145     gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
146                                          is specified */
147     gint32 autostop_filesize;       /**< Maximum capture file size */
148     gboolean has_autostop_duration; /**< TRUE if maximum capture duration
149                                          is specified */
150     gint32 autostop_duration;       /**< Maximum capture duration */
151
152     /* internally used (don't touch from outside) */
153     int fork_child;                 /**< If not -1, in parent, process ID of child */
154     int fork_child_status;          /**< Child exit status */
155 #ifdef _WIN32
156     int signal_pipe_write_fd;       /**< the pipe to signal the child */
157 #endif
158     capture_state state;            /**< current state of the capture engine */
159     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
160 #ifndef _WIN32
161     uid_t owner;                    /**< owner of the cfile */
162     gid_t group;                    /**< group of the cfile */
163 #endif
164 } capture_options;
165
166 /* initialize the capture_options with some reasonable values */
167 extern void
168 capture_opts_init(capture_options *capture_opts, void *cf);
169
170 /* set a command line option value */
171 extern int
172 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
173
174 /* log content of capture_opts */
175 extern void
176 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
177
178 /* print interface capabilities, including link layer types */
179 extern void
180 capture_opts_print_if_capabilities(if_capabilities_t *caps,
181                                    gboolean monitor_mode);
182
183 /* print list of interfaces */
184 extern void
185 capture_opts_print_interfaces(GList *if_list);
186
187 /* trim the snaplen entry */
188 extern void
189 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
190
191 /* trim the ring_num_files entry */
192 extern void
193 capture_opts_trim_ring_num_files(capture_options *capture_opts);
194
195 /* trim the interface entry */
196 extern gboolean
197 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
198
199 #endif /* capture_opts.h */