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  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  *
  22  */
  23
  24 #include <config.h>
  25
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <glib.h>
  30
  31 #ifdef HAVE_GETOPT_H
  32 #include <getopt.h>
  33 #endif
  34
  35 #ifdef HAVE_LIBZ
  36 #include <zlib.h>      /* to get the libz version number */
  37 #endif
  38
  39 #include "wtap.h"
  40
  41 #ifndef HAVE_GETOPT_LONG
  42 #include "wsutil/wsgetopt.h"
  43 #endif
  44
  45 #include <wsutil/crash_info.h>
  46 #include <wsutil/file_util.h>
  47 #include <wsutil/ws_diag_control.h>
  48 #include <wsutil/ws_version_info.h>
  49
  50 /* Show command-line usage */
  51 static void
  52 print_usage(FILE *output)
  53 {
  54     fprintf(output, "\n");
  55     fprintf(output, "Usage: reordercap [options] <infile> <outfile>\n");
  56     fprintf(output, "\n");
  57     fprintf(output, "Options:\n");
  58     fprintf(output, "  -n        don't write to output file if the input file is ordered.\n");
  59     fprintf(output, "  -h        display this help and exit.\n");
  60 }
  61
  62 /* Remember where this frame was in the file */
  63 typedef struct FrameRecord_t {
  64     gint64       offset;
  65     guint        num;
  66
  67     nstime_t     frame_time;
  68 } FrameRecord_t;
  69
  70
  71 /**************************************************/
  72 /* Debugging only                                 */
  73
  74 /* Enable this symbol to see debug output */
  75 /* #define REORDER_DEBUG */
  76
  77 #ifdef REORDER_DEBUG
  78 #define DEBUG_PRINT printf
  79 #else
  80 #define DEBUG_PRINT(...)
  81 #endif
  82 /**************************************************/
  83
  84
  85 static void
  86 frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh,
  87             struct wtap_pkthdr *phdr, Buffer *buf, const char *infile)
  88 {
  89     int    err;
  90     gchar  *err_info;
  91
  92     DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
  93                 frame->offset);
  94
  95
  96     /* Re-read the frame from the stored location */
  97     if (!wtap_seek_read(wth, frame->offset, phdr, buf, &err, &err_info)) {
  98         if (err != 0) {
  99             /* Print a message noting that the read failed somewhere along the line. */
 100             fprintf(stderr,
 101                     "reordercap: An error occurred while re-reading \"%s\": %s.\n",
 102                     infile, wtap_strerror(err));
 103             if (err_info != NULL) {
 104                 fprintf(stderr, "(%s)\n", err_info);
 105                 g_free(err_info);
 106             }
 107             exit(1);
 108         }
 109     }
 110
 111     /* Copy, and set length and timestamp from item. */
 112     /* TODO: remove when wtap_seek_read() fills in phdr,
 113        including time stamps, for all file types  */
 114     phdr->ts = frame->frame_time;
 115
 116     /* Dump frame to outfile */
 117     if (!wtap_dump(pdh, phdr, ws_buffer_start_ptr(buf), &err, &err_info)) {
 118         fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
 119                 wtap_strerror(err));
 120         if (err_info != NULL) {
 121             fprintf(stderr, "(%s)\n", err_info);
 122             g_free(err_info);
 123         }
 124         exit(1);
 125     }
 126 }
 127
 128 /* Comparing timestamps between 2 frames.
 129    negative if (t1 < t2)
 130    zero     if (t1 == t2)
 131    positive if (t1 > t2)
 132 */
 133 static int
 134 frames_compare(gconstpointer a, gconstpointer b)
 135 {
 136     const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
 137     const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
 138
 139     const nstime_t *time1 = &frame1->frame_time;
 140     const nstime_t *time2 = &frame2->frame_time;
 141
 142     return nstime_cmp(time1, time2);
 143 }
 144
 145 static void
 146 get_reordercap_compiled_info(GString *str)
 147 {
 148     /* LIBZ */
 149     g_string_append(str, ", ");
 150 #ifdef HAVE_LIBZ
 151     g_string_append(str, "with libz ");
 152 #ifdef ZLIB_VERSION
 153     g_string_append(str, ZLIB_VERSION);
 154 #else /* ZLIB_VERSION */
 155     g_string_append(str, "(version unknown)");
 156 #endif /* ZLIB_VERSION */
 157 #else /* HAVE_LIBZ */
 158     g_string_append(str, "without libz");
 159 #endif /* HAVE_LIBZ */
 160 }
 161
 162 static void
 163 get_reordercap_runtime_info(GString *str)
 164 {
 165     /* zlib */
 166 #if defined(HAVE_LIBZ) && !defined(_WIN32)
 167     g_string_append_printf(str, ", with libz %s", zlibVersion());
 168 #endif
 169 }
 170
 171 /********************************************************************/
 172 /* Main function.                                                   */
 173 /********************************************************************/
 174 int
 175 main(int argc, char *argv[])
 176 {
 177     GString *comp_info_str;
 178     GString *runtime_info_str;
 179     wtap *wth = NULL;
 180     wtap_dumper *pdh = NULL;
 181     struct wtap_pkthdr dump_phdr;
 182     Buffer buf;
 183     int err;
 184     gchar *err_info;
 185     gint64 data_offset;
 186     const struct wtap_pkthdr *phdr;
 187     guint wrong_order_count = 0;
 188     gboolean write_output_regardless = TRUE;
 189     guint i;
 190     wtapng_section_t            *shb_hdr = NULL;
 191     wtapng_iface_descriptions_t *idb_inf = NULL;
 192     wtapng_name_res_t           *nrb_hdr = NULL;
 193
 194     GPtrArray *frames;
 195     FrameRecord_t *prevFrame = NULL;
 196
 197     int opt;
 198 DIAG_OFF(cast-qual)
 199     static const struct option long_options[] = {
 200         {(char *)"help", no_argument, NULL, 'h'},
 201         {(char *)"version", no_argument, NULL, 'v'},
 202         {0, 0, 0, 0 }
 203     };
 204 DIAG_ON(cast-qual)
 205     int file_count;
 206     char *infile;
 207     const char *outfile;
 208
 209     /* Get the compile-time version information string */
 210     comp_info_str = get_compiled_version_info(NULL, get_reordercap_compiled_info);
 211
 212     /* Get the run-time version information string */
 213     runtime_info_str = get_runtime_version_info(get_reordercap_runtime_info);
 214
 215     /* Add it to the information to be reported on a crash. */
 216     ws_add_crash_info("Reordercap (Wireshark) %s\n"
 217          "\n"
 218          "%s"
 219          "\n"
 220          "%s",
 221       get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
 222
 223     /* Process the options first */
 224     while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
 225         switch (opt) {
 226             case 'n':
 227                 write_output_regardless = FALSE;
 228                 break;
 229             case 'h':
 230                 printf("Reordercap (Wireshark) %s\n"
 231                        "Reorder timestamps of input file frames into output file.\n"
 232                        "See https://www.wireshark.org for more information.\n",
 233                        get_ws_vcs_version_info());
 234                 print_usage(stdout);
 235                 exit(0);
 236             case 'v':
 237                 show_version("Reordercap (Wireshark)", comp_info_str, runtime_info_str);
 238                 g_string_free(comp_info_str, TRUE);
 239                 g_string_free(runtime_info_str, TRUE);
 240                 exit(0);
 241             case '?':
 242                 print_usage(stderr);
 243                 exit(1);
 244         }
 245     }
 246
 247     /* Remaining args are file names */
 248     file_count = argc - optind;
 249     if (file_count == 2) {
 250         infile  = argv[optind];
 251         outfile = argv[optind+1];
 252     }
 253     else {
 254         print_usage(stderr);
 255         exit(1);
 256     }
 257
 258     /* Open infile */
 259     /* TODO: if reordercap is ever changed to give the user a choice of which
 260        open_routine reader to use, then the following needs to change. */
 261     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
 262     if (wth == NULL) {
 263         fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
 264                 wtap_strerror(err));
 265         if (err_info != NULL) {
 266             fprintf(stderr, "(%s)\n", err_info);
 267             g_free(err_info);
 268         }
 269         exit(1);
 270     }
 271     DEBUG_PRINT("file_type_subtype is %u\n", wtap_file_type_subtype(wth));
 272
 273     shb_hdr = wtap_file_get_shb_for_new_file(wth);
 274     idb_inf = wtap_file_get_idb_info(wth);
 275     nrb_hdr = wtap_file_get_nrb_for_new_file(wth);
 276
 277     /* Open outfile (same filetype/encap as input file) */
 278     if (strcmp(outfile, "-") == 0) {
 279       pdh = wtap_dump_open_stdout_ng(wtap_file_type_subtype(wth), wtap_file_encap(wth),
 280                                      65535, FALSE, shb_hdr, idb_inf, nrb_hdr, &err);
 281       outfile = "standard output";
 282     } else {
 283       pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
 284                               65535, FALSE, shb_hdr, idb_inf, nrb_hdr, &err);
 285     }
 286     g_free(idb_inf);
 287     idb_inf = NULL;
 288
 289     if (pdh == NULL) {
 290         fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
 291                 outfile, wtap_strerror(err));
 292         wtap_free_shb(shb_hdr);
 293         wtap_free_nrb(nrb_hdr);
 294         exit(1);
 295     }
 296
 297     /* Allocate the array of frame pointers. */
 298     frames = g_ptr_array_new();
 299
 300     /* Read each frame from infile */
 301     while (wtap_read(wth, &err, &err_info, &data_offset)) {
 302         FrameRecord_t *newFrameRecord;
 303
 304         phdr = wtap_phdr(wth);
 305
 306         newFrameRecord = g_slice_new(FrameRecord_t);
 307         newFrameRecord->num = frames->len + 1;
 308         newFrameRecord->offset = data_offset;
 309         if (phdr->presence_flags & WTAP_HAS_TS) {
 310             newFrameRecord->frame_time = phdr->ts;
 311         } else {
 312             nstime_set_unset(&newFrameRecord->frame_time);
 313         }
 314
 315         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
 316            wrong_order_count++;
 317         }
 318
 319         g_ptr_array_add(frames, newFrameRecord);
 320         prevFrame = newFrameRecord;
 321     }
 322     if (err != 0) {
 323       /* Print a message noting that the read failed somewhere along the line. */
 324       fprintf(stderr,
 325               "reordercap: An error occurred while reading \"%s\": %s.\n",
 326               infile, wtap_strerror(err));
 327       if (err_info != NULL) {
 328           fprintf(stderr, "(%s)\n", err_info);
 329           g_free(err_info);
 330       }
 331     }
 332
 333     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
 334
 335     /* Sort the frames */
 336     if (wrong_order_count > 0) {
 337         g_ptr_array_sort(frames, frames_compare);
 338     }
 339
 340     /* Write out each sorted frame in turn */
 341     wtap_phdr_init(&dump_phdr);
 342     ws_buffer_init(&buf, 1500);
 343     for (i = 0; i < frames->len; i++) {
 344         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
 345
 346         /* Avoid writing if already sorted and configured to */
 347         if (write_output_regardless || (wrong_order_count > 0)) {
 348             frame_write(frame, wth, pdh, &dump_phdr, &buf, infile);
 349         }
 350         g_slice_free(FrameRecord_t, frame);
 351     }
 352     wtap_phdr_cleanup(&dump_phdr);
 353     ws_buffer_free(&buf);
 354
 355     if (!write_output_regardless && (wrong_order_count == 0)) {
 356         printf("Not writing output file because input file is already in order!\n");
 357     }
 358
 359     /* Free the whole array */
 360     g_ptr_array_free(frames, TRUE);
 361
 362     /* Close outfile */
 363     if (!wtap_dump_close(pdh, &err)) {
 364         fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
 365                 wtap_strerror(err));
 366         wtap_free_shb(shb_hdr);
 367         wtap_free_nrb(nrb_hdr);
 368         exit(1);
 369     }
 370     wtap_free_shb(shb_hdr);
 371     wtap_free_nrb(nrb_hdr);
 372
 373     /* Finally, close infile */
 374     wtap_fdclose(wth);
 375
 376     return 0;
 377 }
 378
 379 /*
 380  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 381  *
 382  * Local variables:
 383  * c-basic-offset: 4
 384  * tab-width: 8
 385  * indent-tabs-mode: nil
 386  * End:
 387  *
 388  * vi: set shiftwidth=4 tabstop=8 expandtab:
 389  * :indentSize=4:tabSize=8:noTabs=true:
 390  */