clarify a comment
[metze/wireshark/wip.git] / capture.c
index 703c67476431452cf451a329b849843b1943154a..074acc3fe78a6b287a80389e3703feac8b91864d 100644 (file)
--- a/capture.c
+++ b/capture.c
@@ -1,5 +1,5 @@
 /* capture.c
- * Routines for packet capture windows
+ * Routines for packet capture
  *
  * $Id$
  *
 
 #ifdef HAVE_LIBPCAP
 
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
 #include <fcntl.h>
 #endif
 
-#ifdef HAVE_IO_H
-# include <io.h>
-#endif
-
 #include <signal.h>
 #include <errno.h>
 
 #include "capture-wpcap.h"
 #endif
 #include "ui_util.h"
+#include "file_util.h"
+#include "log.h"
 
 
-static void stop_capture_signal_handler(int signo);
-
 
-
-/* start a capture */
-/* Returns TRUE if the capture starts successfully, FALSE otherwise. */
+/** 
+ * Start a capture.
+ *
+ * @return TRUE if the capture starts successfully, FALSE otherwise.
+ */
 gboolean
-do_capture(capture_options *capture_opts)
+capture_start(capture_options *capture_opts)
 {
   gboolean ret;
 
@@ -82,98 +84,155 @@ do_capture(capture_options *capture_opts)
   /* close the currently loaded capture file */
   cf_close(capture_opts->cf);
 
-  /* try to start the capture child process */
-  ret = sync_pipe_do_capture(capture_opts, capture_opts->save_file == NULL);
+  g_assert(capture_opts->state == CAPTURE_STOPPED);
+  capture_opts->state = CAPTURE_PREPARING;
 
-  if(ret) {
-      /* tell callbacks (menu, ...) that capture is running now */
-      cf_callback_invoke(cf_cb_live_capture_prepare, capture_opts);
-  } else {
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Start ...");
+
+  /* try to start the capture child process */
+  ret = sync_pipe_start(capture_opts);
+  if(!ret) {
       if(capture_opts->save_file != NULL) {
           g_free(capture_opts->save_file);
           capture_opts->save_file = NULL;
       }
+
+      capture_opts->state = CAPTURE_STOPPED;
+  } else {
+      /* the capture child might not respond shortly after bringing it up */
+      /* (especially it will block, if no input coming from an input capture pipe (e.g. mkfifo) is coming in) */
+
+      /* to prevent problems, bring the main GUI into "capture mode" right after successfully */
+      /* spawn/exec the capture child, without waiting for any response from it */
+      cf_callback_invoke(cf_cb_live_capture_prepared, capture_opts);
   }
 
   return ret;
 }
 
 
-/* we've succeeded a capture, try to read it into a new capture file */
+void
+capture_stop(capture_options *capture_opts)
+{
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Stop ...");
+
+  cf_callback_invoke(cf_cb_live_capture_stopping, capture_opts);
+
+  /* stop the capture child gracefully */
+  sync_pipe_stop(capture_opts);
+}
+
+
+void
+capture_restart(capture_options *capture_opts)
+{
+    g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture Restart");
+
+    capture_opts->restart = TRUE;
+    capture_stop(capture_opts);
+}
+
+
+void
+capture_kill_child(capture_options *capture_opts)
+{
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "Capture Kill");
+
+  /* kill the capture child */
+  sync_pipe_kill(capture_opts);
+}
+
+
+
+/* We've succeeded a (non real-time) capture, try to read it into a new capture file */
 static gboolean
 capture_input_read_all(capture_options *capture_opts, gboolean is_tempfile, gboolean drops_known,
 guint32 drops)
 {
-    int err;
+  int err;
 
 
-    /* Capture succeeded; attempt to read in the capture file. */
-    if (cf_open(capture_opts->cf, capture_opts->save_file, is_tempfile, &err) != CF_OK) {
-      /* We're not doing a capture any more, so we don't have a save
-        file. */
-      return FALSE;
-    }
-
-    /* Set the read filter to NULL. */
-    /* XXX - this is odd here, try to put it somewhere, where it fits better */
-    cf_set_rfcode(capture_opts->cf, NULL);
-
-    /* Get the packet-drop statistics.
-
-       XXX - there are currently no packet-drop statistics stored
-       in libpcap captures, and that's what we're reading.
-
-       At some point, we will add support in Wiretap to return
-       packet-drop statistics for capture file formats that store it,
-       and will make "cf_read()" get those statistics from Wiretap.
-       We clear the statistics (marking them as "not known") in
-       "cf_open()", and "cf_read()" will only fetch them and mark
-       them as known if Wiretap supplies them, so if we get the
-       statistics now, after calling "cf_open()" but before calling
-       "cf_read()", the values we store will be used by "cf_read()".
-
-       If a future libpcap capture file format stores the statistics,
-       we'll put them into the capture file that we write, and will
-       thus not have to set them here - "cf_read()" will get them from
-       the file and use them. */
-    if (drops_known) {
-      cf_set_drops_known(capture_opts->cf, TRUE);
-
-      /* XXX - on some systems, libpcap doesn't bother filling in
-         "ps_ifdrop" - it doesn't even set it to zero - so we don't
-         bother looking at it.
-
-         Ideally, libpcap would have an interface that gave us
-         several statistics - perhaps including various interface
-         error statistics - and would tell us which of them it
-         supplies, allowing us to display only the ones it does. */
-      cf_set_drops(capture_opts->cf, drops);
-    }
-    switch (cf_read(capture_opts->cf)) {
+  /* Capture succeeded; attempt to open the capture file. */
+  if (cf_open(capture_opts->cf, capture_opts->save_file, is_tempfile, &err) != CF_OK) {
+    /* We're not doing a capture any more, so we don't have a save
+       file. */
+    return FALSE;
+  }
 
-    case CF_READ_OK:
-    case CF_READ_ERROR:
-      /* Just because we got an error, that doesn't mean we were unable
-         to read any of the file; we handle what we could get from the
-         file. */
-      break;
+  /* Set the read filter to NULL. */
+  /* XXX - this is odd here, try to put it somewhere, where it fits better */
+  cf_set_rfcode(capture_opts->cf, NULL);
+
+  /* Get the packet-drop statistics.
+
+     XXX - there are currently no packet-drop statistics stored
+     in libpcap captures, and that's what we're reading.
+
+     At some point, we will add support in Wiretap to return
+     packet-drop statistics for capture file formats that store it,
+     and will make "cf_read()" get those statistics from Wiretap.
+     We clear the statistics (marking them as "not known") in
+     "cf_open()", and "cf_read()" will only fetch them and mark
+     them as known if Wiretap supplies them, so if we get the
+     statistics now, after calling "cf_open()" but before calling
+     "cf_read()", the values we store will be used by "cf_read()".
+
+     If a future libpcap capture file format stores the statistics,
+     we'll put them into the capture file that we write, and will
+     thus not have to set them here - "cf_read()" will get them from
+     the file and use them. */
+  if (drops_known) {
+    cf_set_drops_known(capture_opts->cf, TRUE);
+
+    /* XXX - on some systems, libpcap doesn't bother filling in
+       "ps_ifdrop" - it doesn't even set it to zero - so we don't
+       bother looking at it.
+
+       Ideally, libpcap would have an interface that gave us
+       several statistics - perhaps including various interface
+       error statistics - and would tell us which of them it
+       supplies, allowing us to display only the ones it does. */
+    cf_set_drops(capture_opts->cf, drops);
+  }
 
-    case CF_READ_ABORTED:
-      /* Exit by leaving the main loop, so that any quit functions
-         we registered get called. */
-      main_window_nested_quit();
-      return FALSE;
-    }
+  /* read in the packet data */
+  switch (cf_read(capture_opts->cf)) {
+
+  case CF_READ_OK:
+  case CF_READ_ERROR:
+    /* Just because we got an error, that doesn't mean we were unable
+       to read any of the file; we handle what we could get from the
+       file. */
+    break;
+
+  case CF_READ_ABORTED:
+    /* User wants to quit program. Exit by leaving the main loop, 
+       so that any quit functions we registered get called. */
+    main_window_nested_quit();
+    return FALSE;
+  }
 
-    /* if we didn't captured even a single packet, close the file again */
-    if(cf_packet_count(capture_opts->cf) == 0) {
-      simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
-      "%sNo packets captured!%s\n\n"
-      "As no data was captured, closing the %scapture file!",
-      simple_dialog_primary_start(), simple_dialog_primary_end(),
-      (cf_is_tempfile(capture_opts->cf)) ? "temporary " : "");
-      cf_close(capture_opts->cf);
-    }
+  /* if we didn't captured even a single packet, close the file again */
+  if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
+    simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
+"%sNo packets captured!%s\n"
+"\n"
+"As no data was captured, closing the %scapture file!\n"
+"\n"
+"\n"
+"Help about capturing can be found at:\n"
+"\n"
+"       http://wiki.ethereal.com/CaptureSetup"
+#ifdef _WIN32
+"\n\n"
+"Wireless (Wi-Fi/WLAN):\n"
+"Try to switch off promiscuous mode in the Capture Options!"
+#endif
+"",
+    simple_dialog_primary_start(), simple_dialog_primary_end(),
+    (cf_is_tempfile(capture_opts->cf)) ? "temporary " : "");
+    cf_close(capture_opts->cf);
+  }
   return TRUE;
 }
 
@@ -186,41 +245,57 @@ capture_input_new_file(capture_options *capture_opts, gchar *new_file)
   int  err;
 
 
-      /*g_warning("New capture file: %s", new_file);*/
+  if(capture_opts->state == CAPTURE_PREPARING) {
+    g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture started!");
+  }
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "File: \"%s\"", new_file);
 
-      /* save the new filename */
-      if(capture_opts->save_file != NULL) {
-        /* we start a new capture file, simply close the old one */
-        /* XXX - is it enough to call cf_close here? */
-        /* XXX - is it safe to call cf_close even if the file is close before? */
+  g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
+
+  /* free the old filename */
+  if(capture_opts->save_file != NULL) {
+    /* we start a new capture file, close the old one (if we had one before) */
+    /* (we can only have an open capture file in real_time_mode!) */
+    if( ((capture_file *) capture_opts->cf)->state != FILE_CLOSED) {
+        cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
+        cf_finish_tail(capture_opts->cf, &err);
         cf_close(capture_opts->cf);
-        g_free(capture_opts->save_file);
-        is_tempfile = FALSE;
-      } else {
-        /* we didn't had a save_file before, must be a tempfile */
-        is_tempfile = TRUE;
-        cf_set_tempfile(capture_opts->cf, TRUE);
-      }
-      capture_opts->save_file = g_strdup(new_file);
-
-      /* if we are in sync mode, open the new file */
-    if(capture_opts->sync_mode) {
-        /* The child process started a capture.
-           Attempt to open the capture file and set up to read it. */
-        switch(cf_start_tail(capture_opts->cf, capture_opts->save_file, is_tempfile, &err)) {
-        case CF_OK:
-            break;
-        case CF_ERROR:
-            /* Don't unlink the save file - leave it around, for debugging
-            purposes. */
-            g_free(capture_opts->save_file);
-            capture_opts->save_file = NULL;
-            return FALSE;
-            break;
-        }
     }
+    g_free(capture_opts->save_file);
+    is_tempfile = FALSE;
+    cf_set_tempfile(capture_opts->cf, FALSE);
+  } else {
+    /* we didn't had a save_file before, must be a tempfile */
+    is_tempfile = TRUE;
+    cf_set_tempfile(capture_opts->cf, TRUE);
+  }
 
-    return TRUE;
+  /* save the new filename */
+  capture_opts->save_file = g_strdup(new_file);
+
+  /* if we are in real-time mode, open the new file now */
+  if(capture_opts->real_time_mode) {
+    /* Attempt to open the capture file and set up to read from it. */
+       switch(cf_start_tail(capture_opts->cf, capture_opts->save_file, is_tempfile, &err)) {
+    case CF_OK:
+      break;
+    case CF_ERROR:
+      /* Don't unlink (delete) the save file - leave it around, 
+         for debugging purposes. */
+      g_free(capture_opts->save_file);
+      capture_opts->save_file = NULL;
+      return FALSE;
+      break;
+    }
+
+    cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
+  } else {
+    cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
+  }
+
+  capture_opts->state = CAPTURE_RUNNING;
+
+  return TRUE;
 }
 
     
@@ -231,31 +306,62 @@ capture_input_new_packets(capture_options *capture_opts, int to_read)
   int  err;
 
 
-  if(capture_opts->sync_mode) {
-      /* Read from the capture file the number of records the child told us
-         it added.
-         XXX - do something if this fails? */
-      switch (cf_continue_tail(capture_opts->cf, to_read, &err)) {
+  g_assert(capture_opts->save_file);
 
-      case CF_READ_OK:
-      case CF_READ_ERROR:
-        /* Just because we got an error, that doesn't mean we were unable
-           to read any of the file; we handle what we could get from the
-           file.
+  if(capture_opts->real_time_mode) {
+    /* Read from the capture file the number of records the child told us it added. */
+    switch (cf_continue_tail(capture_opts->cf, to_read, &err)) {
 
-           XXX - abort on a read error? */
-        break;
+    case CF_READ_OK:
+    case CF_READ_ERROR:
+      /* Just because we got an error, that doesn't mean we were unable
+         to read any of the file; we handle what we could get from the
+         file.
 
-      case CF_READ_ABORTED:
-        /* Kill the child capture process; the user wants to exit, and we
-           shouldn't just leave it running. */
-        capture_kill_child(capture_opts);
-        break;
-      }
+         XXX - abort on a read error? */
+         cf_callback_invoke(cf_cb_live_capture_update_continue, capture_opts->cf);
+                /* update the main window, so we get events (e.g. from the stop toolbar button) */
+         main_window_update();
+      break;
+
+    case CF_READ_ABORTED:
+      /* Kill the child capture process; the user wants to exit, and we
+         shouldn't just leave it running. */
+      capture_kill_child(capture_opts);
+      break;
+    }
   }
 }
 
 
