White space changes.
[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 #ifdef __cplusplus
42 extern "C" {
43 #endif /* __cplusplus */
44
45 /* Current state of capture engine. XXX - differentiate states */
46 typedef enum {
47     CAPTURE_STOPPED,        /**< stopped */
48     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
49     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
50 } capture_state;
51
52 #ifdef HAVE_PCAP_REMOTE
53 /* Type of capture source */
54 typedef enum {
55     CAPTURE_IFLOCAL,        /**< Local network interface */
56     CAPTURE_IFREMOTE        /**< Remote network interface */
57 } capture_source;
58
59 /* Type of RPCAPD Authentication */
60 typedef enum {
61     CAPTURE_AUTH_NULL,      /**< No authentication */
62     CAPTURE_AUTH_PWD        /**< User/password authentication */
63 } capture_auth;
64 #endif
65 #ifdef HAVE_PCAP_SETSAMPLING
66 /**
67  * Method of packet sampling (dropping some captured packets),
68  * may require additional integer parameter, marked here as N
69  */
70 typedef enum {
71     CAPTURE_SAMP_NONE,      /**< No sampling - capture all packets */
72     CAPTURE_SAMP_BY_COUNT,  /**< Counter-based sampling -
73                                  capture 1 packet from every N */
74     CAPTURE_SAMP_BY_TIMER   /**< Timer-based sampling -
75                                  capture no more than 1 packet
76                                  in N milliseconds */
77 } capture_sampling;
78 #endif
79
80 typedef enum {
81     IF_WIRED,
82     IF_AIRPCAP,
83     IF_PIPE,
84     IF_STDIN,
85     IF_BLUETOOTH,
86     IF_WIRELESS,
87     IF_DIALUP,
88     IF_USB,
89     IF_VIRTUAL
90 } interface_type;
91
92 #ifdef HAVE_PCAP_REMOTE
93 struct remote_host_info {
94     gchar *remote_host;          /**< Host name or network address for remote capturing */
95     gchar *remote_port;          /**< TCP port of remote RPCAP server */
96     gint auth_type;              /**< Authentication type */
97     gchar *auth_username;        /**< Remote authentication parameters */
98     gchar *auth_password;        /**< Remote authentication parameters */
99     gboolean datatx_udp;
100     gboolean nocap_rpcap;
101     gboolean nocap_local;
102 };
103
104 typedef struct remote_options_tag {
105     capture_source src_type;
106     struct remote_host_info remote_host_opts;
107 #ifdef HAVE_PCAP_SETSAMPLING
108     capture_sampling sampling_method;
109     int sampling_param;
110 #endif
111 } remote_options;
112 #endif /* HAVE_PCAP_REMOTE */
113
114 typedef struct interface_tag {
115     gchar *name;
116     gchar *display_name;
117     guint type;
118     gchar *addresses;
119     gint no_addresses;
120     gchar *cfilter;
121     GList *links;
122     gint active_dlt;
123     gboolean pmode;
124     gboolean has_snaplen;
125     guint snaplen;
126     gboolean local;
127 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
128     gint buffer;
129 #endif
130 #ifdef HAVE_PCAP_CREATE
131     gboolean monitor_mode_enabled;
132     gboolean monitor_mode_supported;
133 #endif
134 #ifdef HAVE_PCAP_REMOTE
135     remote_options remote_opts;
136 #endif
137     guint32     last_packets;
138     if_info_t   if_info;
139     gboolean    selected;
140     gboolean    hidden;
141     gboolean    locked;
142 } interface_t;
143
144 typedef struct link_row_tag {
145     gchar *name;
146     gint dlt;
147 } link_row;
148
149 typedef struct interface_options_tag {
150     gchar *name;
151     gchar *descr;
152     gchar *cfilter;
153     gboolean has_snaplen;
154     int snaplen;
155     int linktype;
156     gboolean promisc_mode;
157 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
158     int buffer_size;
159 #endif
160     gboolean monitor_mode;
161 #ifdef HAVE_PCAP_REMOTE
162     capture_source src_type;
163     gchar *remote_host;
164     gchar *remote_port;
165     capture_auth auth_type;
166     gchar *auth_username;
167     gchar *auth_password;
168     gboolean datatx_udp;
169     gboolean nocap_rpcap;
170     gboolean nocap_local;
171 #endif
172 #ifdef HAVE_PCAP_SETSAMPLING
173     capture_sampling sampling_method;
174     int sampling_param;
175 #endif
176 } interface_options;
177
178 /** Capture options coming from user interface */
179 typedef struct capture_options_tag {
180     /* general */
181     void     *cf;                   /**< handle to cfile (note: untyped handle) */
182     GArray   *ifaces;               /**< array of interfaces.
183                                          Currently only used by dumpcap. */
184     GArray   *all_ifaces;
185     guint    num_selected;
186     interface_options default_options;
187     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
188     gchar    *save_file;            /**< the capture file name */
189     gboolean group_read_access;     /**< TRUE is group read permission needs to be set */
190     gboolean use_pcapng;            /**< TRUE if file format is pcapng */
191
192     /* GUI related */
193     gboolean real_time_mode;        /**< Update list of packets in real time */
194     gboolean show_info;             /**< show the info dialog */
195     gboolean quit_after_cap;        /**< Makes a "capture only mode". Implies -k */
196     gboolean restart;               /**< restart after closing is done */
197
198     /* multiple files (and ringbuffer) */
199     gboolean multi_files_on;        /**< TRUE if ring buffer in use */
200
201     gboolean has_file_duration;     /**< TRUE if ring duration specified */
202     gint32 file_duration;           /**< Switch file after n seconds */
203     gboolean has_ring_num_files;    /**< TRUE if ring num_files specified */
204     guint32 ring_num_files;         /**< Number of multiple buffer files */
205
206     /* autostop conditions */
207     gboolean has_autostop_files;    /**< TRUE if maximum number of capture files
208                                          are specified */
209     gint32 autostop_files;          /**< Maximum number of capture files */
210
211     gboolean has_autostop_packets;  /**< TRUE if maximum packet count is
212                                          specified */
213     int autostop_packets;           /**< Maximum packet count */
214     gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
215                                          is specified */
216     gint32 autostop_filesize;       /**< Maximum capture file size */
217     gboolean has_autostop_duration; /**< TRUE if maximum capture duration
218                                          is specified */
219     gint32 autostop_duration;       /**< Maximum capture duration */
220
221     /* internally used (don't touch from outside) */
222     int fork_child;                 /**< If not -1, in parent, process ID of child */
223     int fork_child_status;          /**< Child exit status */
224 #ifdef _WIN32
225     int signal_pipe_write_fd;       /**< the pipe to signal the child */
226 #endif
227     capture_state state;            /**< current state of the capture engine */
228     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
229 #ifndef _WIN32
230     uid_t owner;                    /**< owner of the cfile */
231     gid_t group;                    /**< group of the cfile */
232 #endif
233 } capture_options;
234
235 /* initialize the capture_options with some reasonable values */
236 extern void
237 capture_opts_init(capture_options *capture_opts, void *cf);
238
239 /* set a command line option value */
240 extern int
241 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
242
243 extern int
244 capture_opts_add_iface_opt(capture_options *capture_opts, const char *optarg_str_p);
245
246 /* log content of capture_opts */
247 extern void
248 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
249
250 /* print interface capabilities, including link layer types */
251 extern void
252 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
253                                    gboolean monitor_mode);
254
255 /* print list of interfaces */
256 extern void
257 capture_opts_print_interfaces(GList *if_list);
258
259 /* trim the snaplen entry */
260 extern void
261 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
262
263 /* trim the ring_num_files entry */
264 extern void
265 capture_opts_trim_ring_num_files(capture_options *capture_opts);
266
267 /* trim the interface entry */
268 extern gboolean
269 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
270
271 extern void
272 collect_ifaces(capture_options *capture_opts);
273
274 typedef struct {
275     gboolean monitor_mode;
276     int linktype;
277 } cap_settings_t;
278
279 /** Get capture settings for interface
280  *
281  * @param if_name interface name
282  */
283 cap_settings_t
284 capture_get_cap_settings (gchar *if_name);
285
286 extern void 
287 scan_local_interfaces(capture_options* capture_opts, int *error);
288
289 #ifdef __cplusplus
290 }
291 #endif /* __cplusplus */
292
293 #endif /* capture_opts.h */