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