some cleanup of the initial start sequence of Ethereal, filling in capture_opts and...
[obnox/wireshark/wip.git] / capture.c
1 /* capture.c
2  * Routines 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 /* With MSVC and a libethereal.dll this file needs to import some variables 
26    in a special way. Therefore _NEED_VAR_IMPORT_ is defined. */
27 #define _NEED_VAR_IMPORT_
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #ifdef HAVE_LIBPCAP
34
35 #include <stdlib.h>
36 #include <string.h>
37
38 #ifdef HAVE_FCNTL_H
39 #include <fcntl.h>
40 #endif
41
42 #ifdef HAVE_IO_H
43 # include <io.h>
44 #endif
45
46 #include <signal.h>
47 #include <errno.h>
48
49 #include <pcap.h>
50
51 #include <glib.h>
52
53 #include <epan/packet.h>
54 #include <epan/dfilter/dfilter.h>
55 #include "file.h"
56 #include "capture.h"
57 #include "capture_sync.h"
58 #include "capture_ui_utils.h"
59 #include "util.h"
60 #include "pcap-util.h"
61 #include "alert_box.h"
62 #include "simple_dialog.h"
63 #include <epan/prefs.h>
64 #include "conditions.h"
65 #include "ringbuffer.h"
66
67 #ifdef _WIN32
68 #include "capture-wpcap.h"
69 #endif
70 #include "ui_util.h"
71
72
73 /* Win32 needs the O_BINARY flag for open() */
74 #ifndef O_BINARY
75 #define O_BINARY        0
76 #endif
77
78 static gboolean normal_do_capture(capture_options *capture_opts, gboolean is_tempfile);
79 static void stop_capture_signal_handler(int signo);
80
81
82 void
83 capture_opts_init(capture_options *capture_opts, void *cfile)
84 {
85   capture_opts->cf                      = cfile;
86 #ifdef _WIN32
87   capture_opts->buffer_size             = 1;                /* 1 MB */
88 #endif
89   capture_opts->has_snaplen             = FALSE;
90   capture_opts->snaplen                 = MIN_PACKET_SIZE;
91   capture_opts->promisc_mode            = TRUE;
92   capture_opts->linktype                = -1;               /* the default linktype */
93   capture_opts->capture_child           = FALSE;
94   capture_opts->save_file               = NULL;
95   capture_opts->save_file_fd            = -1;
96   capture_opts->sync_mode               = TRUE;
97   capture_opts->show_info               = TRUE;
98   capture_opts->quit_after_cap          = FALSE;
99
100   capture_opts->multi_files_on          = FALSE;
101   capture_opts->has_file_duration       = FALSE;
102   capture_opts->file_duration           = 60;               /* 1 min */
103   capture_opts->has_ring_num_files      = TRUE;
104   capture_opts->ring_num_files          = 2;
105
106   capture_opts->has_autostop_files      = FALSE;
107   capture_opts->autostop_files          = 1;
108   capture_opts->has_autostop_packets    = FALSE;
109   capture_opts->autostop_packets        = 1;
110   capture_opts->has_autostop_filesize   = FALSE;
111   capture_opts->autostop_filesize       = 1024 * 1024;      /* 1 MB */
112   capture_opts->has_autostop_duration   = FALSE;
113   capture_opts->autostop_duration       = 60;               /* 1 min */
114 }
115
116
117 /* open the output file (temporary/specified name/ringbuffer) and close the old one */
118 /* Returns TRUE if the file opened successfully, FALSE otherwise. */
119 static gboolean
120 capture_open_output(capture_options *capture_opts, const char *save_file, gboolean *is_tempfile) {
121   char tmpname[128+1];
122   gchar *capfile_name;
123
124
125   if (save_file != NULL) {
126     /* If the Sync option is set, we return to the caller while the capture
127      * is in progress.  Therefore we need to take a copy of save_file in
128      * case the caller destroys it after we return.
129      */
130     capfile_name = g_strdup(save_file);
131     if (capture_opts->multi_files_on) {
132       /* ringbuffer is enabled */
133       capture_opts->save_file_fd = ringbuf_init(capfile_name,
134           (capture_opts->has_ring_num_files) ? capture_opts->ring_num_files : 0);
135     } else {
136       /* Try to open/create the specified file for use as a capture buffer. */
137       capture_opts->save_file_fd = open(capfile_name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
138                                 0600);
139     }
140     *is_tempfile = FALSE;
141   } else {
142     /* Choose a random name for the temporary capture buffer */
143     capture_opts->save_file_fd = create_tempfile(tmpname, sizeof tmpname, "ether");
144     capfile_name = g_strdup(tmpname);
145     *is_tempfile = TRUE;
146   }
147
148   /* did we fail to open the output file? */
149   if (capture_opts->save_file_fd == -1) {
150     if (is_tempfile) {
151       simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK,
152         "The temporary file to which the capture would be saved (\"%s\")"
153         "could not be opened: %s.", capfile_name, strerror(errno));
154     } else {
155       if (capture_opts->multi_files_on) {
156         ringbuf_error_cleanup();
157       }
158       open_failure_alert_box(capfile_name, errno, TRUE);
159     }
160     g_free(capfile_name);
161     return FALSE;
162   }
163
164   /* close the old file */
165   cf_close(capture_opts->cf);
166   g_assert(capture_opts->save_file == NULL);
167   capture_opts->save_file = capfile_name;
168   /* capture_opts.save_file is "g_free"ed later, which is equivalent to
169      "g_free(capfile_name)". */
170
171   return TRUE;
172 }
173
174
175 /* Open a specified file, or create a temporary file, and start a capture
176    to the file in question.  */
177 /* Returns TRUE if the capture starts successfully, FALSE otherwise. */
178 gboolean
179 do_capture(capture_options *capture_opts, const char *save_file)
180 {
181   gboolean is_tempfile;
182   gboolean ret;
183   gchar *title;
184
185   /* open the output file (temporary/specified name/ringbuffer) and close the old one */
186   if(!capture_open_output(capture_opts, save_file, &is_tempfile)) {
187     return FALSE;
188   }
189
190   title = g_strdup_printf("%s: Capturing - Ethereal",
191                           get_interface_descriptive_name(cf_get_iface(capture_opts->cf)));
192   if (capture_opts->sync_mode) {        
193     /* sync mode: do the capture in a child process */
194     ret = sync_pipe_do_capture(capture_opts, is_tempfile);
195     /* capture is still running */
196     set_main_window_name(title);
197   } else {
198     /* normal mode: do the capture synchronously */
199     set_main_window_name(title);
200     ret = normal_do_capture(capture_opts, is_tempfile);
201     /* capture is finished here */
202   }
203   g_free(title);
204
205   return ret;
206 }
207
208
209 /* start a normal capture session */
210 static gboolean
211 normal_do_capture(capture_options *capture_opts, gboolean is_tempfile)
212 {
213     int capture_succeeded;
214     gboolean stats_known;
215     struct pcap_stat stats;
216     int err;
217
218     /* Not sync mode. */
219     capture_succeeded = capture_start(capture_opts, &stats_known, &stats);
220     if (capture_opts->quit_after_cap) {
221       /* DON'T unlink the save file.  Presumably someone wants it. */
222         main_window_exit();
223     }
224     if (!capture_succeeded) {
225       /* We didn't succeed in doing the capture, so we don't have a save
226          file. */
227       if (capture_opts->multi_files_on) {
228         ringbuf_free();
229       } else {
230         g_free(capture_opts->save_file);
231       }
232       capture_opts->save_file = NULL;
233       return FALSE;
234     }
235     /* Capture succeeded; attempt to read in the capture file. */
236     if (cf_open(capture_opts->cf, capture_opts->save_file, is_tempfile, &err) != CF_OK) {
237       /* We're not doing a capture any more, so we don't have a save
238          file. */
239       if (capture_opts->multi_files_on) {
240         ringbuf_free();
241       } else {
242         g_free(capture_opts->save_file);
243       }
244       capture_opts->save_file = NULL;
245       return FALSE;
246     }
247
248     /* Set the read filter to NULL. */
249     cf_set_rfcode(capture_opts->cf, NULL);
250
251     /* Get the packet-drop statistics.
252
253        XXX - there are currently no packet-drop statistics stored
254        in libpcap captures, and that's what we're reading.
255
256        At some point, we will add support in Wiretap to return
257        packet-drop statistics for capture file formats that store it,
258        and will make "cf_read()" get those statistics from Wiretap.
259        We clear the statistics (marking them as "not known") in
260        "cf_open()", and "cf_read()" will only fetch them and mark
261        them as known if Wiretap supplies them, so if we get the
262        statistics now, after calling "cf_open()" but before calling
263        "cf_read()", the values we store will be used by "cf_read()".
264
265        If a future libpcap capture file format stores the statistics,
266        we'll put them into the capture file that we write, and will
267        thus not have to set them here - "cf_read()" will get them from
268        the file and use them. */
269     if (stats_known) {
270       cf_set_drops_known(capture_opts->cf, TRUE);
271
272       /* XXX - on some systems, libpcap doesn't bother filling in
273          "ps_ifdrop" - it doesn't even set it to zero - so we don't
274          bother looking at it.
275
276          Ideally, libpcap would have an interface that gave us
277          several statistics - perhaps including various interface
278          error statistics - and would tell us which of them it
279          supplies, allowing us to display only the ones it does. */
280       cf_set_drops(capture_opts->cf, stats.ps_drop);
281     }
282     switch (cf_read(capture_opts->cf)) {
283
284     case CF_READ_OK:
285     case CF_READ_ERROR:
286       /* Just because we got an error, that doesn't mean we were unable
287          to read any of the file; we handle what we could get from the
288          file. */
289       break;
290
291     case CF_READ_ABORTED:
292       /* Exit by leaving the main loop, so that any quit functions
293          we registered get called. */
294       main_window_nested_quit();
295       return FALSE;
296     }
297
298     /* We're not doing a capture any more, so we don't have a save
299        file. */
300     if (capture_opts->multi_files_on) {
301       ringbuf_free();
302     } else {
303       g_free(capture_opts->save_file);
304     }
305     capture_opts->save_file = NULL;
306
307     /* if we didn't captured even a single packet, close the file again */
308     if(cf_packet_count(capture_opts->cf) == 0) {
309       simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
310       "%sNo packets captured!%s\n\n"
311       "As no data was captured, closing the %scapture file!",
312       simple_dialog_primary_start(), simple_dialog_primary_end(),
313       (cf_is_tempfile(capture_opts->cf)) ? "temporary " : "");
314       cf_close(capture_opts->cf);
315     }
316   return TRUE;
317 }
318
319
320 static void
321 stop_capture_signal_handler(int signo _U_)
322 {
323   capture_loop_stop();
324 }
325
326
327 int  
328 capture_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats)
329 {
330 #ifndef _WIN32
331   /*
332    * Catch SIGUSR1, so that we exit cleanly if the parent process
333    * kills us with it due to the user selecting "Capture->Stop".
334    */
335   if (capture_opts->capture_child)
336     signal(SIGUSR1, stop_capture_signal_handler);
337 #endif
338
339   return capture_loop_start(capture_opts, stats_known, stats);
340 }
341
342 void
343 capture_stop(capture_options *capture_opts)
344 {
345
346   if (capture_opts->sync_mode) {        
347     sync_pipe_stop(capture_opts);
348   }
349     
350   capture_loop_stop();
351 }
352
353 void
354 capture_kill_child(capture_options *capture_opts)
355 {
356   if (capture_opts->sync_mode) {        
357     sync_pipe_kill(capture_opts);
358   }
359 }
360
361
362 #endif /* HAVE_LIBPCAP */