Move strnatcmp.{h,c} from epan into wsutil: there's nothing epan-specific
[metze/wireshark/wip.git] / mergecap.c
1 /* Combine two dump files, either by appending or by merging by timestamp
2  *
3  * $Id$
4  *
5  * Wireshark - Network traffic analyzer
6  * By Gerald Combs <gerald@wireshark.org>
7  * Copyright 1998 Gerald Combs
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  *
23  * Mergecap written by Scott Renfro <scott@renfro.org> based on
24  * editcap by Richard Sharpe and Guy Harris
25  *
26  */
27
28 #include "config.h"
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <errno.h>
33 #include <glib.h>
34
35 #ifdef HAVE_UNISTD_H
36 #include <unistd.h>
37 #endif
38
39 #ifdef HAVE_SYS_TIME_H
40 #include <sys/time.h>
41 #endif
42
43 #include <string.h>
44 #include "wtap.h"
45
46 #ifndef HAVE_GETOPT
47 #include "wsutil/wsgetopt.h"
48 #endif
49
50 #include "wsutil/strnatcmp.h"
51
52 #define WS_BUILD_DLL
53 #define RESET_SYMBOL_EXPORT /* wsutil/wsgetopt.h set export behavior above. */
54 #undef WS_BUILD_DLL
55 #define RESET_SYMBOL_EXPORT
56
57 #include "svnversion.h"
58 #include "merge.h"
59 #include "wsutil/file_util.h"
60
61 #ifdef HAVE_FCNTL_H
62 #include <fcntl.h>
63 #endif
64
65 #ifdef _WIN32
66 #include <wsutil/unicode-utils.h>
67 #endif /* _WIN32 */
68
69 static int
70 get_natural_int(const char *string, const char *name)
71 {
72   long number;
73   char *p;
74
75   number = strtol(string, &p, 10);
76   if (p == string || *p != '\0') {
77     fprintf(stderr, "mergecap: The specified %s \"%s\" isn't a decimal number\n",
78             name, string);
79     exit(1);
80   }
81   if (number < 0) {
82     fprintf(stderr, "mergecap: The specified %s is a negative number\n",
83             name);
84     exit(1);
85   }
86   if (number > INT_MAX) {
87     fprintf(stderr, "mergecap: The specified %s is too large (greater than %d)\n",
88             name, INT_MAX);
89     exit(1);
90   }
91   return (int)number;
92 }
93
94 static int
95 get_positive_int(const char *string, const char *name)
96 {
97   int number;
98
99   number = get_natural_int(string, name);
100
101   if (number == 0) {
102     fprintf(stderr, "mergecap: The specified %s is zero\n",
103             name);
104     exit(1);
105   }
106
107   return number;
108 }
109
110 /*
111  * Show the usage
112  */
113 static void
114 usage(void)
115 {
116
117   fprintf(stderr, "Mergecap %s"
118 #ifdef SVNVERSION
119           " (" SVNVERSION " from " SVNPATH ")"
120 #endif
121           "\n", VERSION);
122   fprintf(stderr, "Merge two or more capture files into one.\n");
123   fprintf(stderr, "See http://www.wireshark.org for more information.\n");
124   fprintf(stderr, "\n");
125   fprintf(stderr, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
126   fprintf(stderr, "\n");
127   fprintf(stderr, "Output:\n");
128   fprintf(stderr, "  -a                concatenate rather than merge files.\n");
129   fprintf(stderr, "                    default is to merge based on frame timestamps.\n");
130   fprintf(stderr, "  -s <snaplen>      truncate packets to <snaplen> bytes of data.\n");
131   fprintf(stderr, "  -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.\n");
132   fprintf(stderr, "  -F <capture type> set the output file type; default is pcapng.\n");
133   fprintf(stderr, "                    an empty \"-F\" option will list the file types.\n");
134   fprintf(stderr, "  -T <encap type>   set the output file encapsulation type;\n");
135   fprintf(stderr, "                    default is the same as the first input file.\n");
136   fprintf(stderr, "                    an empty \"-T\" option will list the encapsulation types.\n");
137   fprintf(stderr, "\n");
138   fprintf(stderr, "Miscellaneous:\n");
139   fprintf(stderr, "  -h                display this help and exit.\n");
140   fprintf(stderr, "  -v                verbose output.\n");
141 }
142
143 struct string_elem {
144     const char *sstr;   /* The short string */
145     const char *lstr;   /* The long string */
146 };
147
148 static gint
149 string_compare(gconstpointer a, gconstpointer b)
150 {
151     return strcmp(((const struct string_elem *)a)->sstr,
152         ((const struct string_elem *)b)->sstr);
153 }
154
155 static gint
156 string_nat_compare(gconstpointer a, gconstpointer b)
157 {
158     return strnatcmp(((const struct string_elem *)a)->sstr,
159         ((const struct string_elem *)b)->sstr);
160 }
161
162 static void
163 string_elem_print(gpointer data, gpointer not_used _U_)
164 {
165     fprintf(stderr, "    %s - %s\n",
166         ((struct string_elem *)data)->sstr,
167         ((struct string_elem *)data)->lstr);
168 }
169
170 static void
171 list_capture_types(void) {
172   int i;
173   struct string_elem *captypes;
174   GSList *list = NULL;
175
176   captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES);
177
178   fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
179   for (i = 0; i < WTAP_NUM_FILE_TYPES; i++) {
180     if (wtap_dump_can_open(i)) {
181       captypes[i].sstr = wtap_file_type_short_string(i);
182       captypes[i].lstr = wtap_file_type_string(i);
183       list = g_slist_insert_sorted(list, &captypes[i], string_compare);
184     }
185   }
186   g_slist_foreach(list, string_elem_print, NULL);
187   g_slist_free(list);
188   g_free(captypes);
189 }
190
191 static void
192 list_encap_types(void) {
193     int i;
194     struct string_elem *encaps;
195     GSList *list = NULL;
196
197     encaps = g_new(struct string_elem,WTAP_NUM_ENCAP_TYPES);
198     fprintf(stderr, "mergecap: The available encapsulation types for the \"-T\" flag are:\n");
199     for (i = 0; i < WTAP_NUM_ENCAP_TYPES; i++) {
200         encaps[i].sstr = wtap_encap_short_string(i);
201         if (encaps[i].sstr != NULL) {
202             encaps[i].lstr = wtap_encap_string(i);
203             list = g_slist_insert_sorted(list, &encaps[i], string_nat_compare);
204         }
205     }
206     g_slist_foreach(list, string_elem_print, NULL);
207     g_slist_free(list);
208     g_free(encaps);
209 }
210
211 int
212 main(int argc, char *argv[])
213 {
214   int          opt;
215
216   gboolean     do_append     = FALSE;
217   gboolean     verbose       = FALSE;
218   int          in_file_count = 0;
219   guint        snaplen = 0;
220 #ifdef PCAP_NG_DEFAULT
221   int          file_type = WTAP_FILE_PCAPNG;    /* default to pcap format */
222 #else
223   int          file_type = WTAP_FILE_PCAP;      /* default to pcapng format */
224 #endif
225   int          frame_type = -2;
226   int          out_fd;
227   merge_in_file_t   *in_files      = NULL, *in_file;
228   int          i;
229   struct wtap_pkthdr *phdr, snap_phdr;
230   wtap_dumper *pdh;
231   int          open_err, read_err=0, write_err, close_err;
232   gchar       *err_info;
233   int          err_fileno;
234   char        *out_filename = NULL;
235   gboolean     got_read_error = FALSE, got_write_error = FALSE;
236   int          count;
237
238 #ifdef _WIN32
239   arg_list_utf_16to8(argc, argv);
240   create_app_running_mutex();
241 #endif /* _WIN32 */
242
243   /* Process the options first */
244   while ((opt = getopt(argc, argv, "hvas:T:F:w:")) != -1) {
245
246     switch (opt) {
247     case 'w':
248       out_filename = optarg;
249       break;
250
251     case 'a':
252       do_append = !do_append;
253       break;
254
255     case 'T':
256       frame_type = wtap_short_string_to_encap(optarg);
257       if (frame_type < 0) {
258         fprintf(stderr, "mergecap: \"%s\" isn't a valid encapsulation type\n",
259             optarg);
260         list_encap_types();
261         exit(1);
262       }
263       break;
264
265     case 'F':
266       file_type = wtap_short_string_to_file_type(optarg);
267       if (file_type < 0) {
268         fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
269             optarg);
270         list_capture_types();
271         exit(1);
272       }
273       break;
274
275     case 'v':
276       verbose = TRUE;
277       break;
278
279     case 's':
280       snaplen = get_positive_int(optarg, "snapshot length");
281       break;
282
283     case 'h':
284       usage();
285       exit(0);
286       break;
287
288     case '?':              /* Bad options if GNU getopt */
289       switch(optopt) {
290       case'F':
291         list_capture_types();
292         break;
293       case'T':
294         list_encap_types();
295         break;
296       default:
297         usage();
298       }
299       exit(1);
300       break;
301
302     }
303
304   }
305
306   /* check for proper args; at a minimum, must have an output
307    * filename and one input file
308    */
309   in_file_count = argc - optind;
310   if (!out_filename) {
311     fprintf(stderr, "mergecap: an output filename must be set with -w\n");
312     fprintf(stderr, "          run with -h for help\n");
313     return 1;
314   }
315   if (in_file_count < 1) {
316     fprintf(stderr, "mergecap: No input files were specified\n");
317     return 1;
318   }
319
320   /* open the input files */
321   if (!merge_open_in_files(in_file_count, &argv[optind], &in_files,
322                            &open_err, &err_info, &err_fileno)) {
323     fprintf(stderr, "mergecap: Can't open %s: %s\n", argv[optind + err_fileno],
324         wtap_strerror(open_err));
325     switch (open_err) {
326
327     case WTAP_ERR_UNSUPPORTED:
328     case WTAP_ERR_UNSUPPORTED_ENCAP:
329     case WTAP_ERR_BAD_FILE:
330       fprintf(stderr, "(%s)\n", err_info);
331       g_free(err_info);
332       break;
333     }
334     return 2;
335   }
336
337   if (verbose) {
338     for (i = 0; i < in_file_count; i++)
339       fprintf(stderr, "mergecap: %s is type %s.\n", argv[optind + i],
340               wtap_file_type_string(wtap_file_type(in_files[i].wth)));
341   }
342
343   if (snaplen == 0) {
344     /*
345      * Snapshot length not specified - default to the maximum of the
346      * snapshot lengths of the input files.
347      */
348     snaplen = merge_max_snapshot_length(in_file_count, in_files);
349   }
350
351   /* set the outfile frame type */
352   if (frame_type == -2) {
353     /*
354      * Default to the appropriate frame type for the input files.
355      */
356     frame_type = merge_select_frame_type(in_file_count, in_files);
357     if (verbose) {
358       if (frame_type == WTAP_ENCAP_PER_PACKET) {
359         /*
360          * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
361          */
362         int first_frame_type, this_frame_type;
363
364         first_frame_type = wtap_file_encap(in_files[0].wth);
365         for (i = 1; i < in_file_count; i++) {
366           this_frame_type = wtap_file_encap(in_files[i].wth);
367           if (first_frame_type != this_frame_type) {
368             fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
369             fprintf(stderr, "          defaulting to WTAP_ENCAP_PER_PACKET\n");
370             fprintf(stderr, "          %s had type %s (%s)\n",
371                     in_files[0].filename,
372                     wtap_encap_string(first_frame_type),
373                     wtap_encap_short_string(first_frame_type));
374             fprintf(stderr, "          %s had type %s (%s)\n",
375                     in_files[i].filename,
376                     wtap_encap_string(this_frame_type),
377                     wtap_encap_short_string(this_frame_type));
378             break;
379           }
380         }
381       }
382       fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
383               wtap_encap_string(frame_type),
384               wtap_encap_short_string(frame_type));
385     }
386   }
387
388   /* open the outfile */
389   if (strncmp(out_filename, "-", 2) == 0) {
390     /* use stdout as the outfile */
391     out_fd = 1 /*stdout*/;
392   } else {
393     /* open the outfile */
394     out_fd = ws_open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
395     if (out_fd == -1) {
396       fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
397               out_filename, g_strerror(errno));
398       exit(1);
399     }
400   }
401
402   /* prepare the outfile */
403   if(file_type == WTAP_FILE_PCAPNG ){
404     wtapng_section_t    *shb_hdr;
405     GString *comment_gstr;
406
407     shb_hdr = g_new(wtapng_section_t,1);
408     comment_gstr = g_string_new("File created by merging: \n");
409
410     for (i = 0; i < in_file_count; i++) {
411         g_string_append_printf(comment_gstr, "File%d: %s \n",i+1,in_files[i].filename);
412     }
413     shb_hdr->section_length = -1;
414     /* options */
415     shb_hdr->opt_comment   =    comment_gstr->str;              /* NULL if not available */
416     shb_hdr->shb_hardware  =    NULL;           /* NULL if not available, UTF-8 string containing the description of the hardware used to create this section. */
417     shb_hdr->shb_os        =    NULL;           /* NULL if not available, UTF-8 string containing the name of the operating system used to create this section. */
418     shb_hdr->shb_user_appl =    "mergecap";     /* NULL if not available, UTF-8 string containing the name of the application used to create this section. */
419
420     pdh = wtap_dump_fdopen_ng(out_fd, file_type, frame_type, snaplen,
421                               FALSE /* compressed */, shb_hdr, NULL /* wtapng_iface_descriptions_t *idb_inf */, &open_err);
422     g_string_free(comment_gstr, TRUE);
423   }else{
424        pdh = wtap_dump_fdopen(out_fd, file_type, frame_type, snaplen, FALSE /* compressed */, &open_err);
425   }
426   if (pdh == NULL) {
427     merge_close_in_files(in_file_count, in_files);
428     g_free(in_files);
429     fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
430             wtap_strerror(open_err));
431     exit(1);
432   }
433
434   /* do the merge (or append) */
435   count = 1;
436   for (;;) {
437     if (do_append)
438       in_file = merge_append_read_packet(in_file_count, in_files, &read_err,
439                                          &err_info);
440     else
441       in_file = merge_read_packet(in_file_count, in_files, &read_err,
442                                   &err_info);
443     if (in_file == NULL) {
444       /* EOF */
445       break;
446     }
447
448     if (read_err != 0) {
449       /* I/O error reading from in_file */
450       got_read_error = TRUE;
451       break;
452     }
453
454     if (verbose)
455       fprintf(stderr, "Record: %u\n", count++);
456
457     /* We simply write it, perhaps after truncating it; we could do other
458      * things, like modify it. */
459     phdr = wtap_phdr(in_file->wth);
460     if (snaplen != 0 && phdr->caplen > snaplen) {
461       snap_phdr = *phdr;
462       snap_phdr.caplen = snaplen;
463       phdr = &snap_phdr;
464     }
465
466     if (!wtap_dump(pdh, phdr, wtap_buf_ptr(in_file->wth), &write_err)) {
467       got_write_error = TRUE;
468       break;
469     }
470   }
471
472   merge_close_in_files(in_file_count, in_files);
473   if (!got_read_error && !got_write_error) {
474     if (!wtap_dump_close(pdh, &write_err))
475       got_write_error = TRUE;
476   } else
477     wtap_dump_close(pdh, &close_err);
478
479   if (got_read_error) {
480     /*
481      * Find the file on which we got the error, and report the error.
482      */
483     for (i = 0; i < in_file_count; i++) {
484       if (in_files[i].state == GOT_ERROR) {
485         fprintf(stderr, "mergecap: Error reading %s: %s\n",
486                 in_files[i].filename, wtap_strerror(read_err));
487         switch (read_err) {
488
489         case WTAP_ERR_UNSUPPORTED:
490         case WTAP_ERR_UNSUPPORTED_ENCAP:
491         case WTAP_ERR_BAD_FILE:
492           fprintf(stderr, "(%s)\n", err_info);
493           g_free(err_info);
494           break;
495         }
496       }
497     }
498   }
499
500   if (got_write_error) {
501     switch (write_err) {
502
503     case WTAP_ERR_UNSUPPORTED_ENCAP:
504       /*
505        * This is a problem with the particular frame we're writing;
506        * note that, and give the frame number.
507        */
508       fprintf(stderr, "mergecap: Frame %u of \"%s\" has a network type that can't be saved in a file with that format\n.",
509               in_file->packet_num, in_file->filename);
510       break;
511
512     default:
513       fprintf(stderr, "mergecap: Error writing to outfile: %s\n",
514               wtap_strerror(write_err));
515       break;
516     }
517   }
518
519   g_free(in_files);
520
521   return (!got_read_error && !got_write_error) ? 0 : 2;
522 }