The common merge code merely needs to offer the abstraction of routines
[obnox/wireshark/wip.git] / merge.c
diff --git a/merge.c b/merge.c
index 64f24a573b4a712eef3a1f90a1a819c9788f3d76..d82c14136bca9e24f2fdb60e3638576e1f7b4d38 100644 (file)
--- a/merge.c
+++ b/merge.c
@@ -1,6 +1,6 @@
-/* Combine two dump files, either by appending or by merging by timestamp
+/* Combine multiple dump files, either by appending or by merging by timestamp
  *
- * $Id: merge.c,v 1.4 2004/06/18 12:04:49 jmayer Exp $
+ * $Id$
  *
  * Written by Scott Renfro <scott@renfro.org> based on
  * editcap by Richard Sharpe and Guy Harris
@@ -14,6 +14,7 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <glib.h>
+#include <errno.h>
 
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #include <sys/time.h>
 #endif
 
+#ifdef HAVE_SYS_STAT_H
+#include <sys/stat.h>
+#endif
+
 #include <string.h>
 #include "wtap.h"
 #include "merge.h"
 
 /*
- * Global variables
- */
-int merge_verbose = VERBOSE_NONE;
-
-
-/*
- * Routine to write frame to output file
- */
-static gboolean
-write_frame(wtap *wth, merge_out_file_t *out_file, int *err)
-{
-  const struct wtap_pkthdr *phdr = wtap_phdr(wth);
-  struct wtap_pkthdr snap_phdr;
-
-  if (merge_verbose == VERBOSE_ALL)
-    fprintf(stderr, "Record: %u\n", out_file->count++);
-
-  /* We simply write it, perhaps after truncating it; we could do other
-   * things, like modify it. */
-  if (out_file->snaplen != 0 && phdr->caplen > out_file->snaplen) {
-    snap_phdr = *phdr;
-    snap_phdr.caplen = out_file->snaplen;
-    phdr = &snap_phdr;
-  }
-
-  if (!wtap_dump(out_file->pdh, phdr, wtap_pseudoheader(wth), wtap_buf_ptr(wth), err)) {
-    if (merge_verbose == VERBOSE_ERRORS)
-      fprintf(stderr, "mergecap: Error writing to %s: %s\n",
-            out_file->filename, wtap_strerror(*err));
-    return FALSE;
-  }
-
-  return TRUE;
-}
-
-
-static gboolean
-append_loop(wtap *wth, int count, merge_out_file_t *out_file, int *err,
-    gchar **err_info)
-{
-       long            data_offset;
-       int             loop = 0;
-
-       /* Start by clearing error flag */
-       *err = 0;
-
-       while ( (wtap_read(wth, err, err_info, &data_offset)) ) {
-               if(!write_frame(wth, out_file, err))
-            return FALSE;   /* failure */
-               if (count > 0 && ++loop >= count)
-                       break;
-       }
-
-    if (*err == 0) {
-               return TRUE;    /* success */
-    } else {
-               return FALSE;   /* failure */
-    }
-}
-
-
-
-/*
- * routine to concatenate files
+ * Scan through the arguments and open the input files
  */
 gboolean
-merge_append_files(int count, merge_in_file_t in_files[], merge_out_file_t *out_file, int *err)
+merge_open_in_files(int in_file_count, char *const *in_file_names,
+                    merge_in_file_t **in_files, int *err, gchar **err_info,
+                    int *err_fileno)
 {
-  int i;
-  gchar *err_info;
-
-  for (i = 0; i < count; i++) {
-    if (!append_loop(in_files[i].wth, 0, out_file, err, &err_info)) {
-        if (merge_verbose == VERBOSE_ERRORS)
-          fprintf(stderr, "mergecap: Error appending %s to %s: %s\n",
-                  in_files[i].filename, out_file->filename, wtap_strerror(*err));
-          switch (*err) {
+  int i, j;
+  int files_size = in_file_count * sizeof(merge_in_file_t);
+  merge_in_file_t *files;
+  struct stat statb;
 
-          case WTAP_ERR_UNSUPPORTED:
-          case WTAP_ERR_UNSUPPORTED_ENCAP:
-          case WTAP_ERR_BAD_RECORD:
-             fprintf(stderr, "(%s)\n", err_info);
+  files = g_malloc(files_size);
+  *in_files = files;
 
-           break;
-      }
+  for (i = 0; i < in_file_count; i++) {
+    files[i].filename    = in_file_names[i];
+    files[i].wth         = wtap_open_offline(in_file_names[i], err, err_info, FALSE);
+    files[i].data_offset = 0;
+    files[i].state       = PACKET_NOT_PRESENT;
+    if (!files[i].wth) {
+      /* Close the files we've already opened. */
+      for (j = 0; j < i; j++)
+        wtap_close(files[j].wth);
+      *err_fileno = i;
       return FALSE;
     }
-  }
-
-  return TRUE;
-}
-
-
-/*
- * returns TRUE if first argument is earlier than second
- */
-static gboolean
-is_earlier(struct timeval *l, struct timeval *r) {
-  if (l->tv_sec > r->tv_sec) {  /* left is later */
-    return FALSE;
-  } else if (l->tv_sec < r->tv_sec) { /* left is earlier */
-    return TRUE;
-  } else if (l->tv_usec > r->tv_usec) { /* tv_sec equal, l.usec later */
-    return FALSE;
-  }
-  /* either one < two or one == two
-   * either way, return one
-   */
-  return TRUE;
-}
-
-
-/*
- * returns index of earliest timestamp in set of input files
- * or -1 if no valid files remain
- */
-static int
-earliest(int count, merge_in_file_t in_files[]) {
-  int i;
-  int ei = -1;
-  struct timeval tv = {LONG_MAX, LONG_MAX};
-
-  for (i = 0; i < count; i++) {
-    struct wtap_pkthdr *phdr = wtap_phdr(in_files[i].wth);
-
-    if (in_files[i].ok && is_earlier(&(phdr->ts), &tv)) {
-      tv = phdr->ts;
-      ei = i;
+    if (fstat(wtap_fd(files[i].wth), &statb) < 0) {
+      *err = errno;
+      for (j = 0; j <= i; j++)
+        wtap_close(files[j].wth);
+      *err_fileno = i;
+      return FALSE;
     }
+    files[i].size = statb.st_size;
   }
-  return ei;
+  return TRUE;
 }
 
 /*
- * actually merge the files
+ * Scan through and close each input file
  */
-gboolean
-merge_files(int count, merge_in_file_t in_files[], merge_out_file_t *out_file, int *err)
+void
+merge_close_in_files(int count, merge_in_file_t in_files[])
 {
   int i;
-
-  /* prime the pump (read in first frame from each file) */
   for (i = 0; i < count; i++) {
-    in_files[i].ok = wtap_read(in_files[i].wth, &(in_files[i].err),
-                               &(in_files[i].err_info),
-                               &(in_files[i].data_offset));
-  }
-
-  /* now keep writing the earliest frame until we're out of frames */
-  while ( -1 != (i = earliest(count, in_files))) {
-
-    /* write out earliest frame, and fetch another from its
-     * input file
-     */
-    if(!write_frame(in_files[i].wth, out_file, err))
-                return FALSE;
-    in_files[i].ok = wtap_read(in_files[i].wth, &(in_files[i].err),
-                               &(in_files[i].err_info),
-                               &(in_files[i].data_offset));
+    wtap_close(in_files[i].wth);
   }
-
-  return TRUE;
 }
 
-
 /*
  * Select an output frame type based on the input files
  * From Guy: If all files have the same frame type, then use that.
@@ -213,80 +104,13 @@ merge_select_frame_type(int count, merge_in_file_t files[])
     int this_frame_type = wtap_file_encap(files[i].wth);
     if (selected_frame_type != this_frame_type) {
       selected_frame_type = WTAP_ENCAP_PER_PACKET;
-      if (merge_verbose == VERBOSE_ALL) {
-        fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
-        fprintf(stderr, "          defaulting to WTAP_ENCAP_PER_PACKET\n");
-        fprintf(stderr, "          %s had type %s (%s)\n",
-                files[0].filename,
-                wtap_encap_string(selected_frame_type),
-                wtap_encap_short_string(selected_frame_type));
-        fprintf(stderr, "          %s had type %s (%s)\n",
-                files[i].filename,
-                wtap_encap_string(this_frame_type),
-                wtap_encap_short_string(this_frame_type));
-      }
       break;
     }
   }
 
-  if (merge_verbose == VERBOSE_ALL) {
-      fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
-              wtap_encap_string(selected_frame_type),
-              wtap_encap_short_string(selected_frame_type));
-  }
-
   return selected_frame_type;
 }
 
-
-/*
- * Close the output file
- */
-void
-merge_close_outfile(merge_out_file_t *out_file)
-{
-  int err;
-  if (!wtap_dump_close(out_file->pdh, &err)) {
-    if (merge_verbose == VERBOSE_ERRORS)
-        fprintf(stderr, "mergecap: Error closing file %s: %s\n",
-            out_file->filename, wtap_strerror(err));
-  }
-}
-
-
-/*
- * Open the output file
- *
- * Return FALSE if file cannot be opened (so caller can clean up)
- */
-gboolean
-merge_open_outfile(merge_out_file_t *out_file, int snapshot_len, int *err)
-{
-
-  if (!out_file) {
-    if (merge_verbose == VERBOSE_ERRORS)
-        fprintf(stderr, "mergecap: internal error (null out_file)\n");
-    return FALSE;
-  }
-
-  /* Allow output to stdout by using - */
-  if (strncmp(out_file->filename, "-", 2) == 0)
-    out_file->filename = "";
-
-
-  out_file->pdh = wtap_dump_open(out_file->filename, out_file->file_type,
-                                 out_file->frame_type, snapshot_len, err);
-  if (!out_file->pdh) {
-    if (merge_verbose == VERBOSE_ERRORS) {
-        fprintf(stderr, "mergecap: Can't open/create %s:\n", out_file->filename);
-        fprintf(stderr, "          %s\n", wtap_strerror(*err));
-    }
-    return FALSE;
-  }
-  return TRUE;
-}
-
-
 /*
  * Scan through input files and find maximum snapshot length
  */
@@ -309,130 +133,112 @@ merge_max_snapshot_length(int count, merge_in_file_t in_files[])
   return max_snapshot;
 }
 
-
 /*
- * Scan through and close each input file
+ * returns TRUE if first argument is earlier than second
  */
-void
-merge_close_in_files(int count, merge_in_file_t in_files[])
-{
-  int i;
-  for (i = 0; i < count; i++) {
-    wtap_close(in_files[i].wth);
+static gboolean
+is_earlier(struct timeval *l, struct timeval *r) {
+  if (l->tv_sec > r->tv_sec) {  /* left is later */
+    return FALSE;
+  } else if (l->tv_sec < r->tv_sec) { /* left is earlier */
+    return TRUE;
+  } else if (l->tv_usec > r->tv_usec) { /* tv_sec equal, l.usec later */
+    return FALSE;
   }
+  /* either one < two or one == two
+   * either way, return one
+   */
+  return TRUE;
 }
 
-
 /*
- * Scan through the arguments and open the input files
+ * Read the next packet, in chronological order, from the set of files
+ * to be merged.
  */
-int
-merge_open_in_files(int in_file_count, char *in_file_names[], merge_in_file_t *in_files[], int *err)
+wtap *
+merge_read_packet(int in_file_count, merge_in_file_t in_files[], int *err,
+                  gchar **err_info)
 {
   int i;
-  int count = 0;
-  gchar *err_info;
-  int files_size = in_file_count * sizeof(merge_in_file_t);
-  merge_in_file_t *files;
-
-
-  files = g_malloc(files_size);
-  *in_files = files;
+  int ei = -1;
+  struct timeval tv = {LONG_MAX, LONG_MAX};
+  struct wtap_pkthdr *phdr;
 
+  /*
+   * Make sure we have a packet available from each file, if there are any
+   * packets left in the file in question, and search for the packet
+   * with the earliest time stamp.
+   */
   for (i = 0; i < in_file_count; i++) {
-    files[count].filename    = in_file_names[i];
-    files[count].wth         = wtap_open_offline(in_file_names[i], err, &err_info, FALSE);
-    files[count].err         = 0;
-    files[count].data_offset = 0;
-    files[count].ok          = TRUE;
-    if (!files[count].wth) {
-      if (merge_verbose == VERBOSE_ERRORS) {
-        fprintf(stderr, "mergecap: skipping %s: %s\n", in_file_names[i],
-              wtap_strerror(*err));
-      switch (*err) {
-
-      case WTAP_ERR_UNSUPPORTED:
-      case WTAP_ERR_UNSUPPORTED_ENCAP:
-      case WTAP_ERR_BAD_RECORD:
-        fprintf(stderr, "(%s)\n", err_info);
-        g_free(err_info);
-        break;
-      }
-      }
-    } else {
-      if (merge_verbose == VERBOSE_ALL) {
-        fprintf(stderr, "mergecap: %s is type %s.\n", in_file_names[i],
-                wtap_file_type_string(wtap_file_type(files[count].wth)));
+    if (in_files[i].state == PACKET_NOT_PRESENT) {
+      /*
+       * No packet available, and we haven't seen an error or EOF yet,
+       * so try to read the next packet.
+       */
+      if (!wtap_read(in_files[i].wth, err, err_info, &in_files[i].data_offset)) {
+        if (*err != 0) {
+          in_files[i].state = GOT_ERROR;
+          return NULL;
+        }
+        in_files[i].state = AT_EOF;
+      } else
+        in_files[i].state = PACKET_PRESENT;
+    }
+    
+    if (in_files[i].state == PACKET_PRESENT) {
+      phdr = wtap_phdr(in_files[i].wth);
+      if (is_earlier(&phdr->ts, &tv)) {
+        tv = phdr->ts;
+        ei = i;
       }
-      count++;
     }
   }
-  if (merge_verbose == VERBOSE_ALL)
-    fprintf(stderr, "mergecap: opened %d of %d input files\n", count,
-    in_file_count);
 
-  return count;
-}
+  if (ei == -1) {
+    /* All the streams are at EOF.  Return an EOF indication. */
+    *err = 0;
+    return NULL;
+  }
 
+  /* We'll need to read another packet from this file. */
+  in_files[ei].state = PACKET_NOT_PRESENT;
+
+  /* Return a pointer to the wtap structure for the file with that frame. */
+  return in_files[ei].wth;
+}
 
 /*
- * Convenience function: merge two files into one.
+ * Read the next packet, in file sequence order, from the set of files
+ * to be merged.
  */
-gboolean
-merge_two_files(char *out_filename, char *in_file0, char *in_file1, gboolean do_append, int *err)
+wtap *
+merge_append_read_packet(int in_file_count, merge_in_file_t in_files[],
+                         int *err, gchar **err_info)
 {
-  extern char *optarg;
-  extern int   optind;
-  int          in_file_count = 0;
-  char        *in_filenames[2];
-  merge_in_file_t   *in_files      = NULL;
-  merge_out_file_t   out_file;
-  gboolean     ret;
-
-  /* initialize out_file */
-  out_file.filename   = out_filename;
-  out_file.pdh        = NULL;              /* wiretap dumpfile */
-  out_file.file_type  = WTAP_FILE_PCAP;    /* default to "libpcap" */
-  out_file.frame_type = -2;                /* leave type alone */
-  out_file.snaplen    = 0;                 /* no limit */
-  out_file.count      = 1;                 /* frames output */
+  int i;
 
-  /* check for proper args; at a minimum, must have an output
-   * filename and one input file
+  /*
+   * Find the first file not at EOF, and read the next packet from it.
    */
-  in_file_count = 2;
-
-  in_filenames[0] = in_file0;
-  in_filenames[1] = in_file1;
-
-  /* open the input files */
-  in_file_count = merge_open_in_files(in_file_count, in_filenames, &in_files, err);
-  if (in_file_count < 2) {
-    if (merge_verbose == VERBOSE_ALL)
-        fprintf(stderr, "mergecap: Not all input files valid\n");
-    return FALSE;
+  for (i = 0; i < in_file_count; i++) {
+    if (in_files[i].state == AT_EOF)
+      continue; /* This file is already at EOF */
+    if (wtap_read(in_files[i].wth, err, err_info, &in_files[i].data_offset))
+      break; /* We have a packet */
+    if (*err != 0) {
+      /* Read error - quit immediately. */
+      in_files[i].state = GOT_ERROR;
+      return NULL;
+    }
+    /* EOF - flag this file as being at EOF, and try the next one. */
+    in_files[i].state = AT_EOF;
   }
-
-  /* set the outfile frame type */
-  if (out_file.frame_type == -2)
-    out_file.frame_type = merge_select_frame_type(in_file_count, in_files);
-
-  /* open the outfile */
-  if (!merge_open_outfile(&out_file, merge_max_snapshot_length(in_file_count, in_files), err)) {
-    merge_close_in_files(in_file_count, in_files);
-    return FALSE;
+  if (i == in_file_count) {
+    /* All the streams are at EOF.  Return an EOF indication. */
+    *err = 0;
+    return NULL;
   }
 
-  /* do the merge (or append) */
-  if (do_append)
-    ret = merge_append_files(in_file_count, in_files, &out_file, err);
-  else
-    ret = merge_files(in_file_count, in_files, &out_file, err);
-
-  merge_close_in_files(in_file_count, in_files);
-  merge_close_outfile(&out_file);
-
-  free(in_files);
-
-  return ret;
+  /* Return a pointer to the wtap structure for the file with that frame. */
+  return in_files[i].wth;
 }