wmem: allow wmem_destroy_list to ignore a NULL list.
[metze/wireshark/wip.git] / reordercap.c
index c206e31e84a693509fa45edd222dfe6b3847e741..7f3463d89bd66f04ab2ebffb85e2c56f09a6d4e8 100644 (file)
@@ -1,63 +1,70 @@
 /* Reorder the frames from an input dump file, and write to output dump file.
- * Martin Mathieson
- *
- * $Id$
+ * Martin Mathieson and Jakub Jawadzki
  *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
- *
+ * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
+#include <config.h>
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <glib.h>
+
+#ifdef HAVE_GETOPT_H
+#include <getopt.h>
+#endif
+
+#include <wiretap/wtap.h>
+
+#ifndef HAVE_GETOPT_LONG
+#include "wsutil/wsgetopt.h"
+#endif
+
+#include <ui/cmdarg_err.h>
+#include <wsutil/filesystem.h>
+#include <wsutil/file_util.h>
+#include <wsutil/privileges.h>
+#include <cli_main.h>
+#include <version_info.h>
+#include <wiretap/wtap_opttypes.h>
 
-#include "wtap.h"
+#ifdef HAVE_PLUGINS
+#include <wsutil/plugins.h>
+#endif
 
+#include <wsutil/report_message.h>
+
+#include "ui/failure_message.h"
+
+#define INVALID_OPTION 1
+#define OPEN_ERROR 2
+#define OUTPUT_FILE_ERROR 1
 
 /* Show command-line usage */
