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