Send error messages to the standard error, and include the program name
[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  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License along
21  * with this program; if not, write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  *
24  */
25
26 #include "config.h"
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <string.h>
31 #include <glib.h>
32
33 #ifdef HAVE_UNISTD_H
34 #include <unistd.h>
35 #endif
36
37 #include "wtap.h"
38
39 #ifndef HAVE_GETOPT
40 #include "wsutil/wsgetopt.h"
41 #endif
42
43 /* Show command-line usage */
44 static void usage(void)
45 {
46     fprintf(stderr, "Reordercap %s"
47 #ifdef SVNVERSION
48           " (" SVNVERSION " from " SVNPATH ")"
49 #endif
50           "\n", VERSION);
51     fprintf(stderr, "Reorder timestamps of input file frames into output file.\n");
52     fprintf(stderr, "See http://www.wireshark.org for more information.\n");
53     fprintf(stderr, "\n");
54     fprintf(stderr, "Usage: reordercap [options] <infile> <outfile>\n");
55     fprintf(stderr, "\n");
56     fprintf(stderr, "Options:\n");
57     fprintf(stderr, "  -n        don't write to output file if the input file is ordered.\n");
58 }
59
60 /* Remember where this frame was in the file */
61 typedef struct FrameRecord_t {
62     gint64               offset;
63     guint32              length;
64     guint                num;
65
66     struct wtap_nstime   time;
67 } FrameRecord_t;
68
69
70 /**************************************************/
71 /* Debugging only                                 */
72
73 /* Enable this symbol to see debug output */
74 /* #define REORDER_DEBUG */
75
76 #ifdef REORDER_DEBUG
77 #define DEBUG_PRINT printf
78 #else
79 #define DEBUG_PRINT(...)
80 #endif
81 /**************************************************/
82
83
84 static void
85 frame_write(FrameRecord_t *frame, wtap *wth, wtap_dumper *pdh, Buffer *buf)
86 {
87     int    err;
88     gchar  *errinfo;
89     struct wtap_pkthdr phdr;
90
91     DEBUG_PRINT("\nDumping frame (offset=%" G_GINT64_MODIFIER "u, length=%u)\n", 
92                 frame->offset, frame->length);
93
94     
95     /* Re-read the first frame from the stored location */
96     wtap_seek_read(wth,
97                    frame->offset,
98                    &phdr,
99                    buf,
100                    frame->length,
101                    &err,
102                    &errinfo);
103     DEBUG_PRINT("re-read: err is %d, buf is (%s)\n", err, buf);
104
105     /* Copy, and set length and timestamp from item. */
106     /* TODO: remove when wtap_seek_read() will read phdr */
107     phdr.ts = frame->time;
108
109     /* Dump frame to outfile */
110     if (!wtap_dump(pdh, &phdr, buffer_start_ptr(buf), &err)) {
111         fprintf(stderr, "reordercap: Error (%s) writing frame to outfile\n",
112                 wtap_strerror(err));
113         exit(1);
114     }
115 }
116
117 /* Comparing timestamps between 2 frames.
118    -1 if (t1 < t2)
119    0  if (t1 == t2)
120    1  if (t1 > t2)
121 */
122 static int
123 frames_compare(gconstpointer a, gconstpointer b)
124 {
125     const FrameRecord_t *frame1 = *(const FrameRecord_t **) a;
126     const FrameRecord_t *frame2 = *(const FrameRecord_t **) b;
127
128     const struct wtap_nstime *time1 = &frame1->time;
129     const struct wtap_nstime *time2 = &frame2->time;
130
131     if (time1->secs > time2->secs)
132         return 1;
133     if (time1->secs < time2->secs)
134         return -1;
135
136     /* time1->secs == time2->secs */
137     if (time1->nsecs > time2->nsecs)
138         return 1;
139     if (time1->nsecs < time2->nsecs)
140         return -1;
141
142     /* time1->nsecs == time2->nsecs */
143
144     if (frame1->num > frame2->num)
145         return 1;
146     if (frame1->num < frame2->num)
147         return -1;
148     return 0;
149 }
150
151
152 /********************************************************************/
153 /* Main function.                                                   */
154 /********************************************************************/
155 int main(int argc, char *argv[])
156 {
157     wtap *wth = NULL;
158     wtap_dumper *pdh = NULL;
159     Buffer buf;
160     int err;
161     gchar *err_info;
162     gint64 data_offset;
163     const struct wtap_pkthdr *phdr;
164     guint wrong_order_count = 0;
165     gboolean write_output_regardless = TRUE;
166     guint i;
167     wtapng_section_t            *shb_hdr;
168     wtapng_iface_descriptions_t *idb_inf;
169
170     GPtrArray *frames;
171     FrameRecord_t *prevFrame = NULL;
172
173     int opt;
174     int file_count;
175     char *infile;
176     char *outfile;
177
178     /* Process the options first */
179     while ((opt = getopt(argc, argv, "n")) != -1) {
180         switch (opt) {
181             case 'n':
182                 write_output_regardless = FALSE;
183                 break;
184             case '?':
185                 usage();
186                 exit(1);
187         }
188     }
189
190     /* Remaining args are file names */
191     file_count = argc - optind;
192     if (file_count == 2) {
193         infile = argv[optind];
194         outfile = argv[optind+1];
195     }
196     else {
197         usage();
198         exit(1);
199     }
200
201     /* Open infile */
202     wth = wtap_open_offline(infile, &err, &err_info, TRUE);
203     if (wth == NULL) {
204         fprintf(stderr, "reordercap: Can't open %s: %s\n", infile,
205                 wtap_strerror(err));
206         exit(1);
207     }
208     DEBUG_PRINT("file_type is %u\n", wtap_file_type(wth));
209
210     shb_hdr = wtap_file_get_shb_info(wth);
211     idb_inf = wtap_file_get_idb_info(wth);
212
213     /* Open outfile (same filetype/encap as input file) */
214     pdh = wtap_dump_open_ng(outfile, wtap_file_type(wth), wtap_file_encap(wth),
215                             65535, FALSE, shb_hdr, idb_inf, &err);
216     g_free(idb_inf);
217     if (pdh == NULL) {
218         fprintf(stderr, "reordercap: Failed to open output file: (%s) - error %s\n",
219                 outfile, wtap_strerror(err));
220         g_free(shb_hdr);
221         exit(1);
222     }
223
224     /* Allocate the array of frame pointers. */
225     frames = g_ptr_array_new();
226
227     /* Read each frame from infile */
228     while (wtap_read(wth, &err, &err_info, &data_offset)) {
229         FrameRecord_t *newFrameRecord;
230
231         phdr = wtap_phdr(wth);
232
233         newFrameRecord = g_slice_new(FrameRecord_t);
234         newFrameRecord->num = frames->len + 1;
235         newFrameRecord->offset = data_offset;
236         newFrameRecord->length = phdr->len;
237         newFrameRecord->time = phdr->ts;
238
239         if (prevFrame && frames_compare(&newFrameRecord, &prevFrame) < 0) {
240            wrong_order_count++;
241         }
242
243         g_ptr_array_add(frames, newFrameRecord);
244         prevFrame = newFrameRecord;
245     }
246     printf("%u frames, %u out of order\n", frames->len, wrong_order_count);
247
248     /* Sort the frames */
249     if (wrong_order_count > 0) {
250         g_ptr_array_sort(frames, frames_compare);
251     }
252
253     /* Write out each sorted frame in turn */
254     buffer_init(&buf, 1500);
255     for (i = 0; i < frames->len; i++) {
256         FrameRecord_t *frame = (FrameRecord_t *)frames->pdata[i];
257
258         /* Avoid writing if already sorted and configured to */
259         if (write_output_regardless || (wrong_order_count > 0)) {
260             frame_write(frame, wth, pdh, &buf);
261         }
262         g_slice_free(FrameRecord_t, frame);
263     }
264     buffer_free(&buf);
265
266     if (!write_output_regardless && (wrong_order_count == 0)) {
267         printf("Not writing output file because input file is already in order!\n");
268     }
269
270     /* Free the whole array */
271     g_ptr_array_free(frames, TRUE);
272
273     /* Close outfile */
274     if (!wtap_dump_close(pdh, &err)) {
275         fprintf(stderr, "reordercap: Error closing %s: %s\n", outfile,
276                 wtap_strerror(err));
277         g_free(shb_hdr);
278         exit(1);
279     }
280     g_free(shb_hdr);
281
282     /* Finally, close infile */
283     wtap_fdclose(wth);
284
285     return 0;
286 }
287