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