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