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