1 /* Reorder the frames from an input dump file, and write to output dump file.
2 * Martin Mathieson and Jakub Jawadzki
4 * Wireshark - Network traffic analyzer
5 * By Gerald Combs <gerald@wireshark.org>
6 * Copyright 1998 Gerald Combs
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.
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.
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.
35 #include <wiretap/wtap.h>
37 #ifndef HAVE_GETOPT_LONG
38 #include "wsutil/wsgetopt.h"
41 #include <wsutil/crash_info.h>
42 #include <wsutil/filesystem.h>
43 #include <wsutil/file_util.h>
44 #include <wsutil/privileges.h>
45 #include <ws_version_info.h>
46 #include <wiretap/wtap_opttypes.h>
49 #include <wsutil/plugins.h>
52 #include <wsutil/report_err.h>
54 /* Show command-line usage */
56 print_usage(FILE *output)
58 fprintf(output, "\n");
59 fprintf(output, "Usage: reordercap [options] <infile> <outfile>\n");
60 fprintf(output, "\n");
61 fprintf(output, "Options:\n");
62 fprintf(output, " -n don't write to output file if the input file is ordered.\n");
63 fprintf(output, " -h display this help and exit.\n");
66 /* Remember where this frame was in the file */
67 typedef struct FrameRecord_t {
75 /**************************************************/
78 /* Enable this symbol to see debug output */
79 /* #define REORDER_DEBUG */
82 #define DEBUG_PRINT printf
84 #define DEBUG_PRINT(...)
86 /**************************************************/
90 frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh,
91 struct wtap_pkthdr *phdr, Buffer *buf, const char *infile)
96 DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
100 /* Re-read the frame from the stored location */
101 if (!wtap_seek_read(wth, frame->offset, phdr, buf, &err, &err_info)) {
103 /* Print a message noting that the read failed somewhere along the line. */
105 "reordercap: An error occurred while re-reading \"%s\": %s.\n",
106 infile, wtap_strerror(err));
107 if (err_info != NULL) {
108 fprintf(stderr, "(%s)\n", err_info);
115 /* Copy, and set length and timestamp from item. */
116 /* TODO: remove when wtap_seek_read() fills in phdr,
117 including time stamps, for all file types */
118 phdr->ts = frame->frame_time;
120 /* Dump frame to outfile */
121 if (!wtap_dump(pdh, phdr, ws_buffer_start_ptr(buf), &err, &err_info)) {
122 fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
124 if (err_info != NULL) {
125 fprintf(stderr, "(%s)\n", err_info);
132 /* Comparing timestamps between 2 frames.
133 negative if (t1 < t2)
135 positive if (t1 > t2)
138 frames_compare(gconstpointer a, gconstpointer b)
140 const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
141 const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
143 const nstime_t *time1 = &frame1->frame_time;
144 const nstime_t *time2 = &frame2->frame_time;
146 return nstime_cmp(time1, time2);
151 * General errors are reported with an console message in reordercap.
154 failure_message(const char *msg_format, va_list ap)
156 fprintf(stderr, "reordercap: ");
157 vfprintf(stderr, msg_format, ap);
158 fprintf(stderr, "\n");
162 /********************************************************************/
164 /********************************************************************/
166 main(int argc, char *argv[])
168 GString *comp_info_str;
169 GString *runtime_info_str;
171 wtap_dumper *pdh = NULL;
172 struct wtap_pkthdr dump_phdr;
177 const struct wtap_pkthdr *phdr;
178 guint wrong_order_count = 0;
179 gboolean write_output_regardless = TRUE;
181 GArray *shb_hdrs = NULL;
182 wtapng_iface_descriptions_t *idb_inf = NULL;
183 GArray *nrb_hdrs = NULL;
186 FrameRecord_t *prevFrame = NULL;
189 static const struct option long_options[] = {
190 {"help", no_argument, NULL, 'h'},
191 {"version", no_argument, NULL, 'v'},
199 char *init_progfile_dir_error;
202 /* Get the compile-time version information string */
203 comp_info_str = get_compiled_version_info(NULL, NULL);
205 /* Get the run-time version information string */
206 runtime_info_str = get_runtime_version_info(NULL);
208 /* Add it to the information to be reported on a crash. */
209 ws_add_crash_info("Reordercap (Wireshark) %s\n"
214 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
215 g_string_free(comp_info_str, TRUE);
216 g_string_free(runtime_info_str, TRUE);
219 * Get credential information for later use.
221 init_process_policies();
222 init_open_routines();
225 /* Register wiretap plugins */
226 if ((init_progfile_dir_error = init_progfile_dir(argv[0], main))) {
227 g_warning("reordercap: init_progfile_dir(): %s", init_progfile_dir_error);
228 g_free(init_progfile_dir_error);
230 /* Register all the plugin types we have. */
231 wtap_register_plugin_types(); /* Types known to libwiretap */
233 init_report_err(failure_message,NULL,NULL,NULL);
235 /* Scan for plugins. This does *not* call their registration routines;
238 Don't report failures to load plugins because most (non-wiretap)
239 plugins *should* fail to load (because we're not linked against
240 libwireshark and dissector plugins need libwireshark). */
241 scan_plugins(DONT_REPORT_LOAD_FAILURE);
243 /* Register all libwiretap plugin modules. */
244 register_all_wiretap_modules();
248 /* Process the options first */
249 while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
252 write_output_regardless = FALSE;
255 printf("Reordercap (Wireshark) %s\n"
256 "Reorder timestamps of input file frames into output file.\n"
257 "See https://www.wireshark.org for more information.\n",
258 get_ws_vcs_version_info());
262 comp_info_str = get_compiled_version_info(NULL, NULL);
263 runtime_info_str = get_runtime_version_info(NULL);
264 show_version("Reordercap (Wireshark)", comp_info_str, runtime_info_str);
265 g_string_free(comp_info_str, TRUE);
266 g_string_free(runtime_info_str, TRUE);
274 /* Remaining args are file names */
275 file_count = argc - optind;
276 if (file_count == 2) {
277 infile = argv[optind];
278 outfile = argv[optind+1];
286 /* TODO: if reordercap is ever changed to give the user a choice of which
287 open_routine reader to use, then the following needs to change. */
288 wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
290 fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
292 if (err_info != NULL) {
293 fprintf(stderr, "(%s)\n", err_info);
298 DEBUG_PRINT("file_type_subtype is %d\n", wtap_file_type_subtype(wth));
300 shb_hdrs = wtap_file_get_shb_for_new_file(wth);
301 idb_inf = wtap_file_get_idb_info(wth);
302 nrb_hdrs = wtap_file_get_nrb_for_new_file(wth);
304 /* Open outfile (same filetype/encap as input file) */
305 if (strcmp(outfile, "-") == 0) {
306 pdh = wtap_dump_open_stdout_ng(wtap_file_type_subtype(wth), wtap_file_encap(wth),
307 65535, FALSE, shb_hdrs, idb_inf, nrb_hdrs, &err);
308 outfile = "standard output";
310 pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
311 65535, FALSE, shb_hdrs, idb_inf, nrb_hdrs, &err);
317 fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
318 outfile, wtap_strerror(err));
319 wtap_block_array_free(shb_hdrs);
320 wtap_block_array_free(nrb_hdrs);
324 /* Allocate the array of frame pointers. */
325 frames = g_ptr_array_new();
327 /* Read each frame from infile */
328 while (wtap_read(wth, &err, &err_info, &data_offset)) {
329 FrameRecord_t *newFrameRecord;
331 phdr = wtap_phdr(wth);
333 newFrameRecord = g_slice_new(FrameRecord_t);
334 newFrameRecord->num = frames->len + 1;
335 newFrameRecord->offset = data_offset;
336 if (phdr->presence_flags & WTAP_HAS_TS) {
337 newFrameRecord->frame_time = phdr->ts;
339 nstime_set_unset(&newFrameRecord->frame_time);
342 if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
346 g_ptr_array_add(frames, newFrameRecord);
347 prevFrame = newFrameRecord;
350 /* Print a message noting that the read failed somewhere along the line. */
352 "reordercap: An error occurred while reading \"%s\": %s.\n",
353 infile, wtap_strerror(err));
354 if (err_info != NULL) {
355 fprintf(stderr, "(%s)\n", err_info);
360 printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
362 /* Sort the frames */
363 if (wrong_order_count > 0) {
364 g_ptr_array_sort(frames, frames_compare);
367 /* Write out each sorted frame in turn */
368 wtap_phdr_init(&dump_phdr);
369 ws_buffer_init(&buf, 1500);
370 for (i = 0; i < frames->len; i++) {
371 FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
373 /* Avoid writing if already sorted and configured to */
374 if (write_output_regardless || (wrong_order_count > 0)) {
375 frame_write(frame, wth, pdh, &dump_phdr, &buf, infile);
377 g_slice_free(FrameRecord_t, frame);
379 wtap_phdr_cleanup(&dump_phdr);
380 ws_buffer_free(&buf);
382 if (!write_output_regardless && (wrong_order_count == 0)) {
383 printf("Not writing output file because input file is already in order!\n");
386 /* Free the whole array */
387 g_ptr_array_free(frames, TRUE);
390 if (!wtap_dump_close(pdh, &err)) {
391 fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
393 wtap_block_array_free(shb_hdrs);
394 wtap_block_array_free(nrb_hdrs);
397 wtap_block_array_free(shb_hdrs);
398 wtap_block_array_free(nrb_hdrs);
400 /* Finally, close infile and release resources. */
407 * Editor modelines - http://www.wireshark.org/tools/modelines.html
412 * indent-tabs-mode: nil
415 * vi: set shiftwidth=4 tabstop=8 expandtab:
416 * :indentSize=4:tabSize=8:noTabs=true: