reordercap.c

   1 /* Reorder the frames from an input dump file, and write to output dump file.
   2  * Martin Mathieson and Jakub Jawadzki
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11 #include <config.h>
  12
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <glib.h>
  17
  18 #ifdef HAVE_GETOPT_H
  19 #include <getopt.h>
  20 #endif
  21
  22 #include <wiretap/wtap.h>
  23
  24 #ifndef HAVE_GETOPT_LONG
  25 #include "wsutil/wsgetopt.h"
  26 #endif
  27
  28 #include <wsutil/cmdarg_err.h>
  29 #include <wsutil/crash_info.h>
  30 #include <wsutil/filesystem.h>
  31 #include <wsutil/file_util.h>
  32 #include <wsutil/privileges.h>
  33 #include <version_info.h>
  34 #include <wiretap/wtap_opttypes.h>
  35
  36 #ifdef HAVE_PLUGINS
  37 #include <wsutil/plugins.h>
  38 #endif
  39
  40 #include <wsutil/report_message.h>
  41
  42 #include "ui/failure_message.h"
  43
  44 #define INVALID_OPTION 1
  45 #define OPEN_ERROR 2
  46 #define OUTPUT_FILE_ERROR 1
  47
  48 /* Show command-line usage */
  49 static void
  50 print_usage(FILE *output)
  51 {
  52     fprintf(output, "\n");
  53     fprintf(output, "Usage: reordercap [options] <infile> <outfile>\n");
  54     fprintf(output, "\n");
  55     fprintf(output, "Options:\n");
  56     fprintf(output, "  -n        don't write to output file if the input file is ordered.\n");
  57     fprintf(output, "  -h        display this help and exit.\n");
  58 }
  59
  60 /* Remember where this frame was in the file */
  61 typedef struct FrameRecord_t {
  62     gint64       offset;
  63     guint        num;
  64
  65     nstime_t     frame_time;
  66 } FrameRecord_t;
  67
  68
  69 /**************************************************/
  70 /* Debugging only                                 */
  71
  72 /* Enable this symbol to see debug output */
  73 /* #define REORDER_DEBUG */
  74
  75 #ifdef REORDER_DEBUG
  76 #define DEBUG_PRINT printf
  77 #else
  78 #define DEBUG_PRINT(...)
  79 #endif
  80 /**************************************************/
  81
  82
  83 static void
  84 frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh,
  85             wtap_rec *rec, Buffer *buf, const char *infile,
  86             const char *outfile)
  87 {
  88     int    err;
  89     gchar  *err_info;
  90
  91     DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
  92                 frame->offset);
  93
  94
  95     /* Re-read the frame from the stored location */
  96     if (!wtap_seek_read(wth, frame->offset, rec, buf, &err, &err_info)) {
  97         if (err != 0) {
  98             /* Print a message noting that the read failed somewhere along the line. */
  99             fprintf(stderr,
 100                     "reordercap: An error occurred while re-reading \"%s\".\n",
 101                     infile);
 102             cfile_read_failure_message("reordercap", infile, err, err_info);
 103             exit(1);
 104         }
 105     }
 106
 107     /* Copy, and set length and timestamp from item. */
 108     /* TODO: remove when wtap_seek_read() fills in rec,
 109        including time stamps, for all file types  */
 110     rec->ts = frame->frame_time;
 111
 112     /* Dump frame to outfile */
 113     if (!wtap_dump(pdh, rec, ws_buffer_start_ptr(buf), &err, &err_info)) {
 114         cfile_write_failure_message("reordercap", infile, outfile, err,
 115                                     err_info, frame->num,
 116                                     wtap_file_type_subtype(wth));
 117         exit(1);
 118     }
 119 }
 120
 121 /* Comparing timestamps between 2 frames.
 122    negative if (t1 < t2)
 123    zero     if (t1 == t2)
 124    positive if (t1 > t2)
 125 */
 126 static int
 127 frames_compare(gconstpointer a, gconstpointer b)
 128 {
 129     const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
 130     const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
 131
 132     const nstime_t *time1 = &frame1->frame_time;
 133     const nstime_t *time2 = &frame2->frame_time;
 134
 135     return nstime_cmp(time1, time2);
 136 }
 137
 138 /*
 139  * General errors and warnings are reported with an console message
 140  * in reordercap.
 141  */
 142 static void
 143 failure_warning_message(const char *msg_format, va_list ap)
 144 {
 145     fprintf(stderr, "reordercap: ");
 146     vfprintf(stderr, msg_format, ap);
 147     fprintf(stderr, "\n");
 148 }
 149
 150 /*
 151  * Report additional information for an error in command-line arguments.
 152  */
 153 static void
 154 failure_message_cont(const char *msg_format, va_list ap)
 155 {
 156     vfprintf(stderr, msg_format, ap);
 157     fprintf(stderr, "\n");
 158 }
 159
 160 /********************************************************************/
 161 /* Main function.                                                   */
 162 /********************************************************************/
 163 int
 164 main(int argc, char *argv[])
 165 {
 166     GString *comp_info_str;
 167     GString *runtime_info_str;
 168     char *init_progfile_dir_error;
 169     wtap *wth = NULL;
 170     wtap_dumper *pdh = NULL;
 171     wtap_rec dump_rec;
 172     Buffer buf;
 173     int err;
 174     gchar *err_info;
 175     gint64 data_offset;
 176     const wtap_rec *rec;
 177     guint wrong_order_count = 0;
 178     gboolean write_output_regardless = TRUE;
 179     guint i;
 180     wtap_dump_params params;
 181     int                          ret = EXIT_SUCCESS;
 182
 183     GPtrArray *frames;
 184     FrameRecord_t *prevFrame = NULL;
 185
 186     int opt;
 187     static const struct option long_options[] = {
 188         {"help", no_argument, NULL, 'h'},
 189         {"version", no_argument, NULL, 'v'},
 190         {0, 0, 0, 0 }
 191     };
 192     int file_count;
 193     char *infile;
 194     const char *outfile;
 195
 196     cmdarg_err_init(failure_warning_message, failure_message_cont);
 197
 198     /* Get the compile-time version information string */
 199     comp_info_str = get_compiled_version_info(NULL, NULL);
 200
 201     /* Get the run-time version information string */
 202     runtime_info_str = get_runtime_version_info(NULL);
 203
 204     /* Add it to the information to be reported on a crash. */
 205     ws_add_crash_info("Reordercap (Wireshark) %s\n"
 206          "\n"
 207          "%s"
 208          "\n"
 209          "%s",
 210       get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
 211     g_string_free(comp_info_str, TRUE);
 212     g_string_free(runtime_info_str, TRUE);
 213
 214     /*
 215      * Get credential information for later use.
 216      */
 217     init_process_policies();
 218
 219     /*
 220      * Attempt to get the pathname of the directory containing the
 221      * executable file.
 222      */
 223     init_progfile_dir_error = init_progfile_dir(argv[0]);
 224     if (init_progfile_dir_error != NULL) {
 225         fprintf(stderr,
 226                 "reordercap: Can't get pathname of directory containing the reordercap program: %s.\n",
 227                 init_progfile_dir_error);
 228         g_free(init_progfile_dir_error);
 229     }
 230
 231     init_report_message(failure_warning_message, failure_warning_message,
 232                         NULL, NULL, NULL);
 233
 234     wtap_init(TRUE);
 235
 236     /* Process the options first */
 237     while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
 238         switch (opt) {
 239             case 'n':
 240                 write_output_regardless = FALSE;
 241                 break;
 242             case 'h':
 243                 printf("Reordercap (Wireshark) %s\n"
 244                        "Reorder timestamps of input file frames into output file.\n"
 245                        "See https://www.wireshark.org for more information.\n",
 246                        get_ws_vcs_version_info());
 247                 print_usage(stdout);
 248                 goto clean_exit;
 249             case 'v':
 250                 comp_info_str = get_compiled_version_info(NULL, NULL);
 251                 runtime_info_str = get_runtime_version_info(NULL);
 252                 show_version("Reordercap (Wireshark)", comp_info_str, runtime_info_str);
 253                 g_string_free(comp_info_str, TRUE);
 254                 g_string_free(runtime_info_str, TRUE);
 255                 goto clean_exit;
 256             case '?':
 257                 print_usage(stderr);
 258                 ret = INVALID_OPTION;
 259                 goto clean_exit;
 260         }
 261     }
 262
 263     /* Remaining args are file names */
 264     file_count = argc - optind;
 265     if (file_count == 2) {
 266         infile  = argv[optind];
 267         outfile = argv[optind+1];
 268     }
 269     else {
 270         print_usage(stderr);
 271         ret = INVALID_OPTION;
 272         goto clean_exit;
 273     }
 274
 275     /* Open infile */
 276     /* TODO: if reordercap is ever changed to give the user a choice of which
 277        open_routine reader to use, then the following needs to change. */
 278     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
 279     if (wth == NULL) {
 280         cfile_open_failure_message("reordercap", infile, err, err_info);
 281         ret = OPEN_ERROR;
 282         goto clean_exit;
 283     }
 284     DEBUG_PRINT("file_type_subtype is %d\n", wtap_file_type_subtype(wth));
 285
 286     wtap_dump_params_init(&params, wth);
 287
 288     /* Open outfile (same filetype/encap as input file) */
 289     if (strcmp(outfile, "-") == 0) {
 290       pdh = wtap_dump_open_stdout(wtap_file_type_subtype(wth), FALSE, &params, &err);
 291     } else {
 292       pdh = wtap_dump_open(outfile, wtap_file_type_subtype(wth), FALSE, &params, &err);
 293     }
 294     g_free(params.idb_inf);
 295     params.idb_inf = NULL;
 296
 297     if (pdh == NULL) {
 298         cfile_dump_open_failure_message("reordercap", outfile, err,
 299                                         wtap_file_type_subtype(wth));
 300         wtap_dump_params_cleanup(&params);
 301         ret = OUTPUT_FILE_ERROR;
 302         goto clean_exit;
 303     }
 304
 305     /* Allocate the array of frame pointers. */
 306     frames = g_ptr_array_new();
 307
 308     /* Read each frame from infile */
 309     while (wtap_read(wth, &err, &err_info, &data_offset)) {
 310         FrameRecord_t *newFrameRecord;
 311
 312         rec = wtap_get_rec(wth);
 313
 314         newFrameRecord = g_slice_new(FrameRecord_t);
 315         newFrameRecord->num = frames->len + 1;
 316         newFrameRecord->offset = data_offset;
 317         if (rec->presence_flags & WTAP_HAS_TS) {
 318             newFrameRecord->frame_time = rec->ts;
 319         } else {
 320             nstime_set_unset(&newFrameRecord->frame_time);
 321         }
 322
 323         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
 324            wrong_order_count++;
 325         }
 326
 327         g_ptr_array_add(frames, newFrameRecord);
 328         prevFrame = newFrameRecord;
 329     }
 330     if (err != 0) {
 331       /* Print a message noting that the read failed somewhere along the line. */
 332       cfile_read_failure_message("reordercap", infile, err, err_info);
 333     }
 334
 335     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
 336
 337     /* Sort the frames */
 338     if (wrong_order_count > 0) {
 339         g_ptr_array_sort(frames, frames_compare);
 340     }
 341
 342     /* Write out each sorted frame in turn */
 343     wtap_rec_init(&dump_rec);
 344     ws_buffer_init(&buf, 1500);
 345     for (i = 0; i < frames->len; i++) {
 346         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
 347
 348         /* Avoid writing if already sorted and configured to */
 349         if (write_output_regardless || (wrong_order_count > 0)) {
 350             frame_write(frame, wth, pdh, &dump_rec, &buf, infile, outfile);
 351         }
 352         g_slice_free(FrameRecord_t, frame);
 353     }
 354     wtap_rec_cleanup(&dump_rec);
 355     ws_buffer_free(&buf);
 356
 357     if (!write_output_regardless && (wrong_order_count == 0)) {
 358         printf("Not writing output file because input file is already in order.\n");
 359     }
 360
 361     /* Free the whole array */
 362     g_ptr_array_free(frames, TRUE);
 363
 364     /* Close outfile */
 365     if (!wtap_dump_close(pdh, &err)) {
 366         cfile_close_failure_message(outfile, err);
 367         wtap_dump_params_cleanup(&params);
 368         ret = OUTPUT_FILE_ERROR;
 369         goto clean_exit;
 370     }
 371     wtap_dump_params_cleanup(&params);
 372
 373     /* Finally, close infile and release resources. */
 374     wtap_close(wth);
 375
 376 clean_exit:
 377     wtap_cleanup();
 378     free_progdirs();
 379     return ret;
 380 }
 381
 382 /*
 383  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 384  *
 385  * Local variables:
 386  * c-basic-offset: 4
 387  * tab-width: 8
 388  * indent-tabs-mode: nil
 389  * End:
 390  *
 391  * vi: set shiftwidth=4 tabstop=8 expandtab:
 392  * :indentSize=4:tabSize=8:noTabs=true:
 393  */