Refactor wiretap option block types into a registration system.
[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_GETOPT_H
34 #include <getopt.h>
35 #endif
36
37 #ifdef HAVE_LIBZ
38 #include <zlib.h>      /* to get the libz version number */
39 #endif
40
41 #include <string.h>
42
43 #include <wiretap/wtap.h>
44
45 #ifndef HAVE_GETOPT_LONG
46 #include <wsutil/wsgetopt.h>
47 #endif
48
49 #include <wsutil/clopts_common.h>
50 #include <wsutil/cmdarg_err.h>
51 #include <wsutil/crash_info.h>
52 #include <wsutil/filesystem.h>
53 #include <wsutil/file_util.h>
54 #include <wsutil/strnatcmp.h>
55 #include <wsutil/ws_diag_control.h>
56 #include <wsutil/ws_version_info.h>
57
58 #ifdef HAVE_PLUGINS
59 #include <wsutil/plugins.h>
60 #endif
61
62 #include <wsutil/report_err.h>
63
64 #include <wiretap/merge.h>
65 #include <wiretap/pcap-encap.h>
66
67 #ifdef _WIN32
68 #include <wsutil/unicode-utils.h>
69 #endif /* _WIN32 */
70
71 /*
72  * Show the usage
73  */
74 static void
75 print_usage(FILE *output)
76 {
77   fprintf(output, "\n");
78   fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
79   fprintf(output, "\n");
80   fprintf(output, "Output:\n");
81   fprintf(output, "  -a                concatenate rather than merge files.\n");
82   fprintf(output, "                    default is to merge based on frame timestamps.\n");
83   fprintf(output, "  -s <snaplen>      truncate packets to <snaplen> bytes of data.\n");
84   fprintf(output, "  -w <outfile>|-    set the output filename to <outfile> or '-' for stdout.\n");
85   fprintf(output, "  -F <capture type> set the output file type; default is pcapng.\n");
86   fprintf(output, "                    an empty \"-F\" option will list the file types.\n");
87   fprintf(output, "  -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
88   fprintf(output, "                    an empty \"-I\" option will list the merge modes.\n");
89   fprintf(output, "\n");
90   fprintf(output, "Miscellaneous:\n");
91   fprintf(output, "  -h                display this help and exit.\n");
92   fprintf(output, "  -v                verbose output.\n");
93 }
94
95 /*
96  * Report an error in command-line arguments.
97  */
98 static void
99 mergecap_cmdarg_err(const char *fmt, va_list ap)
100 {
101   fprintf(stderr, "mergecap: ");
102   vfprintf(stderr, fmt, ap);
103   fprintf(stderr, "\n");
104 }
105
106 /*
107  * Report additional information for an error in command-line arguments.
108  */
109 static void
110 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
111 {
112   vfprintf(stderr, fmt, ap);
113   fprintf(stderr, "\n");
114 }
115
116 struct string_elem {
117   const char *sstr;     /* The short string */
118   const char *lstr;     /* The long string */
119 };
120
121 static gint
122 string_compare(gconstpointer a, gconstpointer b)
123 {
124   return strcmp(((const struct string_elem *)a)->sstr,
125                 ((const struct string_elem *)b)->sstr);
126 }
127
128 static void
129 string_elem_print(gpointer data, gpointer not_used _U_)
130 {
131   fprintf(stderr, "    %s - %s\n", ((struct string_elem *)data)->sstr,
132           ((struct string_elem *)data)->lstr);
133 }
134
135 #ifdef HAVE_PLUGINS
136 /*
137  *  Don't report failures to load plugins because most (non-wiretap) plugins
138  *  *should* fail to load (because we're not linked against libwireshark and
139  *  dissector plugins need libwireshark).
140  */
141 static void
142 failure_message(const char *msg_format _U_, va_list ap _U_)
143 {
144   return;
145 }
146 #endif
147
148 static void
149 list_capture_types(void) {
150   int i;
151   struct string_elem *captypes;
152   GSList *list = NULL;
153
154   captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
155
156   fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
157   for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
158     if (wtap_dump_can_open(i)) {
159       captypes[i].sstr = wtap_file_type_subtype_short_string(i);
160       captypes[i].lstr = wtap_file_type_subtype_string(i);
161       list = g_slist_insert_sorted(list, &captypes[i], string_compare);
162     }
163   }
164   g_slist_foreach(list, string_elem_print, NULL);
165   g_slist_free(list);
166   g_free(captypes);
167 }
168
169 static void
170 list_idb_merge_modes(void) {
171   int i;
172
173   fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
174   for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
175     fprintf(stderr, "    %s\n", merge_idb_merge_mode_to_string(i));
176   }
177 }
178
179 static void
180 get_mergecap_compiled_info(GString *str)
181 {
182   /* LIBZ */
183   g_string_append(str, ", ");
184 #ifdef HAVE_LIBZ
185   g_string_append(str, "with libz ");
186 #ifdef ZLIB_VERSION
187   g_string_append(str, ZLIB_VERSION);
188 #else /* ZLIB_VERSION */
189   g_string_append(str, "(version unknown)");
190 #endif /* ZLIB_VERSION */
191 #else /* HAVE_LIBZ */
192   g_string_append(str, "without libz");
193 #endif /* HAVE_LIBZ */
194 }
195
196 static void
197 get_mergecap_runtime_info(GString *str)
198 {
199   /* zlib */
200 #if defined(HAVE_LIBZ) && !defined(_WIN32)
201   g_string_append_printf(str, ", with libz %s", zlibVersion());
202 #endif
203 }
204
205
206 static gboolean
207 merge_callback(merge_event event, int num,
208                const merge_in_file_t in_files[], const guint in_file_count,
209                void *data _U_)
210 {
211   guint i;
212
213   switch (event) {
214
215     case MERGE_EVENT_INPUT_FILES_OPENED:
216       for (i = 0; i < in_file_count; i++) {
217         fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
218                 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
219       }
220       break;
221
222     case MERGE_EVENT_FRAME_TYPE_SELECTED:
223       /* for this event, num = frame_type */
224       if (num == WTAP_ENCAP_PER_PACKET) {
225         /*
226          * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
227          */
228         int first_frame_type, this_frame_type;
229
230         first_frame_type = wtap_file_encap(in_files[0].wth);
231         for (i = 1; i < in_file_count; i++) {
232           this_frame_type = wtap_file_encap(in_files[i].wth);
233           if (first_frame_type != this_frame_type) {
234             fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
235             fprintf(stderr, "          defaulting to WTAP_ENCAP_PER_PACKET\n");
236             fprintf(stderr, "          %s had type %s (%s)\n",
237                     in_files[0].filename,
238                     wtap_encap_string(first_frame_type),
239                     wtap_encap_short_string(first_frame_type));
240             fprintf(stderr, "          %s had type %s (%s)\n",
241                     in_files[i].filename,
242                     wtap_encap_string(this_frame_type),
243                     wtap_encap_short_string(this_frame_type));
244             break;
245           }
246         }
247       }
248       fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
249               wtap_encap_string(num),
250               wtap_encap_short_string(num));
251       break;
252
253     case MERGE_EVENT_READY_TO_MERGE:
254       fprintf(stderr, "mergecap: ready to merge records\n");
255       break;
256
257     case MERGE_EVENT_PACKET_WAS_READ:
258       /* for this event, num = count */
259       fprintf(stderr, "Record: %d\n", num);
260       break;
261
262     case MERGE_EVENT_DONE:
263       fprintf(stderr, "mergecap: merging complete\n");
264       break;
265   }
266
267   /* false = do not stop merging */
268   return FALSE;
269 }
270
271
272 int
273 main(int argc, char *argv[])
274 {
275   GString            *comp_info_str;
276   GString            *runtime_info_str;
277   int                 opt;
278   static const struct option long_options[] = {
279       {"help", no_argument, NULL, 'h'},
280       {"version", no_argument, NULL, 'V'},
281       {0, 0, 0, 0 }
282   };
283   gboolean            do_append          = FALSE;
284   gboolean            verbose            = FALSE;
285   int                 in_file_count      = 0;
286   guint               snaplen            = 0;
287 #ifdef PCAP_NG_DEFAULT
288   int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
289 #else
290   int                 file_type          = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
291 #endif
292   int                 out_fd;
293   int                 err                = 0;
294   gchar              *err_info           = NULL;
295   int                 err_fileno;
296   char               *out_filename       = NULL;
297   merge_result        status;
298   idb_merge_mode      mode               = IDB_MERGE_MODE_MAX;
299   gboolean            use_stdout         = FALSE;
300   merge_progress_callback_t cb;
301
302 #ifdef HAVE_PLUGINS
303   char  *init_progfile_dir_error;
304 #endif
305
306   cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
307
308 #ifdef _WIN32
309   arg_list_utf_16to8(argc, argv);
310   create_app_running_mutex();
311 #endif /* _WIN32 */
312
313   /* Get the compile-time version information string */
314   comp_info_str = get_compiled_version_info(NULL, get_mergecap_compiled_info);
315
316   /* Get the run-time version information string */
317   runtime_info_str = get_runtime_version_info(get_mergecap_runtime_info);
318
319   /* Add it to the information to be reported on a crash. */
320   ws_add_crash_info("Mergecap (Wireshark) %s\n"
321        "\n"
322        "%s"
323        "\n"
324        "%s",
325     get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
326
327 #ifdef HAVE_PLUGINS
328   if ((init_progfile_dir_error = init_progfile_dir(argv[0], main))) {
329     g_warning("captype: init_progfile_dir(): %s", init_progfile_dir_error);
330     g_free(init_progfile_dir_error);
331   } else {
332     /* Register all the plugin types we have. */
333     wtap_register_plugin_types(); /* Types known to libwiretap */
334
335     init_report_err(failure_message,NULL,NULL,NULL);
336
337     /* Scan for plugins.  This does *not* call their registration routines;
338        that's done later. */
339     scan_plugins();
340
341     /* Register all libwiretap plugin modules. */
342     register_all_wiretap_modules();
343   }
344 #endif
345
346   /* Process the options first */
347   while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
348
349     switch (opt) {
350     case 'a':
351       do_append = !do_append;
352       break;
353
354     case 'F':
355       file_type = wtap_short_string_to_file_type_subtype(optarg);
356       if (file_type < 0) {
357         fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
358                 optarg);
359         list_capture_types();
360         exit(1);
361       }
362       break;
363
364     case 'h':
365       printf("Mergecap (Wireshark) %s\n"
366              "Merge two or more capture files into one.\n"
367              "See https://www.wireshark.org for more information.\n",
368              get_ws_vcs_version_info());
369       print_usage(stdout);
370       exit(0);
371       break;
372
373     case 'I':
374       mode = merge_string_to_idb_merge_mode(optarg);
375       if (mode == IDB_MERGE_MODE_MAX) {
376         fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
377                 optarg);
378         list_idb_merge_modes();
379         exit(1);
380       }
381       break;
382
383     case 's':
384       snaplen = get_positive_int(optarg, "snapshot length");
385       break;
386
387     case 'v':
388       verbose = TRUE;
389       break;
390
391     case 'V':
392       show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
393       g_string_free(comp_info_str, TRUE);
394       g_string_free(runtime_info_str, TRUE);
395       exit(0);
396       break;
397
398     case 'w':
399       out_filename = optarg;
400       break;
401
402     case '?':              /* Bad options if GNU getopt */
403       switch(optopt) {
404       case'F':
405         list_capture_types();
406         break;
407       case'I':
408         list_idb_merge_modes();
409         break;
410       default:
411         print_usage(stderr);
412       }
413       exit(1);
414       break;
415     }
416   }
417
418   cb.callback_func = merge_callback;
419   cb.data = NULL;
420
421   /* check for proper args; at a minimum, must have an output
422    * filename and one input file
423    */
424   in_file_count = argc - optind;
425   if (!out_filename) {
426     fprintf(stderr, "mergecap: an output filename must be set with -w\n");
427     fprintf(stderr, "          run with -h for help\n");
428     return 1;
429   }
430   if (in_file_count < 1) {
431     fprintf(stderr, "mergecap: No input files were specified\n");
432     return 1;
433   }
434
435   /* setting IDB merge mode must use PCAPNG output */
436   if (mode != IDB_MERGE_MODE_MAX && file_type != WTAP_FILE_TYPE_SUBTYPE_PCAPNG) {
437     fprintf(stderr, "The IDB merge mode can only be used with PCAPNG output format\n");
438     return 1;
439   }
440
441   /* if they didn't set IDB merge mode, set it to our default */
442   if (mode == IDB_MERGE_MODE_MAX) {
443     mode = IDB_MERGE_MODE_ALL_SAME;
444   }
445
446   /* open the outfile */
447   if (strncmp(out_filename, "-", 2) == 0) {
448     /* use stdout as the outfile */
449     use_stdout = TRUE;
450     out_fd = 1 /*stdout*/;
451   } else {
452     /* open the outfile */
453     out_fd = ws_open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
454     if (out_fd == -1) {
455       fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
456               out_filename, g_strerror(errno));
457       exit(1);
458     }
459   }
460
461   /* merge the files */
462   status = merge_files(out_fd, out_filename, file_type,
463                        (const char *const *) &argv[optind], in_file_count,
464                        do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
465                        &err, &err_info, &err_fileno);
466
467   switch (status) {
468     case MERGE_OK:
469       break;
470
471     case MERGE_USER_ABORTED:
472       /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
473       g_assert(FALSE);
474       break;
475
476     case MERGE_ERR_CANT_OPEN_INFILE:
477       fprintf(stderr, "mergecap: Can't open %s: %s (%s)\n", argv[optind + err_fileno],
478               wtap_strerror(err), err_info ? err_info : "no more information");
479       break;
480
481     case MERGE_ERR_CANT_OPEN_OUTFILE:
482       fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
483                   wtap_strerror(err));
484       if (!use_stdout)
485         ws_close(out_fd);
486       break;
487
488     case MERGE_ERR_CANT_READ_INFILE:      /* fall through */
489     case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
490     case MERGE_ERR_CANT_WRITE_OUTFILE:
491     case MERGE_ERR_CANT_CLOSE_OUTFILE:
492     default:
493       fprintf(stderr, "mergecap: %s\n", err_info ? err_info : "unknown error");
494       break;
495   }
496
497   g_free(err_info);
498
499   return (status == MERGE_OK) ? 0 : 2;
500 }
501
502 /*
503  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
504  *
505  * Local variables:
506  * c-basic-offset: 2
507  * tab-width: 8
508  * indent-tabs-mode: nil
509  * End:
510  *
511  * vi: set shiftwidth=2 tabstop=8 expandtab:
512  * :indentSize=2:tabSize=8:noTabs=true:
513  */
514