Revert "Refactor Wiretap"
[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    -1 if (t1 < t2)
139    0  if (t1 == t2)
140    1  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     if (time1->secs > time2->secs)
152         return 1;
153     if (time1->secs < time2->secs)
154         return -1;
155
156     /* time1->secs == time2->secs */
157     if (time1->nsecs > time2->nsecs)
158         return 1;
159     if (time1->nsecs < time2->nsecs)
160         return -1;
161
162     /* time1->nsecs == time2->nsecs */
163
164     if (frame1->num > frame2->num)
165         return 1;
166     if (frame1->num < frame2->num)
167         return -1;
168     return 0;
169 }
170
171
172 /********************************************************************/
173 /* Main function.                                                   */
174 /********************************************************************/
175 int main(int argc, char *argv[])
176 {
177     wtap *wth = NULL;
178     wtap_dumper *pdh = NULL;
179     Buffer buf;
180     int err;
181     gchar *err_info;
182     gint64 data_offset;
183     const struct wtap_pkthdr *phdr;
184     guint wrong_order_count = 0;
185     gboolean write_output_regardless = TRUE;
186     guint i;
187     wtapng_section_t            *shb_hdr;
188     wtapng_iface_descriptions_t *idb_inf;
189
190     GPtrArray *frames;
191     FrameRecord_t *prevFrame = NULL;
192
193     int opt;
194     int file_count;
195     char *infile;
196     char *outfile;
197
198     /* Process the options first */
199     while ((opt = getopt(argc, argv, "hn")) != -1) {
200         switch (opt) {
201             case 'n':
202                 write_output_regardless = FALSE;
203                 break;
204             case 'h':
205                 usage(FALSE);
206                 exit(0);
207             case '?':
208                 usage(TRUE);
209                 exit(1);
210         }
211     }
212
213     /* Remaining args are file names */
214     file_count = argc - optind;
215     if (file_count == 2) {
216         infile  = argv[optind];
217         outfile = argv[optind+1];
218     }
219     else {
220         usage(TRUE);
221         exit(1);
222     }
223
224     init_open_routines();
225
226     /* Open infile */
227     /* TODO: if reordercap is ever changed to give the user a choice of which
228        open_routine reader to use, then the following needs to change. */
229     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
230     if (wth == NULL) {
231         fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
232                 wtap_strerror(err));
233         switch (err) {
234
235         case WTAP_ERR_UNSUPPORTED:
236         case WTAP_ERR_UNSUPPORTED_ENCAP:
237         case WTAP_ERR_BAD_FILE:
238             fprintf(stderr, "(%s)\n", err_info);
239             g_free(err_info);
240             break;
241         }
242         exit(1);
243     }
244     DEBUG_PRINT("file_type_subtype is %u\n", wtap_file_type_subtype(wth));
245
246     shb_hdr = wtap_file_get_shb_info(wth);
247     idb_inf = wtap_file_get_idb_info(wth);
248
249     /* Open outfile (same filetype/encap as input file) */
250     pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
251                             65535, FALSE, shb_hdr, idb_inf, &err);
252     g_free(idb_inf);
253     if (pdh == NULL) {
254         fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
255                 outfile, wtap_strerror(err));
256         g_free(shb_hdr);
257         exit(1);
258     }
259
260     /* Allocate the array of frame pointers. */
261     frames = g_ptr_array_new();
262
263     /* Read each frame from infile */
264     while (wtap_read(wth, &err, &err_info, &data_offset)) {
265         FrameRecord_t *newFrameRecord;
266
267         phdr = wtap_phdr(wth);
268
269         newFrameRecord = g_slice_new(FrameRecord_t);
270         newFrameRecord->num = frames->len + 1;
271         newFrameRecord->offset = data_offset;
272         newFrameRecord->time = phdr->ts;
273
274         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
275            wrong_order_count++;
276         }
277
278         g_ptr_array_add(frames, newFrameRecord);
279         prevFrame = newFrameRecord;
280     }
281     if (err != 0) {
282       /* Print a message noting that the read failed somewhere along the line. */
283       fprintf(stderr,
284               "reordercap: An error occurred while reading \"%s\": %s.\n",
285               infile, wtap_strerror(err));
286       switch (err) {
287
288       case WTAP_ERR_UNSUPPORTED:
289       case WTAP_ERR_UNSUPPORTED_ENCAP:
290       case WTAP_ERR_BAD_FILE:
291           fprintf(stderr, "(%s)\n", err_info);
292           g_free(err_info);
293           break;
294       }
295     }
296
297     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
298
299     /* Sort the frames */
300     if (wrong_order_count > 0) {
301         g_ptr_array_sort(frames, frames_compare);
302     }
303
304     /* Write out each sorted frame in turn */
305     buffer_init(&buf, 1500);
306     for (i = 0; i < frames->len; i++) {
307         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
308
309         /* Avoid writing if already sorted and configured to */
310         if (write_output_regardless || (wrong_order_count > 0)) {
311             frame_write(frame, wth, pdh, &buf, infile);
312         }
313         g_slice_free(FrameRecord_t, frame);
314     }
315     buffer_free(&buf);
316
317     if (!write_output_regardless && (wrong_order_count == 0)) {
318         printf("Not writing output file because input file is already in order!\n");
319     }
320
321     /* Free the whole array */
322     g_ptr_array_free(frames, TRUE);
323
324     /* Close outfile */
325     if (!wtap_dump_close(pdh, &err)) {
326         fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
327                 wtap_strerror(err));
328         g_free(shb_hdr);
329         exit(1);
330     }
331     g_free(shb_hdr);
332
333     /* Finally, close infile */
334     wtap_fdclose(wth);
335
336     return 0;
337 }
338
339 /*
340  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
341  *
342  * Local variables:
343  * c-basic-offset: 4
344  * tab-width: 8
345  * indent-tabs-mode: nil
346  * End:
347  *
348  * vi: set shiftwidth=4 tabstop=8 expandtab:
349  * :indentSize=4:tabSize=8:noTabs=true:
350  */