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