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