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_message.h>
60 #include <wiretap/merge.h>
63 #include <wsutil/unicode-utils.h>
66 #include "ui/failure_message.h"
72 print_usage(FILE *output)
74 fprintf(output, "\n");
75 fprintf(output, "Usage: mergecap [options] -w <outfile>|- <infile> [<infile> ...]\n");
76 fprintf(output, "\n");
77 fprintf(output, "Output:\n");
78 fprintf(output, " -a concatenate rather than merge files.\n");
79 fprintf(output, " default is to merge based on frame timestamps.\n");
80 fprintf(output, " -s <snaplen> truncate packets to <snaplen> bytes of data.\n");
81 fprintf(output, " -w <outfile>|- set the output filename to <outfile> or '-' for stdout.\n");
82 fprintf(output, " -F <capture type> set the output file type; default is pcapng.\n");
83 fprintf(output, " an empty \"-F\" option will list the file types.\n");
84 fprintf(output, " -I <IDB merge mode> set the merge mode for Interface Description Blocks; default is 'all'.\n");
85 fprintf(output, " an empty \"-I\" option will list the merge modes.\n");
86 fprintf(output, "\n");
87 fprintf(output, "Miscellaneous:\n");
88 fprintf(output, " -h display this help and exit.\n");
89 fprintf(output, " -v verbose output.\n");
93 * Report an error in command-line arguments.
96 mergecap_cmdarg_err(const char *fmt, va_list ap)
98 fprintf(stderr, "mergecap: ");
99 vfprintf(stderr, fmt, ap);
100 fprintf(stderr, "\n");
104 * Report additional information for an error in command-line arguments.
107 mergecap_cmdarg_err_cont(const char *fmt, va_list ap)
109 vfprintf(stderr, fmt, ap);
110 fprintf(stderr, "\n");
114 const char *sstr; /* The short string */
115 const char *lstr; /* The long string */
119 string_compare(gconstpointer a, gconstpointer b)
121 return strcmp(((const struct string_elem *)a)->sstr,
122 ((const struct string_elem *)b)->sstr);
126 string_elem_print(gpointer data, gpointer not_used _U_)
128 fprintf(stderr, " %s - %s\n", ((struct string_elem *)data)->sstr,
129 ((struct string_elem *)data)->lstr);
134 * General errors and warnings are reported with an console message
138 failure_warning_message(const char *msg_format, va_list ap)
140 fprintf(stderr, "mergecap: ");
141 vfprintf(stderr, msg_format, ap);
142 fprintf(stderr, "\n");
147 list_capture_types(void) {
149 struct string_elem *captypes;
152 captypes = g_new(struct string_elem,WTAP_NUM_FILE_TYPES_SUBTYPES);
154 fprintf(stderr, "mergecap: The available capture file types for the \"-F\" flag are:\n");
155 for (i = 0; i < WTAP_NUM_FILE_TYPES_SUBTYPES; i++) {
156 if (wtap_dump_can_open(i)) {
157 captypes[i].sstr = wtap_file_type_subtype_short_string(i);
158 captypes[i].lstr = wtap_file_type_subtype_string(i);
159 list = g_slist_insert_sorted(list, &captypes[i], string_compare);
162 g_slist_foreach(list, string_elem_print, NULL);
168 list_idb_merge_modes(void) {
171 fprintf(stderr, "mergecap: The available IDB merge modes for the \"-I\" flag are:\n");
172 for (i = 0; i < IDB_MERGE_MODE_MAX; i++) {
173 fprintf(stderr, " %s\n", merge_idb_merge_mode_to_string(i));
178 merge_callback(merge_event event, int num,
179 const merge_in_file_t in_files[], const guint in_file_count,
186 case MERGE_EVENT_INPUT_FILES_OPENED:
187 for (i = 0; i < in_file_count; i++) {
188 fprintf(stderr, "mergecap: %s is type %s.\n", in_files[i].filename,
189 wtap_file_type_subtype_string(wtap_file_type_subtype(in_files[i].wth)));
193 case MERGE_EVENT_FRAME_TYPE_SELECTED:
194 /* for this event, num = frame_type */
195 if (num == WTAP_ENCAP_PER_PACKET) {
197 * Find out why we had to choose WTAP_ENCAP_PER_PACKET.
199 int first_frame_type, this_frame_type;
201 first_frame_type = wtap_file_encap(in_files[0].wth);
202 for (i = 1; i < in_file_count; i++) {
203 this_frame_type = wtap_file_encap(in_files[i].wth);
204 if (first_frame_type != this_frame_type) {
205 fprintf(stderr, "mergecap: multiple frame encapsulation types detected\n");
206 fprintf(stderr, " defaulting to WTAP_ENCAP_PER_PACKET\n");
207 fprintf(stderr, " %s had type %s (%s)\n",
208 in_files[0].filename,
209 wtap_encap_string(first_frame_type),
210 wtap_encap_short_string(first_frame_type));
211 fprintf(stderr, " %s had type %s (%s)\n",
212 in_files[i].filename,
213 wtap_encap_string(this_frame_type),
214 wtap_encap_short_string(this_frame_type));
219 fprintf(stderr, "mergecap: selected frame_type %s (%s)\n",
220 wtap_encap_string(num),
221 wtap_encap_short_string(num));
224 case MERGE_EVENT_READY_TO_MERGE:
225 fprintf(stderr, "mergecap: ready to merge records\n");
228 case MERGE_EVENT_PACKET_WAS_READ:
229 /* for this event, num = count */
230 fprintf(stderr, "Record: %d\n", num);
233 case MERGE_EVENT_DONE:
234 fprintf(stderr, "mergecap: merging complete\n");
238 /* false = do not stop merging */
244 main(int argc, char *argv[])
246 GString *comp_info_str;
247 GString *runtime_info_str;
248 char *init_progfile_dir_error;
250 static const struct option long_options[] = {
251 {"help", no_argument, NULL, 'h'},
252 {"version", no_argument, NULL, 'V'},
255 gboolean do_append = FALSE;
256 gboolean verbose = FALSE;
257 int in_file_count = 0;
259 #ifdef PCAP_NG_DEFAULT
260 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAPNG; /* default to pcap format */
262 int file_type = WTAP_FILE_TYPE_SUBTYPE_PCAP; /* default to pcapng format */
265 gchar *err_info = NULL;
267 guint32 err_framenum;
268 char *out_filename = NULL;
269 merge_result status = MERGE_OK;
270 idb_merge_mode mode = IDB_MERGE_MODE_MAX;
271 merge_progress_callback_t cb;
273 cmdarg_err_init(mergecap_cmdarg_err, mergecap_cmdarg_err_cont);
276 arg_list_utf_16to8(argc, argv);
277 create_app_running_mutex();
280 /* Get the compile-time version information string */
281 comp_info_str = get_compiled_version_info(NULL, NULL);
283 /* Get the run-time version information string */
284 runtime_info_str = get_runtime_version_info(NULL);
286 /* Add it to the information to be reported on a crash. */
287 ws_add_crash_info("Mergecap (Wireshark) %s\n"
292 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
293 g_string_free(comp_info_str, TRUE);
294 g_string_free(runtime_info_str, TRUE);
297 * Get credential information for later use.
299 init_process_policies();
302 * Attempt to get the pathname of the directory containing the
305 init_progfile_dir_error = init_progfile_dir(argv[0], main);
306 if (init_progfile_dir_error != NULL) {
308 "mergecap: Can't get pathname of directory containing the mergecap program: %s.\n",
309 init_progfile_dir_error);
310 g_free(init_progfile_dir_error);
316 init_report_message(failure_warning_message, failure_warning_message,
319 /* Scan for plugins. This does *not* call their registration routines;
322 Don't report failures to load plugins because most (non-wiretap)
323 plugins *should* fail to load (because we're not linked against
324 libwireshark and dissector plugins need libwireshark).*/
325 scan_plugins(DONT_REPORT_LOAD_FAILURE);
327 /* Register all libwiretap plugin modules. */
328 register_all_wiretap_modules();
331 /* Process the options first */
332 while ((opt = getopt_long(argc, argv, "aF:hI:s:vVw:", long_options, NULL)) != -1) {
336 do_append = !do_append;
340 file_type = wtap_short_string_to_file_type_subtype(optarg);
342 fprintf(stderr, "mergecap: \"%s\" isn't a valid capture file type\n",
344 list_capture_types();
345 status = MERGE_ERR_INVALID_OPTION;
351 printf("Mergecap (Wireshark) %s\n"
352 "Merge two or more capture files into one.\n"
353 "See https://www.wireshark.org for more information.\n",
354 get_ws_vcs_version_info());
360 mode = merge_string_to_idb_merge_mode(optarg);
361 if (mode == IDB_MERGE_MODE_MAX) {
362 fprintf(stderr, "mergecap: \"%s\" isn't a valid IDB merge mode\n",
364 list_idb_merge_modes();
365 status = MERGE_ERR_INVALID_OPTION;
371 snaplen = get_nonzero_guint32(optarg, "snapshot length");
379 comp_info_str = get_compiled_version_info(NULL, NULL);
380 runtime_info_str = get_runtime_version_info(NULL);
381 show_version("Mergecap (Wireshark)", comp_info_str, runtime_info_str);
382 g_string_free(comp_info_str, TRUE);
383 g_string_free(runtime_info_str, TRUE);
388 out_filename = optarg;
391 case '?': /* Bad options if GNU getopt */
394 list_capture_types();
397 list_idb_merge_modes();
402 status = MERGE_ERR_INVALID_OPTION;
408 cb.callback_func = merge_callback;
411 /* check for proper args; at a minimum, must have an output
412 * filename and one input file
414 in_file_count = argc - optind;
416 fprintf(stderr, "mergecap: an output filename must be set with -w\n");
417 fprintf(stderr, " run with -h for help\n");
418 status = MERGE_ERR_INVALID_OPTION;
421 if (in_file_count < 1) {
422 fprintf(stderr, "mergecap: No input files were specified\n");
426 /* setting IDB merge mode must use PCAPNG output */
427 if (mode != IDB_MERGE_MODE_MAX && file_type != WTAP_FILE_TYPE_SUBTYPE_PCAPNG) {
428 fprintf(stderr, "The IDB merge mode can only be used with PCAPNG output format\n");
429 status = MERGE_ERR_INVALID_OPTION;
433 /* if they didn't set IDB merge mode, set it to our default */
434 if (mode == IDB_MERGE_MODE_MAX) {
435 mode = IDB_MERGE_MODE_ALL_SAME;
438 /* open the outfile */
439 if (strcmp(out_filename, "-") == 0) {
440 /* merge the files to the standard output */
441 status = merge_files_to_stdout(file_type,
442 (const char *const *) &argv[optind],
443 in_file_count, do_append, mode, snaplen,
444 "mergecap", verbose ? &cb : NULL,
445 &err, &err_info, &err_fileno, &err_framenum);
447 /* merge the files to the outfile */
448 status = merge_files(out_filename, file_type,
449 (const char *const *) &argv[optind], in_file_count,
450 do_append, mode, snaplen, "mergecap", verbose ? &cb : NULL,
451 &err, &err_info, &err_fileno, &err_framenum);
458 case MERGE_USER_ABORTED:
459 /* we don't catch SIGINT/SIGTERM (yet?), so we couldn't have aborted */
463 case MERGE_ERR_CANT_OPEN_INFILE:
464 cfile_open_failure_message("mergecap", argv[optind + err_fileno],
468 case MERGE_ERR_CANT_OPEN_OUTFILE:
469 cfile_dump_open_failure_message("mergecap", out_filename, err, file_type);
472 case MERGE_ERR_CANT_READ_INFILE:
473 cfile_read_failure_message("mergecap", argv[optind + err_fileno],
477 case MERGE_ERR_BAD_PHDR_INTERFACE_ID:
478 cmdarg_err("Record %u of \"%s\" has an interface ID that does not match any IDB in its file.",
479 err_framenum, argv[optind + err_fileno]);
482 case MERGE_ERR_CANT_WRITE_OUTFILE:
483 cfile_write_failure_message("mergecap", argv[optind + err_fileno],
484 out_filename, err, err_info, err_framenum,
488 case MERGE_ERR_CANT_CLOSE_OUTFILE:
489 cfile_close_failure_message(out_filename, err);
493 cmdarg_err("Unknown merge_files error %d", status);
503 return (status == MERGE_OK) ? 0 : 2;
507 * Editor modelines - http://www.wireshark.org/tools/modelines.html
512 * indent-tabs-mode: nil
515 * vi: set shiftwidth=2 tabstop=8 expandtab:
516 * :indentSize=2:tabSize=8:noTabs=true: