Change a comment to be slightly easier to read
[metze/wireshark/wip.git] / reordercap.c
index 5933abed371fcbcc2b67819574bfae0c7b7a51aa..92469746821ffa5c787fef3338c6d51d6db5a790 100644 (file)
@@ -1,8 +1,6 @@
 /* Reorder the frames from an input dump file, and write to output dump file.
  * Martin Mathieson and Jakub Jawadzki
  *
- * $Id$
- *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
 #include <unistd.h>
 #endif
 
+#ifdef HAVE_GETOPT_H
+#include <getopt.h>
+#endif
+
+#ifdef HAVE_LIBZ
+#include <zlib.h>      /* to get the libz version number */
+#endif
+
 #include "wtap.h"
 
 #ifndef HAVE_GETOPT
 #include "wsutil/wsgetopt.h"
 #endif
 
+#include <wsutil/strnatcmp.h>
+#include <wsutil/file_util.h>
+#include <wsutil/crash_info.h>
+#include <wsutil/copyright_info.h>
+#include <wsutil/os_version_info.h>
+#include <wsutil/ws_version_info.h>
+
+#include "version_info.h"
+
+static void
+show_version(GString *comp_info_str, GString *runtime_info_str)
+{
+    printf("Reordercap (Wireshark) %s\n"
+           "\n"
+           "%s"
+           "\n"
+           "%s"
+           "\n"
+           "%s",
+           get_ws_vcs_version_info(), get_copyright_info(),
+           comp_info_str->str, runtime_info_str->str);
+}
+
 /* Show command-line usage */
-static void usage(void)
+static void
+print_usage(FILE *output)
 {
-    fprintf(stderr, "Reordercap %s"
-#ifdef SVNVERSION
-         " (" SVNVERSION " from " SVNPATH ")"
-#endif
-         "\n", VERSION);
-    fprintf(stderr, "Reorder timestamps of input file frames into output file.\n");
-    fprintf(stderr, "See http://www.wireshark.org for more information.\n");
-    fprintf(stderr, "\n");
-    fprintf(stderr, "Usage: reordercap [options] <infile> <outfile>\n");
-    fprintf(stderr, "\n");
-    fprintf(stderr, "Options:\n");
-    fprintf(stderr, "  -n        don't write to output file if the input file is ordered.\n");
+    fprintf(output, "\n");
+    fprintf(output, "Usage: reordercap [options] <infile> <outfile>\n");
+    fprintf(output, "\n");
+    fprintf(output, "Options:\n");
+    fprintf(output, "  -n        don't write to output file if the input file is ordered.\n");
+    fprintf(output, "  -h        display this help and exit.\n");
 }
 
 /* Remember where this frame was in the file */
 typedef struct FrameRecord_t {
-    gint64               offset;
-    guint32              length;
-    guint                num;
+    gint64       offset;
+    guint        num;
 
-    struct wtap_nstime   time;
+    nstime_t     time;
 } FrameRecord_t;
 
 
@@ -82,87 +105,105 @@ typedef struct FrameRecord_t {
 
 
 static void
-frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh)
+frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh, Buffer *buf,
+            const char *infile)
 {
-    union wtap_pseudo_header pseudo_header;
     int    err;
-    gchar  *errinfo;
-    const struct wtap_pkthdr *phdr;
-    guint8 buf[65535];
-    struct wtap_pkthdr new_phdr;
+    gchar  *err_info;
+    struct wtap_pkthdr phdr;
+
+    memset(&phdr, 0, sizeof(struct wtap_pkthdr));
+
+    DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
+                frame->offset);
 
-    DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u, length=%u)\n", 
-                frame->offset, frame->length);
 
     /* Re-read the first frame from the stored location */
-    wtap_seek_read(wth,
-                   frame->offset,
-                   &pseudo_header,
-                   buf,
-                   frame->length,
-                   &err,
-                   &errinfo);
-    DEBUG_PRINT("re-read: err is %d, buf is (%s)\n", err, buf);
-
-    /* Get packet header */
-    /* XXX, this might not work */
-    phdr = wtap_phdr(wth);
+    if (!wtap_seek_read(wth, frame->offset, &phdr, buf, &err, &err_info)) {
+        if (err != 0) {
+            /* Print a message noting that the read failed somewhere along the line. */
+            fprintf(stderr,
+                    "reordercap: An error occurred while re-reading \"%s\": %s.\n",
+                    infile, wtap_strerror(err));
+            switch (err) {
+
+            case WTAP_ERR_UNSUPPORTED:
+            case WTAP_ERR_UNSUPPORTED_ENCAP:
+            case WTAP_ERR_BAD_FILE:
+                fprintf(stderr, "(%s)\n", err_info);
+                g_free(err_info);
+                break;
+            }
+            exit(1);
+        }
+    }
 
     /* Copy, and set length and timestamp from item. */