-/* TODO: add reoder list length as an optional param? */
-static void usage(void)
+static void
+print_usage(FILE *output)
 {
-    printf("usage:  reordercap <infile> <outfile>\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;
-
-    struct wtap_nstime   time;
+    gint64       offset;
+    guint        num;
 
-    /* List item pointers */
-    struct FrameRecord_t *prev;
-    struct FrameRecord_t *next;
+    nstime_t     frame_time;
 } FrameRecord_t;
 
-/* This is pretty big, but I don't mind waiting a few seconds */
-#define MAX_REORDER_LIST_LENGTH 3000
-static unsigned int g_FrameRecordCount;
-
-/* This is the list of frames, sorted by time.  Later frames at the front, earlier
-   ones at the end */
-static FrameRecord_t *g_FrameListHead;
-static FrameRecord_t *g_FrameListTail;
-
 
 /**************************************************/
 /* Debugging only                                 */
@@ -65,294 +72,300 @@ static FrameRecord_t *g_FrameListTail;
 /* Enable this symbol to see debug output */
 /* #define REORDER_DEBUG */
 
-#ifdef REORDER_DEBUG
-static void ReorderListDebugPrint(void)
-{
-    int count=0;
-    FrameRecord_t *tmp = g_FrameListHead;
-    printf("\n");
-    while (tmp != NULL) {
-        printf("%6d: offset=%6" G_GINT64_MODIFIER "u, length=%6u, time=%lu:%u",
-               ++count, tmp->offset, tmp->length, tmp->time.secs, tmp->time.nsecs);
-
-        if (tmp == g_FrameListHead) {
-            printf(" (head)");
-        }
-        if (tmp == g_FrameListTail) {
-            printf(" (tail)\n");
-        }
-        printf("\n");
-
-        tmp = tmp->next;
-    }
-    printf("\n");
-}
-#else
-#define ReorderListDebugPrint()
-#endif
-
 #ifdef REORDER_DEBUG
 #define DEBUG_PRINT printf
 #else
 #define DEBUG_PRINT(...)
 #endif
-
 /**************************************************/
 
-/* Counting frames that weren't in order */
-static unsigned int g_OutOfOrder = 0;
-
-
-/* Is time1 later than time2? */
-static gboolean isLaterTime(struct wtap_nstime time1,
-                            struct wtap_nstime time2)
-{
-    if (time1.secs > time2.secs) {
-        return TRUE;
-    }
-    if (time1.secs == time2.secs) {
-        return (time1.nsecs > time2.nsecs);
-    }
-    else {
-        return FALSE;
-    }
-}
-
-/* Is the reorder list empty? */
-static gboolean ReorderListEmpty(void)
-{
-    return (g_FrameRecordCount == 0);
-}
 
-/* Is the reorder list full? */
-static gboolean ReorderListFull(void)
+static void
+frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh,
+            wtap_rec *rec, Buffer *buf, const char *infile,
+            const char *outfile)
 {
-    return (g_FrameRecordCount >= MAX_REORDER_LIST_LENGTH);
-}
-
-/* Add a new frame to the reorder list */
-/* Adding later ones to the front */
-static void ReorderListAdd(gint64 offset, guint32 length,
-                           struct wtap_nstime time)
-{
-    FrameRecord_t *tmp;
-    FrameRecord_t *newFrameRecord = g_malloc(sizeof(FrameRecord_t));
-
-    /* Populate fields */
-    DEBUG_PRINT("\nAdded with offset=%06" G_GINT64_MODIFIER "u, length=%05u, secs=%lu, nsecs=%d\n",
-                offset, length, time.secs, time.nsecs);
-    newFrameRecord->offset = offset;
-    newFrameRecord->length = length;
-    newFrameRecord->time = time;
-
-    /* We will definitely add it below, so inc counter */
-    g_FrameRecordCount++;
-
-    /* First time, this will be the head */
-    if (g_FrameListHead == NULL) {
-        DEBUG_PRINT("this item will be head - only item\n");
-        g_FrameListHead = newFrameRecord;
-        newFrameRecord->prev = NULL;
-        newFrameRecord->next = NULL;
-        g_FrameListTail = newFrameRecord;
-        return;
-    }
-
-    /* Look for the place in the list where this item fits */
-    tmp = g_FrameListHead;
-    while (tmp != NULL) {
-        if (isLaterTime(time, tmp->time)) {
-            DEBUG_PRINT("Time was Later, writing before element\n");
-
-            /* Insert newFrameRecord *before* tmp */
-
-            /* Fix up prev item */
-            if (tmp == g_FrameListHead) {
-                /* Inserting before existing head */
-                g_FrameListHead = newFrameRecord;
-            }
-            else {
-                /* Our prev is tmps old prev */
-                newFrameRecord->prev = tmp->prev;
-                /* Its next points to us */
-                newFrameRecord->prev->next = newFrameRecord;
-
-                /* Inserted after another item */
-                DEBUG_PRINT("*** Inc out out of order count\n");
-                g_OutOfOrder++;
-            }
-
-            /* Fix up next item */
-            newFrameRecord->next = tmp;
-            tmp->prev = newFrameRecord;
-
-            return;
-        }
-
-        /* Didn't find an item to insert in front of */
-        if (tmp->next == NULL) {
-            DEBUG_PRINT("Reached the end of the list, so insert here\n");
+    int    err;
+    gchar  *err_info;
 
-            /* We are the new last item */
-            tmp->next = newFrameRecord;
-            newFrameRecord->prev = tmp;
-            newFrameRecord->next = NULL;
-            g_FrameListTail = newFrameRecord;
+    DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
+                frame->offset);
 
-            /* There were other items but we were earlier than them */
-            DEBUG_PRINT("*** Inc out out of order count\n");
-            g_OutOfOrder++;
 
-            return;
-        }
-        else {
-            /* Move onto the next item */
-            DEBUG_PRINT("Time was earlier, move to next position\n");
-            tmp = tmp->next;
+    /* Re-read the frame from the stored location */
+    if (!wtap_seek_read(wth, frame->offset, rec, 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\".\n",
+                    infile);
+            cfile_read_failure_message("reordercap", infile, err, err_info);
+            exit(1);
         }
     }
-}
-
-/* Dump the earliest item in the reorder list to the output file, and pop it */
-static void ReorderListDumpEarliest(wtap *wth, wtap_dumper *pdh)
-{
-    union wtap_pseudo_header pseudo_header;
-    int    err;
-    gchar  *errinfo;
-    const struct wtap_pkthdr *phdr;
-    guint8 buf[16000];
-    struct wtap_pkthdr new_phdr;
-
-    FrameRecord_t *prev_tail = g_FrameListTail;
-
-    DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u, length=%u) (%u items in list)\n", 
-                g_FrameListHead->offset, g_FrameListHead->length,
-                g_FrameRecordCount);
-
-    /* Re-read the first frame from the stored location */
-    wtap_seek_read(wth,
-                   g_FrameListTail->offset,
-                   &pseudo_header,
-                   buf,
-                   g_FrameListTail->length,
-                   &err,
-                   &errinfo);
-    DEBUG_PRINT("re-read: err is %d, buf is (%s)\n", err, buf);
-
-    /* Get packet header */
-    phdr = wtap_phdr(wth);
 
     /* Copy, and set length and timestamp from item. */
-    memcpy((void*)&new_phdr, phdr, sizeof(struct wtap_pkthdr));
-    new_phdr.len = g_FrameListTail->length;
-    new_phdr.ts.secs = g_FrameListTail->time.secs;
-    new_phdr.ts.nsecs = g_FrameListTail->time.nsecs;
+    /* TODO: remove when wtap_seek_read() fills in rec,
+       including time stamps, for all file types  */
+    rec->ts = frame->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, rec, ws_buffer_start_ptr(buf), &err, &err_info)) {
+        cfile_write_failure_message("reordercap", infile, outfile, err,
+                                    err_info, frame->num,
+                                    wtap_file_type_subtype(wth));
         exit(1);
     }
