Make sure err_info is always set, and print it iff it's non-null.
[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             if (err_info != NULL) {
125                 fprintf(stderr, "(%s)\n", err_info);
126                 g_free(err_info);
127             }
128             exit(1);
129         }
130     }
131
132     /* Copy, and set length and timestamp from item. */
133     /* TODO: remove when wtap_seek_read() fills in phdr,
134        including time stamps, for all file types  */
135     phdr->ts = frame->time;
136
137     /* Dump frame to outfile */
138     if (!wtap_dump(pdh, phdr, ws_buffer_start_ptr(buf), &err, &err_info)) {
139         fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
140                 wtap_strerror(err));
141         if (err_info != NULL) {
142             fprintf(stderr, "(%s)\n", err_info);
143             g_free(err_info);
144         }
145         exit(1);
146     }
147 }
148
149 /* Comparing timestamps between 2 frames.
150    negative if (t1 < t2)
151    zero     if (t1 == t2)
152    positive if (t1 > t2)
153 */
154 static int
155 frames_compare(gconstpointer a, gconstpointer b)
156 {
157     const FrameRecord_t *frame1 = *(const FrameRecord_t *const *) a;
158     const FrameRecord_t *frame2 = *(const FrameRecord_t *const *) b;
159
160     const nstime_t *time1 = &frame1->time;
161     const nstime_t *time2 = &frame2->time;
162
163     return nstime_cmp(time1, time2);
164 }
165
166 static void
167 get_reordercap_compiled_info(GString *str)
168 {
169     /* LIBZ */
170     g_string_append(str, ", ");
171 #ifdef HAVE_LIBZ
172     g_string_append(str, "with libz ");
173 #ifdef ZLIB_VERSION
174     g_string_append(str, ZLIB_VERSION);
175 #else /* ZLIB_VERSION */
176     g_string_append(str, "(version unknown)");
177 #endif /* ZLIB_VERSION */
178 #else /* HAVE_LIBZ */
179     g_string_append(str, "without libz");
180 #endif /* HAVE_LIBZ */
181 }
182
183 static void
184 get_reordercap_runtime_info(GString *str)
185 {
186     /* zlib */
187 #if defined(HAVE_LIBZ) && !defined(_WIN32)
188     g_string_append_printf(str, ", with libz %s", zlibVersion());
189 #endif
190 }
191
192 /********************************************************************/
193 /* Main function.                                                   */
194 /********************************************************************/
195 int
196 main(int argc, char *argv[])
197 {
198     GString *comp_info_str;
199     GString *runtime_info_str;
200     wtap *wth = NULL;
201     wtap_dumper *pdh = NULL;
202     struct wtap_pkthdr dump_phdr;
203     Buffer buf;
204     int err;
205     gchar *err_info;
206     gint64 data_offset;
207     const struct wtap_pkthdr *phdr;
208     guint wrong_order_count = 0;
209     gboolean write_output_regardless = TRUE;
210     guint i;
211     wtapng_section_t            *shb_hdr;
212     wtapng_iface_descriptions_t *idb_inf;
213
214     GPtrArray *frames;
215     FrameRecord_t *prevFrame = NULL;
216
217     int opt;
218     static const struct option long_options[] = {
219         {(char *)"help", no_argument, NULL, 'h'},
220         {(char *)"version", no_argument, NULL, 'v'},
221         {0, 0, 0, 0 }
222     };
223     int file_count;
224     char *infile;
225     char *outfile;
226
227     /* Assemble the compile-time version information string */
228     comp_info_str = g_string_new("Compiled ");
229     get_compiled_version_info(comp_info_str, NULL, get_reordercap_compiled_info);
230
231     /* Assemble the run-time version information string */
232     runtime_info_str = g_string_new("Running ");
233     get_runtime_version_info(runtime_info_str, get_reordercap_runtime_info);
234
235     /* Add it to the information to be reported on a crash. */
236     ws_add_crash_info("Reordercap (Wireshark) %s\n"
237          "\n"
238          "%s"
239          "\n"
240          "%s",
241       get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
242
243     /* Process the options first */
244     while ((opt = getopt_long(argc, argv, "hnv", long_options, NULL)) != -1) {
245         switch (opt) {
246             case 'n':
247                 write_output_regardless = FALSE;
248                 break;
249             case 'h':
250                 printf("Reordercap (Wireshark) %s\n"
251                        "Reorder timestamps of input file frames into output file.\n"
252                        "See http://www.wireshark.org for more information.\n",
253                        get_ws_vcs_version_info());
254                 print_usage(stdout);
255                 exit(0);
256             case 'v':
257                 show_version(comp_info_str, runtime_info_str);
258                 g_string_free(comp_info_str, TRUE);
259                 g_string_free(runtime_info_str, TRUE);
260                 exit(0);
261             case '?':
262                 print_usage(stderr);
263                 exit(1);
264         }
265     }
266
267     /* Remaining args are file names */
268     file_count = argc - optind;
269     if (file_count == 2) {
270         infile  = argv[optind];
271         outfile = argv[optind+1];
272     }
273     else {
274         print_usage(stderr);
275         exit(1);
276     }
277
278     /* Open infile */
279     /* TODO: if reordercap is ever changed to give the user a choice of which
280        open_routine reader to use, then the following needs to change. */
281     wth = wtap_open_offline(infile, WTAP_TYPE_AUTO, &err, &err_info, TRUE);
282     if (wth == NULL) {
283         fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
284                 wtap_strerror(err));
285         if (err_info != NULL) {
286             fprintf(stderr, "(%s)\n", err_info);
287             g_free(err_info);
288         }
289         exit(1);
290     }
291     DEBUG_PRINT("file_type_subtype is %u\n", wtap_file_type_subtype(wth));
292
293     shb_hdr = wtap_file_get_shb_info(wth);
294     idb_inf = wtap_file_get_idb_info(wth);
295
296     /* Open outfile (same filetype/encap as input file) */
297     pdh = wtap_dump_open_ng(outfile, wtap_file_type_subtype(wth), wtap_file_encap(wth),
298                             65535, FALSE, shb_hdr, idb_inf, &err);
299     g_free(idb_inf);
300     if (pdh == NULL) {
301         fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
302                 outfile, wtap_strerror(err));
303         g_free(shb_hdr);
304         exit(1);
305     }
306
307     /* Allocate the array of frame pointers. */
308     frames = g_ptr_array_new();
309
310     /* Read each frame from infile */
311     while (wtap_read(wth, &err, &err_info, &data_offset)) {
312         FrameRecord_t *newFrameRecord;
313
314         phdr = wtap_phdr(wth);
315
316         newFrameRecord = g_slice_new(FrameRecord_t);
317         newFrameRecord->num = frames->len + 1;
318         newFrameRecord->offset = data_offset;
319         if (phdr->presence_flags & WTAP_HAS_TS) {
320             newFrameRecord->time = phdr->ts;
321         } else {
322             nstime_set_unset(&newFrameRecord->time);
323         }
324
325         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
326            wrong_order_count++;
327         }
328
329         g_ptr_array_add(frames, newFrameRecord);
330         prevFrame = newFrameRecord;
331     }
332     if (err != 0) {
333       /* Print a message noting that the read failed somewhere along the line. */
334       fprintf(stderr,
335               "reordercap: An error occurred while reading \"%s\": %s.\n",
336               infile, wtap_strerror(err));
337       if (err_info != NULL) {
338           fprintf(stderr, "(%s)\n", err_info);
339           g_free(err_info);
340       }
341     }
342
343     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
344
345     /* Sort the frames */
346     if (wrong_order_count > 0) {
347         g_ptr_array_sort(frames, frames_compare);
348     }
349
350     /* Write out each sorted frame in turn */
351     wtap_phdr_init(&dump_phdr);
352     ws_buffer_init(&buf, 1500);
353     for (i = 0; i < frames->len; i++) {
354         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
355
356         /* Avoid writing if already sorted and configured to */
357         if (write_output_regardless || (wrong_order_count > 0)) {
358             frame_write(frame, wth, pdh, &dump_phdr, &buf, infile);
359         }
360         g_slice_free(FrameRecord_t, frame);
361     }
362     wtap_phdr_cleanup(&dump_phdr);
363     ws_buffer_free(&buf);
364
365     if (!write_output_regardless && (wrong_order_count == 0)) {
366         printf("Not writing output file because input file is already in order!\n");
367     }
368
369     /* Free the whole array */
370     g_ptr_array_free(frames, TRUE);
371
372     /* Close outfile */
373     if (!wtap_dump_close(pdh, &err)) {
374         fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
375                 wtap_strerror(err));
376         g_free(shb_hdr);
377         exit(1);
378     }
379     g_free(shb_hdr);
380
381     /* Finally, close infile */
382     wtap_fdclose(wth);
383
384     return 0;
385 }
386
387 /*
388  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
389  *
390  * Local variables:
391  * c-basic-offset: 4
392  * tab-width: 8
393  * indent-tabs-mode: nil
394  * End:
395  *
396  * vi: set shiftwidth=4 tabstop=8 expandtab:
397  * :indentSize=4:tabSize=8:noTabs=true:
398  */