-    new_phdr = *phdr;
-    new_phdr.len = frame->length;
-    new_phdr.caplen = frame->length;
-    new_phdr.ts = frame->time;
+    /* TODO: remove when wtap_seek_read() will read phdr */
+    phdr.ts = frame->time;
 
     /* Dump frame to outfile */
-    if (!wtap_dump(pdh, &new_phdr, &pseudo_header, buf, &err)) {
-        printf("Error (%s) writing frame to outfile\n", wtap_strerror(err));
+    if (!wtap_dump(pdh, &phdr, buffer_start_ptr(buf), &err)) {
+        fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
+                wtap_strerror(err));
         exit(1);
     }
 }
 
 /* Comparing timestamps between 2 frames.
-   -1 if (t1 < t2)
-   0  if (t1 == t2)
-    if (t1 > t2)
+   negative if (t1 < t2)
+   zero     if (t1 == t2)
+   positive if (t1 > t2)
 */
 static int
 frames_compare(gconstpointer a, gconstpointer b)
 {
-    const FrameRecord_t *frame1 = *(const FrameRecord_t **) a;
-    const FrameRecord_t *frame2 = *(const FrameRecord_t **) b;
-
-    const struct wtap_nstime *time1 = &frame1->time;
-    const struct wtap_nstime *time2 = &frame2->time;
+    const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
+    const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
 
-    if (time1->secs > time2->secs)
-        return 1;
-    if (time1->secs < time2->secs)
-        return -1;
+    const nstime_t *time1 = &frame1->time;
+    const nstime_t *time2 = &frame2->time;
 
-    /* time1->secs == time2->secs */
-    if (time1->nsecs > time2->nsecs)
-        return 1;
-    if (time1->nsecs < time2->nsecs)
-        return -1;
-
-    /* time1->nsecs == time2->nsecs */
+    return nstime_cmp(time1, time2);
+}
 
-    if (frame1->num > frame2->num)
-        return 1;
-    if (frame1->num < frame2->num)
-        return -1;
-    return 0;
+static void
+get_reordercap_compiled_info(GString *str)
+{
+    /* LIBZ */
+    g_string_append(str, ", ");
+#ifdef HAVE_LIBZ
+    g_string_append(str, "with libz ");
+#ifdef ZLIB_VERSION
+    g_string_append(str, ZLIB_VERSION);
+#else /* ZLIB_VERSION */
+    g_string_append(str, "(version unknown)");
+#endif /* ZLIB_VERSION */
+#else /* HAVE_LIBZ */
+    g_string_append(str, "without libz");
+#endif /* HAVE_LIBZ */
 }
 
+static void
+get_reordercap_runtime_info(GString *str)
+{
+    /* zlib */
+#if defined(HAVE_LIBZ) && !defined(_WIN32)
+    g_string_append_printf(str, ", with libz %s", zlibVersion());
+#endif
+}
 
 /********************************************************************/
 /* Main function.                                                   */
 /********************************************************************/