+}
 
-    /* Now remove this (the last/earliest) item from the list */
-    if (g_FrameListTail->prev == NULL) {
-        g_FrameListTail = NULL;
-        g_FrameListHead = NULL;
-    }
-    else {
-        /* 2nd last item is now last */
-        g_FrameListTail->prev->next = NULL;
-        g_FrameListTail = g_FrameListTail->prev;
-    }
+/* Comparing timestamps between 2 frames.
+   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 *const *) a;
+    const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
 
-    /* And free the struct */
-    g_free(prev_tail);
-    g_FrameRecordCount--;
+    const nstime_t *time1 = &frame1->frame_time;
+    const nstime_t *time2 = &frame2->frame_time;
 
-    DEBUG_PRINT("Frame written, %u remaining\n", g_FrameRecordCount);
+    return nstime_cmp(time1, time2);
 }
 
+/*
+ * General errors and warnings are reported with an console message
+ * in reordercap.
+ */
+static void
+failure_warning_message(const char *msg_format, va_list ap)
+{
+    fprintf(stderr, "reordercap: ");
+    vfprintf(stderr, msg_format, ap);
+    fprintf(stderr, "\n");
+}
 
+/*
+ * Report additional information for an error in command-line arguments.
+ */
+static void
+failure_message_cont(const char *msg_format, va_list ap)
+{
+    vfprintf(stderr, msg_format, ap);
+    fprintf(stderr, "\n");
+}
 
 /********************************************************************/
 /* Main function.                                                   */
 /********************************************************************/
-int main(int argc, char *argv[])
+int
+main(int argc, char *argv[])
 {
+    char *init_progfile_dir_error;
     wtap *wth = NULL;
     wtap_dumper *pdh = NULL;
+    wtap_rec dump_rec;
+    Buffer buf;
     int err;
     gchar *err_info;
     gint64 data_offset;
-    const struct wtap_pkthdr *phdr;
-    guint32 read_count = 0;
-
-    /* 1st arg is infile, 2nd arg is outfile */
+    const wtap_rec *rec;
+    guint wrong_order_count = 0;
+    gboolean write_output_regardless = TRUE;
+    guint i;
+    wtap_dump_params params;
+    int                          ret = EXIT_SUCCESS;
+
+    GPtrArray *frames;
+    FrameRecord_t *prevFrame = NULL;
+
+    int opt;
+    static const struct option long_options[] = {
+        {"help", no_argument, NULL, 'h'},
+        {"version", no_argument, NULL, 'v'},
+        {0, 0, 0, 0 }
+    };
+    int file_count;
     char *infile;
-    char *outfile;
-    if (argc == 3) {
-        infile = argv[1];
-        outfile = argv[2];
+    const char *outfile;
+
+    cmdarg_err_init(failure_warning_message, failure_message_cont);
+
+    /* Initialize the version information. */
+    ws_init_version_info("Reordercap (Wireshark)", NULL, NULL, NULL);
+
+    /*
+     * Get credential information for later use.
+     */
+    init_process_policies();
+
+    /*
+     * Attempt to get the pathname of the directory containing the
+     * executable file.
+     */
+    init_progfile_dir_error = init_progfile_dir(argv[0]);
+    if (init_progfile_dir_error != NULL) {
+        fprintf(stderr,
+                "reordercap: Can't get pathname of directory containing the reordercap program: %s.\n",
+                init_progfile_dir_error);
+        g_free(init_progfile_dir_error);
+    }
+
+    init_report_message(failure_warning_message, failure_warning_message,
+                        NULL, NULL, NULL);
+
+    wtap_init(TRUE);
+
+    /* Process the options first */
+    while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
+        switch (opt) {
+            case 'n':
+                write_output_regardless = FALSE;
+                break;
+            case 'h':
+                show_help_header("Reorder timestamps of input file frames into output file.");
+                print_usage(stdout);
+                goto clean_exit;
+            case 'v':
+                show_version();
+                goto clean_exit;
+            case '?':
+                print_usage(stderr);
+                ret = INVALID_OPTION;
+                goto clean_exit;
+        }
+    }
+
+    /* Remaining args are file names */
+    file_count = argc - optind;
+    if (file_count == 2) {
+        infile  = argv[optind];
+        outfile = argv[optind+1];
     }
     else {
-        usage();
-        exit(1);
+        print_usage(stderr);
+        ret = INVALID_OPTION;
+        goto clean_exit;
     }
 
     /* 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));
-        exit(1);
+        cfile_open_failure_message("reordercap", infile, err, err_info);
+        ret = OPEN_ERROR;
+        goto clean_exit;
     }
+    DEBUG_PRINT("file_type_subtype is %d\n", wtap_file_type_subtype(wth));
 
-    DEBUG_PRINT("file_type is %u\n", wtap_file_type(wth));
+    wtap_dump_params_init(&params, 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);
+    if (strcmp(outfile, "-") == 0) {
+      pdh = wtap_dump_open_stdout(wtap_file_type_subtype(wth), WTAP_UNCOMPRESSED, &params, &err);
+    } else {
+      pdh = wtap_dump_open(outfile, wtap_file_type_subtype(wth), WTAP_UNCOMPRESSED, &params, &err);
+    }
+    g_free(params.idb_inf);
+    params.idb_inf = NULL;
+
     if (pdh == NULL) {
-        printf("Failed to open output file: (%s) - error %s\n", outfile, wtap_strerror(err));
-        exit(1);
+        cfile_dump_open_failure_message("reordercap", outfile, err,
+                                        wtap_file_type_subtype(wth));
+        wtap_dump_params_cleanup(&params);
+        ret = OUTPUT_FILE_ERROR;
+        goto clean_exit;
     }
 
+    /* Allocate the array of frame pointers. */
+    frames = g_ptr_array_new();
 
     /* Read each frame from infile */
     while (wtap_read(wth, &err, &err_info, &data_offset)) {
-        read_count++;
-        phdr = wtap_phdr(wth);
+        FrameRecord_t *newFrameRecord;
+
+        rec = wtap_get_rec(wth);
+
+        newFrameRecord = g_slice_new(FrameRecord_t);
+        newFrameRecord->num = frames->len + 1;
+        newFrameRecord->offset = data_offset;
+        if (rec->presence_flags & WTAP_HAS_TS) {
+            newFrameRecord->frame_time = rec->ts;
+        } else {
+            nstime_set_unset(&newFrameRecord->frame_time);
+        }
+
+        if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
+           wrong_order_count++;
+        }
 
-        /* Add it to the reordering list */
-        ReorderListAdd(data_offset, phdr->len, phdr->ts);
-        ReorderListDebugPrint();
+        g_ptr_array_add(frames, newFrameRecord);
+        prevFrame = newFrameRecord;
+    }
+    if (err != 0) {
+      /* Print a message noting that the read failed somewhere along the line. */
+      cfile_read_failure_message("reordercap", infile, err, err_info);
+    }
+
+    printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
 
