1 /* Combine dump files, either by appending or by merging by timestamp
3 * Wireshark - Network traffic analyzer
4 * By Gerald Combs <gerald@wireshark.org>
5 * Copyright 1998 Gerald Combs
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.
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.
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.
21 * Mergecap written by Scott Renfro <scott@renfro.org> based on
22 * editcap by Richard Sharpe and Guy Harris
39 #include <wiretap/wtap.h>
41 #ifndef HAVE_GETOPT_LONG
42 #include <wsutil/wsgetopt.h>
45 #include <wsutil/clopts_common.h>
46 #include <wsutil/cmdarg_err.h>
47 #include <wsutil/crash_info.h>
48 #include <wsutil/filesystem.h>
49 #include <wsutil/file_util.h>
50 #include <wsutil/privileges.h>
51 #include <wsutil/strnatcmp.h>
52 #include <ws_version_info.h>
55 #include <wsutil/plugins.h>
58 #include <wsutil/report_err.h>
60 #include <wiretap/merge.h>
63 #include <wsutil/unicode-utils.h>
70 print_usage(FILE *output)
72 fprintf(output, "\n");
73 fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
74 fprintf(output, "\n");
75 fprintf(output, "Output:\n");
76 fprintf(output, " -a concatenate rather than merge files.\n");
77 fprintf(output, " default is to merge based on frame timestamps.\n");
78 fprintf(output, " -s <snaplen> truncate packets to <snaplen> bytes of data.\n");
79 fprintf(output, " -w <outfile>|- set the output filename to <outfile> or '-' for stdout.\n");
80 fprintf(output, " -F <capture type> set the output file type; default is pcapng.\n");
81 fprintf(output, " an empty \"-F\" option will list the file types.\n");
82 fprintf(output, " -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
83 fprintf(output, " an empty \"-I\" option will list the merge modes.\n");
84 fprintf(output, "\n");
85 fprintf(output, "Miscellaneous:\n");
86 fprintf(output, " -h display this help and exit.\n");
87 fprintf(output, " -v verbose output.\n");
91 * Report an error in command-line arguments.
94 mergecap_cmdarg_err(const char *fmt, va_list ap)
96 fprintf(stderr, "mergecap: ");
97 vfprintf(stderr, fmt, ap);
98 fprintf(stderr, "\n");
102 * Report additional information for an error in command-line arguments.
105 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
107 vfprintf(stderr, fmt, ap);
108 fprintf(stderr, "\n");
112 const char *sstr; /* The short string */
113 const char *lstr; /* The long string */
117 string_compare(gconstpointer a, gconstpointer b)
119 return strcmp(((const struct string_elem *)a)->sstr,
120 ((const struct string_elem *)b)->sstr);
124 string_elem_print(gpointer data, gpointer not_used _U_)
126 fprintf(stderr, " %s - %s\n", ((struct string_elem *)data)->sstr,
127 ((struct string_elem *)data)->lstr);
132 * General errors are reported with an console message in mergecap.
135 failure_message(const char *msg_format, va_list ap)
137 fprintf(stderr, "mergecap: ");
138 vfprintf(stderr, msg_format, ap);
139 fprintf(stderr, "\n");
144 list_capture_types(void) {
146 struct string_elem *captypes;
149 captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
151 fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
152 for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
153 if (wtap_dump_can_open(i)) {
154 captypes[i].sstr = wtap_file_type_subtype_short_string(i);
155 captypes[i].lstr = wtap_file_type_subtype_string(i);
156 list = g_slist_insert_sorted(list, &captypes[i], string_compare);
159 g_slist_foreach(list, string_elem_print, NULL);
165 list_idb_merge_modes(void) {
168 fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
169 for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
170 fprintf(stderr, " %s\n", merge_idb_merge_mode_to_string(i));
175 merge_callback(merge_event event, int num,
176 const merge_in_file_t in_files[], const guint in_file_count,
183 case MERGE_EVENT_INPUT_FILES_OPENED:
184 for (i = 0; i < in_file_count; i++) {
185 fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
186 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
190 case MERGE_EVENT_FRAME_TYPE_SELECTED:
191 /* for this event, num = frame_type */
192 if (num == WTAP_ENCAP_PER_PACKET) {
194 * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
196 int first_frame_type, this_frame_type;
198 first_frame_type = wtap_file_encap(in_files[0].wth);
199 for (i = 1; i < in_file_count; i++) {
200 this_frame_type = wtap_file_encap(in_files[i].wth);
201 if (first_frame_type != this_frame_type) {
202 fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
203 fprintf(stderr, " defaulting to WTAP_ENCAP_PER_PACKET\n");
204 fprintf(stderr, " %s had type %s (%s)\n",
205 in_files[0].filename,
206 wtap_encap_string(first_frame_type),
207 wtap_encap_short_string(first_frame_type));
208 fprintf(stderr, " %s had type %s (%s)\n",
209 in_files[i].filename,
210 wtap_encap_string(this_frame_type),
211 wtap_encap_short_string(this_frame_type));
216 fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
217 wtap_encap_string(num),
218 wtap_encap_short_string(num));
221 case MERGE_EVENT_READY_TO_MERGE:
222 fprintf(stderr, "mergecap: ready to merge records\n");
225 case MERGE_EVENT_PACKET_WAS_READ:
226 /* for this event, num = count */
227 fprintf(stderr, "Record: %d\n", num);
230 case MERGE_EVENT_DONE:
231 fprintf(stderr, "mergecap: merging complete\n");
235 /* false = do not stop merging */
241 main(int argc, char *argv[])
243 GString *comp_info_str;
244 GString *runtime_info_str;
246 static const struct option long_options[] = {
247 {"help", no_argument, NULL, 'h'},
248 {"version", no_argument, NULL, 'V'},
251 gboolean do_append = FALSE;
252 gboolean verbose = FALSE;
253 int in_file_count = 0;
255 #ifdef PCAP_NG_DEFAULT
256 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
258 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
262 gchar *err_info = NULL;
264 char *out_filename = NULL;
266 idb_merge_mode mode = IDB_MERGE_MODE_MAX;
267 gboolean use_stdout = FALSE;
268 merge_progress_callback_t cb;
271 char *init_progfile_dir_error;
274 cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
277 arg_list_utf_16to8(argc, argv);
278 create_app_running_mutex();
281 /* Get the compile-time version information string */
282 comp_info_str = get_compiled_version_info(NULL, NULL);
284 /* Get the run-time version information string */
285 runtime_info_str = get_runtime_version_info(NULL);
287 /* Add it to the information to be reported on a crash. */
288 ws_add_crash_info("Mergecap (Wireshark) %s\n"
293 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
294 g_string_free(comp_info_str, TRUE);
295 g_string_free(runtime_info_str, TRUE);
298 * Get credential information for later use.
300 init_process_policies();
301 init_open_routines();
304 /* Register wiretap plugins */
305 if ((init_progfile_dir_error = init_progfile_dir(argv[0], main))) {
306 g_warning("mergecap: init_progfile_dir(): %s", init_progfile_dir_error);
307 g_free(init_progfile_dir_error);
309 /* Register all the plugin types we have. */
310 wtap_register_plugin_types(); /* Types known to libwiretap */
312 init_report_err(failure_message,NULL,NULL,NULL);
314 /* Scan for plugins. This does *not* call their registration routines;
317 Don't report failures to load plugins because most (non-wiretap)
318 plugins *should* fail to load (because we're not linked against
319 libwireshark and dissector plugins need libwireshark).*/
320 scan_plugins(DONT_REPORT_LOAD_FAILURE);
322 /* Register all libwiretap plugin modules. */
323 register_all_wiretap_modules();
327 /* Process the options first */
328 while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
332 do_append = !do_append;
336 file_type = wtap_short_string_to_file_type_subtype(optarg);
338 fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
340 list_capture_types();
346 printf("Mergecap (Wireshark) %s\n"
347 "Merge two or more capture files into one.\n"
348 "See https://www.wireshark.org for more information.\n",
349 get_ws_vcs_version_info());
355 mode = merge_string_to_idb_merge_mode(optarg);
356 if (mode == IDB_MERGE_MODE_MAX) {
357 fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
359 list_idb_merge_modes();
365 snaplen = get_nonzero_guint32(optarg, "snapshot length");
373 comp_info_str = get_compiled_version_info(NULL, NULL);
374 runtime_info_str = get_runtime_version_info(NULL);
375 show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
376 g_string_free(comp_info_str, TRUE);
377 g_string_free(runtime_info_str, TRUE);
382 out_filename = optarg;
385 case '?': /* Bad options if GNU getopt */
388 list_capture_types();
391 list_idb_merge_modes();
401 cb.callback_func = merge_callback;
404 /* check for proper args; at a minimum, must have an output
405 * filename and one input file
407 in_file_count = argc - optind;
409 fprintf(stderr, "mergecap: an output filename must be set with -w\n");
410 fprintf(stderr, " run with -h for help\n");
413 if (in_file_count < 1) {
414 fprintf(stderr, "mergecap: No input files were specified\n");
418 /* setting IDB merge mode must use PCAPNG output */
419 if (mode != IDB_MERGE_MODE_MAX && file_type != WTAP_FILE_TYPE_SUBTYPE_PCAPNG) {
420 fprintf(stderr, "The IDB merge mode can only be used with PCAPNG output format\n");
424 /* if they didn't set IDB merge mode, set it to our default */
425 if (mode == IDB_MERGE_MODE_MAX) {
426 mode = IDB_MERGE_MODE_ALL_SAME;
429 /* open the outfile */
430 if (strcmp(out_filename, "-") == 0) {
431 /* use stdout as the outfile */
433 out_fd = 1 /*stdout*/;
435 /* open the outfile */
436 out_fd = ws_open(out_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
438 fprintf(stderr, "mergecap: Couldn't open output file %s: %s\n",
439 out_filename, g_strerror(errno));
444 /* merge the files */
445 status = merge_files(out_fd, out_filename, file_type,
446 (const char *const *) &argv[optind], in_file_count,
447 do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
448 &err, &err_info, &err_fileno);
454 case MERGE_USER_ABORTED:
455 /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
459 case MERGE_ERR_CANT_OPEN_INFILE:
460 fprintf(stderr, "mergecap: Can't open %s: %s (%s)\n", argv[optind + err_fileno],
461 wtap_strerror(err), err_info ? err_info : "no more information");
464 case MERGE_ERR_CANT_OPEN_OUTFILE:
465 fprintf(stderr, "mergecap: Can't open or create %s: %s\n", out_filename,
471 case MERGE_ERR_CANT_READ_INFILE: /* fall through */
472 case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
473 case MERGE_ERR_CANT_WRITE_OUTFILE:
474 case MERGE_ERR_CANT_CLOSE_OUTFILE:
476 fprintf(stderr, "mergecap: %s\n", err_info ? err_info : "unknown error");
482 return (status == MERGE_OK) ? 0 : 2;
486 * Editor modelines - http://www.wireshark.org/tools/modelines.html
491 * indent-tabs-mode: nil
494 * vi: set shiftwidth=2 tabstop=8 expandtab:
495 * :indentSize=2:tabSize=8:noTabs=true: