clarify a comment
[metze/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 #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 #include "file_util.h"
69 #include "log.h"
70
71
72
73 /** 
74  * Start a capture.
75  *
76  * @return TRUE if the capture starts successfully, FALSE otherwise.
77  */
78 gboolean
79 capture_start(capture_options *capture_opts)
80 {
81   gboolean ret;
82
83
84   /* close the currently loaded capture file */
85   cf_close(capture_opts->cf);
86
87   g_assert(capture_opts->state == CAPTURE_STOPPED);
88   capture_opts->state = CAPTURE_PREPARING;
89
90   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Start ...");
91
92   /* try to start the capture child process */
93   ret = sync_pipe_start(capture_opts);
94   if(!ret) {
95       if(capture_opts->save_file != NULL) {
96           g_free(capture_opts->save_file);
97           capture_opts->save_file = NULL;
98       }
99
100       capture_opts->state = CAPTURE_STOPPED;
101   } else {
102       /* the capture child might not respond shortly after bringing it up */
103       /* (especially it will block, if no input coming from an input capture pipe (e.g. mkfifo) is coming in) */
104
105       /* to prevent problems, bring the main GUI into "capture mode" right after successfully */
106       /* spawn/exec the capture child, without waiting for any response from it */
107       cf_callback_invoke(cf_cb_live_capture_prepared, capture_opts);
108   }
109
110   return ret;
111 }
112
113
114 void
115 capture_stop(capture_options *capture_opts)
116 {
117   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Stop ...");
118
119   cf_callback_invoke(cf_cb_live_capture_stopping, capture_opts);
120
121   /* stop the capture child gracefully */
122   sync_pipe_stop(capture_opts);
123 }
124
125
126 void
127 capture_restart(capture_options *capture_opts)
128 {
129     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Restart");
130
131     capture_opts->restart = TRUE;
132     capture_stop(capture_opts);
133 }
134
135
136 void
137 capture_kill_child(capture_options *capture_opts)
138 {
139   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "Capture Kill");
140
141   /* kill the capture child */
142   sync_pipe_kill(capture_opts);
143 }
144
145
146
147 /* We've succeeded a (non real-time) capture, try to read it into a new capture file */
148 static gboolean
149 capture_input_read_all(capture_options *capture_opts, gboolean is_tempfile, gboolean drops_known,
150 guint32 drops)
151 {
152   int err;
153
154
155   /* Capture succeeded; attempt to open the capture file. */
156   if (cf_open(capture_opts->cf, capture_opts->save_file, is_tempfile, &err) != CF_OK) {
157     /* We're not doing a capture any more, so we don't have a save
158        file. */
159     return FALSE;
160   }
161
162   /* Set the read filter to NULL. */
163   /* XXX - this is odd here, try to put it somewhere, where it fits better */
164   cf_set_rfcode(capture_opts->cf, NULL);
165
166   /* Get the packet-drop statistics.
167
168      XXX - there are currently no packet-drop statistics stored
169      in libpcap captures, and that's what we're reading.
170
171      At some point, we will add support in Wiretap to return
172      packet-drop statistics for capture file formats that store it,
173      and will make "cf_read()" get those statistics from Wiretap.
174      We clear the statistics (marking them as "not known") in
175      "cf_open()", and "cf_read()" will only fetch them and mark
176      them as known if Wiretap supplies them, so if we get the
177      statistics now, after calling "cf_open()" but before calling
178      "cf_read()", the values we store will be used by "cf_read()".
179
180      If a future libpcap capture file format stores the statistics,
181      we'll put them into the capture file that we write, and will
182      thus not have to set them here - "cf_read()" will get them from
183      the file and use them. */
184   if (drops_known) {
185     cf_set_drops_known(capture_opts->cf, TRUE);
186
187     /* XXX - on some systems, libpcap doesn't bother filling in
188        "ps_ifdrop" - it doesn't even set it to zero - so we don't
189        bother looking at it.
190
191        Ideally, libpcap would have an interface that gave us
192        several statistics - perhaps including various interface
193        error statistics - and would tell us which of them it
194        supplies, allowing us to display only the ones it does. */
195     cf_set_drops(capture_opts->cf, drops);
196   }
197
198   /* read in the packet data */
199   switch (cf_read(capture_opts->cf)) {
200
201   case CF_READ_OK:
202   case CF_READ_ERROR:
203     /* Just because we got an error, that doesn't mean we were unable
204        to read any of the file; we handle what we could get from the
205        file. */
206     break;
207
208   case CF_READ_ABORTED:
209     /* User wants to quit program. Exit by leaving the main loop, 
210        so that any quit functions we registered get called. */
211     main_window_nested_quit();
212     return FALSE;
213   }
214
215   /* if we didn't captured even a single packet, close the file again */
216   if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
217     simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
218 "%sNo packets captured!%s\n"
219 "\n"
220 "As no data was captured, closing the %scapture file!\n"
221 "\n"
222 "\n"
223 "Help about capturing can be found at:\n"
224 "\n"
225 "       http://wiki.ethereal.com/CaptureSetup"
226 #ifdef _WIN32
227 "\n\n"
228 "Wireless (Wi-Fi/WLAN):\n"
229 "Try to switch off promiscuous mode in the Capture Options!"
230 #endif
231 "",
232     simple_dialog_primary_start(), simple_dialog_primary_end(),
233     (cf_is_tempfile(capture_opts->cf)) ? "temporary " : "");
234     cf_close(capture_opts->cf);
235   }
236   return TRUE;
237 }
238
239
240 /* capture child tells us, we have a new (or the first) capture file */
241 gboolean
242 capture_input_new_file(capture_options *capture_opts, gchar *new_file)
243 {
244   gboolean is_tempfile;
245   int  err;
246
247
248   if(capture_opts->state == CAPTURE_PREPARING) {
249     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture started!");
250   }
251   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "File: \"%s\"", new_file);
252
253   g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
254
255   /* free the old filename */
256   if(capture_opts->save_file != NULL) {
257     /* we start a new capture file, close the old one (if we had one before) */
258     /* (we can only have an open capture file in real_time_mode!) */
259     if( ((capture_file *) capture_opts->cf)->state != FILE_CLOSED) {
260         cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
261         cf_finish_tail(capture_opts->cf, &err);
262         cf_close(capture_opts->cf);
263     }
264     g_free(capture_opts->save_file);
265     is_tempfile = FALSE;
266     cf_set_tempfile(capture_opts->cf, FALSE);
267   } else {
268     /* we didn't had a save_file before, must be a tempfile */
269     is_tempfile = TRUE;
270     cf_set_tempfile(capture_opts->cf, TRUE);
271   }
272
273   /* save the new filename */
274   capture_opts->save_file = g_strdup(new_file);
275
276   /* if we are in real-time mode, open the new file now */
277   if(capture_opts->real_time_mode) {
278     /* Attempt to open the capture file and set up to read from it. */
279        switch(cf_start_tail(capture_opts->cf, capture_opts->save_file, is_tempfile, &err)) {
280     case CF_OK:
281       break;
282     case CF_ERROR:
283       /* Don't unlink (delete) the save file - leave it around, 
284          for debugging purposes. */
285       g_free(capture_opts->save_file);
286       capture_opts->save_file = NULL;
287       return FALSE;
288       break;
289     }
290
291     cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
292   } else {
293     cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
294   }
295
296   capture_opts->state = CAPTURE_RUNNING;
297
298   return TRUE;
299 }
300
301     
302 /* capture child tells us, we have new packets to read */
303 void
304 capture_input_new_packets(capture_options *capture_opts, int to_read)
305 {
306   int  err;
307
308
309   g_assert(capture_opts->save_file);
310
311   if(capture_opts->real_time_mode) {
312     /* Read from the capture file the number of records the child told us it added. */
313     switch (cf_continue_tail(capture_opts->cf, to_read, &err)) {
314
315     case CF_READ_OK:
316     case CF_READ_ERROR:
317       /* Just because we got an error, that doesn't mean we were unable
318          to read any of the file; we handle what we could get from the
319          file.
320
321          XXX - abort on a read error? */
322          cf_callback_invoke(cf_cb_live_capture_update_continue, capture_opts->cf);
323                  /* update the main window, so we get events (e.g. from the stop toolbar button) */
324          main_window_update();
325       break;
326
327     case CF_READ_ABORTED:
328       /* Kill the child capture process; the user wants to exit, and we
329          shouldn't just leave it running. */
330       capture_kill_child(capture_opts);
331       break;
332     }
333   }
334 }
335
336
337 /* Capture child told us, how many dropped packets it counted.
338  */
339 void
340 capture_input_drops(capture_options *capture_opts, int dropped)
341 {
342   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "%d packet%s dropped", dropped, plurality(dropped, "", "s"));
343
344   g_assert(capture_opts->state == CAPTURE_RUNNING);
345
346   cf_set_drops_known(capture_opts->cf, TRUE);
347   cf_set_drops(capture_opts->cf, dropped);
348 }
349
350
351 /* Capture child told us, that an error has occurred while starting the capture. */
352 void
353 capture_input_error_message(capture_options *capture_opts, char *error_message)
354 {
355   g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Error message from child: \"%s\"", error_message);
356
357   g_assert(capture_opts->state == CAPTURE_PREPARING);
358
359   simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s", error_message);
360
361   /* the capture child will close the sync_pipe, nothing to do for now */
362 }
363
364
365 /* capture child closed it's side ot the pipe, do the required cleanup */
366 void
367 capture_input_closed(capture_options *capture_opts)
368 {
369     int  err;
370
371
372     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture stopped!");
373     g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
374
375     /* if we didn't started the capture, do a fake start */
376     /* (happens if we got an error message - we won't get a filename then) */
377     if(capture_opts->state == CAPTURE_PREPARING) {
378         if(capture_opts->real_time_mode) {
379             cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
380         } else {
381             cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
382         }
383     }
384
385     if(capture_opts->real_time_mode) {
386                 cf_read_status_t status;
387
388         /* Read what remains of the capture file. */
389         status = cf_finish_tail(capture_opts->cf, &err);
390
391         /* Tell the GUI, we are not doing a capture any more.
392                    Must be done after the cf_finish_tail(), so file lengths are displayed 
393                    correct. */
394         cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
395
396         /* Finish the capture. */
397         switch (status) {
398
399         case CF_READ_OK:
400             if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
401                 simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
402 "%sNo packets captured!%s\n"
403 "\n"
404 "As no data was captured, closing the %scapture file!\n"
405 "\n"
406 "\n"
407 "Help about capturing can be found at:\n"
408 "\n"
409 "       http://wiki.ethereal.com/CaptureSetup"
410 #ifdef _WIN32
411 "\n\n"
412 "Wireless (Wi-Fi/WLAN):\n"
413 "Try to switch off promiscuous mode in the Capture Options!"
414 #endif
415 "",
416               simple_dialog_primary_start(), simple_dialog_primary_end(),
417               cf_is_tempfile(capture_opts->cf) ? "temporary " : "");
418               cf_close(capture_opts->cf);
419             }
420             break;
421         case CF_READ_ERROR:
422           /* Just because we got an error, that doesn't mean we were unable
423              to read any of the file; we handle what we could get from the
424              file. */
425           break;
426
427         case CF_READ_ABORTED:
428           /* Exit by leaving the main loop, so that any quit functions
429              we registered get called. */
430           main_window_quit();
431         }
432
433     } else {
434         /* first of all, we are not doing a capture any more */
435         cf_callback_invoke(cf_cb_live_capture_fixed_finished, capture_opts->cf);
436
437         /* this is a normal mode capture and if no error happened, read in the capture file data */
438         if(capture_opts->save_file != NULL) {
439             capture_input_read_all(capture_opts, cf_is_tempfile(capture_opts->cf), 
440                 cf_get_drops_known(capture_opts->cf), cf_get_drops(capture_opts->cf));
441         }
442     }
443
444     capture_opts->state = CAPTURE_STOPPED;
445
446     /* if we couldn't open a capture file, there's nothing more for us to do */
447     if(capture_opts->save_file == NULL) {
448         cf_close(capture_opts->cf);
449         return;
450     }
451
452     /* does the user wants to restart the current capture? */
453     if(capture_opts->restart) {
454         capture_opts->restart = FALSE;
455
456         eth_unlink(capture_opts->save_file);
457
458         /* if it was a tempfile, throw away the old filename (so it will become a tempfile again) */
459         if(cf_is_tempfile(capture_opts->cf)) {
460             g_free(capture_opts->save_file);
461             capture_opts->save_file = NULL;
462         }
463
464         /* ... and start the capture again */
465         capture_start(capture_opts);
466     } else {
467         /* We're not doing a capture any more, so we don't have a save file. */
468         g_free(capture_opts->save_file);
469         capture_opts->save_file = NULL;
470     }
471 }
472
473
474 #endif /* HAVE_LIBPCAP */