-        /* If/when the list gets full, dump the earliest item out */
-        if (ReorderListFull()) {
-            DEBUG_PRINT("List is full, dumping earliest!\n");
+    /* Sort the frames */
+    if (wrong_order_count > 0) {
+        g_ptr_array_sort(frames, frames_compare);
+    }
+
+    /* Write out each sorted frame in turn */
+    wtap_rec_init(&dump_rec);
+    ws_buffer_init(&buf, 1500);
+    for (i = 0; i < frames->len; i++) {
+        FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
 
-            /* Write out the earliest one */
-            ReorderListDumpEarliest(wth, pdh);
-            ReorderListDebugPrint();
+        /* Avoid writing if already sorted and configured to */
+        if (write_output_regardless || (wrong_order_count > 0)) {
+            frame_write(frame, wth, pdh, &dump_rec, &buf, infile, outfile);
         }
+        g_slice_free(FrameRecord_t, frame);
     }
+    wtap_rec_cleanup(&dump_rec);
+    ws_buffer_free(&buf);
 
-    /* Flush out the remaining (ordered) frames */
-    while (!ReorderListEmpty()) {
-        ReorderListDumpEarliest(wth, pdh);
-        ReorderListDebugPrint();
+    if (!write_output_regardless && (wrong_order_count == 0)) {
+        printf("Not writing output file because input file is already in order.\n");
     }
 
+    /* Free the whole array */
+    g_ptr_array_free(frames, TRUE);
+
     /* Close outfile */
     if (!wtap_dump_close(pdh, &err)) {
-        printf("Error closing %s: %s\n", outfile, wtap_strerror(err));
-        exit(1);
+        cfile_close_failure_message(outfile, err);
+        wtap_dump_params_cleanup(&params);
+        ret = OUTPUT_FILE_ERROR;
+        goto clean_exit;
     }
+    wtap_dump_params_cleanup(&params);
 
-    /* Write how many frames, and how many were out of order */
-    printf("%u frames, %u out of order\n", read_count, g_OutOfOrder);
-
-    /* Finally, close infile */
-    wtap_fdclose(wth);
+    /* Finally, close infile and release resources. */
+    wtap_close(wth);
 
-    return 0;
+clean_exit:
+    wtap_cleanup();
+    free_progdirs();
+    return ret;
 }
 
+/*
+ * 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:
+ */