WTAP_ERR_UNWRITABLE_ errors aren't returned by reads or open-for-reading.
[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 #ifdef HAVE_GETOPT_H
36 #include <getopt.h>
37 #endif
38
39 #ifdef HAVE_LIBZ
40 #include <zlib.h>      /* to get the libz version number */
41 #endif
42
43 #include "wtap.h"
44
45 #ifndef HAVE_GETOPT
46 #include "wsutil/wsgetopt.h"
47 #endif
48
49 #include <wsutil/file_util.h>
50 #include <wsutil/crash_info.h>
51 #include <wsutil/copyright_info.h>
52 #include <wsutil/os_version_info.h>
53 #include <wsutil/ws_version_info.h>
54
55 #include "version_info.h"
56
57 static void
58 show_version(GString *comp_info_str, GString *runtime_info_str)
59 {
60     printf("Reordercap (Wireshark) %s\n"
61            "\n"
62            "%s"
63            "\n"
64            "%s"
65            "\n"
66            "%s",
67            get_ws_vcs_version_info(), get_copyright_info(),
68            comp_info_str->str, runtime_info_str->str);
69 }
70
71 /* Show command-line usage */
72 static void
73 print_usage(FILE *output)
74 {
75     fprintf(output, "\n");
76     fprintf(output, "Usage: reordercap [options] <infile> <outfile>\n");
77     fprintf(output, "\n");
78     fprintf(output, "Options:\n");
79     fprintf(output, "  -n        don't write to output file if the input file is ordered.\n");
80     fprintf(output, "  -h        display this help and exit.\n");
81 }
82
83 /* Remember where this frame was in the file */
84 typedef struct FrameRecord_t {
85     gint64       offset;
86     guint        num;
87
88     nstime_t     time;
89 } FrameRecord_t;
90
91
92 /**************************************************/
93 /* Debugging only                                 */
94
95 /* Enable this symbol to see debug output */
96 /* #define REORDER_DEBUG */
97
98 #ifdef REORDER_DEBUG
99 #define DEBUG_PRINT printf
100 #else
101 #define DEBUG_PRINT(...)
102 #endif
103 /**************************************************/
104
105
106 static void
107 frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh,
108             struct wtap_pkthdr *phdr, Buffer *buf, const char *infile)
109 {
110     int    err;
111     gchar  *err_info;
112
113     DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u)\n",
114                 frame->offset);
115
116
117     /* Re-read the frame from the stored location */
118     if (!wtap_seek_read(wth, frame->offset, phdr, buf, &err, &err_info)) {
119         if (err != 0) {
120             /* Print a message noting that the read failed somewhere along the line. */
121             fprintf(stderr,
122                     "reordercap: An error occurred while re-reading \"%s\": %s.\n",
123                     infile, wtap_strerror(err));
124             switch (err) {
125
126             case WTAP_ERR_UNSUPPORTED:
127             case WTAP_ERR_BAD_FILE:
128                 fprintf(stderr, "(%s)\n", err_info);
129                 g_free(err_info);
130                 break;
131             }
132             exit(1);
133         }
134     }
135
136     /* Copy, and set length and timestamp from item. */
137     /* TODO: remove when wtap_seek_read() fills in phdr,
138        including time stamps, for all file types  */
139     phdr->ts = frame->time;
140
141     /* Dump frame to outfile */
142     if (!wtap_dump(pdh, phdr, ws_buffer_start_ptr(buf), &err, &err_info)) {
143         switch (err) {
144
145         case WTAP_ERR_UNWRITABLE_REC_DATA:
146             fprintf(stderr, "reordercap: Error (%s) writing frame to outfile (%s)\n",
147                     wtap_strerror(err), err_info);
148             g_free(err_info);
149             break;
150
151         default:
152             fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
153                     wtap_strerror(err));
154             break;
155         }
156         exit(1);
157     }
158 }
159
160 /* Comparing timestamps between 2 frames.
161    negative if (t1 < t2)
162    zero     if (t1 == t2)
163    positive if (t1 > t2)
164 */
165 static int
166 frames_compare(gconstpointer a, gconstpointer b)
167 {
168     const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
169     const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
170
171     const nstime_t *time1 = &frame1->time;
172     const nstime_t *time2 = &frame2->time;
173
174     return nstime_cmp(time1, time2);
175 }
176
177 static void
178 get_reordercap_compiled_info(GString *str)
179 {
180     /* LIBZ */
181     g_string_append(str, ", ");
182 #ifdef HAVE_LIBZ
183     g_string_append(str, "with libz ");
184 #ifdef ZLIB_VERSION
185     g_string_append(str, ZLIB_VERSION);
186 #else /* ZLIB_VERSION */
187     g_string_append(str, "(version unknown)");
188 #endif /* ZLIB_VERSION */
189 #else /* HAVE_LIBZ */
190     g_string_append(str, "without libz");
191 #endif /* HAVE_LIBZ */
192 }
193
194 static void
195 get_reordercap_runtime_info(GString *str)
196 {
197     /* zlib */
198 #if defined(HAVE_LIBZ) && !defined(_WIN32)
199     g_string_append_printf(str, ", with libz %s", zlibVersion());
200 #endif
201 }
202
203 /********************************************************************/
204 /* Main function.                                                   */
205 /********************************************************************/
206 int
207 main(int argc, char *argv[])
208 {
209     GString *comp_info_str;
210     GString *runtime_info_str;
211     wtap *wth = NULL;
212     wtap_dumper *pdh = NULL;
213     struct wtap_pkthdr dump_phdr;
214     Buffer buf;
215     int err;
216     gchar *err_info;
217     gint64 data_offset;
218     const struct wtap_pkthdr *phdr;
219     guint wrong_order_count = 0;
220     gboolean write_output_regardless = TRUE;
221     guint i;
222     wtapng_section_t            *shb_hdr;
223     wtapng_iface_descriptions_t *idb_inf;
224
225     GPtrArray *frames;
226     FrameRecord_t *prevFrame = NULL;
227
228     int opt;
229     static const struct option long_options[] = {
230         {(char *)"help", no_argument, NULL, 'h'},
231         {(char *)"version", no_argument, NULL, 'v'},
232         {0, 0, 0, 0 }
233     };
234     int file_count;
235     char *infile;
236     char *outfile;
237
238     /* Assemble the compile-time version information string */
239     comp_info_str = g_string_new("Compiled ");
240     get_compiled_version_info(comp_info_str, NULL, get_reordercap_compiled_info);
241
242     /* Assemble the run-time version information string */
243     runtime_info_str = g_string_new("Running ");
244     get_runtime_version_info(runtime_info_str, get_reordercap_runtime_info);
245
246     /* Add it to the information to be reported on a crash. */
247     ws_add_crash_info("Reordercap (Wireshark) %s\n"
248          "\n"
249          "%s"
250          "\n"
251          "%s",
252       get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
253
254     /* Process the options first */
255     while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
256         switch (opt) {
257             case 'n':
258                 write_output_regardless = FALSE;
259                 break;
260             case 'h':
261                 printf("Reordercap (Wireshark) %s\n"
262                        "Reorder timestamps of input file frames into output file.\n"
263                        "See http://www.wireshark.org for more information.\n",
264                        get_ws_vcs_version_info());
265                 print_usage(stdout);
266                 exit(0);
267             case 'v':
268                 show_version(comp_info_str, runtime_info_str);
269                 g_string_free(comp_info_str, TRUE);
270                 g_string_free(runtime_info_str, TRUE);
271                 exit(0);
272             case '?':
273                 print_usage(stderr);
274                 exit(1);
275         }
276     }
277
278     /* Remaining args are file names */
279     file_count = argc - optind;
280     if (file_count == 2) {
281         infile  = argv[optind];
282         outfile = argv[optind+1];
283     }
284     else {
285         print_usage(stderr);
286         exit(1);
287     }
288
289     /* Open infile */
290     /* TODO: if reordercap is ever changed to give the user a choice of which
291        open_routine reader to use, then the following needs to change. */
292     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
293     if (wth == NULL) {
294         fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
295                 wtap_strerror(err));
296         switch (err) {
297
298         case WTAP_ERR_UNSUPPORTED:
299         case WTAP_ERR_BAD_FILE:
300             fprintf(stderr, "(%s)\n", err_info);
301             g_free(err_info);
302             break;
303         }
304         exit(1);
305     }
306     DEBUG_PRINT("file_type_subtype is %u\n", wtap_file_type_subtype(wth));
307
308     shb_hdr = wtap_file_get_shb_info(wth);
309     idb_inf = wtap_file_get_idb_info(wth);
310
311     /* Open outfile (same filetype/encap as input file) */
312     pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
313                             65535, FALSE, shb_hdr, idb_inf, &err);
314     g_free(idb_inf);
315     if (pdh == NULL) {
316         fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
317                 outfile, wtap_strerror(err));
318         g_free(shb_hdr);
319         exit(1);
320     }
321
322     /* Allocate the array of frame pointers. */
323     frames = g_ptr_array_new();
324
325     /* Read each frame from infile */
326     while (wtap_read(wth, &err, &err_info, &data_offset)) {
327         FrameRecord_t *newFrameRecord;
328
329         phdr = wtap_phdr(wth);
330
331         newFrameRecord = g_slice_new(FrameRecord_t);
332         newFrameRecord->num = frames->len + 1;
333         newFrameRecord->offset = data_offset;
334         if (phdr->presence_flags & WTAP_HAS_TS) {
335             newFrameRecord->time = phdr->ts;
336         } else {
337             nstime_set_unset(&newFrameRecord->time);
338         }
339
340         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
341            wrong_order_count++;
342         }
343
344         g_ptr_array_add(frames, newFrameRecord);
345         prevFrame = newFrameRecord;
346     }
347     if (err != 0) {
348       /* Print a message noting that the read failed somewhere along the line. */
349       fprintf(stderr,
350               "reordercap: An error occurred while reading \"%s\": %s.\n",
351               infile, wtap_strerror(err));
352       switch (err) {
353
354       case WTAP_ERR_UNSUPPORTED:
355       case WTAP_ERR_BAD_FILE:
356           fprintf(stderr, "(%s)\n", err_info);
357           g_free(err_info);
358           break;
359       }
360     }
361
362     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
363
364     /* Sort the frames */
365     if (wrong_order_count > 0) {
366         g_ptr_array_sort(frames, frames_compare);
367     }
368
369     /* Write out each sorted frame in turn */
370     wtap_phdr_init(&dump_phdr);
371     ws_buffer_init(&buf, 1500);
372     for (i = 0; i < frames->len; i++) {
373         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
374
375         /* Avoid writing if already sorted and configured to */
376         if (write_output_regardless || (wrong_order_count > 0)) {
377             frame_write(frame, wth, pdh, &dump_phdr, &buf, infile);
378         }
379         g_slice_free(FrameRecord_t, frame);
380     }
381     wtap_phdr_cleanup(&dump_phdr);
382     ws_buffer_free(&buf);
383
384     if (!write_output_regardless && (wrong_order_count == 0)) {
385         printf("Not writing output file because input file is already in order!\n");
386     }
387
388     /* Free the whole array */
389     g_ptr_array_free(frames, TRUE);
390
391     /* Close outfile */
392     if (!wtap_dump_close(pdh, &err)) {
393         fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
394                 wtap_strerror(err));
395         g_free(shb_hdr);
396         exit(1);
397     }
398     g_free(shb_hdr);
399
400     /* Finally, close infile */
401     wtap_fdclose(wth);
402
403     return 0;
404 }
405
406 /*
407  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
408  *
409  * Local variables:
410  * c-basic-offset: 4
411  * tab-width: 8
412  * indent-tabs-mode: nil
413  * End:
414  *
415  * vi: set shiftwidth=4 tabstop=8 expandtab:
416  * :indentSize=4:tabSize=8:noTabs=true:
417  */