Revert "sq h2"
[metze/wireshark/wip.git] / 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 <ui/cmdarg_err.h>
29 #include <wsutil/filesystem.h>
30 #include <wsutil/file_util.h>
31 #include <wsutil/privileges.h>
32 #include <cli_main.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     char *init_progfile_dir_error;
167     wtap *wth = NULL;
168     wtap_dumper *pdh = NULL;
169     wtap_rec dump_rec;
170     Buffer buf;
171     int err;
172     gchar *err_info;
173     gint64 data_offset;
174     const wtap_rec *rec;
175     guint wrong_order_count = 0;
176     gboolean write_output_regardless = TRUE;
177     guint i;
178     wtap_dump_params params;
179     int                          ret = EXIT_SUCCESS;
180
181     GPtrArray *frames;
182     FrameRecord_t *prevFrame = NULL;
183
184     int opt;
185     static const struct option long_options[] = {
186         {"help", no_argument, NULL, 'h'},
187         {"version", no_argument, NULL, 'v'},
188         {0, 0, 0, 0 }
189     };
190     int file_count;
191     char *infile;
192     const char *outfile;
193
194     cmdarg_err_init(failure_warning_message, failure_message_cont);
195
196     /* Initialize the version information. */
197     ws_init_version_info("Reordercap (Wireshark)", NULL, NULL, NULL);
198
199     /*
200      * Get credential information for later use.
201      */
202     init_process_policies();
203
204     /*
205      * Attempt to get the pathname of the directory containing the
206      * executable file.
207      */
208     init_progfile_dir_error = init_progfile_dir(argv[0]);
209     if (init_progfile_dir_error != NULL) {
210         fprintf(stderr,
211                 "reordercap: Can't get pathname of directory containing the reordercap program: %s.\n",
212                 init_progfile_dir_error);
213         g_free(init_progfile_dir_error);
214     }
215
216     init_report_message(failure_warning_message, failure_warning_message,
217                         NULL, NULL, NULL);
218
219     wtap_init(TRUE);
220
221     /* Process the options first */
222     while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
223         switch (opt) {
224             case 'n':
225                 write_output_regardless = FALSE;
226                 break;
227             case 'h':
228                 show_help_header("Reorder timestamps of input file frames into output file.");
229                 print_usage(stdout);
230                 goto clean_exit;
231             case 'v':
232                 show_version();
233                 goto clean_exit;
234             case '?':
235                 print_usage(stderr);
236                 ret = INVALID_OPTION;
237                 goto clean_exit;
238         }
239     }
240
241     /* Remaining args are file names */
242     file_count = argc - optind;
243     if (file_count == 2) {
244         infile  = argv[optind];
245         outfile = argv[optind+1];
246     }
247     else {
248         print_usage(stderr);
249         ret = INVALID_OPTION;
250         goto clean_exit;
251     }
252
253     /* Open infile */
254     /* TODO: if reordercap is ever changed to give the user a choice of which
255        open_routine reader to use, then the following needs to change. */
256     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
257     if (wth == NULL) {
258         cfile_open_failure_message("reordercap", infile, err, err_info);
259         ret = OPEN_ERROR;
260         goto clean_exit;
261     }
262     DEBUG_PRINT("file_type_subtype is %d\n", wtap_file_type_subtype(wth));
263
264     wtap_dump_params_init(&params, wth);
265
266     /* Open outfile (same filetype/encap as input file) */
267     if (strcmp(outfile, "-") == 0) {
268       pdh = wtap_dump_open_stdout(wtap_file_type_subtype(wth), WTAP_UNCOMPRESSED, &params, &err);
269     } else {
270       pdh = wtap_dump_open(outfile, wtap_file_type_subtype(wth), WTAP_UNCOMPRESSED, &params, &err);
271     }
272     g_free(params.idb_inf);
273     params.idb_inf = NULL;
274
275     if (pdh == NULL) {
276         cfile_dump_open_failure_message("reordercap", outfile, err,
277                                         wtap_file_type_subtype(wth));
278         wtap_dump_params_cleanup(&params);
279         ret = OUTPUT_FILE_ERROR;
280         goto clean_exit;
281     }
282
283     /* Allocate the array of frame pointers. */
284     frames = g_ptr_array_new();
285
286     /* Read each frame from infile */
287     while (wtap_read(wth, &err, &err_info, &data_offset)) {
288         FrameRecord_t *newFrameRecord;
289
290         rec = wtap_get_rec(wth);
291
292         newFrameRecord = g_slice_new(FrameRecord_t);
293         newFrameRecord->num = frames->len + 1;
294         newFrameRecord->offset = data_offset;
295         if (rec->presence_flags & WTAP_HAS_TS) {
296             newFrameRecord->frame_time = rec->ts;
297         } else {
298             nstime_set_unset(&newFrameRecord->frame_time);
299         }
300
301         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
302            wrong_order_count++;
303         }
304
305         g_ptr_array_add(frames, newFrameRecord);
306         prevFrame = newFrameRecord;
307     }
308     if (err != 0) {
309       /* Print a message noting that the read failed somewhere along the line. */
310       cfile_read_failure_message("reordercap", infile, err, err_info);
311     }
312
313     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
314
315     /* Sort the frames */
316     if (wrong_order_count > 0) {
317         g_ptr_array_sort(frames, frames_compare);
318     }
319
320     /* Write out each sorted frame in turn */
321     wtap_rec_init(&dump_rec);
322     ws_buffer_init(&buf, 1500);
323     for (i = 0; i < frames->len; i++) {
324         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
325
326         /* Avoid writing if already sorted and configured to */
327         if (write_output_regardless || (wrong_order_count > 0)) {
328             frame_write(frame, wth, pdh, &dump_rec, &buf, infile, outfile);
329         }
330         g_slice_free(FrameRecord_t, frame);
331     }
332     wtap_rec_cleanup(&dump_rec);
333     ws_buffer_free(&buf);
334
335     if (!write_output_regardless && (wrong_order_count == 0)) {
336         printf("Not writing output file because input file is already in order.\n");
337     }
338
339     /* Free the whole array */
340     g_ptr_array_free(frames, TRUE);
341
342     /* Close outfile */
343     if (!wtap_dump_close(pdh, &err)) {
344         cfile_close_failure_message(outfile, err);
345         wtap_dump_params_cleanup(&params);
346         ret = OUTPUT_FILE_ERROR;
347         goto clean_exit;
348     }
349     wtap_dump_params_cleanup(&params);
350
351     /* Finally, close infile and release resources. */
352     wtap_close(wth);
353
354 clean_exit:
355     wtap_cleanup();
356     free_progdirs();
357     return ret;
358 }
359
360 /*
361  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
362  *
363  * Local variables:
364  * c-basic-offset: 4
365  * tab-width: 8
366  * indent-tabs-mode: nil
367  * End:
368  *
369  * vi: set shiftwidth=4 tabstop=8 expandtab:
370  * :indentSize=4:tabSize=8:noTabs=true:
371  */