-int main(int argc, char *argv[])
+int
+main(int argc, char *argv[])
 {
+    GString *comp_info_str;
+    GString *runtime_info_str;
     wtap *wth = NULL;
     wtap_dumper *pdh = NULL;
+    Buffer buf;
     int err;
     gchar *err_info;
     gint64 data_offset;
@@ -170,23 +211,58 @@ int main(int argc, char *argv[])
     guint wrong_order_count = 0;
     gboolean write_output_regardless = TRUE;
     guint i;
+    wtapng_section_t            *shb_hdr;
+    wtapng_iface_descriptions_t *idb_inf;
 
     GPtrArray *frames;
     FrameRecord_t *prevFrame = NULL;
 
     int opt;
+    static const struct option long_options[] = {
+        {(char *)"help", no_argument, NULL, 'h'},
+        {(char *)"version", no_argument, NULL, 'v'},
+        {0, 0, 0, 0 }
+    };
     int file_count;
     char *infile;
     char *outfile;
 
+    /* Assemble the compile-time version information string */
+    comp_info_str = g_string_new("Compiled ");
+    get_compiled_version_info(comp_info_str, NULL, get_reordercap_compiled_info);
+
+    /* Assemble the run-time version information string */
+    runtime_info_str = g_string_new("Running ");
+    get_runtime_version_info(runtime_info_str, get_reordercap_runtime_info);
+
+    /* Add it to the information to be reported on a crash. */
+    ws_add_crash_info("Reordercap (Wireshark) %s\n"
+         "\n"
+         "%s"
+         "\n"
+         "%s",
+      get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
+
     /* Process the options first */
-    while ((opt = getopt(argc, argv, "n")) != -1) {
+    while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
         switch (opt) {
             case 'n':
                 write_output_regardless = FALSE;
                 break;
+            case 'h':
+                printf("Reordercap (Wireshark) %s\n"
+                       "Reorder timestamps of input file frames into output file.\n"
+                       "See http://www.wireshark.org for more information.\n",
+                       get_ws_vcs_version_info());
+                print_usage(stdout);
+                exit(0);
+            case 'v':
+                show_version(comp_info_str, runtime_info_str);
+                g_string_free(comp_info_str, TRUE);
+                g_string_free(runtime_info_str, TRUE);
+                exit(0);
             case '?':
-                usage();
+                print_usage(stderr);
                 exit(1);
         }
     }
@@ -194,26 +270,45 @@ int main(int argc, char *argv[])
     /* Remaining args are file names */
     file_count = argc - optind;
     if (file_count == 2) {
-        infile = argv[optind];
+        infile  = argv[optind];
         outfile = argv[optind+1];
     }
     else {
-        usage();
+        print_usage(stderr);
         exit(1);
     }
 
     /* Open infile */
-    wth = wtap_open_offline(infile, &err, &err_info, TRUE);
+    /* TODO: if reordercap is ever changed to give the user a choice of which
+       open_routine reader to use, then the following needs to change. */
+    wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
     if (wth == NULL) {
-        printf("reorder: Can't open %s: %s\n", infile, wtap_strerror(err));
+        fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
+                wtap_strerror(err));
+        switch (err) {
+
+        case WTAP_ERR_UNSUPPORTED:
+        case WTAP_ERR_UNSUPPORTED_ENCAP:
+        case WTAP_ERR_BAD_FILE:
+            fprintf(stderr, "(%s)\n", err_info);
+            g_free(err_info);
+            break;
+        }
         exit(1);
     }
-    DEBUG_PRINT("file_type is %u\n", wtap_file_type(wth));
+    DEBUG_PRINT("file_type_subtype is %u\n", wtap_file_type_subtype(wth));
+
+    shb_hdr = wtap_file_get_shb_info(wth);
+    idb_inf = wtap_file_get_idb_info(wth);
 
     /* Open outfile (same filetype/encap as input file) */
-    pdh = wtap_dump_open(outfile, wtap_file_type(wth), wtap_file_encap(wth), 65535, FALSE, &err);
+    pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
+                            65535, FALSE, shb_hdr, idb_inf, &err);
+    g_free(idb_inf);
     if (pdh == NULL) {
-        printf("Failed to open output file: (%s) - error %s\n", outfile, wtap_strerror(err));
+        fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
+                outfile, wtap_strerror(err));
+        g_free(shb_hdr);
         exit(1);
     }
 
@@ -229,8 +324,11 @@ int main(int argc, char *argv[])
         newFrameRecord = g_slice_new(FrameRecord_t);
         newFrameRecord->num = frames->len + 1;
         newFrameRecord->offset = data_offset;
-        newFrameRecord->length = phdr->len;
-        newFrameRecord->time = phdr->ts;
+        if (phdr->presence_flags & WTAP_HAS_TS) {
+            newFrameRecord->time = phdr->ts;
+        } else {
+            nstime_set_unset(&newFrameRecord->time);
+        }
 
         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
            wrong_order_count++;
@@ -239,6 +337,22 @@ int main(int argc, char *argv[])
         g_ptr_array_add(frames, newFrameRecord);
         prevFrame = newFrameRecord;
     }
+    if (err != 0) {
+      /* Print a message noting that the read failed somewhere along the line. */
+      fprintf(stderr,
+              "reordercap: An error occurred while reading \"%s\": %s.\n",
+              infile, wtap_strerror(err));
+      switch (err) {
+
+      case WTAP_ERR_UNSUPPORTED:
+      case WTAP_ERR_UNSUPPORTED_ENCAP:
+      case WTAP_ERR_BAD_FILE:
+          fprintf(stderr, "(%s)\n", err_info);
+          g_free(err_info);
+          break;
+      }
+    }
+
     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
 
     /* Sort the frames */
@@ -247,15 +361,17 @@ int main(int argc, char *argv[])
     }
 
     /* Write out each sorted frame in turn */
+    buffer_init(&buf, 1500);
     for (i = 0; i < frames->len; i++) {
-        FrameRecord_t *frame = frames->pdata[i];
+        FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
 
         /* Avoid writing if already sorted and configured to */
         if (write_output_regardless || (wrong_order_count > 0)) {
-            frame_write(frame, wth, pdh);
+            frame_write(frame, wth, pdh, &buf, infile);
         }
         g_slice_free(FrameRecord_t, frame);
     }
+    buffer_free(&buf);
 
     if (!write_output_regardless && (wrong_order_count == 0)) {
         printf("Not writing output file because input file is already in order!\n");
@@ -266,9 +382,12 @@ int main(int argc, char *argv[])
 
     /* Close outfile */
     if (!wtap_dump_close(pdh, &err)) {
-        printf("Error closing %s: %s\n", outfile, wtap_strerror(err));
+        fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
+                wtap_strerror(err));
+        g_free(shb_hdr);
         exit(1);
     }
+    g_free(shb_hdr);
 
     /* Finally, close infile */
     wtap_fdclose(wth);
@@ -276,3 +395,15 @@ int main(int argc, char *argv[])
     return 0;
 }
 
+/*
+ * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */