Add command-line argument to request the version to a number of the utilities.
[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  * 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_UNISTD_H
32 #include <unistd.h>
33 #endif
34
35 #include "wtap.h"
36
37 #ifndef HAVE_GETOPT
38 #include "wsutil/wsgetopt.h"
39 #endif
40
41 #include "version.h"
42
43 static void
44 print_version(FILE *output)
45 {
46   fprintf(output, "Reordercap %s"
47 #ifdef GITVERSION
48       " (" GITVERSION " from " GITBRANCH ")"
49 #endif
50       "\n", VERSION);
51 }
52
53 /* Show command-line usage */
54 static void
55 usage(gboolean is_error)
56 {
57     FILE *output;
58
59     if (!is_error) {
60         output = stdout;
61     }
62     else {
63         output = stderr;
64     }
65
66     print_version(output);
67     fprintf(output, "Reorder timestamps of input file frames into output file.\n");
68     fprintf(output, "See http://www.wireshark.org for more information.\n");
69     fprintf(output, "\n");
70     fprintf(output, "Usage: reordercap [options] <infile> <outfile>\n");
71     fprintf(output, "\n");
72     fprintf(output, "Options:\n");
73     fprintf(output, "  -n        don't write to output file if the input file is ordered.\n");
74     fprintf(output, "  -h        display this help and exit.\n");
75 }
76
77 /* Remember where this frame was in the file */
78 typedef struct FrameRecord_t {
79     gint64       offset;
80     guint        num;
81
82     nstime_t     time;
83 } FrameRecord_t;
84
85
86 /**************************************************/
87 /* Debugging only                                 */
88
89 /* Enable this symbol to see debug output */
90 /* #define REORDER_DEBUG */
91
92 #ifdef REORDER_DEBUG
93 #define DEBUG_PRINT printf
94 #else
95 #define DEBUG_PRINT(...)
96 #endif
97 /**************************************************/
98
99
100 static void
101 frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh, Buffer *buf,
102             const char *infile)
103 {
104     int    err;
105     gchar  *err_info;
106     struct wtap_pkthdr phdr;
107
108     memset(&phdr, 0, sizeof(struct wtap_pkthdr));
109
110     DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
111                 frame->offset);
112
113
114     /* Re-read the first frame from the stored location */
115     if (!wtap_seek_read(wth, frame->offset, &phdr, buf, &err, &err_info)) {
116         if (err != 0) {
117             /* Print a message noting that the read failed somewhere along the line. */
118             fprintf(stderr,
119                     "reordercap: An error occurred while re-reading \"%s\": %s.\n",
120                     infile, wtap_strerror(err));
121             switch (err) {
122
123             case WTAP_ERR_UNSUPPORTED:
124             case WTAP_ERR_UNSUPPORTED_ENCAP:
125             case WTAP_ERR_BAD_FILE:
126                 fprintf(stderr, "(%s)\n", err_info);
127                 g_free(err_info);
128                 break;
129             }
130             exit(1);
131         }
132     }
133
134     /* Copy, and set length and timestamp from item. */
135     /* TODO: remove when wtap_seek_read() will read phdr */
136     phdr.ts = frame->time;
137
138     /* Dump frame to outfile */
139     if (!wtap_dump(pdh, &phdr, buffer_start_ptr(buf), &err)) {
140         fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
141                 wtap_strerror(err));
142         exit(1);
143     }
144 }
145
146 /* Comparing timestamps between 2 frames.
147    negative if (t1 < t2)
148    zero     if (t1 == t2)
149    positive if (t1 > t2)
150 */
151 static int
152 frames_compare(gconstpointer a, gconstpointer b)
153 {
154     const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
155     const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
156
157     const nstime_t *time1 = &frame1->time;
158     const nstime_t *time2 = &frame2->time;
159
160     return nstime_cmp(time1, time2);
161 }
162
163
164 /********************************************************************/
165 /* Main function.                                                   */
166 /********************************************************************/
167 int
168 main(int argc, char *argv[])
169 {
170     wtap *wth = NULL;
171     wtap_dumper *pdh = NULL;
172     Buffer buf;
173     int err;
174     gchar *err_info;
175     gint64 data_offset;
176     const struct wtap_pkthdr *phdr;
177     guint wrong_order_count = 0;
178     gboolean write_output_regardless = TRUE;
179     guint i;
180     wtapng_section_t            *shb_hdr;
181     wtapng_iface_descriptions_t *idb_inf;
182
183     GPtrArray *frames;
184     FrameRecord_t *prevFrame = NULL;
185
186     int opt;
187     int file_count;
188     char *infile;
189     char *outfile;
190
191     /* Process the options first */
192     while ((opt = getopt(argc, argv, "hnv")) != -1) {
193         switch (opt) {
194             case 'n':
195                 write_output_regardless = FALSE;
196                 break;
197             case 'h':
198                 usage(FALSE);
199                 exit(0);
200             case 'v':
201                 print_version(stdout);
202                 exit(0);
203             case '?':
204                 usage(TRUE);
205                 exit(1);
206         }
207     }
208
209     /* Remaining args are file names */
210     file_count = argc - optind;
211     if (file_count == 2) {
212         infile  = argv[optind];
213         outfile = argv[optind+1];
214     }
215     else {
216         usage(TRUE);
217         exit(1);
218     }
219
220     /* Open infile */
221     /* TODO: if reordercap is ever changed to give the user a choice of which
222        open_routine reader to use, then the following needs to change. */
223     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
224     if (wth == NULL) {
225         fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
226                 wtap_strerror(err));
227         switch (err) {
228
229         case WTAP_ERR_UNSUPPORTED:
230         case WTAP_ERR_UNSUPPORTED_ENCAP:
231         case WTAP_ERR_BAD_FILE:
232             fprintf(stderr, "(%s)\n", err_info);
233             g_free(err_info);
234             break;
235         }
236         exit(1);
237     }
238     DEBUG_PRINT("file_type_subtype is %u\n", wtap_file_type_subtype(wth));
239
240     shb_hdr = wtap_file_get_shb_info(wth);
241     idb_inf = wtap_file_get_idb_info(wth);
242
243     /* Open outfile (same filetype/encap as input file) */
244     pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
245                             65535, FALSE, shb_hdr, idb_inf, &err);
246     g_free(idb_inf);
247     if (pdh == NULL) {
248         fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
249                 outfile, wtap_strerror(err));
250         g_free(shb_hdr);
251         exit(1);
252     }
253
254     /* Allocate the array of frame pointers. */
255     frames = g_ptr_array_new();
256
257     /* Read each frame from infile */
258     while (wtap_read(wth, &err, &err_info, &data_offset)) {
259         FrameRecord_t *newFrameRecord;
260
261         phdr = wtap_phdr(wth);
262
263         newFrameRecord = g_slice_new(FrameRecord_t);
264         newFrameRecord->num = frames->len + 1;
265         newFrameRecord->offset = data_offset;
266         if (phdr->presence_flags & WTAP_HAS_TS) {
267             newFrameRecord->time = phdr->ts;
268         } else {
269             nstime_set_unset(&newFrameRecord->time);
270         }
271
272         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
273            wrong_order_count++;
274         }
275
276         g_ptr_array_add(frames, newFrameRecord);
277         prevFrame = newFrameRecord;
278     }
279     if (err != 0) {
280       /* Print a message noting that the read failed somewhere along the line. */
281       fprintf(stderr,
282               "reordercap: An error occurred while reading \"%s\": %s.\n",
283               infile, wtap_strerror(err));
284       switch (err) {
285
286       case WTAP_ERR_UNSUPPORTED:
287       case WTAP_ERR_UNSUPPORTED_ENCAP:
288       case WTAP_ERR_BAD_FILE:
289           fprintf(stderr, "(%s)\n", err_info);
290           g_free(err_info);
291           break;
292       }
293     }
294
295     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
296
297     /* Sort the frames */
298     if (wrong_order_count > 0) {
299         g_ptr_array_sort(frames, frames_compare);
300     }
301
302     /* Write out each sorted frame in turn */
303     buffer_init(&buf, 1500);
304     for (i = 0; i < frames->len; i++) {
305         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
306
307         /* Avoid writing if already sorted and configured to */
308         if (write_output_regardless || (wrong_order_count > 0)) {
309             frame_write(frame, wth, pdh, &buf, infile);
310         }
311         g_slice_free(FrameRecord_t, frame);
312     }
313     buffer_free(&buf);
314
315     if (!write_output_regardless && (wrong_order_count == 0)) {
316         printf("Not writing output file because input file is already in order!\n");
317     }
318
319     /* Free the whole array */
320     g_ptr_array_free(frames, TRUE);
321
322     /* Close outfile */
323     if (!wtap_dump_close(pdh, &err)) {
324         fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
325                 wtap_strerror(err));
326         g_free(shb_hdr);
327         exit(1);
328     }
329     g_free(shb_hdr);
330
331     /* Finally, close infile */
332     wtap_fdclose(wth);
333
334     return 0;
335 }
336
337 /*
338  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
339  *
340  * Local variables:
341  * c-basic-offset: 4
342  * tab-width: 8
343  * indent-tabs-mode: nil
344  * End:
345  *
346  * vi: set shiftwidth=4 tabstop=8 expandtab:
347  * :indentSize=4:tabSize=8:noTabs=true:
348  */