changed the loglevel of "capture kill" from message to info (it's no action that...
[obnox/wireshark/wip.git] / capture.c
1 /* capture.c
2  * Routines for packet capture
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 #ifdef HAVE_UNISTD_H
32 #include <unistd.h>
33 #endif
34
35 #include <stdlib.h>
36 #include <string.h>
37 #include <ctype.h>
38
39 #ifdef HAVE_FCNTL_H
40 #include <fcntl.h>
41 #endif
42
43 #ifdef HAVE_IO_H
44 # include <io.h>
45 #endif
46
47 #include <signal.h>
48 #include <errno.h>
49
50 #include <pcap.h>
51
52 #include <glib.h>
53
54 #include <epan/packet.h>
55 #include <epan/dfilter/dfilter.h>
56 #include "file.h"
57 #include "capture.h"
58 #include "capture_sync.h"
59 #include "capture_ui_utils.h"
60 #include "util.h"
61 #include "pcap-util.h"
62 #include "alert_box.h"
63 #include "simple_dialog.h"
64 #include <epan/prefs.h>
65 #include "conditions.h"
66 #include "ringbuffer.h"
67
68 #ifdef _WIN32
69 #include "capture-wpcap.h"
70 #endif
71 #include "ui_util.h"
72 #include "log.h"
73
74
75
76 /** 
77  * Start a capture.
78  *
79  * @return TRUE if the capture starts successfully, FALSE otherwise.
80  */
81 gboolean
82 capture_start(capture_options *capture_opts)
83 {
84   gboolean ret;
85
86
87   /* close the currently loaded capture file */
88   cf_close(capture_opts->cf);
89
90   g_assert(capture_opts->state == CAPTURE_STOPPED);
91   capture_opts->state = CAPTURE_PREPARING;
92
93   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Start ...");
94
95   /* try to start the capture child process */
96   ret = sync_pipe_start(capture_opts);
97   if(!ret) {
98       if(capture_opts->save_file != NULL) {
99           g_free(capture_opts->save_file);
100           capture_opts->save_file = NULL;
101       }
102
103       capture_opts->state = CAPTURE_STOPPED;
104   } else {
105       /* the capture child might not respond shortly after bringing it up */
106       /* (especially it will block, if no input coming from an input capture pipe (e.g. mkfifo) is coming in) */
107
108       /* to prevent problems, bring the main GUI into "capture mode" right after successfully */
109       /* spawn/exec the capture child, without waiting for any response from it */
110       cf_callback_invoke(cf_cb_live_capture_prepared, capture_opts);
111   }
112
113   return ret;
114 }
115
116
117 void
118 capture_stop(capture_options *capture_opts)
119 {
120   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Stop ...");
121
122   /* stop the capture child gracefully */
123   sync_pipe_stop(capture_opts);
124 }
125
126
127 void
128 capture_restart(capture_options *capture_opts)
129 {
130     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Restart");
131
132     capture_opts->restart = TRUE;
133     capture_stop(capture_opts);
134 }
135
136
137 void
138 capture_kill_child(capture_options *capture_opts)
139 {
140   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "Capture Kill");
141
142   /* kill the capture child */
143   sync_pipe_kill(capture_opts);
144 }
145
146
147
148 /* We've succeeded a (non real-time) capture, try to read it into a new capture file */
149 static gboolean
150 capture_input_read_all(capture_options *capture_opts, gboolean is_tempfile, gboolean drops_known,
151 guint32 drops)
152 {
153   int err;
154
155
156   /* Capture succeeded; attempt to open the capture file. */
157   if (cf_open(capture_opts->cf, capture_opts->save_file, is_tempfile, &err) != CF_OK) {
158     /* We're not doing a capture any more, so we don't have a save
159        file. */
160     return FALSE;
161   }
162
163   /* Set the read filter to NULL. */
164   /* XXX - this is odd here, try to put it somewhere, where it fits better */
165   cf_set_rfcode(capture_opts->cf, NULL);
166
167   /* Get the packet-drop statistics.
168
169      XXX - there are currently no packet-drop statistics stored
170      in libpcap captures, and that's what we're reading.
171
172      At some point, we will add support in Wiretap to return
173      packet-drop statistics for capture file formats that store it,
174      and will make "cf_read()" get those statistics from Wiretap.
175      We clear the statistics (marking them as "not known") in
176      "cf_open()", and "cf_read()" will only fetch them and mark
177      them as known if Wiretap supplies them, so if we get the
178      statistics now, after calling "cf_open()" but before calling
179      "cf_read()", the values we store will be used by "cf_read()".
180
181      If a future libpcap capture file format stores the statistics,
182      we'll put them into the capture file that we write, and will
183      thus not have to set them here - "cf_read()" will get them from
184      the file and use them. */
185   if (drops_known) {
186     cf_set_drops_known(capture_opts->cf, TRUE);
187
188     /* XXX - on some systems, libpcap doesn't bother filling in
189        "ps_ifdrop" - it doesn't even set it to zero - so we don't
190        bother looking at it.
191
192        Ideally, libpcap would have an interface that gave us
193        several statistics - perhaps including various interface
194        error statistics - and would tell us which of them it
195        supplies, allowing us to display only the ones it does. */
196     cf_set_drops(capture_opts->cf, drops);
197   }
198
199   /* read in the packet data */
200   switch (cf_read(capture_opts->cf)) {
201
202   case CF_READ_OK:
203   case CF_READ_ERROR:
204     /* Just because we got an error, that doesn't mean we were unable
205        to read any of the file; we handle what we could get from the
206        file. */
207     break;
208
209   case CF_READ_ABORTED:
210     /* User wants to quit program. Exit by leaving the main loop, 
211        so that any quit functions we registered get called. */
212     main_window_nested_quit();
213     return FALSE;
214   }
215
216   /* if we didn't captured even a single packet, close the file again */
217   if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
218     simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
219     "%sNo packets captured!%s\n\n"
220     "As no data was captured, closing the %scapture file!",
221     simple_dialog_primary_start(), simple_dialog_primary_end(),
222     (cf_is_tempfile(capture_opts->cf)) ? "temporary " : "");
223     cf_close(capture_opts->cf);
224   }
225   return TRUE;
226 }
227
228
229 /* capture child tells us, we have a new (or the first) capture file */
230 gboolean
231 capture_input_new_file(capture_options *capture_opts, gchar *new_file)
232 {
233   gboolean is_tempfile;
234   int  err;
235
236
237   if(capture_opts->state == CAPTURE_PREPARING) {
238     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture started!");
239   }
240   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "File: \"%s\"", new_file);
241
242   g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
243
244   /* free the old filename */
245   if(capture_opts->save_file != NULL) {
246     /* we start a new capture file, close the old one (if we had one before) */
247     if( ((capture_file *) capture_opts->cf)->state != FILE_CLOSED) {
248         cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
249         cf_finish_tail(capture_opts->cf, &err);
250         cf_close(capture_opts->cf);
251     }
252     g_free(capture_opts->save_file);
253     is_tempfile = FALSE;
254     cf_set_tempfile(capture_opts->cf, FALSE);
255   } else {
256     /* we didn't had a save_file before, must be a tempfile */
257     is_tempfile = TRUE;
258     cf_set_tempfile(capture_opts->cf, TRUE);
259   }
260
261   /* save the new filename */
262   capture_opts->save_file = g_strdup(new_file);
263
264   /* if we are in real-time mode, open the new file now */
265   if(capture_opts->real_time_mode) {
266     /* Attempt to open the capture file and set up to read from it. */
267        switch(cf_start_tail(capture_opts->cf, capture_opts->save_file, is_tempfile, &err)) {
268     case CF_OK:
269       break;
270     case CF_ERROR:
271       /* Don't unlink (delete) the save file - leave it around, 
272          for debugging purposes. */
273       g_free(capture_opts->save_file);
274       capture_opts->save_file = NULL;
275       return FALSE;
276       break;
277     }
278
279     cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
280   } else {
281     cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
282   }
283
284   capture_opts->state = CAPTURE_RUNNING;
285
286   return TRUE;
287 }
288
289     
290 /* capture child tells us, we have new packets to read */
291 void
292 capture_input_new_packets(capture_options *capture_opts, int to_read)
293 {
294   int  err;
295
296
297   g_assert(capture_opts->save_file);
298
299   if(capture_opts->real_time_mode) {
300     /* Read from the capture file the number of records the child told us
301        it added.
302        XXX - do something if this fails? */
303     switch (cf_continue_tail(capture_opts->cf, to_read, &err)) {
304
305     case CF_READ_OK:
306     case CF_READ_ERROR:
307       /* Just because we got an error, that doesn't mean we were unable
308          to read any of the file; we handle what we could get from the
309          file.
310
311          XXX - abort on a read error? */
312          cf_callback_invoke(cf_cb_live_capture_update_continue, capture_opts->cf);
313          main_window_update();
314       break;
315
316     case CF_READ_ABORTED:
317       /* Kill the child capture process; the user wants to exit, and we
318          shouldn't just leave it running. */
319       capture_kill_child(capture_opts);
320       break;
321     }
322   }
323 }
324
325
326 /* capture child closed it's side ot the pipe, do the required cleanup */
327 void
328 capture_input_closed(capture_options *capture_opts)
329 {
330     int  err;
331
332
333     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture stopped!");
334     g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
335
336     /* if we didn't started the capture (happens if an error occured), do a fake start */
337     if(capture_opts->state == CAPTURE_PREPARING) {
338         if(capture_opts->real_time_mode) {
339             cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
340         } else {
341             cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
342         }
343     }
344
345     if(capture_opts->real_time_mode) {
346         /* first of all, we are not doing a capture any more */
347         cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
348
349         /* Read what remains of the capture file, and finish the capture.
350            XXX - do something if this fails? */
351         switch (cf_finish_tail(capture_opts->cf, &err)) {
352
353         case CF_READ_OK:
354             if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
355               simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
356               "%sNo packets captured!%s\n\n"
357               "As no data was captured, closing the %scapture file!",
358               simple_dialog_primary_start(), simple_dialog_primary_end(),
359               cf_is_tempfile(capture_opts->cf) ? "temporary " : "");
360               cf_close(capture_opts->cf);
361             }
362             break;
363         case CF_READ_ERROR:
364           /* Just because we got an error, that doesn't mean we were unable
365              to read any of the file; we handle what we could get from the
366              file. */
367           break;
368
369         case CF_READ_ABORTED:
370           /* Exit by leaving the main loop, so that any quit functions
371              we registered get called. */
372           main_window_quit();
373         }
374
375     } else {
376         /* first of all, we are not doing a capture any more */
377         cf_callback_invoke(cf_cb_live_capture_fixed_finished, capture_opts->cf);
378
379         /* this is a normal mode capture and if no error happened, read in the capture file data */
380         if(capture_opts->save_file != NULL) {
381             capture_input_read_all(capture_opts, cf_is_tempfile(capture_opts->cf), 
382                 cf_get_drops_known(capture_opts->cf), cf_get_drops(capture_opts->cf));
383         }
384     }
385
386     capture_opts->state = CAPTURE_STOPPED;
387
388     /* if we couldn't open a capture file, there's nothing more for us to do */
389     if(capture_opts->save_file == NULL) {
390         cf_close(capture_opts->cf);
391         return;
392     }
393
394     /* does the user wants to restart the current capture? */
395     if(capture_opts->restart) {
396         capture_opts->restart = FALSE;
397
398         unlink(capture_opts->save_file);
399
400         /* if it was a tempfile, throw away the old filename (so it will become a tempfile again) */
401         if(cf_is_tempfile(capture_opts->cf)) {
402             g_free(capture_opts->save_file);
403             capture_opts->save_file = NULL;
404         }
405
406         /* ... and start the capture again */
407         capture_start(capture_opts);
408     } else {
409         /* We're not doing a capture any more, so we don't have a save file. */
410         g_free(capture_opts->save_file);
411         capture_opts->save_file = NULL;
412     }
413 }
414
415
416 #endif /* HAVE_LIBPCAP */