+/* Capture child told us, how many dropped packets it counted.
+ */
+void
+capture_input_drops(capture_options *capture_opts, int dropped)
+{
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_INFO, "%d packet%s dropped", dropped, plurality(dropped, "", "s"));
+
+  g_assert(capture_opts->state == CAPTURE_RUNNING);
+
+  cf_set_drops_known(capture_opts->cf, TRUE);
+  cf_set_drops(capture_opts->cf, dropped);
+}
+
+
+/* Capture child told us, that an error has occurred while starting the capture. */
+void
+capture_input_error_message(capture_options *capture_opts, char *error_message)
+{
+  g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Error message from child: \"%s\"", error_message);
+
+  g_assert(capture_opts->state == CAPTURE_PREPARING);
+
+  simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "%s", error_message);
+
+  /* the capture child will close the sync_pipe, nothing to do for now */
+}
+
+
 /* capture child closed it's side ot the pipe, do the required cleanup */
 void
 capture_input_closed(capture_options *capture_opts)
@@ -263,16 +369,50 @@ capture_input_closed(capture_options *capture_opts)
     int  err;
 
 
-    if(capture_opts->sync_mode) {
-        /* Read what remains of the capture file, and finish the capture.
-           XXX - do something if this fails? */
-        switch (cf_finish_tail(capture_opts->cf, &err)) {
+    g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_MESSAGE, "Capture stopped!");
+    g_assert(capture_opts->state == CAPTURE_PREPARING || capture_opts->state == CAPTURE_RUNNING);
+
+    /* if we didn't started the capture, do a fake start */
+    /* (happens if we got an error message - we won't get a filename then) */
+    if(capture_opts->state == CAPTURE_PREPARING) {
+        if(capture_opts->real_time_mode) {
+            cf_callback_invoke(cf_cb_live_capture_update_started, capture_opts);
+        } else {
+            cf_callback_invoke(cf_cb_live_capture_fixed_started, capture_opts);
+        }
+    }
+
+    if(capture_opts->real_time_mode) {
+               cf_read_status_t status;
+
+        /* Read what remains of the capture file. */
+        status = cf_finish_tail(capture_opts->cf, &err);
+
+        /* Tell the GUI, we are not doing a capture any more.
+                  Must be done after the cf_finish_tail(), so file lengths are displayed 
+                  correct. */
+        cf_callback_invoke(cf_cb_live_capture_update_finished, capture_opts->cf);
+
+        /* Finish the capture. */
+        switch (status) {
 
         case CF_READ_OK:
-            if(cf_packet_count(capture_opts->cf) == 0) {
-              simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
-              "%sNo packets captured!%s\n\n"
-              "As no data was captured, closing the %scapture file!",
+            if(cf_packet_count(capture_opts->cf) == 0 && !capture_opts->restart) {
+                simple_dialog(ESD_TYPE_INFO, ESD_BTN_OK, 
+"%sNo packets captured!%s\n"
+"\n"
+"As no data was captured, closing the %scapture file!\n"
+"\n"
+"\n"
+"Help about capturing can be found at:\n"
+"\n"
+"       http://wiki.ethereal.com/CaptureSetup"
+#ifdef _WIN32
+"\n\n"
+"Wireless (Wi-Fi/WLAN):\n"
+"Try to switch off promiscuous mode in the Capture Options!"
+#endif
+"",
               simple_dialog_primary_start(), simple_dialog_primary_end(),
               cf_is_tempfile(capture_opts->cf) ? "temporary " : "");
               cf_close(capture_opts->cf);
@@ -289,61 +429,45 @@ capture_input_closed(capture_options *capture_opts)
              we registered get called. */
           main_window_quit();
         }
-    } else {
-        /* this is a normal mode capture, read in the capture file data */
-        capture_input_read_all(capture_opts, cf_is_tempfile(capture_opts->cf), 
-            cf_get_drops_known(capture_opts->cf), cf_get_drops(capture_opts->cf));
-    }
-
-    /* We're not doing a capture any more, so we don't have a save file. */
-    g_assert(capture_opts->save_file);
-    g_free(capture_opts->save_file);
-    capture_opts->save_file = NULL;
-}
 
+    } else {
+        /* first of all, we are not doing a capture any more */
+        cf_callback_invoke(cf_cb_live_capture_fixed_finished, capture_opts->cf);
 
-#ifndef _WIN32
-static void
-capture_child_stop_signal_handler(int signo _U_)
-{
-  capture_loop_stop();
-}
-#endif
+        /* this is a normal mode capture and if no error happened, read in the capture file data */
+        if(capture_opts->save_file != NULL) {
+            capture_input_read_all(capture_opts, cf_is_tempfile(capture_opts->cf), 
+                cf_get_drops_known(capture_opts->cf), cf_get_drops(capture_opts->cf));
+        }
+    }
 
+    capture_opts->state = CAPTURE_STOPPED;
 
-int  
-capture_child_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats)
-{
-  g_assert(capture_opts->capture_child);
-
-#ifndef _WIN32
-  /*
-   * Catch SIGUSR1, so that we exit cleanly if the parent process
-   * kills us with it due to the user selecting "Capture->Stop".
-   */
-    signal(SIGUSR1, capture_child_stop_signal_handler);
-#endif
+    /* if we couldn't open a capture file, there's nothing more for us to do */
+    if(capture_opts->save_file == NULL) {
+        cf_close(capture_opts->cf);
+        return;
+    }
 
-  return capture_loop_start(capture_opts, stats_known, stats);
-}
+    /* does the user wants to restart the current capture? */
+    if(capture_opts->restart) {
+        capture_opts->restart = FALSE;
 
-void
-capture_stop(capture_options *capture_opts)
-{
-  /* stop the capture child, if we have one */
-  if (!capture_opts->capture_child) {  
-    sync_pipe_stop(capture_opts);
-  }
+        eth_unlink(capture_opts->save_file);
 
-  /* stop the capture loop */
-  capture_loop_stop();
-}
+        /* if it was a tempfile, throw away the old filename (so it will become a tempfile again) */
+        if(cf_is_tempfile(capture_opts->cf)) {
+            g_free(capture_opts->save_file);
+            capture_opts->save_file = NULL;
+        }
 
-void
-capture_kill_child(capture_options *capture_opts)
-{
-  /* kill the capture child, if we have one */
-  sync_pipe_kill(capture_opts);
+        /* ... and start the capture again */
+        capture_start(capture_opts);
+    } else {
+        /* We're not doing a capture any more, so we don't have a save file. */
+        g_free(capture_opts->save_file);
+        capture_opts->save_file = NULL;
+    }
 }